调用DescribeAutoProvisioningGroups查询一个或多个弹性供应组。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecs:DescribeAutoProvisioningGroups | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 弹性供应组所在地域的 ID。 | cn-hangzhou |
PageNumber | integer | 否 | 分页查询时设置的列表页码。 起始值:1。 默认值:1。 | 1 |
PageSize | integer | 否 | 分页查询时设置的每页行数。 最大值:100。 默认值:10。 | 2 |
AutoProvisioningGroupName | string | 否 | 弹性供应组的名称。 | testAutoProvisioningGroupName |
ResourceGroupId | string | 否 | 弹性供应组所属的资源组 ID。 | rg-bp67acfmxazb4p**** |
AutoProvisioningGroupId | array | 否 | 弹性供应组 ID 列表。可输入最多 20 个弹性供应组 ID。 | |
string | 否 | 弹性供应组 ID。 | apg-sn54avj8htgvtyh8**** | |
AutoProvisioningGroupStatus | array | 否 | 弹性供应组的状态列表。 | |
string | 否 | 弹性供应组的状态,取值范围:
| active | |
Tag | array<object> | 否 | 弹性供应组绑定的标签。 | |
object | 否 | 弹性供应组绑定的标签。 | ||
Key | string | 否 | 弹性供应组的标签键。 N 的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以 aliyun 和 acs:开头,不能包含 http://或者 https://。 | TestKey |
Value | string | 否 | 弹性供应组的标签值。 N 的取值范围:1~20。一旦传入该值,允许为空字符串。最多支持 128 个字符,不能包含 http://或者 https://。 | TestValue |
返回参数
示例
正常返回示例
JSON
格式
{
"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"
}
]
}
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | MissingParamter.RegionId | The regionId should not be null. | 参数 RegionId 不得为空。 |
400 | InvalidName.Malformed | The specified parameter "AutoProvisioningGroupName" is not valid. | - |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-02-29 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-01-04 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |