华为云用户手册

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 关键字查询(根据实例名，描述模糊查询)

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 名称 描述 是否必选 备注 Content-Type 消息体的类型（格式） 是 默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token 用户Token 否 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 X-Project-ID 子项目ID 否 在多项目场景中使用 X-Domain-ID 账号ID - - 公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参加AK/SK认证。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxx为project的名称，如cn-north-1，您可以从地区和终端节点中获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求URI 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 请求URI由四部分构成：{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 各参数含义如下： 参数 说明 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从终端节点中获取。例如，IAM服务在华北-北京一区域的Endpoint为iam.cn-north-1.myhuaweicloud.com。 resource-path 资源路径，即API访问路径，从具体API的URI模块获取。例如，获取用户Token接口的resource-path为/v3/auth/tokens。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个？，形式为参数名=参数取值。例如，limit=10表示查询不超过10条数据。 例如，您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 请求方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

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

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

文档修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第十九次正式发布，本次变更说明如下： 新增接口：查询插件分类 新增接口：插件发布 新增接口：获取插件检测结果 新增接口：获取当前用户下的发布商列表 新增接口：文件上传归一化 新增接口：CreateLogin接口 新增接口：CreateJoinRequest接口 新增接口：CreateEvent接口 2023-04-11 第十八次正式发布，本次变更说明如下： CloudIDE服务更名为CodeArts IDE Online 2023-02-16 第十七次正式发布，本次变更说明如下： 新增接口：CreateAcceptance接口 新增接口：Create Request接口 新增接口：Show Result接口 2022-12-05 第十六次正式发布，本次变更说明如下： 新增接口：添加插件评论 新增接口：添加评论回复、回复评论回复 新增接口：添加新评星 新增接口：举报评论,举报回复 新增接口：删除评论 新增接口：删除回复 新增接口：查询插件列表 新增接口：查询插件详细信息 新增接口：查询插件评价 新增接口：查询插件评星 2022-11-23 第十五次正式发布，本次变更说明如下： 接口查询某个IDE实例更新：响应示例中删掉instance.is_private。 接口启动IDE实例更新：新增请求示例。 接口查询某个租户下的IDE实例列表更新：响应示例参数删除 instances.count、instances.items.is_private。 接口查询IDE实例列表更新：响应示例参数删除 instances.count、instances.items.is_private。 接口查询技术栈模板工程更新：响应参数中新增arch参数。 2022-08-24 第十四次正式发布，本次变更说明如下： 新增接口：查询某个IDE实例的状态。 接口创建IDE实例更新：删除参数instance_user_domain_name、instance_user_name。 接口外部第三方集成商创建IDE实例更新：删除参数instance_user_domain_name、instance_user_name。 2022-07-22 第十三次正式发布，本次变更说明如下： 新增接口：上传插件。 2022-07-01 第十二次正式发布，本次变更说明如下： 接口创建IDE实例更新：新增请求Body参数instance_domain_id和instance_user_id。 参数描述中“组织”修改改成“租户”。 2022-03-01 第十一次正式发布，本次变更说明如下： 刷新refresh_interval参数。 2022-01-26 第十次正式发布，本次变更说明如下： 新增接口：按region获取标签所有技术栈。 废弃接口：获取标签所有技术栈。 2022-01-11 第九次正式发布，本次变更说明如下： 修改接口查询某个IDE实例的响应参数。 修改接口查询某个租户下的IDE实例列表的响应参数。 修改接口查询IDE实例列表的响应参数。 更新部分接口的参数描述。 2021-12-20 第八次正式发布，本次变更说明如下： 新增接口：查询用户是否有权限访问某个IDE实例 新增接口：刷新IDE实例活跃状态 新增接口：查询ide实例对插件的授权情况 新增接口：设置ide实例对插件的授权 2021-12-13 第七次正式发布，本次变更说明如下： 新增权限策略和授权项相关内容。 2021-08-24 第六次正式发布，本次变更说明如下： 接口创建IDE实例更新：新增请求Body参数。 更新部分接口参数描述。 2021-01-27 第五次正式发布，本次变更说明如下： 错误码更新：错误响应Body体格式示例更新。 接口启动IDE实例更新：新增请求body参数。 接口创建IDE实例更新：请求Body参数新增port_id、private_ip、vpc_id三个参数。 新增接口：查询当前账号访问权限。 2020-12-29 第四次正式发布，本次变更说明如下： 接口创建IDE实例返回值更新。 接口外部第三方集成商创建IDE实例返回值更新。 2020-11-09 第三次正式发布，本次变更说明如下： 更新终端节点，新增北京一和大连。 2020-09-17 第二次正式发布，本次变更说明如下： 新增应用示例。 2020-07-31 第一次正式发布。 2020-07-07

请求示例 创建名为“testjava”、Java技术栈、CPU规格为“2U4G”、PVC规则为“5GB”、自动休眠时长为30分钟、不在页面显示，用户ID和租户ID为“test”的实例。 POST https://{endpoint}/v2/instances { "instance_name" : "testjava", "stack_id" : "java", "description" : "", "cpu_memory" : "2U4G", "pvc_quantity" : "5GB", "refresh_time" : "30", "is_temporary" : false, "instance_user_id" : "test", "instance_user_domain_id" : "test" }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 result result object 返回值 status String 状态 表6 result 参数 参数类型 描述 link String 链接 arch String cpu架构 x86|arm 枚举值： x86 arm id String 实例id private Boolean 是否私有平台 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 406 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 arch 否 String cpu架构 x86|arm 枚举值： x86 arm cpu_memory 是 String cpu规格.arm架构支持4U8G，x86架构支持1U1G,2U4G,2U8G 与技术栈配置的规格对应，可通过技术栈管理ListStacks接口获取。如果标签不为空，以标签配置的技术栈规格为准。 quantum技术栈，x86架构cpu规格为2U8G;其他技术栈，x86架构cpu规格为1U1G,2U4G 枚举值： 1U1G 2U4G 2U8G 4U8G description 否 String 描述。长度不操过100个字符 instance_name 是 String 实例名。 可以输入中文、数字、字母、下划线、点、破折号。长度介于3-100之间 instance_user_domain_id 否 String 租户id（对应华为云账号的domainId） instance_user_id 否 String 用户id is_temporary 否 Boolean 是否页面显示（以标签配置为准） plugins 否 Array of Plugin objects 插件列表 pvc_quantity 是 String PVC规格 5GB|10GB|20GB 枚举值： 5GB 10GB 20GB refresh_time 否 String 自动休眠时长。arm架构,自动休眠时长只能设置成30，60。x86架构可取值为30，60，240，1440和-1。除-1外，其它值的单位为“分钟”。实例无操作超过自动休眠时长后，将会被暂停（已保存的数据不会被删除）。-1表示实例不会自动停止。 stack_id 是 String 技术栈ID，通过技术栈管理ListStacks接口获取。 表4 Plugin 参数 是否必选 参数类型 描述 attribute 否 String 插件属性 name 否 String 插件名

错误码说明 当您调用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 获取工程用户信息失败，请稍后再试 请稍后再试

API概览 表1 CodeArts IDE Online接口说明 分类 接口 IDE实例管理 查询IDE实例名是否重复 查询某个IDE实例 修改IDE实例 删除IDE实例 启动IDE实例 停止IDE实例 创建IDE实例 查询某个租户下的IDE实例列表 查询IDE实例列表 外部第三方集成商创建IDE实例 查询用户是否有权限访问某个IDE实例 刷新IDE实例活跃状态 查询某个IDE实例的状态 技术栈管理 按region获取标签所有技术栈 获取技术栈计费信息 模板管理 查询技术栈模板工程 账号权限管理 查询当前账号访问权限 插件管理 查询ide实例对插件的授权情况 设置ide实例对插件的授权 插件市场 上传插件 添加插件评论 添加评论回复、回复评论回复 添加新评星 举报评论,举报回复 删除评论 删除回复 查询插件列表 查询插件详细信息 查询插件评价 查询插件评星 查询插件分类 插件发布 获取插件检测结果 获取当前用户下的发布商列表 文件上传归一化 codebreeze CreateAcceptance接口 Create Request接口 Show Result接口 CreateLogin接口 CreateJoinRequest接口 CreateEvent接口

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token获取请求认证接口的响应值，该接口是唯一不需要认证的接口。 公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权。 X-Project-ID：子项目ID，可选，在多项目场景中使用。 X-Domain-ID：账号ID。 对于获取用户Token获取请求认证接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token获取请求认证接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxx为project的名称，如cn-north-1，您可以从地区和终端节点中获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token额作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token获取请求认证。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token获取请求认证接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint：指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点中获取。例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path：资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如，您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token获取请求认证的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token获取请求认证的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

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

操作步骤 进入目标课堂页面，通过作业入口即可看到该课堂的所有作业。 选择需要完成作业，单击作业卡片即可进入作业详情。 系统已经作业按照时间维度划分为未提交和已提交，只需要关注未提交的分类即可。 为了更好的筛选作业，将作业截止日期按照时间维度划分为最近7天、最近14天和最近30天。 查看习题等详细内容。 每份作业都有截止时间和提交次数的限制，需要各位同学注意。 自动提交功能：为了最大限度保障各位同学的权益，作业到期后会帮助从未提交的作业自动提交。 为了方便大家查询提交历史，系统也在作业区域设置了历史记录功能，帮助大家查询提交历史。 针对单人项目题，建议大家使用CloudIDE进行在线编辑完成。

获取Classroom学生账号 登录给老师提供的邮箱。 找到发件人为“MailSender [system@info.huaweicloud.com]”，邮件标题为“新建用户名和初始密码”的邮件。 从中获取账号名、用户名、初始密码及Classroom链接。 登录Classroom官网（https://classroom.devcloud.huaweicloud.com/home），单击“登录”。 选择“IAM用户登录”。 父主题： 账号获取

操作步骤 打开Classroom官网的指定课堂，切换到“实验”页签。 进入到课堂之后，单击顶部的实验按钮即可。 进入实验之后，可以查看该实验提交的截止时间。 查看实验详情。 实验详情页面分为左右两部分： 左边为实验的基础信息，包含实验概述、实验手册和实验报告。 实验概述：包含了实验时长和实验的基本情况。 实验手册：是教大家如何一步一步完成实验的操作指引。 实验结果：实验报告是根据教学任务每人都必须提交的制式文档。 右侧为开始实验按钮、实验最后的提交时间和提交实验报告。 开始实验。 节点 按钮，可以切换不同的实验主机。 全屏 按钮，可以将实验主机环境实现最大化。 根据左侧实验手册的要求，一步一步的完成整个实验过程。 开始实验之前，最好先下载实验报告，明确哪些需要实现截图，不然要再做一次实验哦。 实验过程中，一定要注意剩余时间，剩余时间一旦为零，会清空当前实验环境。 结束实验。 提交实验报告。 在结束实验之后，单击实验结果，通过上传实验报告或其他实验结果，完成整个实验。 实验报告的提交是有次数限制，请各位同学修改完毕之后再提交。

使用学生账号登录Classroom 在激活邮件中获取链接进行登录。 单击“IAM用户登录”，依次输入账号名、用户名、初始密码。 “账号登录”适用于管理员账号，“IAM用户登录”适用于子账号。 单击“登录”。 进入后输入初始密码、新密码、单击“获取邮箱验证码”。 打开邮箱后，找到发件人为“system@info.hueweicloud.com”，标题为“华为云邮箱验证码邮件”邮件，获取“邮件验证码”后，输入到修改密码界面“邮件验证码”框中。 单击“确定”。 父主题： 账号获取

功能列表 CodeArts IDE Online功能列表如表1所示。 表1 功能列表 功能 描述 一键式环境获取 一键式获取云端基于容器的工作空间，并可在不需要时释放。 预置技术栈 预置多种技术栈，创建工作空间时选取预置技术栈可获得更快的环境配置能力。 按需配置资源 可按需选择工作空间的计算资源规格（micro或medium）和存储资源规格（GB）。 工作空间启动和停止 启动工作空间，获取由页面编辑器+运行环境+云端存储组成的集成开发环境。 停止工作空间可立即释放计算资源。 访问和配置后端环境 基于页面终端模拟器（WebTerminal）可以以命令行访问和配置后端环境。 多语言代码编写 支持40多种编程语言的语法高亮，以及Java等主流语言的代码智能提示。 代码构建和运行 容器化的运行环境可以构建（Build）和执行（Run）代码，并可查看运行结果及输出日志。 代码调试和预览 代码调试功能可支持Java等语言的在线代码调试，对Web类和接口类应用可提供页面预览或接口调用。 对接Git代码仓库 支持对接Git配置库（代码仓库），实现如Commit、Branch、Push等操作，支持第三方代码仓库（如GitHub）。 企业租户管理权限 向企业租户提供基于黑白名单的企业用户CodeArts IDE Online使用权限控制。

什么是CodeArts IDE Online CodeArts IDE Online是云端开发环境服务，向开发者提供按需配置、快速获取的工作空间（包含编辑器和运行环境），支持完成环境配置、代码阅读、编写代码、构建、运行、调试、预览等操作，并支持对接多种代码仓库。 CodeArts IDE Online基本特性如表1所示。 表1 CodeArts IDE Online基本特性 特性 描述 云化和轻量化 依托华为云的计算和存储资源，实现云化开发环境供给，通过浏览器访问即可完成开发全过程，实现移动办公。 快速按需容器化 用户工作空间基于全容器技术，极短时间即可按用户所需配置（计算和存储）启动并提供服务，用后可随时释放。 多语言和技术栈 支持40多种语言的语法高亮，支持Java等语言的语法补齐，支持7种预置技术栈，无需复杂配置环境即可就位。 视图风格可切换 提供亮色和暗色两种视觉风格，编辑器提供多种视图布局，同时支持满屏编辑和边栏收缩。 后端环境可配置 提供页面终端（WebTerminal）直接访问后端容器环境，以命令行设置变量、处理文件和配置其他环境因素。 构建运行和调试 提供命令管理器以支持构建（Build）和运行（Run），对Java等语言支持断点调试。 可对接三方服务 除了对Git仓库（在代码托管服务中创建的仓库或GitHub等）的支持，还提供对接第三方服务（即通过外网通道对接其他开放服务）的能力。 企业化权限管控 提供基于黑白名单的访问控制能力，为企业租户提供掌控子用户行为的管理面。

CodeArts IDE Online权限 默认情况下，管理员创建的IAM用户没有任何权限，需要将其加入用户组，并给用户组授予策略或角色，才能使得用户组中的用户获得对应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限对云服务进行操作。 CodeArts IDE Online部署时通过物理区域划分，为项目级服务。授权时，“作用范围”需要选择“区域级项目”，然后在指定区域（如华北-北京1）对应的项目（cn-north-1）中设置相关权限，并且该权限仅对此项目生效；如果在“所有项目”中设置权限，则该权限在所有区域项目中都生效。访问CodeArts IDE Online时，需要先切换至授权区域。 根据授权精细程度分为角色和策略。 角色：IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。该机制以服务为粒度，提供有限的服务相关角色用于授权。由于各服务之间存在业务依赖关系，因此给用户授予角色时，可能需要一并授予依赖的其他角色，才能正确完成业务。角色并不能满足用户对精细化授权的要求，无法完全达到企业对权限最小化的安全管控要求。 策略：IAM最新提供的一种细粒度授权的能力，可以精确到具体服务的操作、资源以及请求条件等。基于策略的授权是一种更加灵活的授权方式，能够满足企业对权限最小化的安全管控要求。例如：针对CodeArts IDE Online服务，管理员能够控制IAM用户仅能对实例进行指定的管理操作。多数细粒度策略以API接口为粒度进行权限拆分，CodeArts IDE Online支持的API授权项请参见策略及授权项说明。 如表1所示，包括了CodeArts IDE Online的所有系统权限。 表1 CodeArts IDE Online系统权限 策略名称 描述 类别 CloudIDE FullAccess CodeArts IDE Online所有权限。 系统策略 CloudIDE ReadOnlyAccess CodeArts IDE Online只读权限。 系统策略 CloudIDE InstanceManagement CodeArts IDE Online实例管理权限，用户可以管理自己拥有的实例、访问被分发给自己的实例。 系统策略 CloudIDE Development CodeArts IDE Online开发权限，包括查看、启动、停止、访问实例等操作。 系统策略 表2列出了CodeArts IDE Online常用操作与系统策略的授权关系，您可以参照该表选择合适的系统策略。 表2 常用操作与系统权限的关系 操作 CloudIDE FullAccess CloudIDE ReadOnlyAccess CloudIDE InstanceManagement CloudIDE Development 查询指定IDE实例详情 √ √ √ √ 创建IDE实例 √ × √ × 删除IDE实例 √ × √ × 启动IDE实例 √ × √ √ 停止IDE实例 √ × √ √ 访问IDE实例 √ × √ √ 修改IDE实例（仅修改描述和名称） √ × √ × 分发实例给访问者 √ × √ × 授权实例给用户 √ × √ × 重置实例 √ × √ × 查询用户实例列表 √ √ √ √ 查询租户实例列表 √ √ × × 获取技术栈 √ √ √ √ 查询模板工程 √ √ √ √ 表3 常用操作与对应授权项 操作 授权项 备注 查询指定IDE实例详情 cloudIDE:instance:get 无 创建IDE实例 cloudIDE:instance:create 无 删除IDE实例 cloudIDE:instance:delete 无 启动IDE实例 cloudIDE:instance:start 无 停止IDE实例 cloudIDE:instance:stop 无 访问IDE实例 cloudIDE:instance:access 只有实例的访问者才能访问实例 修改IDE实例（仅修改描述和名称） cloudIDE:instance:update 无 分发实例给访问者 cloudIDE:instance:assign 无 授权实例给用户 cloudIDE:instance:auth 无 重置实例 cloudIDE:instance:reset 无 查询用户实例列表 cloudIDE:instance:listInstances 无 查询租户实例列表 cloudIDE:instance:listOrgInstances 无 获取技术栈 cloudIDE:stack:list 无 查询模板工程 cloudIDE:template:list 无 表4 授权项与对应条件键 条件键 类别 条件类型 action关联 cloudIDE:instanceUser 云服务自定义条件 String cloudIDE:instance:get cloudIDE:instance:delete cloudIDE:instance:update cloudIDE:instance:start cloudIDE:instance:stop cloudIDE:instance:auth cloudIDE:instance:assign cloudIDE:instance:reset cloudIDE:instanceVisitor 云服务自定义条件 String cloudIDE:instance:get cloudIDE:instance:start cloudIDE:instance:stop cloudIDE:instance:access

什么是Classroom？ Classroom是面向高校的一站式软件教学与实践平台，支持教师和学生通过Classroom进行实时互动，极大提升教学体验，教师可以通过我的工作台进行课堂、资源空间、布置和批改作业、管理班级等；学生可以接受作业、开展作业并提交作业给教师、查看教师评分等。 目前Classroom默认开通，且免费使用。 如果账号提示异常，是因为用户账号没有实名认证。请根据系统提示完成实名认证。

Classroom角色权限是什么？ Classroom中主要角色为学生、教师，如表1所示。 表1 Classroom角色说明 Classroom角色 用户说明 创建方法 租户管理员 为租户最高权限用户，具备管理所有教师和学生的权限。请使用“账号登录”方式进行登录。 租户自行登录华为云进行注册。 教师 教师当前具有IAM的te_admin权限，即普通管理员权限，请慎重管理（租户管理员可以在IAM中取消教师的te_admin权限），请使用“IAM用户登录”方式进行登录。 教师在Classroom中添加成员时可以设置成员为学生或教师。 教师具有导入学生、开通收费服务、新建课堂、资源空间管理、成员管理等权限。 Classroom成员（学生、教师）由租户管理员在成员管理中进行添加，并给成员设置不同角色（学生、教师），详细步骤请参见Classroom《教师用户指南》中的添加成员。 须知： 租户管理员添加的所有成员（即子账号）均使用“IAM用户登录”方式进行登录。 学生 由教师在Classroom中进行创建，具有学生的所有权限。 学生获取用户名和密码信息后，请使用“IAM用户登录”方式进行登录。 学生具有查看课堂、接受作业、开展作业、提交作业、查看评分及教师评语等。

概述 如果用户需要对所拥有的CodeArts IDE Online服务进行精细的权限管理，可以使用统一身份认证服务（Identity and Access Management，简称IAM），通过IAM，可以： 根据企业的业务组织，在华为云账号中，给不同职能部门的员工创建IAM用户，让员工拥有唯一安全凭证使用CodeArts IDE Online资源。 根据企业用户的职能不同，设置不同的访问权限，实现用户之间的权限隔离。 将CodeArts IDE Online资源委托给更专业、高效的其他华为云账号或者云服务，这些账号或者云服务可以根据权限进行代运维。 如果华为云账号可以满足用户对权限管理的需求，则不需要创建独立的IAM用户，可以跳过本章节，不影响使用CodeArts IDE Online服务的其它功能。 本章节介绍对用户授权的方法，操作流程如示例流程所示。

示例流程 图1 为用户授权CodeArts IDE Online权限操作流程 创建用户组并授权 在IAM控制台创建用户组，并授予CodeArts IDE Online只读权限“CloudIDE ReadOnlyAccess”。 创建用户并加入用户组 在IAM控制台创建用户，并将其加入步骤1中创建的用户组。 用户登录并验证权限 新创建的用户登录控制台，切换至授权区域，通过以下两种方式验证权限是否生效： 在“服务列表”中选择CodeArts IDE Online，进入CodeArts IDE Online主界面，单击“新建实例”，创建实例，如果无法创建实例（假设当前权限仅包含CloudIDE ReadOnlyAccess），表示“CloudIDE ReadOnlyAccess”已生效。 在“服务列表”中选择除CodeArts IDE Online外（假设当前权限仅包含CloudIDE ReadOnlyAccess）的任意服务，若提示权限不足，表示“CloudIDE ReadOnlyAccess”已生效。

什么是Classroom？ Classroom是基于华为云的一站式软件教学与实践平台，支持高校师生实现备课、上课、作业、考试、实验、实训等全教学流程的线上教学，提供多类习题自动判题、企业级DevOps实训、免费在线习题库等众多高级特性辅助进行数字化教学转型。为学生提供从单个函数到企业级项目的软件开发实践平台，帮助老师更方便的开展授课、演示及软件实践教学，并为老师更全面的了解学生软件开发能力短板提供智能数据分析支持。 Classroom教学平台结合DevCloud践行产教融合新模式，搭建业界领先的“教-学-练-赛-考-评-证”一体化赋能体系。 教培机构与在校师生可以通过Classroom进行实时互动，极大提升了教学体验。教师可以进行我的工作台、课件管理、课件实时预览、课件分享、作业判题、班级管理等；学生可以接受作业、开展作业并提交作业给教师、查看教师评分等 Classroom云上软件教学服务，支持全类型课程工程实训，提供30多种精品课程，10多种企业类实践课程，3000多种习题支持秒级自动判题，覆盖10种开发语言课程打造国内首个教育知识点自动检测服务，支持多种知识点检测云上实验室，提供教学所需的多场景通用型实训环境，海量全品类课程资源库覆盖20+赛道，500门课程。