查询IDE实例列表 - ListInstances

CodeArtsIDEOnline:instance:list

Permission_management

-

-

-

-

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。

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签名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instances

PageInstancesVO object

参数解释：

实例列表。

取值范围：

不涉及

status

String

参数解释：

请求响应的状态，表明请求是否成功。

取值范围：

• success：请求响应成功。

• error：请求响应失败。

empty

Boolean

参数解释：

响应参数的状态，表明响应是否为空。

取值范围：

不涉及

items

Array of InstancesVO objects

参数解释：

列表详情。

取值范围：

0~100

items_before

Long

参数解释：

偏移量，表示从此偏移量开始查询。

取值范围：

0~999

size

Long

参数解释：

每页显示的条目数量。

取值范围：

1~100

total_items_count

Long

参数解释：

总数。

取值范围：

1~9223372036854776000

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实例。

取值范围：

正则表达式：^[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<String,String>

参数解释：

服务器信息。

取值范围：

不涉及

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

参数解释：

访问者租户名称。

取值范围：

不涉及

cpu_limit

String

参数解释：

cpu限制。

取值范围：

不涉及

memory_limit_bytes

String

参数解释：

内存限制。

取值范围：

不涉及

pvc_quantity

String

参数解释：

PVC规格。

取值范围：

不涉及

error_msg

String

参数解释：

错误描述信息。详情请参见错误码。

取值范围：

长度为0~255。

error_code

String

参数解释：

错误码。详情请参见错误码。

取值范围：

长度为0~100。

error_msg

String

参数解释：

错误描述信息。详情请参见错误码。

取值范围：

长度为0~255。

error_code

String

参数解释：

错误码。详情请参见错误码。

取值范围：

长度为0~100。

error_msg

String

参数解释：

错误描述信息。详情请参见错误码。

取值范围：

长度为0~255。

error_code

String

参数解释：

错误码。详情请参见错误码。

取值范围：

长度为0~100。

error_msg

String

参数解释：

错误描述信息。详情请参见错误码。

取值范围：

长度为0~255。

error_code

String

参数解释：

错误码。详情请参见错误码。

取值范围：

长度为0~100。

200

OK

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal Server Error