查询实例列表 - ListInstances

clouddc:instance:list

List

-

-

-

-

project_id

是

String

参数解释：

项目ID

约束限制：

不涉及

取值范围：

账号的项目ID

默认取值：

不涉及

limit

否

String

参数解释：

分页查询时每页行数。

约束限制：

不涉及

取值范围：

10-1000，当不设置值或设置的值小于 10 时，默认值为 10。当设置的值大于 1000 时，默认值为 1000。

默认取值：

1000

marker

否

String

参数解释：

下一页查询地址

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

instance_state

否

String

参数解释：

实例状态

约束限制：

不涉及

取值范围：

• pending：实例正在启动（分配资源/启动操作系统）

• running：实例正常运行（可接受SSH/RDP连接）

• stopped： 实例已完全关闭（存储卷保留）

• shutting-down：实例正在终止（删除流程中）

• terminated：实例已终止（资源完全删除，不可恢复）

• error：对实例的操作出现故障（资源未完全删除，可以尝试恢复）

默认取值：

不涉及

instance_id

否

String

参数解释：

实例 ID。取值可以由多个实例 ID 组成数组。

约束限制：

不涉及

取值范围：

最多支持 100 个 ID，ID 之间用半角逗号（,）隔开，示例：uuid1,uuid2,uuid3。

默认取值：

不涉及

server_id

否

String

参数解释：

服务器 ID。取值可以由多个服务器 ID 组成数组。

约束限制：

与instance_id_set查询条件互斥

取值范围：

最多支持 100 个 ID，ID 之间用半角逗号（,）隔开，示例：uuid1,uuid2,uuid3。

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

调用接口的认证方式分为Token，如果您使用的Token方式，此参数为必填，请填写Token的值

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

instances

Array of QueryInstanceResponseBody objects

实例列表

page_info

PageInfo object

参数解释：

分页信息

约束限制：

不涉及

count

Integer

实例总数

id

String

参数解释：

实例ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

name

String

参数解释：

实例名称

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

vpc_id

String

参数解释：

创建网卡所属的 VPC ID，可通过 VPC API 查询：查询VPC列表。

约束限制：

不涉及

取值范围：

VPC ID

默认取值：

不涉及

network_interfaces

Array of NetworkInterface objects

参数解释：

指定裸金属服务器的网卡信息。

约束限制：

一个裸金属服务器最多挂载2个网卡，参数中第一个网卡会作为裸金属服务器的主网卡。若用户指定了多组网卡参数，需保证各组参数都属于同一VPC。

tags

Array of Tag objects

参数解释：

标签

约束限制：

不涉及

image

Image object

参数解释：

服务器镜像信息

约束限制：

不涉及

description

String

参数解释：

云服务器描述信息。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

空字符串

state

String

参数解释：

实例状态

约束限制：

不涉及

取值范围：

• pending：实例正在启动（分配资源/启动操作系统）

• running：实例正常运行（可接受SSH/RDP连接）

• stopped： 实例已完全关闭（存储卷保留）

• shutting-down：实例正在终止（删除流程中）

• terminated：实例已终止（资源完全删除，不可恢复）

• error：实例处于异常状态（资源未完全删除）

stateDiagram-v2
    [*] --> pending: CreateInstance
    pending --> running: CreateInstance Succeed
    pending --> shutting_down: DeleteInstance
    running --> stopped: PowerOff/PowerReboot
    stopped --> running: PowerOn/Provision Succeed
    stopped --> stopped: ChangePassword
    pending --> error: CreateInstance Failed
    stopped --> error: Provision Failed
    error --> running: Retry Provision Succeed
    stopped --> shutting_down: DeleteInstance
    error --> shutting_down: Retry DeleteInstance
    shutting_down --> error: DeleteInstance Failed
    shutting_down --> terminated: DeleteInstance Succeed

默认取值：

不涉及

operation_state

String

参数解释:

操作状态

约束限制:

不涉及

取值范围:

• install-processing: 安装OS中

• install-succeed: 安装OS成功

• install-failed: 安装OS失败

• reinstall-processing: 重装OS中

• reinstall-succeed: 重装OS成功

• reinstall-failed: 重装OS失败

• switch-install-processing: 切换OS中

• switch-install-succeed: 切换OS成功

• switch-install-failed: 切换OS失败

• modify-ip-processing: 修改IP地址中

• modify-ip-succeed: 修改IP地址成功

• modify-ip-failed: 修改IP地址失败

• uninstall-processing: 卸载OS中

• uninstall-succeed: 卸载OS成功

• uninstall-failed: 卸载OS失败

默认取值:

不涉及

metadata

Map<String,String>

参数解释：

创建裸机实例的元数据。可以通过元数据自定义键值对。

如果元数据中包含了敏感数据，您应当采取适当的措施来保护敏感数据，比如限制访问范围、加密等。

约束限制：

不涉及

取值范围：

最多可注入10对键值（Key/Value）。

主键（Key）只能由大写字母（A-Z）、小写字母（a-z）、数字（0-9）、中划线（-）、下划线（_）、冒号（:）、空格（ ）和小数点（.）组成，长度为[1-255]个字符。

值（value）最大长度为255个字符。

默认取值：

不涉及

user_data

String

参数解释：

创建实例过程中待注入实例自定义数据。

约束限制：

不涉及

取值范围：

user_data的值为base64编码之后的内容。

注入内容（编码之前的内容）最大长度为32K。

默认取值：

不涉及

server_id

String

参数解释：

服务器ID

约束限制：

不涉及

取值范围：

uuid格式

默认取值：

不涉及

created_at

String

参数解释：

创建时间

约束限制：

不涉及

取值范围：

使用RFC 3339格式，例如：2025-04-22T12:03:18.50083+08:00

默认取值：

不涉及

updated_at

String

参数解释：

更新时间

约束限制：

不涉及

取值范围：

使用RFC 3339格式，例如：2025-04-22T12:03:18.50083+08:00

默认取值：

不涉及

launched_at

String

参数解释：

启动时间

约束限制：

不涉及

取值范围：

使用RFC 3339格式，例如：2025-04-22T12:03:18.50083+08:00

默认取值：

不涉及

error

ErrorStatus object

参数解释：

失败时返回的错误对象

约束限制：

不涉及

subnet_id

String

参数解释：

CloudDCN子网ID, 在CloudDCN云化网络中获取

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

ipv4_address

String

参数解释：

弹性网卡私有IPv4地址

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

enable_bgp

Boolean

参数解释：

是否启用BGP功能

约束限制：

不涉及

取值范围：

true/false

默认取值：

false

bind

String

参数解释：

绑定的网卡名称

约束限制：

不涉及

取值范围：

eth0, eth1等

默认取值：

不涉及

key

String

参数解释：

标签key值

约束限制：

不涉及

取值范围：

• 不能为空且首尾不能包含空格，最多支持128个字符

• 可用UTF-8格式表示的任意语种字母、数字和空格

• 支持部分特殊字符：_.:=+-@

• 不能以"_sys_"开头

默认取值：

不涉及

value

String

参数解释：

标签value值

约束限制：

不涉及

取值范围：

• 可以为空但不能缺省，最多支持255个字符

• 可用UTF-8格式表示的汉字、字母、数字和空格

• 支持部分特殊字符：_.:/=+-@

默认取值：

不涉及

id

String

参数解释：

镜像ID

约束限制：

不涉及

取值范围：

格式为UUID

默认取值：

不涉及

name

String

参数解释：

镜像名称

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

os_type

String

参数解释：

镜像os类型

约束限制：

不涉及

取值范围：

• Linux

• Windows

• Other

默认取值：

不涉及

error_code

String

参数解释：

错误码

error_msg

String

参数解释：

错误描述

error_type

String

参数解释：

错误类型

约束限制：

不涉及

取值范围：

• power_off_error：关机异常

• power_on_error：开机异常

• reboot_failed_error：重启异常

默认取值：

不涉及

next_marker

String

参数解释：

下一页查询地址

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

previous_marker

String

参数解释：

上一页查询地址

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

current_count

Integer

参数解释：

本页返回条目数量

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

error_code

String

参数解释：

错误码

error_msg

String

参数解释：

错误描述

error_code

String

参数解释：

错误码

error_msg

String

参数解释：

错误描述

-

String

-

error_code

String

参数解释：

错误码

error_msg

String

参数解释：

错误描述

200

实例列表分页

400

请求参数错误，请求失败

401

请求未鉴权

429

请求过载

500

服务端内部错误