更新时间:2025-08-01 GMT+08:00
分享

获取ECS实例列表

功能介绍

获取弹性云服务器(ECS)实例列表,支持通过名称和分页参数筛选实例。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/sdg/asset/ecs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,用于标识具体的项目。

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页显示的记录数,默认为10。

name

String

实例名称,用于过滤特定名称的实例。

offset

Integer

查询的起始位置,默认为0。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

count

Integer

符合条件的ECS实例总数,表示查询结果中ECS实例的数量。

servers

Array of Ecs objects

ECS实例信息列表,包含所有符合条件的ECS实例。

表4 Ecs

参数

参数类型

描述

task_state

String

实例的任务状态,表示实例当前的任务执行状态,如'PENDING'、'RUNNING'等。

addresses

Object

实例的网络地址信息,包含实例的公网和私网IP地址。

created

String

实例的创建时间,表示实例创建的时间戳。

flavor

Flavor object

ECS实例的规格信息对象,包含实例的硬件配置。

id

String

实例的唯一标识符,用于唯一标识具体的ECS实例。

metadata

Metadata object

ECS实例的元数据信息对象,包含实例的附加信息。

name

String

实例的名称,用于标识ECS实例的名称。

security_groups

Array of SecurityGroup objects

实例的安全组列表,包含实例所属的安全组信息。

status

String

实例的状态,表示实例的当前运行状态,如'ACTIVE'表示运行中。

updated

String

实例的更新时间,表示实例最后一次更新的时间戳。

vpc_id

String

虚拟私有云(VPC)的唯一标识符,用于唯一标识实例所属的VPC。

表5 Flavor

参数

参数类型

描述

disk

String

实例的磁盘容量,表示实例的磁盘大小,单位为GB。

id

String

规格的唯一标识符,用于唯一标识具体的规格。

name

String

规格的名称,用于标识规格的名称,如'c6.large'。

ram

String

实例的内存容量,表示实例的内存大小,单位为MB。

vcpus

String

实例的虚拟CPU数量,表示实例的计算能力。

表6 Metadata

参数

参数类型

描述

vpc_id

String

虚拟私有云(VPC)的唯一标识符,用于唯一标识实例所属的VPC。

表7 SecurityGroup

参数

参数类型

描述

description

String

安全组的描述信息,用于描述安全组的作用和用途。

id

String

安全组的唯一标识符,用于唯一标识具体的安全组。

name

String

安全组的名称,用于标识安全组的名称。

请求示例

响应示例

状态码

状态码

描述

200

获取ECS实例列表成功。

401

未授权访问,请求被拒绝。

403

无权限进行此操作,请求被拒绝。

404

项目不存在,获取失败。

错误码

请参见错误码

相关文档