Use DescribeAutoProvisioningGroupInstances to query instances in an auto provisioning group - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries information about instances in an auto provisioning group.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeAutoProvisioningGroupInstances

get

*AutoProvisioningGroup

acs:ecs:{#regionId}:{#accountId}:autoprovisioninggroup/{#autoprovisioninggroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the auto provisioning group resides. You can invoke DescribeRegions to query the most recent region list.	cn-hangzhou
PageNumber	integer	No	The page number for the paging query. Minimum value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page in the paging query. You can use this parameter to configure paging settings. Maximum value: 100. Default value: 10.	10
AutoProvisioningGroupId	string	Yes	The ID of the auto provisioning group.	apg-uf6jel2bbl62wh13****

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	B48A12CD-1295-4A38-A8F0-0E92C937****
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of instances in the auto provisioning group.	2
Instances	object
Instance	array<object>	The information about all instances in the auto provisioning group.
	object	The information about all instances in the auto provisioning group.
Status	string	The status of the instance.	Running
CreationTime	string	The time when the instance was created.	2017-12-10T04:04Z
IsSpot	boolean	Indicates whether the instance is a spot instance.	true
CPU	integer	The number of vCPU cores of the instance.	2
InstanceId	string	The instance ID.	i-bp67acfmxazb4p****
NetworkType	string	The network type of the instance. Valid values: vpc: Virtual Private Cloud (VPC) classic: classic network	vpc
InstanceType	string	The ECS instance type.	ecs.g5.large
RegionId	string	The region ID of the container group.	cn-hangzhou
IoOptimized	boolean	Indicates whether the instance is an I/O optimized instance.	true
OsType	string	The operating system type of the instance. Valid values: windows linux	linux
ZoneId	string	The ID of the zone to which the instance belongs.	cn-hangzhou-g
Memory	integer	The memory capacity of the instance. Unit: MiB.	1024

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	MissingParameter	The specified parameter "AutoProvisioningGroupId" should not be null.	Elastic Supply Group Id(AutoProvisioningGroupId) must be filled in.
400	MissingParamter.RegionId	The regionId should not be null.	The RegionId parameter is required.
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API doesn't support RAM.
404	InvalidAutoProvisioningGroupId.NotFound	The specified AutoProvisioningGroupId does not exist.	The specified elastic supply group does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.