すべてのプロダクト
Search

このプロダクト

    Elastic Compute Service:DescribeAutoProvisioningGroups

    ドキュメントセンター

    Elastic Compute Service:DescribeAutoProvisioningGroups

    最終更新日:Sep 20, 2026

    1 つ以上の自動プロビジョニンググループを照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ecs:DescribeAutoProvisioningGroups

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    自動プロビジョニンググループが存在するリージョンの ID。

    cn-hangzhou
    PageNumber

    integer

    任意

    ページングクエリで返されるリストのページ番号。

    最小値: 1。

    デフォルト値: 1。

    1
    PageSize

    integer

    任意

    ページングクエリにおける 1 ページあたりのエントリ数。

    最大値: 100。

    デフォルト値: 10。

    2
    AutoProvisioningGroupName

    string

    任意

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

    テスト自動プロビジョニンググループ名
    ResourceGroupId

    string

    任意

    自動プロビジョニンググループが属するリソースグループの ID。

    rg-bp67acfmxazb4p****
    AutoProvisioningGroupId

    array

    任意

    自動プロビジョニンググループの ID。最大 20 個の自動プロビジョニンググループ ID を指定できます。

    apg-sn54avj8htgvtyh8****

    string

    任意

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

    apg-sn54avj8htgvtyh8****
    AutoProvisioningGroupStatus

    array

    任意

    自動プロビジョニンググループのステータスのリスト。

    アクティブな

    string

    任意

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

    • submitted: 自動プロビジョニンググループは作成されていますが、スケジューリングタスクを実行する処理は開始されていません。

    • active: 自動プロビジョニンググループはアクティブな状態であり、スケジューリングタスクを実行する処理が開始されています。

    • deleted: 自動プロビジョニンググループは削除されています。

    • delete-running: 自動プロビジョニンググループの削除が実行中です。

    • modifying: 自動プロビジョニンググループは変更済み状態へ更新中です。

    アクティブな
    AutoProvisioningGroupTypes

    array

    任意

    自動プロビジョニンググループのタイプ。有効な値: リクエスト、maintain、candidate。

    string

    任意

    自動プロビジョニンググループのタイプ。有効な値: リクエスト、maintain、candidate。

    リクエスト
    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

    object

    AutoProvisioningGroup

    array<object>

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

    array<object>

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

    CreationTime

    string

    作成時刻。時刻は ISO 8601 形式の協定世界時 (UTC) で表示されます。

    2019-04-01T15:10:20Z
    AutoProvisioningGroupName

    string

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

    EcsDocTest
    Status

    string

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

    • submitted: 自動プロビジョニンググループは作成されていますが、スケジューリングタスクを実行する処理は開始されていません。

    • active: 自動プロビジョニンググループはアクティブな状態であり、スケジューリングタスクを実行する処理が開始されています。

    • deleted: 自動プロビジョニンググループは削除されています。

    • delete-running: 自動プロビジョニンググループの削除が実行中です。

    • modifying: 自動プロビジョニンググループは変更済み状態へ更新中です。

    submitted
    TerminateInstances

    boolean

    自動プロビジョニンググループが削除されるときに、グループ内のインスタンスをリリースするかどうかを指定します。有効な値:

    • true: グループ内のインスタンスをリリースします。

    • false: グループ内のインスタンスを保持します。

    false
    MaxSpotPrice

    number

    スポットインスタンスの最大価格。

    説明

    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: 1 回限り。自動プロビジョニンググループは起動時にのみインスタンスクラスターを配信し、スケジューリング失敗後のリトライは行いません。

    • maintain: 継続的プロビジョニング。自動プロビジョニンググループは起動時にインスタンスクラスターの配信を試み、リアルタイムキャパシティを監視します。ターゲットキャパシティに達していない場合、グループは ECS インスタンスの作成を継続します。

    maintain
    AutoProvisioningGroupId

    string

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

    apg-sn54avj8htgvtyh8****
    ExcessCapacityTerminationPolicy

    string

    自動プロビジョニンググループのリアルタイムキャパシティがターゲットキャパシティを超え、スケールインイベントがトリガーされたときに、スケールインされたインスタンスをリリースするかどうかを指定します。有効な値:

    • termination: スケールインされたインスタンスをリリースします。

    • no-termination: スケールインされたインスタンスを自動プロビジョニンググループから削除するのみです。

    termination
    ResourceGroupId

    string

    自動プロビジョニンググループが属するリソースグループの ID。

    rg-bp67acfmxazb4p****
    LaunchTemplateConfigs

    object

    LaunchTemplateConfig

    array<object>

    拡張起動テンプレートの詳細。

    object

    MaxPrice

    number

    拡張起動テンプレートで指定されたインスタンスタイプの最大価格。

    3
    Priority

    number

    拡張起動テンプレートで指定されたインスタンスタイプの優先度。値 0 は最優先を示します。

    1
    VSwitchId

    string

    拡張起動テンプレートで指定された vSwitch の ID。

    vsw-sn5bsitu4lfzgc5o7****
    WeightedCapacity

    number

    拡張起動テンプレートで指定されたインスタンスタイプの重み。

    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

    number

    スポットインスタンスのターゲットキャパシティ。

    20
    PayAsYouGoTargetCapacity

    number

    従量課金インスタンスのターゲットキャパシティ。

    30
    DefaultTargetCapacityType

    string

    PayAsYouGoTargetCapacity と SpotTargetCapacity の合計が TotalTargetCapacity 未満の場合のキャパシティ差のデフォルトタイプ。有効な値:

    • PayAsYouGo: 従量課金インスタンス。

    • Spot: スポットインスタンス。

    Spot
    TotalTargetCapacity

    number

    自動プロビジョニンググループのターゲット合計キャパシティ。次の 3 つの部分で構成されます。

    • PayAsYouGoTargetCapacity

    • SpotTargetCapacity

    • TotalTargetCapacity と、PayAsYouGoTargetCapacity および SpotTargetCapacity の合計との差

    60
    Tags

    object

    Tag

    array<object>

    自動プロビジョニンググループに関連付けられているタグ。

    object

    自動プロビジョニンググループに関連付けられているタグ。

    TagKey

    string

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

    N の有効な値: 1 ~ 20。タグキーは空文字列にできません。タグキーの長さは最大 128 文字で、aliyun または acs: で始めることはできません。タグキーに http:// または https:// を含めることはできません。

    TestKey
    TagValue

    string

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

    N の有効な値: 1 ~ 20。タグ値は空文字列にできます。タグ値の長さは最大 128 文字で、http:// または https:// を含めることはできません。

    TestValue
    CandidateOptions

    object

    候補タイプに関連する設定。

    TimeoutMinutes

    integer

    自動プロビジョニンググループがターゲットキャパシティへのスケールアウトを試みるタイムアウト期間。単位: 分。

    60
    CapacitySpecification

    object

    自動プロビジョニンググループの現在のキャパシティディストリビューション。

    PayAsYouGoCapacity

    number

    自動プロビジョニンググループ内の現在の従量課金インスタンスのキャパシティ。

    2
    PrePaidCapacity

    number

    自動プロビジョニンググループ内の現在のサブスクリプションインスタンスのキャパシティ。

    0
    SpotCapacity

    number

    自動プロビジョニンググループ内の現在のスポットインスタンスのキャパシティ。

    3
    TotalCapacity

    number

    自動プロビジョニンググループ内の現在の合計インスタンスキャパシティ。

    5
    SuspendedProcesses

    object

    SuspendedProcess

    array

    自動プロビジョニンググループの一時停止されたプロセス。有効な値:

    1. ScaleIn: スケールインプロセス。

    2. ScaleOut: スケールアウトプロセス。

    string

    自動プロビジョニンググループの一時停止されたプロセス。有効な値:

    1. ScaleIn: スケールインプロセス。

    2. ScaleOut: スケールアウトプロセス。

    ScaleOut

    例

    成功レスポンス

    JSONJSON

    {
  "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"
            }
          ]
        },
        "CandidateOptions": {
          "TimeoutMinutes": 60
        },
        "CapacitySpecification": {
          "PayAsYouGoCapacity": 2,
          "PrePaidCapacity": 0,
          "SpotCapacity": 3,
          "TotalCapacity": 5
        },
        "SuspendedProcesses": {
          "SuspendedProcess": [
            "ScaleOut"
          ]
        }
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 MissingParamter.RegionId The regionId should not be null. RegionId パラメーターは空にできません。
    400 InvalidName.Malformed The specified parameter "AutoProvisioningGroupName" is not valid.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。