すべてのプロダクト
Search

このプロダクト

    :GetStackInstance

    ドキュメントセンター

    :GetStackInstance

    最終更新日:Jun 03, 2026

    スタックグループに関連付けられたスタックインスタンスに関する情報を照会します。

    操作説明

    この例では、MyStackGroup という名前のスタックグループに関連付けられたスタックインスタンスの情報を照会します。 スタックインスタンスは、151266687691**** Alibaba Cloud アカウントの中国 (北京) リージョンにデプロイされています。 スタックグループは自己管理権限を持ち、中国 (杭州) リージョンにデプロイされています。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ros:GetStackInstance

    get

    *StackInstance

    acs:ros:{#regionId}:{#accountId}:stackinstance/{#StackGroupName}/{#StackInstanceAccountId}/{#StackInstanceRegionId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    スタックグループが属するリージョン ID。 DescribeRegions API を呼び出して、最新のリージョンリストを取得できます。

    cn-hangzhou
    StackGroupName

    string

    必須

    スタックグループの名前。名前はリージョン内で一意である必要があります。
    名前は最大 255 文字で、数字、文字、ハイフン (-)、アンダースコア (_) を使用できます。 先頭の文字は、数字または文字である必要があります。

    MyStackGroup
    StackInstanceAccountId

    string

    必須

    スタックインスタンスが属する宛先アカウントの ID。

    • スタックグループに自己管理権限が付与されている場合、スタックインスタンスは Alibaba Cloud アカウントに属します。

    • スタックグループにサービス管理権限が付与されている場合、スタックインスタンスはリソースディレクトリのメンバーに属します。

    説明

    宛先アカウントの詳細については、「概要」をご参照ください。

    151266687691****
    StackInstanceRegionId

    string

    必須

    スタックインスタンスが属するリージョン ID。

    cn-beijing
    OutputOption

    string

    任意

    Outputs パラメーターを返すかどうかを指定します。 Outputs パラメーターはスタックの出力を指定します。 有効な値：

    • Enabled：Outputs パラメーターを返します。

    • Disabled (デフォルト)：Outputs パラメーターを返しません。

    説明

    Outputs パラメーターは計算に時間がかかります。 スタックの出力が不要な場合は、API の応答速度を向上させるために、OutputOption を Disabled に設定することを推奨します。

    Disabled

    共通リクエストパラメータの詳細については、「共通パラメータ」をご参照ください。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    B8A6B693-82C8-419D-8796-DE99EC33CFF9
    StackInstance

    object

    スタックインスタンスに関する情報。

    Status

    string

    スタックインスタンスの状態。

    有効な値：

    • CURRENT：スタックインスタンスはスタックグループと一致しています。

    • OUTDATED：スタックインスタンスはスタックグループと一致していません。スタックインスタンスが OUTDATED 状態になる理由は次のとおりです：

      • CreateStackInstances API を呼び出してスタックインスタンスを作成する際に、スタックインスタンスの作成に失敗した場合。

      • UpdateStackInstances API または UpdateStackGroup API を呼び出してスタックインスタンスを更新する際に、スタックインスタンスの更新に失敗した、または特定のスタックインスタンスのみが更新された場合。

      • 作成または更新操作が完了していない場合。

    CURRENT
    StackGroupId

    string

    スタックグループの ID。

    fd0ddef9-9540-4b42-a464-94f77835****
    StackId

    string

    スタック ID。

    説明

    このパラメーターは、スタックインスタンスが CURRENT 状態の場合にのみ返されます。

    35ad60e3-6a92-42d8-8812-f0700d45****
    DriftDetectionTime

    string

    スタックグループで最後に成功したドリフト検出が実行された時刻。

    説明

    このパラメーターは、スタックグループでドリフト検出が実行された場合にのみ返されます。

    2020-02-27T07:47:47
    StackDriftStatus

    string

    スタックグループで最後に成功したドリフト検出が実行されたときのスタックインスタンスのドリフトステータス。

    有効な値：

    • DRIFTED：スタックインスタンスはドリフトしています。

    • NOT_CHECKED：スタックインスタンスで成功したドリフト検出は実行されていません。

    • IN_SYNC：スタックインスタンスは同期されています。

    説明

    このパラメーターは、スタックグループでドリフト検出が実行された場合にのみ返されます。

    IN_SYNC
    StatusReason

    string

    スタックインスタンスが OUTDATED 状態である理由。

    説明

    このパラメーターは、スタックインスタンスが OUTDATED 状態の場合にのみ返されます。

    User initiated stop
    ParameterOverrides

    array<object>

    パラメーターオーバーライドのリスト。

    object

    ParameterKey

    string

    特定のパラメーターを上書きするために使用されるパラメーターの名前。

    Amount
    ParameterValue

    string

    パラメーター値。

    1
    StackGroupName

    string

    スタックグループの名前。

    MyStackGroup
    AccountId

    string

    スタックインスタンスが属する宛先アカウントの ID。

    151266687691****
    RegionId

    string

    スタックインスタンスのリージョン ID。

    cn-beijing
    RdFolderId

    string

    リソースディレクトリ内のフォルダーの ID。

    説明

    このパラメーターは、スタックグループにサービス管理権限が付与されている場合にのみ返されます。

    fd-4PvlVLOL8v
    Outputs

    array<object>

    スタックインスタンスの出力のリスト。

    説明

    このパラメーターは、OutputOption が Enabled に設定されている場合に返されます。

    object

    スタックインスタンスの出力。

    説明

    このパラメーターは、OutputOption が Enabled に設定されている場合に返されます。

    [{'OutputKey': 'rds_connection_string', 'OutputValue': 'rm-gw868n4lzy0i7kzx3.mysql.germany.rds.aliyuncs.com'}]

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "B8A6B693-82C8-419D-8796-DE99EC33CFF9",
  "StackInstance": {
    "Status": "CURRENT",
    "StackGroupId": "fd0ddef9-9540-4b42-a464-94f77835****",
    "StackId": "35ad60e3-6a92-42d8-8812-f0700d45****",
    "DriftDetectionTime": "2020-02-27T07:47:47",
    "StackDriftStatus": "IN_SYNC",
    "StatusReason": "User initiated stop",
    "ParameterOverrides": [
      {
        "ParameterKey": "Amount",
        "ParameterValue": "1"
      }
    ],
    "StackGroupName": "MyStackGroup",
    "AccountId": "151266687691****",
    "RegionId": "cn-beijing",
    "RdFolderId": "fd-4PvlVLOL8v",
    "Outputs": [
      {
        "test": "test",
        "test2": 1
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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