全部产品
Search
文档中心

云服务器 ECS:DescribeAutoProvisioningGroupInstances - 查询一个弹性供应组内的实例

更新时间:Feb 04, 2024

调用DescribeAutoProvisioningGroupInstances查询一个弹性供应组内的实例。

调试

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

授权信息

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

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

请求参数

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

弹性供应组所在地域的 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
PageNumberinteger

分页查询列表的页码。

起始值:1

默认值:1

1
PageSizeinteger

分页查询时设置的每页行数。

最大值:100

默认值:10

10
AutoProvisioningGroupIdstring

弹性供应组的 ID。

apg-uf6jel2bbl62wh13****

返回参数

名称类型描述示例值
object
PageSizeinteger

每页行数。

10
RequestIdstring

请求 ID。

B48A12CD-1295-4A38-A8F0-0E92C937****
PageNumberinteger

页码。

1
TotalCountinteger

查询到的弹性供应组内实例的个数。

2
Instancesobject []

弹性供应组下所有实例的信息。

Statusstring

实例状态。

Running
CreationTimestring

实例创建时间。

2017-12-10T04:04Z
IsSpotboolean

是否为抢占式实例。

true
CPUinteger

实例的 vCPU 核数。

2
InstanceIdstring

实例 ID。

i-bp67acfmxazb4p****
NetworkTypestring

实例的网络类型,取值范围:

  • vpc:专有网络
  • classic:经典网络
vpc
InstanceTypestring

实例规格。

ecs.g5.large
RegionIdstring

实例所属地域的 ID。

cn-hangzhou
IoOptimizedboolean

是否为 I/O 优化型实例。

true
OsTypestring

实例的操作系统类型,取值范围:

  • windows:操作系统类型为 Windows。
  • linux:操作系统类型为 Linux。
linux
ZoneIdstring

实例所属可用区。

cn-hangzhou-g
Memoryinteger

内存大小,单位 MiB。

1024

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "B48A12CD-1295-4A38-A8F0-0E92C937****",
  "PageNumber": 1,
  "TotalCount": 2,
  "Instances": {
    "Instance": [
      {
        "Status": "Running",
        "CreationTime": "2017-12-10T04:04Z",
        "IsSpot": true,
        "CPU": 2,
        "InstanceId": "i-bp67acfmxazb4p****",
        "NetworkType": "vpc",
        "InstanceType": "ecs.g5.large",
        "RegionId": "cn-hangzhou",
        "IoOptimized": true,
        "OsType": "linux",
        "ZoneId": "cn-hangzhou-g",
        "Memory": 1024
      }
    ]
  }
}

JSON格式

{
  "PageSize": 10,
  "RequestId": "B48A12CD-1295-4A38-A8F0-0E92C937****",
  "PageNumber": 1,
  "TotalCount": 2,
  "Instances": {
    "Instance": [
      {
        "Status": "Running",
        "CreationTime": "2017-12-10T04:04Z",
        "IsSpot": true,
        "CPU": 2,
        "InstanceId": "i-bp67acfmxazb4p****",
        "NetworkType": "vpc",
        "InstanceType": "ecs.g5.large",
        "RegionId": "cn-hangzhou",
        "IoOptimized": true,
        "OsType": "linux",
        "ZoneId": "cn-hangzhou-g",
        "Memory": 1024
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400MissingParameterThe specified parameter "AutoProvisioningGroupId" should not be null.-
400MissingParamter.RegionIdThe regionId should not be null.参数 RegionId 不得为空。
403Forbidden.RAMUser not authorized to operate on the specified resource, or this API doesn't support RAM.-
404InvalidAutoProvisioningGroupId.NotFoundThe specified AutoProvisioningGroupId does not exist.-

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