
# 配置CodeArts IDE Online连接器
CodeArts IDE Online连接器用于对接华为云CodeArts IDE Online服务。
华为云CodeArts IDE Online是云开发环境服务，开发者通过浏览器访问即可极速获取云端开发环境，支持编码、调试、运行、预览，还可访问代码仓库和执行命令行，同时支持丰富的插件扩展。
#### 前提条件
使用CodeArts IDE Online连接器前，需要开通CodeArts IDE Online服务。
#### 创建CodeArts IDE Online连接
1. 登录[ROMA Connect控制台](https://console.huaweicloud.com/roma3)。

2. 在左侧导航栏选择"连接器"，在连接器页面单击"新建连接"。
3. 选择"CodeArts IDE Online"连接器。
4. 在弹窗中配置连接器信息，完成后单击"确定"。
   
   | 参数                | 说明                                                                                                                                                         |
   |:---|:---|
   | 连接名称              | 填写连接器实例名称。                                                                                                                                                 |
   | 描述                | 填写连接器的描述信息，用于识别不同的连接器。                                                                                                                                     |
   | Access Key        | 当前账号的AK（Access Key ID）。请参考[访问密钥](https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html)获取AK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。    |
   | Secret Access Key | 当前账号的SK（Secret Access Key）。请参考[访问密钥](https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html)获取SK，如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为credentials.csv。 |
      
   
 
#### 支持的动作
- 查询IDE实例列表
- 创建IDE实例
- 查询某个租户下的IDE实例列表
- 停止IDE实例
- 启动IDE实例
- 删除IDE实例
- 修改IDE实例
- 查询某个IDE实例
- 查询IDE实例名是否重复
 
#### 配置参数
表1查询IDE实例列表 
| 参数           | 说明                                                                                |
|:---|:---|
| region_id    | 区域ID。                                                                             |
| limit        | 每页显示的条目数量，最大值为100，最小值为1。                                                          |
| offset       | 偏移量，表示从此偏移量开始查询。                                                                  |
| is_temporary | 是否页面显示（以标签配置为准）。                                                                  |
| label        | 标签。                                                                               |
| search       | 关键字查询(根据实例名，描述模糊查询)。                                                              |
| sort_dir     | 排序方式 asc/desc。                                                                    |
| sort_key     | 排序字段。 display_name 实例名、status状态、pvc_quantity 存储容量、created_time 创建时间、stack_id 技术栈。 |
   
表2创建IDE实例 
| 参数                 | 说明                                                                                                                                                       |
|:---|:---|
| org_id             | 租户ID（对应华为云账号的domainId）。                                                                                                                                  |
| region_id          | 区域ID。                                                                                                                                                    |
| agent_id           | 代理商ID，教程活动场景下使用。                                                                                                                                         |
| arch               | cpu架构，x86或arm。                                                                                                                                           |
| cpu_memory         | cpu规格。arm架构支持4U8G，x86架构支持1U1G、2U4G、2U8G，与技术栈配置的规格对应，可通过技术栈管理ListStacks接口获取。如果标签不为空，以标签配置的技术栈规格为准。 quantum技术栈，x86架构cpu规格为2U8G；其他技术栈，x86架构cpu规格为1U1G、2U4G。 |
| description        | 描述。                                                                                                                                                      |
| display_name       | 实例名。 可以输入中文、数字、字母、下划线、点、破折号。长度介于3-100之间。                                                                                                                 |
| is_temporary       | 实例标签（不同的第三方需要和CodeArtsIDEOnline服务共同设定标签），不传默认为default。                                                                                                   |
| label_tag          | 排序方式asc/desc。                                                                                                                                            |
| plugin_enable_list | 预装插件列表。                                                                                                                                                  |
| plugin_vars        | 预装插件参数，请注意敏感信息保护，若涉及敏感信息，请自行加密。                                                                                                                          |
| port_id            | 云服务器对应的portId，小网连接ecs的场景下使用。                                                                                                                             |
| private_ip         | 云服务器ip，小网连接ecs的场景下使用。                                                                                                                                    |
| pvc_quantity       | PVC规格，如5GB\|10GB\|20GB。                                                                                                                                  |
| refresh_interval   | 自动休眠时长。arm架构，自动休眠时长只能设置成30或60。x86架构可取值为30、60、240、1440和-1。除-1外，其它值的单位为"分钟"。实例无操作超过自动休眠时长后，将会被暂停（已保存的数据不会被删除）。-1表示实例不会自动停止。                                |
| repository_id      | 解放号的仓库ID，解放号场景下使用。                                                                                                                                       |
| stack_id           | 技术栈ID，通过技术栈管理ListStacks接口获取。                                                                                                                             |
| task_type          | 任务类型，教程活动场景下使用。                                                                                                                                          |
| token              | 解放号的token，解放号场景下使用。                                                                                                                                      |
| vpc_id             | 云服务器对应的vpcId，小网连接ecs的场景下使用。                                                                                                                              |
| instance_domain_id | 实例授权用户租户ID。                                                                                                                                              |
| instance_user_id   | 实例授权用户ID。                                                                                                                                                |
   
表3查询某个租户下的IDE实例列表 
| 参数           | 说明                                                     |
|:---|:---|
| org_id       | 租户ID（对应华为云账号的domainId）。                                |
| region_id    | 区域ID。                                                  |
| is_temporary | 实例标签（不同的第三方需要和CodeArtsIDEOnline服务共同设定标签），不传默认为default。 |
| limit        | 每页显示的条目数量，10/15/30。                                    |
| offset       | 偏移量，表示从此偏移量开始查询。                                       |
| search       | 关键字查询(根据实例名，描述模糊查询)。                                   |
   
表4停止IDE实例 
| 参数          | 说明    |
|:---|:---|
| instance_id | 实例ID。 |
| region_id   | 区域ID。 |
   
表5启动IDE实例 
| 参数                 | 说明                            |
|:---|:---|
| instance_id        | 实例ID。                         |
| region_id          | 区域ID。                         |
| plugin_enable_list | 插件列表。                         |
| plugin_vars        | 插件参数，请注意敏感信息保护，若涉及敏感信息，请自行加密。 |
   
表6删除IDE实例 
| 参数          | 说明    |
|:---|:---|
| instance_id | 实例ID。 |
| region_id   | 区域ID。 |
   
表7修改IDE实例 
| 参数               | 说明                                                                                                                        |
|:---|:---|
| instance_id      | 实例ID。                                                                                                                     |
| region_id        | 区域ID。                                                                                                                     |
| description      | 描述。                                                                                                                       |
| display_name     | 实例名。 可以输入中文、数字、字母、下划线、点、破折号。长度介于3-100之间。                                                                                  |
| refresh_interval | 自动休眠时长。arm架构，自动休眠时长只能设置成30或60。x86架构可取值为30、60、240、1440和-1。除-1外，其它值的单位为"分钟"。实例无操作超过自动休眠时长后，将会被暂停（已保存的数据不会被删除）。-1表示实例不会自动停止。 |
   
表8查询某个IDE实例 
| 参数          | 说明    |
|:---|:---|
| instance_id | 实例ID。 |
| region_id   | 区域ID。 |
   
表9查询IDE实例名是否重复 
| 参数           | 说明                                       |
|:---|:---|
| region_id    | 区域ID。                                    |
| display_name | 实例名。 可以输入中文、数字、字母、下划线、点、破折号。长度介于3-100之间。 |
   
