DescribePrinsEcsInstances - 查询 ECS 实例列表

查询ECS实例信息列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cddc:DescribePrinsEcsInstanceslist
*全部资源
*

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。可查看地域信息获取。

cn-hangzhou
EcsInstanceIdstring

ECS 的实例 ID。

i-bp1726beecvi8kak****
PageSizeinteger

每页展示数目。

20
PageNumberinteger

实例列表的页码,起始值为 1,默认值为 1。

1
VpcIdstring

实例所在的专有网络 ID 。

vpc-t4nbtmekgxotv0d3y****
ZoneIdstring

可用区 ID。

cn-hangzhou-j
MaxResultsinteger
说明 该参数暂未上线,当前使用 PageNumber 与 PageSize 完成分页查询操作。

使用 NextToken 方式查询时,每次最多返回的结果数。

20
NextTokenstring
说明 该参数暂未上线,当前使用 PageNumber 与 PageSize 完成分页查询操作。

本次调用返回的查询凭证值。

caeba0bbb2be03f84eb48b699f0a4883
Keywordstring

查询关键字,模糊匹配,支持主机 ID、主机名称、主机 IP。

keyword

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

D6E068C3-25BC-455A-85FE-45F0B22E****
PageSizeinteger

每页展示数目。

20
PageNumberinteger

实例列表的页码,起始值为 1,默认值为 1。

1
TotalCountinteger

总记录条数

100
InstanceListarray<object>

ECS 实例列表。

EcsInstanceobject
InstanceIdstring

ECS 实例 ID。

i-2zeaquy5es02nksh****
VpcIdstring

主机所在专有网络 ID 。

vpc-uf6idhbqkbuw11kw3****
ZoneIdstring

地域下的可用区 ID。

cn-hangzhou-j
InstanceNamestring

ECS 实例名称。

launch-advisor-20250530
Stautsstring

实例状态

Running
IpListarray<object>

IP 信息列表。

IpInfoobject

IP 信息。

Ipstring

主机 IP。

127.0.0.1
Typestring

IP 地址类型,取值:

  • Private:内网 IP

  • Public: 外网 IP

Private
SecurityGroupsarray

安全组列表信息。

Stringstring

安全组 ID

sg-uf66unlpw292cgh6****
Descriptionstring

ECS 主机描述。

test
Disksarray<object>

磁盘列表

DiskInfoobject

磁盘数据

DiskIdstring

云盘或本地盘 ID。

d-uf6aa8sjgtc4168f****
Categorystring

磁盘类型。取值范围:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • cloud_essd:ESSD 云盘。
  • cloud:普通云盘。
cloud_essd
Typestring

云盘或本地盘磁盘类型 ,取值:

  • system:系统盘

  • data: 数据盘

system
Devicestring

云盘或本地盘挂载实例的设备名。

/dev/xvda
Mountstring

挂载目录。

/data
MaxResultsinteger
说明 该参数暂未上线,当前使用 PageNumber 与 PageSize 完成分页查询操作。
50
NextTokenstring
说明 该参数暂未上线,当前使用 PageNumber 与 PageSize 完成分页查询操作。
caeba0bbb2be03f84eb48b699f0a4883

示例

正常返回示例

JSON格式

{
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22E****",
  "PageSize": 20,
  "PageNumber": 1,
  "TotalCount": 100,
  "InstanceList": [
    {
      "InstanceId": "i-2zeaquy5es02nksh****",
      "VpcId": "vpc-uf6idhbqkbuw11kw3****",
      "ZoneId": "cn-hangzhou-j",
      "InstanceName": "launch-advisor-20250530",
      "Stauts": "Running",
      "IpList": [
        {
          "Ip": "127.0.0.1",
          "Type": "Private"
        }
      ],
      "SecurityGroups": [
        "sg-uf66unlpw292cgh6****"
      ],
      "Description": "test",
      "Disks": [
        {
          "DiskId": "d-uf6aa8sjgtc4168f****",
          "Category": "cloud_essd",
          "Type": "system",
          "Device": "/dev/xvda",
          "Mount": "/data"
        }
      ]
    }
  ],
  "MaxResults": 50,
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883"
}

错误码

访问错误中心查看更多错误码。