# 查询IDE实例列表 - ListInstances #### 功能介绍 查询对应租户的IDE实例列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CloudIDE/doc?api=ListInstances)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-cloudide/cloudide_03_0027.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | CodeArtsIDEOnline:instance:list | Permission_management | - | - | - | - | #### URI GET /v2/instances 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Long | **参数解释：** 每页显示的条目数量。 **约束限制：** 不涉及。 **取值范围：** 1\~100。 **默认取值：** 30。 | | offset | 否 | Long | **参数解释：** 偏移量，表示从此偏移量开始查询。 **约束限制：** 不涉及。 **取值范围：** 0\~999。 **默认取值：** 0。 | | is_temporary | 否 | Boolean | **参数解释：** 是否页面显示（以标签配置为准）。 **约束限制：** 不涉及。 **取值范围：** - true：在页面显示。 - false：不在页面显示。 **默认取值：** 不涉及。 | | label | 否 | String | **参数解释：** 标签。 **约束限制：** 不涉及。 **取值范围：** 长度为0\~255。 **默认取值：** 不涉及。 | | search | 否 | String | **参数解释：** 关键字查询(根据实例名，描述模糊查询)。 **约束限制：** 不涉及。 **取值范围：** 长度为0\~100。 **默认取值：** 不涉及。 | | sort_dir | 否 | String | **参数解释：** 排序方式。 **约束限制：** 正则表达式：\^desc$\|\^asc$。 **取值范围：** 长度为0\~10。 **默认取值：** desc。 | | sort_key | 否 | String | **参数解释：** 排序字段。 **约束限制：** 正则表达式：\^created_time$\|\^display_name$\|\^status$\|\^pvc_quantity$\|\^stack_id$。 **取值范围：** - display_name：实例名。 - status：实例状态。 - pvc_quantity：存储容量。 - created_time：创建时间。 - stack_id：技术栈。 **默认取值：** created_time。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 长度为1-100000。 **默认取值：** 不涉及。 | | X-Sdk-Date | 否 | String | **参数解释：** 请求发起时间。 **约束限制：** 不涉及。 **取值范围：** 长度为1-100。 **默认取值：** 不涉及。 | | host | 否 | String | **参数解释：** 请求host地址。 **约束限制：** 不涉及。 **取值范围：** 长度为1-100。 **默认取值：** 不涉及。 | | x-security-token | 否 | String | **参数解释：** IAM 5.0鉴权token。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | Authorization | 否 | String | **参数解释：** AK/SK签名。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | instances | [PageInstancesVO] object | **参数解释：** 实例列表。 **取值范围：** 不涉及 | | status | String | **参数解释：** 请求响应的状态，表明请求是否成功。 **取值范围：** - success：请求响应成功。 - error：请求响应失败。 | 表4PageInstancesVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | empty | Boolean | **参数解释：** 响应参数的状态，表明响应是否为空。 **取值范围：** 不涉及 | | items | Array of [InstancesVO] objects | **参数解释：** 列表详情。 **取值范围：** 0\~100 | | items_before | Long | **参数解释：** 偏移量，表示从此偏移量开始查询。 **取值范围：** 0\~999 | | size | Long | **参数解释：** 每页显示的条目数量。 **取值范围：** 1\~100 | | total_items_count | Long | **参数解释：** 总数。 **取值范围：** 1\~9223372036854776000 | 表5InstancesVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | arch | String | **参数解释：** CPU架构类型。 **取值范围：** - x86：使用x86架构。 - arm：使用arm架构。 | | attributes | [Attributes] object | **参数解释：** 实例属性。 **取值范围：** 不涉及 | | cpu_memory | String | **参数解释：** CPU规格，与技术栈配置的规格对应，可通过技术栈管理ListStacks接口获取。 **取值范围：** - x86架构支持1U1G、2U4G、2U8G。 - arm架构支持4U8G。 | | created_time | String | **参数解释：** 实例创建时间。 **取值范围：** 不涉及 | | description | String | **参数解释：** 实例描述。 **取值范围：** 不涉及 | | display_name | String | **参数解释：** 实例名。 **取值范围：** 支持中文、数字、字母、下划线、点、破折号，长度介于3-100之间。 | | domain_name | String | **参数解释：** 租户名。 **取值范围：** 不涉及 | | id | String | **参数解释：** ID详情。详情请参见[创建IDE实例](https://support.huaweicloud.com/api-cloudide/CreateInstance.html)。 **取值范围：** 正则表达式：\^\[a-zA-Z0-9\]\[-_.a-zA-Z0-9\]{1,126}\[a-zA-Z0-9\]$ | | is_temporary | Boolean | **参数解释：** 是否页面显示（以标签配置为准）。 **取值范围：** - 是：表示页面显示。 - 否：表示页面不显示。 | | label | String | **参数解释：** 标签信息。 **取值范围：** 不涉及 | | link | String | **参数解释：** 链接信息。 **取值范围：** 不涉及 | | name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及 | | organization_id | String | **参数解释：** 租户ID（对应华为云账号的domainId）。 **取值范围：** 不涉及 | | owner_id | String | **参数解释：** 用户ID。 **取值范围：** 不涉及 | | owner_name | String | **参数解释：** 用户名。 **取值范围：** 不涉及 | | platform_id | Long | **参数解释：** 平台ID。 **取值范围：** 不涉及 | | private | Boolean | **参数解释：** 是否私有平台。 **取值范围：** 不涉及 | | pvc_quantity | String | **参数解释：** PVC规格。 **取值范围：** - 5GB - 10GB - 20GB | | refresh_interval | Long | **参数解释：** 自动休眠时长。 **取值范围：** - arm架构，只能设置为30，60，单位为分钟。 - x86架构，可以设置为30，60，240，1440和-1，单位为分钟。-1表示实例不会自动停止。 | | region | String | **参数解释：** 实例所属的区域。 **取值范围：** 不涉及 | | server_map | Map\ | **参数解释：** 服务器信息。 **取值范围：** 不涉及 | | server_url | String | **参数解释：** 服务链接。 **取值范围：** 不涉及 | | stack_id | String | **参数解释：** 技术栈ID，通过技术栈管理ListStacks接口获取。 **取值范围：** 不涉及 | | status | String | **参数解释：** 实例状态 。 **取值范围：** - INIT 实例初始化 - STARTING 实例启动中 - RUNNING 实例运行中 - STOPPING 实例停止中 - STOPPED 实例已停止 - DELETING 实例删除中 - DELETED 实例已删除 - DELETE_FAILED 实例删除失败 | | updated_time | String | **参数解释：** 更新时间。 **取值范围：** 不涉及 | | visitor_id | String | **参数解释：** 访问者id。 **取值范围：** 不涉及 | | visitor_name | String | **参数解释：** 访问者名称。 **取值范围：** 不涉及 | | visitor_domain_name | String | **参数解释：** 访问者租户名称。 **取值范围：** 不涉及 | 表6Attributes | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cpu_limit | String | **参数解释：** cpu限制。 **取值范围：** 不涉及 | | memory_limit_bytes | String | **参数解释：** 内存限制。 **取值范围：** 不涉及 | | pvc_quantity | String | **参数解释：** PVC规格。 **取值范围：** 不涉及 | **状态码：403** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释：** 错误描述信息。详情请参见[错误码](https://support.huaweicloud.com/api-cloudide/ErrorCode.html)。 **取值范围：** 长度为0\~255。 | | error_code | String | **参数解释：** 错误码。详情请参见[错误码](https://support.huaweicloud.com/api-cloudide/ErrorCode.html)。 **取值范围：** 长度为0\~100。 | **状态码：404** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释：** 错误描述信息。详情请参见[错误码](https://support.huaweicloud.com/api-cloudide/ErrorCode.html)。 **取值范围：** 长度为0\~255。 | | error_code | String | **参数解释：** 错误码。详情请参见[错误码](https://support.huaweicloud.com/api-cloudide/ErrorCode.html)。 **取值范围：** 长度为0\~100。 | **状态码：406** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释：** 错误描述信息。详情请参见[错误码](https://support.huaweicloud.com/api-cloudide/ErrorCode.html)。 **取值范围：** 长度为0\~255。 | | error_code | String | **参数解释：** 错误码。详情请参见[错误码](https://support.huaweicloud.com/api-cloudide/ErrorCode.html)。 **取值范围：** 长度为0\~100。 | **状态码：500** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释：** 错误描述信息。详情请参见[错误码](https://support.huaweicloud.com/api-cloudide/ErrorCode.html)。 **取值范围：** 长度为0\~255。 | | error_code | String | **参数解释：** 错误码。详情请参见[错误码](https://support.huaweicloud.com/api-cloudide/ErrorCode.html)。 **取值范围：** 长度为0\~100。 | #### 请求示例 查询IDE实例列表 ``` GET https://{endpoint}/v2/instances ``` #### 响应示例 **状态码：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 | OK | | 403 | Forbidden | | 404 | Not Found | | 406 | Not Acceptable | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cloudide/ErrorCode.html)。