查询某个租户下的IDE实例列表
功能介绍
查询某个租户下的IDE实例列表
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{org_id}/instances
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
org_id |
是 |
String |
租户id（对应华为云账号的domainId） |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
is_temporary |
否 |
Boolean |
是否页面显示（以标签配置为准） |
|
limit |
否 |
Long |
每页显示的条目数量 10/15/30 |
|
offset |
否 |
Long |
偏移量，表示从此偏移量开始查询 |
|
search |
否 |
String |
关键字查询(根据实例名，描述模糊查询) |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
instances |
PageInstancesVO object |
实例列表 |
|
status |
String |
状态 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
empty |
Boolean |
是否为空 |
|
items |
Array of InstancesVO objects |
列表详情 |
|
items_before |
Long |
偏移量，表示从此偏移量开始查询 |
|
size |
Long |
每页显示的条目数量 |
|
total_items_count |
Long |
总数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
arch |
String |
cpu架构 x86|arm 枚举值：
|
|
attributes |
Attributes object |
属性 |
|
cpu_memory |
String |
cpu规格.arm架构支持4U8G，x86架构支持1U1G,2U4G,2U8G 与技术栈配置的规格对应，可通过技术栈管理ListStacks接口获取。如果标签不为空，以标签配置的技术栈规格为准。 quantum技术栈，x86架构cpu规格为2U8G;其他技术栈，x86架构cpu规格为1U1G,2U4G 枚举值：
|
|
created_time |
String |
创建时间 |
|
description |
String |
描述 |
|
display_name |
String |
实例名。 可以输入中文、数字、字母、下划线、点、破折号。长度介于3-100之间 |
|
domain_name |
String |
租户名 |
|
id |
String |
id |
|
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外，其它值的单位为“分钟”。实例无操作超过自动休眠时长后，将会被暂停（已保存的数据不会被删除）。-1表示实例不会自动停止 |
|
region |
String |
区域 |
|
server_map |
Map<String,String> |
server |
|
server_url |
String |
服务链接 |
|
stack_id |
String |
技术栈ID，通过技术栈管理ListStacks接口获取。 |
|
status |
String |
实例状态 。
枚举值：
|
|
updated_time |
String |
更新时间 |
|
visitor_id |
String |
访问者id |
|
visitor_name |
String |
访问者名称 |
|
visitor_domain_name |
String |
访问者租户名称 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
cpu_limit |
String |
cpu限制 |
|
memory_limit_bytes |
String |
内存限制 |
|
pvc_quantity |
String |
pvc规格 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误描述 |
|
error_code |
String |
错误码 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误描述 |
|
error_code |
String |
错误码 |
状态码： 406
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误描述 |
|
error_code |
String |
错误码 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误描述 |
|
error_code |
String |
错误码 |
请求示例
查询某个租户下的IDE实例列表
GET https://{endpoint}/v2/6251b1ee539f4c02ad4b83daeda81633/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 |
错误码
请参见错误码。
