查询ECS实例信息列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cddc:DescribePrinsEcsInstances | list | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 地域 ID。可查看地域信息获取。 | cn-hangzhou |
EcsInstanceId | string | 否 | ECS 的实例 ID。 | i-bp1726beecvi8kak**** |
PageSize | integer | 否 | 每页展示数目。 | 20 |
PageNumber | integer | 否 | 实例列表的页码,起始值为 1,默认值为 1。 | 1 |
VpcId | string | 否 | 实例所在的专有网络 ID 。 | vpc-t4nbtmekgxotv0d3y**** |
ZoneId | string | 否 | 可用区 ID。 | cn-hangzhou-j |
MaxResults | integer | 否 | 说明
该参数暂未上线,当前使用 PageNumber 与 PageSize 完成分页查询操作。
使用 NextToken 方式查询时,每次最多返回的结果数。 | 20 |
NextToken | string | 否 | 说明
该参数暂未上线,当前使用 PageNumber 与 PageSize 完成分页查询操作。
本次调用返回的查询凭证值。 | caeba0bbb2be03f84eb48b699f0a4883 |
Keyword | string | 否 | 查询关键字,模糊匹配,支持主机 ID、主机名称、主机 IP。 | keyword |
返回参数
示例
正常返回示例
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"
}
错误码
访问错误中心查看更多错误码。