DescribeAutoProvisioningGroupInstances

Updated at: 2025-04-17 06:12

Queries instances in an auto provisioning group.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
OperationAccess levelResource typeCondition keyAssociated operation
ecs:DescribeAutoProvisioningGroupInstancesget
*AutoProvisioningGroup
acs:ecs:{#regionId}:{#accountId}:autoprovisioninggroup/{#autoprovisioninggroupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the auto provisioning group. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
PageNumberintegerNo

The page number.

Pages start from page 1.

Default value: 1.

1
PageSizeintegerNo

The number of entries per page.

Valid values: 1 to 100.

Default value: 10.

10
AutoProvisioningGroupIdstringYes

The ID of the auto provisioning group.

apg-uf6jel2bbl62wh13****

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries per page.

10
RequestIdstring

The request ID.

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

The page number.

1
TotalCountinteger

The number of queried instances in the auto provisioning group.

2
Instancesarray<object>

The information about the instances in the auto provisioning group.

Instanceobject
Statusstring

The status of the instance.

Running
CreationTimestring

The time when the instance was created.

2017-12-10T04:04Z
IsSpotboolean

Indicates whether the instance is a preemptible instance.

true
CPUinteger

The number of vCPU cores of the instance.

2
InstanceIdstring

The instance ID.

i-bp67acfmxazb4p****
NetworkTypestring

The network type of the instance. Valid values:

  • vpc: Virtual Private Cloud (VPC)
  • classic: classic network
vpc
InstanceTypestring

The ECS instance type.

ecs.g5.large
RegionIdstring

The region ID of the container group.

cn-hangzhou
IoOptimizedboolean

Indicates whether the instance is an I/O optimized instance.

true
OsTypestring

The operating system type of the instance. Valid values:

  • windows
  • linux
linux
ZoneIdstring

The ID of the zone to which the instance belongs.

cn-hangzhou-g
Memoryinteger

The memory capacity of the instance. Unit: MiB.

1024

Examples

Sample success responses

JSONformat

{
  "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
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
HTTP status codeError codeError messageDescription
400MissingParameterThe specified parameter "AutoProvisioningGroupId" should not be null.Elastic Supply Group Id(AutoProvisioningGroupId) must be filled in.
400MissingParamter.RegionIdThe regionId should not be null.The RegionId parameter is required.
403Forbidden.RAMUser not authorized to operate on the specified resource, or this API doesn't support RAM.-
404InvalidAutoProvisioningGroupId.NotFoundThe specified AutoProvisioningGroupId does not exist.The specified elastic supply group does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
No change history
  • On this page (1)
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback