DescribeAutoProvisioningGroups - 查询一个或多个弹性供应组 - 云服务器 ECS

调用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	否	弹性供应组的状态，取值范围： submitted：完成创建，但弹性供应组尚未开始执行调度任务。 active：弹性供应组已开始执行调度任务。 deleted：弹性供应组已删除。 delete-running：弹性供应组删除中。 modifying：弹性供应组修改中。	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

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	每页行数。	10
RequestId	string	请求 ID。	745CEC9F-0DD7-4451-9FE7-8B752F39****
PageNumber	integer	页码。	1
TotalCount	integer	查询到的弹性供应组的个数。	10
AutoProvisioningGroups	array<object>	弹性供应组的详细信息。
AutoProvisioningGroup	object	弹性供应组的详细信息。
CreationTime	string	创建时间。	2019-04-01T15:10:20Z
AutoProvisioningGroupName	string	弹性供应组的名称。	EcsDocTest
Status	string	弹性供应组的状态。可能值： submitted：完成创建，但弹性供应组尚未开始执行调度任务。 active：弹性供应组已开始执行调度任务。 deleted：弹性供应组已删除。 delete-running：弹性供应组删除中。 modifying：弹性供应组修改中。	submitted
TerminateInstances	boolean	删除弹性供应组时，是否释放组内实例。可能值： true：释放组内实例。 false：保留组内实例。	false
MaxSpotPrice	float	抢占式实例的最高价格。说明同时设置了 MaxSpotPrice 和 LaunchTemplateConfig.N.MaxPrice 时，以最低值为准。 LaunchTemplateConfig.N.MaxPrice 在创建弹性供应组时设置，且不可修改。	2
State	string	弹性供应组整体调度的执行状态。可能值： fulfilled：已成功完成调度任务。 pending-fulfillment：创建实例中。 pending-termination：移除实例中。 error：调度时发生异常，未能交付实例集群。	fulfilled
LaunchTemplateId	string	关联的实例启动模板的 ID。	lt-bp1fgzds4bdogu03****
ValidFrom	string	弹性供应组的启动时间，和`ValidUntil`结合确定有效时段。	2019-04-01T15:10:20Z
LaunchTemplateVersion	string	关联的实例启动模板的版本。	1
TerminateInstancesWithExpiration	boolean	弹性供应组到期时，是否释放组内实例。可能值： true：释放组内实例。 false：只将组内实例移出弹性供应组。	true
RegionId	string	所在地域的 ID。	cn-hangzhou
ValidUntil	string	弹性供应组的到期时间，和`ValidFrom`结合确定有效时段。	2019-06-01T15:10:20Z
AutoProvisioningGroupType	string	交付类型。可能值： request：一次性。供应组仅在启动时交付实例集群，调度失败后不再重试。 maintain：持续供应。供应组在启动时尝试交付实例集群，并监控实时容量，未达到目标容量则尝试继续创建 ECS 实例。	maintain
AutoProvisioningGroupId	string	弹性供应组 ID。	apg-sn54avj8htgvtyh8****
ExcessCapacityTerminationPolicy	string	弹性供应组实时容量超过目标容量并触发缩容时，是否释放缩容的实例。可能值： termination：释放缩容的实例。 no-termination：只将缩容的实例移出弹性供应组。	termination
ResourceGroupId	string	弹性供应组所属的资源组 ID。	rg-bp67acfmxazb4p****
LaunchTemplateConfigs	array<object>	扩展启动模板的详细信息。
LaunchTemplateConfig	object
MaxPrice	float	扩展启动模板对应实例规格的价格上限。	3
Priority	float	扩展启动模板对应的实例规格的优先级，取值为 0 时最高。	1
VSwitchId	string	扩展启动模板对应的虚拟交换机的 ID。	vsw-sn5bsitu4lfzgc5o7****
WeightedCapacity	float	扩展启动模板对应的实例规格的权重。	2
InstanceType	string	扩展启动模板对应的实例规格。	ecs.g5.large
SpotOptions	object	抢占式实例相关的策略。
InstancePoolsToUseCount	integer	弹性供应组选择价格最低的实例规格创建实例的数量。说明该参数在创建弹性供应组时被设置，且不可修改。	2
AllocationStrategy	string	创建抢占式实例的策略。可能值： lowest-price：成本优化策略。选择价格最低的实例规格。 diversified：均衡可用区分布策略。在扩展启动模板指定的可用区内创建实例，均匀分布到各可用区。	diversified
InstanceInterruptionBehavior	string	停止了超额的抢占式实例后的下一步动作。可能值： stop：保持停止状态。 terminate：释放。	stop
PayAsYouGoOptions	object	按量付费实例相关的策略。
AllocationStrategy	string	创建按量付费实例的策略。可能值： lowest-price：成本优化策略。选择价格最低的实例规格。 prioritized：优先级策略。按照 LaunchTemplateConfig.N.Priority 设定的优先级创建实例。说明 LaunchTemplateConfig.N.Priority 在创建弹性供应组时设置，且不可修改。	prioritized
TargetCapacitySpecification	object	弹性供应组的目标容量设置。
SpotTargetCapacity	float	抢占式实例的目标容量。	20
PayAsYouGoTargetCapacity	float	按量付费实例的目标容量。	30
DefaultTargetCapacityType	string	`PayAsYouGoTargetCapacity`和`SpotTargetCapacity`之和小于`TotalTargetCapacity`时，指定的差额容量的计费方式。可能值： PayAsYouGo：按量付费实例 Spot：抢占式实例	Spot
TotalTargetCapacity	float	弹性供应组的目标总容量，由以下三个部分组成： PayAsYouGoTargetCapacity SpotTargetCapacity PayAsYouGoTargetCapacity 和 SpotTargetCapacity 之外的差额容量	60
Tags	array<object>	弹性供应组绑定的标签。
Tag	object	弹性供应组绑定的标签。
TagKey	string	弹性供应组的标签键。 N 的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。	TestKey
TagValue	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 返回结构发生变更	查看变更详情