文档首页/ 数据安全中心 DSC/ API参考/ API/ 基础设施查询/ 获取ecs实例列表 - ListEcs
更新时间:2026-11-13 GMT+08:00
分享

获取ecs实例列表 - ListEcs

功能介绍

功能介绍:获取ecs实例列表

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,标识当前请求所属的华为云项目,可参考获取项目ID相关文档获取

约束限制:

满足正则匹配"^[a-z0-9]{32}$",32位小写字母和数字

取值范围:

长度为32个字符,只能由小写英文字母和数字组成

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释:

每页数量限制

约束限制:

不涉及

取值范围:

不涉及

默认取值:

10

offset

否

Integer

参数解释:

分页偏移

约束限制:

不涉及

取值范围:

不涉及

默认取值:

0

owner_account_id

否

String

参数解释:

拥有者账号ID

约束限制:

满足正则匹配"^[a-z0-9]{32}$",32位小写字母和数字

取值范围:

不涉及

默认取值:

不涉及

name

否

String

参数解释:

ECS实例名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

count

Integer

参数解释:

弹性云服务器响应数量

取值范围:

不涉及

servers

Array of Ecs objects

参数解释:

服务器列表

取值范围:

不涉及

表5 Ecs

参数

参数类型

描述

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

name

String

参数解释:

ECS实例名称

取值范围:

不涉及

status

String

参数解释:

操作结果状态

取值范围:

不涉及

addresses

Object

参数解释:

连接地址列表

取值范围:

不涉及

created

String

参数解释:

创建时间,UTC时间格式,格式为yyyy-MM-ddTHH:mm:ssZ

取值范围:

不涉及

updated

String

参数解释:

更新时间,UTC时间格式,格式为yyyy-MM-ddTHH:mm:ssZ

取值范围:

不涉及

security_groups

Array of SecurityGroup objects

参数解释:

安全分组

取值范围:

不涉及

vpc_id

String

参数解释:

虚拟私有云ID

取值范围:

不涉及

metadata

Metadata object

参数解释:

元数据

取值范围:

不涉及

flavor

Flavor object

参数解释:

规格

取值范围:

不涉及

task_state

String

参数解释:

弹性云服务器状态

取值范围:

不涉及

projectId

String

参数解释:

项目ID

取值范围:

不涉及

表6 SecurityGroup

参数

参数类型

描述

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

name

String

参数解释:

安全组名称

取值范围:

不涉及

description

String

参数解释:

资源描述信息

取值范围:

不涉及

表7 Metadata

参数

参数类型

描述

vpc_id

String

参数解释:

虚拟私有云ID

取值范围:

不涉及

表8 Flavor

参数

参数类型

描述

disk

String

参数解释:

磁盘

取值范围:

不涉及

vcpus

String

参数解释:

虚拟CPU数量

取值范围:

不涉及

ram

String

参数解释:

内存,单位为MB

取值范围:

不涉及

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

name

String

参数解释:

规格名称

取值范围:

不涉及

请求示例

获取ecs实例列表

/v1/2b31ed5200000ebedb6e570000000000/sdg/asset/ecs

响应示例

状态码:200

{
  "count" : 1,
  "servers" : [ {
    "id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
    "projectId" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d",
    "name" : "asset-resource-01",
    "status" : "ACTIVE",
    "addresses" : {
      "addr" : "192.168.1.10"
    },
    "created" : "2024-01-01T00:00:00Z",
    "updated" : "2024-01-01T00:00:00Z",
    "security_groups" : [ {
      "id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
      "name" : "default"
    } ],
    "vpc_id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d",
    "flavor" : {
      "disk" : "40",
      "vcpus" : "2",
      "ram" : "4096",
      "id" : "s6.large.2",
      "name" : "s6.large.2"
    }
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档