Queries information of auto provisioning groups.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID of the auto provisioning group. | cn-hangzhou |
PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
PageSize | integer | No | The number of entries per page. Valid values: 1 to 100. Default value: 10. | 2 |
AutoProvisioningGroupName | string | No | The name of the auto provisioning group. | testAutoProvisioningGroupName |
ResourceGroupId | string | No | The ID of the resource group to which the auto provisioning group belongs. | rg-bp67acfmxazb4p**** |
AutoProvisioningGroupId | array | No | The ID of the auto provisioning group. You can specify up to 20 IDs. | |
string | No | The ID of the auto provisioning group. | apg-sn54avj8htgvtyh8**** | |
AutoProvisioningGroupStatus | array | No | The status of the auto provisioning group. | |
string | No | The status of auto provisioning group N. Valid values:
| active | |
Tag | object [] | No | The tags that are added to the auto provisioning group. | |
Key | string | No | The key of tag N that is added to the auto provisioning group. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun. | TestKey |
Value | string | No | The value of tag N that is added to the auto provisioning group. Valid values of N: 1 to 20. The tag value can be an empty string. The tag key can be up to 128 characters in length and cannot contain http:// or https://. | TestValue |
Response parameters
Examples
Sample success responses
JSON
format
{
"PageSize": 10,
"RequestId": "745CEC9F-0DD7-4451-9FE7-8B752F39****",
"PageNumber": 1,
"TotalCount": 10,
"AutoProvisioningGroups": {
"AutoProvisioningGroup": [
{
"CreationTime": "2019-04-01T15:10:20Z",
"AutoProvisioningGroupName": "EcsDocTest",
"Status": "submitted",
"TerminateInstances": false,
"MaxSpotPrice": 2,
"State": "fulfilled",
"LaunchTemplateId": "lt-bp1fgzds4bdogu03****",
"ValidFrom": "2019-04-01T15:10:20Z",
"LaunchTemplateVersion": "1",
"TerminateInstancesWithExpiration": true,
"RegionId": "cn-hangzhou",
"ValidUntil": "2019-06-01T15:10:20Z",
"AutoProvisioningGroupType": "maintain",
"AutoProvisioningGroupId": "apg-sn54avj8htgvtyh8****",
"ExcessCapacityTerminationPolicy": "termination",
"ResourceGroupId": "rg-bp67acfmxazb4p****",
"LaunchTemplateConfigs": {
"LaunchTemplateConfig": [
{
"MaxPrice": 3,
"Priority": 1,
"VSwitchId": "vsw-sn5bsitu4lfzgc5o7****",
"WeightedCapacity": 2,
"InstanceType": "ecs.g5.large"
}
]
},
"SpotOptions": {
"InstancePoolsToUseCount": 2,
"AllocationStrategy": "diversified",
"InstanceInterruptionBehavior": "stop"
},
"PayAsYouGoOptions": {
"AllocationStrategy": "prioritized"
},
"TargetCapacitySpecification": {
"SpotTargetCapacity": 20,
"PayAsYouGoTargetCapacity": 30,
"DefaultTargetCapacityType": "Spot",
"TotalTargetCapacity": 60
},
"Tags": {
"Tag": [
{
"TagKey": "TestKey",
"TagValue": "TestValue"
}
]
}
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | MissingParamter.RegionId | The regionId should not be null. | The RegionId parameter is required. |
400 | InvalidName.Malformed | The specified parameter "AutoProvisioningGroupName" is not valid. | - |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
2024-02-29 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | see changesets | ||||||||||
| ||||||||||||
2024-01-04 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | see changesets | ||||||||||
|