华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 描述 display_name 是 String 实例名。 可以输入中文、数字、字母、下划线、点、破折号。长度介于3-100之间 refresh_interval 是 String 自动休眠时长。arm架构,自动休眠时长只能设置成30，60。x86架构可取值为30，60，240，1440和-1。除-1外，其它值的单位为“分钟”。实例无操作超过自动休眠时长后，将会被暂停（已保存的数据不会被删除）。-1表示实例不会自动停止

响应示例 状态码： 200 OK { "result" : { "security" : { "status" : "success", "errors" : [ ] }, "basicInformation" : { "status" : "success", "errors" : [ ] }, "file" : { "status" : "success", "errors" : [ ] }, "upload" : { "status" : "success", "errors" : [ ] } }, "status" : "success"} 状态码： 403 Forbidden { "error_msg" : "suspended", "error_code" : "IDE.00000005"} 状态码： 406 Not Acceptable { "error_msg" : "The user has not signed the service declare.", "error_code" : "IDE.00010001"}

响应示例 状态码： 200 OK { "result" : { "size" : 100, "total_items_count" : 20, "items_before" : 0, "items" : [ { "id" : 17, "category" : "Programming Languages", "scene_name" : "cloudide", "type" : 0, "support_ide" : 48 }, { "id" : 18, "category" : "Snippets", "scene_name" : "cloudide", "type" : 0, "support_ide" : 16 } ], "empty" : false }, "status" : "success"}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 result Object 返回值 status String 状态 状态码： 401 表3 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 403 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

基本概念 账号 用户注册华为云时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。 Region分为通用Region和专属Region： 通用Region指面向公共租户提供通用云服务的Region。 专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 华为云的区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。 如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 父主题： 使用前必读

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "cn-north-1", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 error Error object - result Object 结果 status String 状态 表5 Error 参数 参数类型 描述 code String 错误码 reason String 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 406 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

终端节点 终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，CodeArts IDE Online的终端节点如表1所示，请您根据业务需要选择对应区域的终端节点。 表1 CodeArts IDE Online的终端节点 区 域名 称 区域 终端节点（Endpoint） 协议类型 华北-北京四 cn-north-4 cloudide.cn-north-4.myhuaweicloud.com HTTPS 父主题： 使用前必读

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result InstanceStatusResponse object 返回值 status String 状态 表4 InstanceStatusResponse 参数 参数类型 描述 server_url String 服务链接 status String 实例状态。 DELETED 已删除 DELETE_FAILED 删除失败 DELETING 删除中 READY 热实例就绪状态 RUNNING 正在运行 STARTING 正在启动 STOPPED 已停止 STOPPING 停止中 UPDATE 更新Schdule信息 WAITING 热实例创建初始态 枚举值： DELETED DELETE_FAILED DELETING READY RUNNING STARTING STOPPED STOPPING UPDATE WAITING 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 406 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 result AccountStatus object 返回值 status String 状态 表3 AccountStatus 参数 参数类型 描述 cur_org_create_role Boolean 是否有创建实例权限 cur_org_open Boolean 账号所属租户是否开通服务 has_free_trial Boolean 免费试用 show_manage Boolean 是否有管理入口的权限 状态码： 403 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 406 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应示例 状态码： 200 OK { "templates" : [ { "template_id" : 5, "name" : "web-java-spring", "source" : { "location" : "git@codehub.alpha.devcloud.inhuawei.com:Demo00226/JavaWeb.git", "type" : "git", "parameters" : { } }, "display_name" : "web-java-spring", "path" : "/web-java-spring", "description" : "A basic example using Spring servlets. The app returns\nvalues entered into a submit form.", "project_type" : "maven", "region" : "cn-north-7", "tags" : [ "maven", "spring", "java", "web" ], "arch" : "x86,arm" } ], "status" : "success"}

响应示例 状态码： 200 OK { "result" : { "instance_id" : "zhkfjt", "expiration" : 1635837203706, "interval" : 30 }, "status" : "success"} 状态码： 403 Forbidden { "error_code" : "IDE.00010129", "error_msg" : "Instance does not belong to the user or tenant"} 状态码： 404 Not Found { "error_code" : "IDE.00010030", "error_msg" : "instance not exist"} 状态码： 406 Not Acceptable { "error_code" : "IDE.00010048", "error_msg" : "active error:instance status error"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result ExpireVo object 返回值 status String 状态 表4 ExpireVo 参数 参数类型 描述 expiration Long 过期时间。UNIX时间戳，单位毫秒。eg:1635905480465 instance_id String CodeArtsIDEOnline实例id interval Long CodeArtsIDEOnline实例自动休眠时长，单位‘分钟’ 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 406 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

URI GET /v2/instances 表1 Query参数 参数 是否必选 参数类型 描述 limit 否 Long 每页显示的条目数量最大值为100,最小值为1 offset 否 Long 偏移量，表示从此偏移量开始查询 is_temporary 否 Boolean 是否页面显示（以标签配置为准） label 否 String 标签 search 否 String 关键字查询(根据实例名，描述模糊查询) sort_dir 否 String 排序方式 asc/desc sort_key 否 String 排序字段。 display_name 实例名、status状态、pvc_quantity 存储容量、created_time 创建时间、stack_id 技术栈

响应示例 状态码： 200 OK { "instances" : { "items_before" : 0, "size" : 10, "items" : [ { "updated_time" : "2020-03-17 15:21:36", "private" : false, "owner_id" : "d78cbac186b744899480f25bd022f...", "description" : "ddd", "cpu_memory" : "2U4G", "domain_name" : "IAM_DOMAIN_NAME_A", "is_temporary" : false, "stack_id" : "java", "id" : "instancewrqztsgn12imjq7e", "created_time" : "2020-01-06 15:25:04", "owner_name" : "ide_owner_name", "refresh_interval" : 30, "display_name" : "test001", "organization_id" : "6251b1ee539f4c02ad4b83daeda81633...", "name" : "ide_instance8bmjgqx6vfrb9e9n", "platform_id" : 1, "attributes" : { "cpu_limit" : "2", "pvc_quantity" : "5Gi", "memory_limit_bytes" : "4294967296" }, "pvc_quantity" : "5GB", "arch" : "x86", "region" : "cn-north-7", "status" : "STOPPED", "visitor_id" : "c78cbac186b744899480f25bd022f...", "visitor_name" : "ide_visitor_name", "visitor_domain_name" : "IAM_DOMAIN_NAME_B" } ], "empty" : false }, "status" : "success"}

状态码 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本，无法完成处理。 父主题： 附录

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表2 请求Body参数 参数 是否必选 参数类型 描述 extension_id 是 String 插件id comment 否 String 评星内容 stars 是 Integer 评星总数

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result Object 返回值 status String 状态 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result Object 返回值 status String 状态 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应示例 状态码： 200 successful operation { "result" : { "size" : 30, "total_items_count" : 5, "items_before" : 0, "items" : [ { "evaluation" : { "id" : 334, "extension_id" : "17c341ee-797e-4824-aec5-6fafb3c0eced", "extension_name" : "CodeArtsIDEOnline-tomcat", "commentator" : { "id" : "45616456dsadaw1231dsa65dsa156", "name" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxx", "domainId" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "domainName" : "xxxxxxxxxxxxxxxxxxxxxxxxx", "deletedTime" : 0 }, "text" : "测试3", "create_time" : "2022-08-03 19:40:08", "publisher" : { "publisher_id" : "a6f6b0c8-31c8-4ffd-a4b8-482c894f13cc", "publisher_name" : "adashen" }, "status" : 1, "count" : 1 }, "evaluationReply" : [ { "id" : 116, "extension_id" : "17c341ee-797e-4824-aec5-6fafb3c0eced", "extension_name" : "CodeArtsIDEOnline-tomcat", "commentator" : { "id" : "ff46a666ff6c4ca99fcfe2abf64e3ab9", "name" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxx", "domainId" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "domainName" : "xxxxxxxxxxxxxxxxxxxxxxxxx", "deletedTime" : 0 }, "text" : "测试4", "create_time" : "2022-08-03 19:40:59", "publisher" : { "publisher_id" : "45616456dsadaw1231dsa65dsa156", "publisher_name" : "adashen" }, "status" : 1, "evaluation_id" : 334, "reply_to" : { "id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxx", "name" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxx", "domainName" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxx", "deletedTime" : 0 } } ] } ], "empty" : false }, "status" : "success"}

URI GET /v2/{org_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 org_id 是 String 租户id（对应华为云账号的domainId） 表2 Query参数 参数 是否必选 参数类型 描述 is_temporary 否 Boolean 是否页面显示（以标签配置为准） limit 否 Long 每页显示的条目数量 10/15/30 offset 否 Long 偏移量，表示从此偏移量开始查询 search 否 String 关键字查询(根据实例名，描述模糊查询)

响应示例 状态码： 200 OK { "instances" : { "items_before" : 0, "size" : 10, "items" : [ { "updated_time" : "2020-03-17 15:21:36", "private" : false, "owner_id" : "d78cbac186b744899480f25bd022f...", "description" : "ddd", "cpu_memory" : "2U4G", "domain_name" : "IAM_DOMAIN_NAME_A", "is_temporary" : false, "stack_id" : "java", "id" : "instancewrqztsgn12imjq7e", "created_time" : "2020-01-06 15:25:04", "owner_name" : "ide_owner_name", "refresh_interval" : 30, "display_name" : "test001", "organization_id" : "6251b1ee539f4c02ad4b83daeda81633...", "name" : "ide_instance8bmjgqx6vfrb9e9n", "platform_id" : 1, "attributes" : { "cpu_limit" : "2", "pvc_quantity" : "5Gi", "memory_limit_bytes" : "4294967296" }, "pvc_quantity" : "5GB", "arch" : "x86", "region" : "cn-north-7", "status" : "STOPPED", "visitor_id" : "c78cbac186b744899480f25bd022f...", "visitor_name" : "ide_visitor_name", "visitor_domain_name" : "IAM_DOMAIN_NAME_B" } ], "empty" : false }, "status" : "success"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result Object 返回值 status String 状态 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 x-publisher-token和X-Auth-Token必传一个 x-publisher-token 否 String 发布商凭证,x-publisher-token和X-Auth-Token必传一个 表3 请求Body参数 参数 是否必选 参数类型 描述 type 是 Integer 任务类型

错误码说明 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 IDE.00010070 Free user limit not Found! 免费资源的配置无法找到，请稍后再试 请稍后再试 403 IDE.00000004 not subscribe cloudide 未开通CloudIDE服务 开通CloudIDE服务 403 IDE.00000005 suspended 您的账户已欠费冻结 账户充值 403 IDE.00000007 not verified 账号未实名认证，请认证后再试 账号实名认证 403 IDE.00000010 account is not normal 账号状态异常，请稍后再试 检查账号是否异常 403 IDE.00010000 OPERATE LIMIT 操作受限，请确认后再操作 请确认是否有权限 403 IDE.00010085 User already exists 用户已经存在，请确认后再试 确认用户是否已存在 403 IDE.00010086 blackList user 黑名单用户不能添加 使用白名单用户 403 IDE.00010092 no such action 没有这样的动作 请确认是否有权限 406 IDE.00000011 unusual limit 15 minute 15分钟内累计输入用户名错误5次，请15分钟后再试 请15分钟后再试 406 IDE.00000097 parameter is null or error 参数错误 参数规格：参考相应的API文档 406 IDE.00010027 Instance name is exist 实例已经存在 修改实例名 406 IDE.00010028 Instance is Starting, Can't remove it now 实例正在启动，不能被删除，请稍后再试 实例停止后再删除 406 IDE.00010029 Instance has been deleted or is in deleting 实例已经被删除或正在删除，请勿重复删除 等待操作完成 406 IDE.00010030 instance not exist 实例不存在，请确认后操作 确认实例是否存在 406 IDE.00010048 active error:instance status error 实例状态异常 请稍后再试 406 IDE.00010054 Could not stop the ide, instance status is not running or starting 实例不在运行状态，无法停止，请稍后再试 实例运行后在停止 406 IDE.00010058 current user is not subUser in Domain 当前用户不是该组织下的子账号，请确认后操作 确认用户是否为组织下子账号 406 IDE.00010071 Free resource not enough! 免费资源不足，请稍后再试 使用其他免费技术栈资源或购买cloudide服务 406 IDE.00010087 not whiteList user 您不是白名单用户，请确认后操作 确认是否为白名单用户 406 IDE.00010091 Organization already existed 组织已经存在，请确认后操作 确认组织是否存在 406 IDE.00010101 INSTANCE_START_ERROR 实例启动失败，请稍后再试 请稍后再试 406 IDE.00010103 instance number limit 实例数量已经超过上限，请删除旧有实例后再试 删除旧实例 406 IDE.00010104 instance resource limit 实例资源受限，请稍后再试 请稍后再试 406 IDE.00010105 instance arm number limit arm实例数量已经超过上限，请删除旧有实例后再试 删除旧实例 406 IDE.00040001 config error 配置错误 检查配置 406 IDE.00040002 label is not correct 标签不正确 参数规格：参考相应的API文档 406 IDE.00040004 The character string length is incorrect. 字符串长度不匹配 检查字符串 406 IDE.00040005 Unsupported for spec platform or stack 不支持的平台或技术栈规格 参数规格：参考相应的API文档 500 IDE.00000040 outer http request error 外部HTTP请求错误 请稍后再试 500 IDE.00000100 Internal Server Error 服务异常，请稍后再试 服务异常，请稍后再试 500 IDE.00020001 get Repository By ProjectId error 获取仓库失败 请稍后再试 500 IDE.00020002 get Branches By RepoName error 获取分支失败 请稍后再试 500 IDE.00020003 get Related Project error 获取工程失败，请稍后再试 请稍后再试 500 IDE.00020004 get Project user error 获取工程用户信息失败，请稍后再试 请稍后再试

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 stack StacksTags object 技术栈 status String 状态 表4 StacksTags 参数 参数类型 描述 stack_list Array of StackInfo objects 技术栈列表 tags Array of strings 技术栈tag集合 表5 StackInfo 参数 参数类型 描述 arm_config StacksConfig object ARM配置 bundle_url String bundleUrl config StacksConfig object X86配置 created_time String 创建时间 delete Boolean 是否删除 description String 描述 disable Boolean 是否可用 display_name String 显示名称 id Long id label String 标签 logo String 图标 region String region show Boolean 是否显示 stack_name String 技术栈名称 tags Array of strings tags updated_time String 修改时间 users Array of strings 使用者 表6 StacksConfig 参数 参数类型 描述 attributes StacksAttribute object 属性值 recipe Recipe object 镜像 表7 StacksAttribute 参数 参数类型 描述 specs Array of strings 规格列表 suggest String 提示id suggest_title String 提示信息 volumes Array of strings 卷容量列表 表8 Recipe 参数 参数类型 描述 content String 镜像内容 type String 镜像类型 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

响应示例 状态码： 200 OK { "stack" : { "tags" : [ "Quantum", "Java", "Maven", "CPP", "JavaScript", "Vue", "ServiceComb", "GO", "Node.js", "Ruby", "Python" ], "stack_list" : [ { "id" : 6, "stack_name" : "python", "display_name" : "Python", "tags" : [ "Python" ], "region" : "cn-north-7", "users" : [ "ide" ], "description" : "支持Python开发，集成pypi", "disable" : false, "show" : true, "arm_config" : { "recipe" : { "content" : "hishell-python:x86_64_inner_latest_fuxi", "type" : "dockerimage" }, "attributes" : { "specs" : [ "4U8G" ], "volumes" : [ "5GB", "10GB", "20GB" ] } }, "config" : { "recipe" : { "content" : "hishell-python:x86_64_inner_latest_fuxi", "type" : "dockerimage" }, "attributes" : { "specs" : [ "1U1G", "2U4G" ], "volumes" : [ "5GB", "10GB", "20GB" ] } }, "created_time" : "2021-10-15 14:28:40", "updated_time" : "2021-12-27 16:01:22", "bundle_url" : "https://test-static-resource.obs.cn-north-7.ulanqab.huawei.com/CloudIDEStatic/1.0.33.20211227153454/bundle.js", "delete" : false } ] }, "status" : "success"} 状态码： 403 Forbidden { "error_msg" : "not subscribe codeArts ide online", "error_code" : "IDE.00000004"}

查询IDE实例列表 指定limit查询IDE实例列表。 GET: https://{endpoint}/v2/instances?limit=10 { "instances" : { "items_before" : 0, "size" : 10, "total_items_count" : 1, "items" : [ { "is_private" : false, "updated_time" : "2020-03-17 15:21:36", "private" : false, "role" : { "role" : "owner", "id" : "1" }, "owner_id" : "0dc311a468024ad5bf18591c8361272a", "description" : "ddd", "cpu_memory" : "2U4G", "domain_name" : "devcloud_cloudide_name_g01", "role_id" : "1", "is_temporary" : false, "stack_id" : "java", "id" : "instancewrqztsgn12imjq7e", "created_time" : "2020-01-06 15:25:04", "owner_name" : "devcloud_cloudide_pwx501764_g01", "refresh_interval" : 30, "display_name" : "test001", "organization_id" : "6251b1ee539f4c02ad4b83daeda81633", "name" : "cloudide-instance4xceoej8vvpn32lx", "platform_id" : 1, "attributes" : { "cpu_limit" : "2", "pvc_quantity" : "5Gi", "memory_limit_bytes" : "4294967296" }, "pvc_quantity" : "5GB", "arch" : "x86", "region" : "cn-north-7", "actions" : [ { "role_id" : "1", "action_cname" : "创建实例", "id" : "166", "actions" : "CREATE_INSTANCE" }, { "role_id" : "1", "action_cname" : "删除实例", "id" : "167", "actions" : "DELETE_INSTANCE" }, { "role_id" : "1", "action_cname" : "更新实例", "id" : "168", "actions" : "UPDATE_INSTANCE" }, { "role_id" : "1", "action_cname" : "查询实例列表", "id" : "169", "actions" : "QUERY_INSTANCE" }, { "role_id" : "1", "action_cname" : "运行实例", "id" : "170", "actions" : "RUN_INSTANCE" } ], "status" : "STOPPED" } ], "empty" : false }, "status" : "success"} 通过limit和关键字过滤查询实例。 如：查询实例名称或描述中含test的实例列表。 GET: https://{endpoint}/v2/instances?limit=10&search=test

支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 “√”表示支持，“x”表示暂不支持。 CodeArts IDE Online支持的自定义策略授权项如下所示： 公共查询权限 实例相关权限

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result Object 返回值 status String 状态 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码