この操作を呼び出して、自動プロビジョニンググループを照会できます。

デバッグ

API の使用を簡単にするため、Alibaba Cloud では、OpenAPI Explorer を提供しています。 OpenAPI Explorer を使用して、API の検索、API の呼び出し、および SDK サンプルコードの動的な生成を行うことができます。

リクエストパラメーター

パラメーター データ型 必須/任意 説明
RegionId String 必須 cn-hangzhou

自動プロビジョニンググループのリージョン ID。

Action String 任意 DescribeAutoProvisioningGroups

実行する操作。 このパラメーターを DescribeAutoProvisioningGroups に設定します。

AutoProvisioningGroupId.N RepeatList 任意 apg-sn54avj8htgvtyh8****

照会する自動プロビジョニンググループの ID。

AutoProvisioningGroupName String 任意 test

照会する自動プロビジョニンググループの名前。

AutoProvisioningGroupStatus.N RepeatList 任意 active

照会する自動プロビジョニンググループのステータス。 有効な値:

  • submit: 自動プロビジョニンググループは作成されましたが、スケジューリングタスクの実行は開始していません。
  • active: 自動プロビジョニンググループはスケジューリングタスクを実行しています。
  • deleted: 自動プロビジョニンググループは削除されました。
  • deleted-running:自動プロビジョニンググループは削除されています。
  • modifying:自動プロビジョニンググループは変更中です。
PageNumber Integer 任意 1

返すページの番号。 ページは 1 ページから始まります。 デフォルト値: 1

PageSize Integer 任意 10

各ページに返されるエントリの数。 最大値:100。 デフォルト値: 10

レスポンスパラメーター

パラメーター データ型 説明
AutoProvisioningGroups

照会された自動プロビジョニンググループに関する情報。

└AutoProvisioningGroupId String apg-sn54avj8htgvtyh8****

自動プロビジョニンググループの ID。

└AutoProvisioningGroupName String apg-test

自動プロビジョニンググループの名前。

└AutoProvisioningGroupType String maintain

自動プロビジョニンググループのタイプ。 有効な値:

  • request :ワンタイム配信タイプ。 自動プロビジョニンググループが開始されると、インスタンスクラスターの作成は 1 回のみ試行されます。 クラスターの作成に失敗した場合、グループは再試行をしません。
  • maintain: 継続的な配信と容量タイプを維持します。 自動プロビジョニンググループが開始された後、インスタンスクラスターの作成と維持を継続的に試みます。 自動プロビジョニンググループは、クラスターのリアルタイム容量とターゲット容量を比較します。 クラスターがターゲット容量を満たさない場合、グループはクラスターがターゲット容量を満たすまでインスタンスを作成します。
└CreationTime String 2019-04-01T15:10:20Z

自動プロビジョニンググループが作成された時刻。

└ExcessCapacityTerminationPolicy String termination

ターゲット容量を超えた場合の、過剰なプリエンプティブルインスタンスの自動プロビジョニンググループのシャットダウンポリシー。 有効な値:

  • no-termination:過剰なプリエンプティブルインスタンスはシャットダウンされません。
  • termination: 過剰なプリエンプティブルインスタンスはシャットダウンされます。 これらのシャットダウンインスタンスで実行される操作は、SpotInstanceInterruptionBehavior パラメーターで指定されます。
SpotInstanceInterruptionBehavior パラメーターは、自動プロビジョニンググループの作成プロセス中に設定され、変更できません。 詳細については、「CreateAutoProvisioningGroup」をご参照ください。
└LaunchTemplateConfigs

自動プロビジョニンググループの起動テンプレートの拡張設定。

└InstanceType String ecs.g5.large

拡張設定で指定されたインスタンスタイプ。

└MaxPrice Float 3

拡張設定で指定されたインスタンスタイプの最高価格。

└Priority Float 1

拡張設定で指定されたインスタンスタイプの優先度。 0 は、最優先を示します。

└VSwitchId String vsw-sn5bsitu4lfzgc5o7****

拡張設定の VSwitch の ID。

└WeightedCapacity Float 2

拡張設定で指定されたインスタンスタイプの重み。

└LaunchTemplateId String lt-bp1fgzds4bdogu03****

自動プロビジョニンググループに関連付けられた起動テンプレートの ID。

└LaunchTemplateVersion String 1

自動プロビジョニンググループに関連付けられている起動テンプレートのバージョン。

└MaxSpotPrice Float 2

自動プロビジョニンググループのプリエンプティブルインスタンスのグローバル最高価格。 MaxSpotPrice LaunchTemplateConfig.N.MaxPrice パラメーターが両方とも指定されている場合、最高価格は、2 つのうちの低い値です。

LaunchTemplateConfig.N.MaxPrice パラメーターは、自動プロビジョニンググループの作成プロセス中に設定され、変更できません。 詳細については、 「CreateAutoProvisioningGroup」をご参照ください。
└PayAsYouGoOptions

従量課金インスタンスに関連するポリシー。

└AllocationStrategy String prioritized

従量課金インスタンスのスケールアウトポリシー。 有効な値:

  • lowest-price: 自動プロビジョニンググループが従うコスト最適化ポリシー。最低コストのインスタンスタイプを選択してインスタンスを作成します。
  • prioritized :自動プロビジョニンググループがインスタンスを作成するために従う優先度ベースのポリシー。 インスタンスタイプの優先度は、 LaunchTemplateConfig.N.Priority パラメーターによって指定されます。
LaunchTemplateConfig.N.MaxPrice パラメーターは、自動プロビジョニンググループの作成プロセス中に設定され、変更できません。 詳細については、「CreateAutoProvisioningGroup」をご参照ください。
└RegionId String cn-hangzhou

自動プロビジョニンググループのリージョン ID。

└SpotOptions

プリエンプティブルインスタンスのポリシー。

└AllocationStrategy String diversified

プリエンプティブルインスタンスのスケールアウトポリシー。 有効な値:

  • lowest-price :自動プロビジョニンググループが従うコスト最適化ポリシー。最低コストのインスタンスタイプを選択してインスタンスを作成します。
  • diversified :自動プロビジョニンググループが従う分散バランスポリシー。拡張テンプレート設定で指定された複数のゾーンに均等にインスタンスを作成します。
└InstanceInterruptionBehavior String stop

プリエンプティブルインスタンスがシャットダウンされた後のデフォルトの動作。 有効な値:

  • stop: プリエンプティブルインスタンスを停止します。
  • terminate: プリエンプティブルインスタンスをリリースします。
└InstancePoolsToUseCount Integer 2

このパラメーターは、 SpotAllocationStrategy パラメーターが lowest-price に設定されている場合に有効になります。 自動プロビジョニンググループは、最低コストのインスタンスタイプを選択してインスタンスを作成します。

SpotInstanceInterruptionBehavior パラメーターは、自動プロビジョニンググループの作成プロセス中に設定され、変更できません。 詳細については、「CreateAutoProvisioningGroup」をご参照ください。
└State String fulfilled

自動プロビジョニンググループのインスタンススケジューリングの全体的なステータス。 有効な値:

  • fulfilled:スケジューリングが完了し、インスタンスクラスターは配信されました。
  • pending-fulfillment: インスタンスは作成中です。
  • pending-termination: インスタンスは削除中です。
  • error:スケジューリング中に例外が発生し、インスタンスクラスターは配信されませんでした。
└Status String submitted

自動プロビジョニンググループのステータス。 有効な値:

  • submit: 自動プロビジョニンググループは作成されましたが、スケジューリングタスクの実行を開始していません。
  • active: 自動プロビジョニンググループはスケジューリングタスクを実行しています。
  • deleted: 自動プロビジョニンググループは削除されました。
  • deleted-running:自動プロビジョニンググループは削除中です。
  • modifying:自動プロビジョニンググループは変更中です。
└TargetCapacitySpecification

自動プロビジョニンググループのターゲットキャパシティの設定。

└DefaultTargetCapacityType String Spot

補足インスタンスのタイプ。 PayAsYouGoTargetCapacity SpotTargetCapacity の合計値が TotalTargetCapacity の値より小さい場合、自動プロビジョニンググループは、容量要件を満たすために、指定されたタイプのインスタンスを作成します。 有効な値:

  • PayAsYouGo:従量課金インスタンス。
  • Spot:プリエンプティブルインスタンス。
└PayAsYouGoTargetCapacity Float 30

自動プロビジョニンググループの従量課金インスタンスのターゲット容量。

└SpotTargetCapacity Float 20

自動プロビジョニンググループのプリエンプティブルインスタンスのターゲット容量。

└TotalTargetCapacity Float 60

自動プロビジョニンググループの合計容量。 容量は、次の 3 つから構成されます。

  • PayAsYouGoTargetCapacity パラメーターで指定された従量課金インスタンスのターゲット容量
  • SpotTargetCapacity パラメーターで指定されたプリエンプティブルインスタンスのターゲット容量
  • PayAsYouGoTargetCapacity および SpotTargetCapacity 以外の追加の容量
└TerminateInstances Boolean false

自動プロビジョニンググループのインスタンスをリリースするかどうかを示します。 有効な値:

  • true
  • false
└TerminateInstancesWithExpiration Boolean true

自動プロビジョニンググループの有効期限が切れた場合のプリエンプティブルインスタンスのシャットダウンポリシー。 有効な値:

  • true: プリエンプティブルインスタンスをシャットダウンします。 これらのシャットダウンインスタンスで実行される操作は、SpotInstanceInterruptionBehavior パラメーターで指定されます。
  • false:プリエンプティブルインスタンスをシャットダウンしません。
SpotInstanceInterruptionBehavior パラメーターは、自動プロビジョニンググループの作成プロセス中に設定され、変更できません。 詳細については、「CreateAutoProvisioningGroup」をご参照ください。
└ValidFrom String 2019-04-01T15:10:20Z

自動プロビジョニンググループが開始された時刻。 この時点と ValidUntil パラメーターで指定された時点までの期間が、自動プロビジョニンググループの有効期間です。

└ValidUntil String 2019-06-01T15:10:20Z

自動プロビジョニンググループの有効期限が切れる時刻。 この時点と ValidFrom パラメーターで指定された時点までの期間が、自動プロビジョニンググループの有効期間です。

PageNumber Integer 1

返されるページの番号。

PageSize Integer 10

各ページに返されるエントリの数。

RequestId String 745CEC9F-0DD7-4451-9FE7-8B752F39****

リクエストの ID。

TotalCount Integer 10

照会された自動プロビジョニンググループの数。

リクエストの例


http(s)://ecs.aliyuncs.com/? Action=DescribeAutoProvisioningGroups
&AutoProvisioningGroupId. 1=apg-sn54avj8htgvtyh8****
&<Common request parameters>

レスポンスの成功例

XML 形式

<DescribeAutoProvisioningGroups>
  <PageNumber>1</PageNumber>
  <TotalCount>1</TotalCount>
  <PageSize>10</PageSize>
  <RequestId>85331AC9-82C0-4604-9A14-048865BE****</RequestId>
  <AutoProvisioningGroups>
    <AutoProvisioningGroup>
      <TerminateInstancesWithExpiration>false</TerminateInstancesWithExpiration>
      <TerminateInstances>false</TerminateInstances>
      <ValidFrom>2019-06-17T15:22Z</ValidFrom>
      <AutoProvisioningGroupType>maintain</AutoProvisioningGroupType>
      <PayAsYouGoOptions>
        <AllocationStrategy>lowest-price</AllocationStrategy>
      </PayAsYouGoOptions>
      <AutoProvisioningGroupName>test61****</AutoProvisioningGroupName>
      <CreationTime/>
      <ExcessCapacityTerminationPolicy>no-termination</ExcessCapacityTerminationPolicy>
      <Status>active</Status>
      <MaxSpotPrice>5</MaxSpotPrice>
      <LaunchTemplateVersion>1</LaunchTemplateVersion>
      <ValidUntil>2100-01-01T07:59Z</ValidUntil>
      <TargetCapacitySpecification>
        <SpotTargetCapacity>180</SpotTargetCapacity>
        <TotalTargetCapacity>300</TotalTargetCapacity>
        <PayAsYouGoTargetCapacity>120</PayAsYouGoTargetCapacity>
        <DefaultTargetCapacityType>PayAsYouGo</DefaultTargetCapacityType>
      </TargetCapacitySpecification>
      <State>fulfilled</State>
      <LaunchTemplateId>lt-uf657o6auob6aivd****</LaunchTemplateId>
      <RegionId>cn-shanghai</RegionId>
      <AutoProvisioningGroupId>apg-uf6c7pl7b30t4m98****</AutoProvisioningGroupId>
      <SpotOptions>
        <InstancePoolsToUseCount>1</InstancePoolsToUseCount>
        <InstanceInterruptionBehavior>terminate</InstanceInterruptionBehavior>
        <AllocationStrategy>lowest-price</AllocationStrategy>
      </SpotOptions>
      <LaunchTemplateConfigs>
        <LaunchTemplateConfig>
          <MaxPrice>3</MaxPrice>
          <WeightedCapacity>1</WeightedCapacity>
          <VSwitchId>vsw-uf6qbjwokzl67uqqf****</VSwitchId>
          <Priority>1</Priority>
          <InstanceType>ecs.c5.xlarge</InstanceType>
        </LaunchTemplateConfig>
        <LaunchTemplateConfig>
          <MaxPrice>2</MaxPrice>
          <WeightedCapacity>2</WeightedCapacity>
          <VSwitchId>vsw-uf6n6iy1ib39eqvph****</VSwitchId>
          <Priority>1</Priority>
          <InstanceType>ecs.g5.large</InstanceType>
        </LaunchTemplateConfig>
        <LaunchTemplateConfig>
          <MaxPrice>1</MaxPrice>
          <WeightedCapacity>3</WeightedCapacity>
          <VSwitchId>vsw-uf6gs8uerj5osels4****</VSwitchId>
          <Priority>1</Priority>
          <InstanceType>ecs.hfc5.large</InstanceType>
        </LaunchTemplateConfig>
      </LaunchTemplateConfigs>
    </AutoProvisioningGroup>
  </AutoProvisioningGroups>
</DescribeAutoProvisioningGroups>

JSON 形式

{
	"PageNumber":1,
	"TotalCount":1,
	"PageSize":10,
	"RequestId":"85331AC9-82C0-4604-9A14-048865BE****",
	"AutoProvisioningGroups":{
		"AutoProvisioningGroup":[
			{
				"TerminateInstancesWithExpiration":false,
				"TerminateInstances":false,
				"ValidFrom":"2019-06-17T15:22Z",
				"AutoProvisioningGroupType":"maintain",
				"PayAsYouGoOptions":{
					"AllocationStrategy":"lowest-price"
				},
				"AutoProvisioningGroupName":"test61****",
				"CreationTime":"",
				"ExcessCapacityTerminationPolicy":"no-termination",
				"Status":"active",
				"MaxSpotPrice":5,
				"LaunchTemplateVersion":"1",
				"ValidUntil":"2100-01-01T07:59Z",
				"LaunchTemplateId":"lt-uf657o6auob6aivd****",
				"State":"fulfilled",
				"TargetCapacitySpecification":{
					"TotalTargetCapacity":300,
					"SpotTargetCapacity":180,
					"PayAsYouGoTargetCapacity":120,
					"DefaultTargetCapacityType":"PayAsYouGo"
				},
				"RegionId":"cn-shanghai",
				"AutoProvisioningGroupId":"apg-uf6c7pl7b30t4m98****",
				"SpotOptions":{
					"InstancePoolsToUseCount":1,
					"InstanceInterruptionBehavior":"terminate",
					"AllocationStrategy":"lowest-price"
				},
				"LaunchTemplateConfigs":{
					"LaunchTemplateConfig":[
						{
							"MaxPrice":3,
							"WeightedCapacity":1,
							"VSwitchId":"vsw-uf6qbjwokzl67uqqf****",
							"InstanceType":"ecs.c5.xlarge",
							"Priority":1
						},
						{
							"MaxPrice":2,
							"WeightedCapacity":2,
							"VSwitchId":"vsw-uf6n6iy1ib39eqvph****",
							"InstanceType":"ecs.g5.large",
							"Priority":1
						},
						{
							"MaxPrice":1,
							"WeightedCapacity":3,
							"VSwitchId":"vsw-uf6gs8uerj5osels4****",
							"InstanceType":"ecs.hfc5.large",
							"Priority":1
						}
					]
				}
			}
		]
	}
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
400 MissingParamter.RegionId The regionId should not be null. RegionId パラメーターが指定されていない場合に返されるエラーメッセージ。

エラーコードの表示