すべてのプロダクト
Search
ドキュメントセンター

:GetStack

最終更新日:Dec 15, 2025

Resource Orchestration Service (ROS) のスタックに関する情報をクエリします。

操作説明

この例では、中国 (杭州) リージョンにある ID が c754d2a4-28f1-46df-b557-9586173a**** のスタックに関する情報をクエリします。

今すぐお試しください

この 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:GetStack

get

*stack

acs:ros:{#regionId}:{#accountId}:stack/{#stackId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

StackId

string

必須

スタック ID。

c754d2a4-28f1-46df-b557-9586173a****

RegionId

string

必須

スタックが属するリージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。

cn-hangzhou

ClientToken

string

任意

リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。
トークンの長さは最大 64 文字です。
詳細については、「べき等性の保証」をご参照ください。

123e4567-e89b-12d3-a456-42665544****

OutputOption

string

任意

Outputs を返すかどうかを指定します。有効な値:

  • Enabled (デフォルト)

  • Disabled

説明

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

Disabled

ShowResourceProgress

string

任意

ResourceProgress に関する情報を返すかどうかを指定します。有効な値:

  • Disabled (デフォルト):ResourceProgress に関する情報を返しません。

  • PercentageOnly:ResourceProgress の StackOperationProgress と StackActionProgress を返します。

説明

ROS スタックと Terraform スタックがサポートされています。スタックの作成、再開、更新、削除、インポート、ロールバック操作がサポートされています。

  • EnabledIfCreateStack (非推奨):スタック作成操作中にのみ、ResourceProgress の *Count と InProgressResourceDetails を返します。

説明

作成操作中、スタックは次のいずれかの状態になります:CREATE_IN_PROGRESS、CREATE_COMPLETE、CREATE_FAILED、CREATE_ROLLBACK_IN_PROGRESS、CREATE_ROLLBACK_COMPLETE、CREATE_ROLLBACK_FAILED。

Disabled

LogOption

string

任意

ログを返すためのオプション。有効な値:

  • None:ログを返しません。

  • Stack (デフォルト):スタックのログを返します。

  • Resource:スタック内のリソースのログを返します。

  • All:すべてのログを返します。

Stack

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

レスポンスフィールド

フィールド

説明

object

Status

string

スタックの状態。有効な値:

  • CREATE_IN_PROGRESS:スタックは作成中です。

  • CREATE_FAILED:スタックの作成に失敗しました。

  • CREATE_COMPLETE:スタックは作成されました。

  • UPDATE_IN_PROGRESS:スタックは更新中です。

  • UPDATE_FAILED:スタックの更新に失敗しました。

  • UPDATE_COMPLETE:スタックは更新されました。

  • DELETE_IN_PROGRESS:スタックは削除中です。

  • DELETE_FAILED:スタックの削除に失敗しました。

  • CREATE_ROLLBACK_IN_PROGRESS:スタックの作成に失敗した後、リソースはロールバック中です。

  • CREATE_ROLLBACK_FAILED:スタックの作成に失敗した後、リソースのロールバックに失敗しました。

  • CREATE_ROLLBACK_COMPLETE:スタックの作成に失敗した後、リソースはロールバックされました。

  • ROLLBACK_IN_PROGRESS:スタックのリソースはロールバック中です。

  • ROLLBACK_FAILED:スタックのリソースのロールバックに失敗しました。

  • ROLLBACK_COMPLETE:スタックのリソースはロールバックされました。

  • CHECK_IN_PROGRESS:スタックは検証中です。

  • CHECK_FAILED:スタックの検証に失敗しました。

  • CHECK_COMPLETE:スタックは検証されました。

  • REVIEW_IN_PROGRESS:スタックはレビュー中です。

  • IMPORT_CREATE_IN_PROGRESS:インポートされたリソースを使用してスタックが作成中です。

  • IMPORT_CREATE_FAILED:インポートされたリソースを使用したスタックの作成に失敗しました。

  • IMPORT_CREATE_COMPLETE:インポートされたリソースを使用してスタックが作成されました。

  • IMPORT_CREATE_ROLLBACK_IN_PROGRESS:インポートされたリソースを使用したスタックの作成に失敗した後、リソースはロールバック中です。

  • IMPORT_CREATE_ROLLBACK_FAILED:インポートされたリソースを使用したスタックの作成に失敗した後、リソースのロールバックに失敗しました。

  • IMPORT_CREATE_ROLLBACK_COMPLETE:インポートされたリソースを使用したスタックの作成に失敗した後、リソースはロールバックされました。

  • IMPORT_UPDATE_IN_PROGRESS:インポートされたリソースを使用してスタックが更新中です。

  • IMPORT_UPDATE_FAILED:インポートされたリソースを使用したスタックの更新に失敗しました。

  • IMPORT_UPDATE_COMPLETE:インポートされたリソースを使用してスタックが更新されました。

  • IMPORT_UPDATE_ROLLBACK_IN_PROGRESS:インポートされたリソースを使用したスタックの更新に失敗した後、リソースはロールバック中です。

  • IMPORT_UPDATE_ROLLBACK_FAILED:インポートされたリソースを使用したスタックの更新に失敗した後、リソースのロールバックに失敗しました。

  • IMPORT_UPDATE_ROLLBACK_COMPLETE:インポートされたリソースを使用したスタックの更新に失敗した後、リソースはロールバックされました。

CREATE_COMPLETE

Description

string

スタックの説明。

Create a VPC.

Parameters

array<object>

スタックのパラメーター。

object

ParameterKey

string

パラメーター名。

ALIYUN::Region

ParameterValue

string

パラメーター値。

cn-hangzhou

RequestId

string

リクエスト ID。

B288A0BE-D927-4888-B0F7-B35EF84B6E6F

StatusReason

string

スタックが現在の状態にある理由。

Stack CREATE completed successfully

ParentStackId

string

親スタックの ID。

4a6c9851-3b0f-4f5f-b4ca-a14bf692****

CreateTime

string

スタックが作成された時刻。時刻は、YYYY-MM-DDThh:mm:ss 形式の ISO 8601 標準に準拠しています。時刻は UTC で表示されます。

2020-09-16T08:21:40

DeletionProtection

string

スタックの削除保護が有効になっているかどうかを示します。有効な値:

  • Enabled:スタックの削除保護が有効になっています。

  • Disabled:スタックの削除保護が無効になっています。ROS コンソールを使用するか、DeleteStack 操作を呼び出すことでスタックを削除できます。

説明

ネストされたスタックの削除保護は、そのルートスタックの削除保護と同じです。

Disabled

RootStackId

string

ルートスタックの ID。指定されたスタックがネストされたスタックの場合、このパラメーターが返されます。

4a6c9851-3b0f-4f5f-b4ca-a14bf692****

TemplateDescription

string

テンプレートの説明。

Create a VPC.

StackType

string

スタックタイプ。有効な値:

  • ROS:ROS スタック。スタックは ROS テンプレートを使用して作成されます。

  • Terraform:Terraform スタック。スタックは Terraform テンプレートを使用して作成されます。

ROS

RamRoleName

string

Resource Access Management (RAM) ロールの名前。ROS は RAM ロールを引き受けてスタックを作成し、そのロールの認証情報を使用して Alibaba Cloud サービスの API を呼び出します。
ROS は RAM ロールを引き受けてスタックに対する操作を実行します。スタックに対する操作権限がある場合、RAM ロールを使用する権限がなくても、ROS は RAM ロールを引き受けます。最小権限の原則に基づいて、RAM ロールに権限が付与されていることを確認する必要があります。
このパラメーターが指定されていない場合、ROS はスタックに関連付けられている既存のロールを使用します。利用可能なロールがない場合、ROS はアカウントの認証情報から生成された一時的な認証情報を使用します。
RAM ロール名は最大 64 文字です。


test-role

UpdateTime

string

スタックが更新された時刻。時刻は、YYYY-MM-DDThh:mm:ss 形式の ISO 8601 標準に準拠しています。時刻は UTC で表示されます。

2020-09-17T08:21:40

Outputs

array<object>

スタックの出力。

object

スタックの出力。

説明

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

[{"Description": "VPC ID","OutputKey": "VpcId","OutputValue": "vpc-bp1m6fww66xbntjyc****"}]

DriftDetectionTime

string

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

2020-09-16T09:21:40

RegionId

string

スタックが属するリージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。

cn-hangzhou

StackDriftStatus

string

最後に成功したドリフト検出が実行されたスタックの状態。有効な値:

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

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

  • IN_SYNC:スタックは同期中です。

IN_SYNC

NotificationURLs

array

スタックイベントを受信するためのコールバック URL。

string

スタックイベントを受信するためのコールバック URL。

["http://127.XX.XX.1:8080/x", "http://127.0.XX.XX:8080/y"]

DisableRollback

boolean

スタックの作成に失敗した場合にロールバックが無効になるかどうかを示します。有効な値:

  • true

  • false (デフォルト)

false

StackName

string

スタック名。
名前は最大 255 文字で、数字、文字、ハイフン (-)、アンダースコア (_) を使用できます。名前は数字または文字で始まる必要があります。

MyStack

Tags

array<object>

スタックのタグ。

object

Key

string

スタックのタグキー。

usage

Value

string

スタックのタグ値。

test

TimeoutInMinutes

integer

スタック作成のタイムアウト期間。単位:分。

10

StackId

string

スタック ID。

c754d2a4-28f1-46df-b557-9586173a****

ResourceGroupId

string

リソースグループの ID。

rg-acfmxazb4ph6aiy****

ResourceProgress

object

リソース作成の進捗状況。

TotalResourceCount

integer

リソースの総数。

説明

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

2

SuccessResourceCount

integer

作成されたリソースの数。

説明

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

1

FailedResourceCount

integer

作成に失敗したリソースの数。

説明

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

0

InProgressResourceCount

integer

作成中のリソースの数。

説明

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

1

PendingResourceCount

integer

作成されるリソースの数。

説明

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

0

InProgressResourceDetails

array<object>

作成中のリソースの進捗詳細。

説明

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

object

ResourceName

string

リソース名。

WaitCondition

ResourceType

string

リソースタイプ。

ALIYUN::ROS::WaitCondition

ProgressValue

number

リソースの現在の進捗値。

5

ProgressTargetValue

number

リソースの目標進捗値。

10

StackOperationProgress

number

スタックの全体的な作成進捗率 (パーセンテージ)。有効な値:0~100。

スタック作成操作中、値は 0 から 100 に向かって徐々に増加します。スタックが作成されると、値は 100 に達します。スタックの作成に失敗すると、スタックリソースのロールバックが開始され、値は徐々に減少します。スタックリソースがロールバックされると、値は 0 に減少します。このパラメーターは、スタックの作成中かロールバック中かに関わらず、全体的な作成進捗のみを示します。

説明

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

100

StackActionProgress

number

スタックの作成またはロールバックの進捗率 (パーセンテージ)。有効な値:0~100。

スタック作成操作中、値は 0 から 100 に向かって徐々に増加します。スタックが作成されると、値は 100 に達します。スタックの作成に失敗すると、スタックリソースのロールバックが開始され、値は残りの進捗率 (100 - スタック作成失敗時に生成された進捗値) から徐々に増加します。スタックリソースがロールバックされると、値は 100 に増加します。このパラメーターは、スタック作成操作中の作成進捗を示し、スタックロールバック操作中のロールバック進捗を示します。

説明

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

100

Log

object

スタックのログ。

TerraformLogs

array<object>

Terraform スタックの実行時に生成されるログ。このパラメーターは Terraform スタックに対してのみ返されます。LogOption が空または Stack または All に設定されている場合に返されます。

説明

このパラメーターは、実行中のスタックに対しては返されません。ログは、作成、再開、更新、削除など、スタックに対する最新の操作から生成されます。

object

test

Command

string

実行される Terraform コマンドの名前。有効な値:

  • apply

  • plan

  • destroy

  • version

Terraform コマンドの詳細については、「Basic CLI Features」をご参照ください。

apply

Stream

string

出力ストリーム。有効な値:

  • stdout:標準出力ストリーム

  • stderr:標準エラーストリーム

stdout

Content

string

コマンド実行後に返される出力ストリームの内容。

Apply complete! Resources: 42 added, 0 changed, 0 destroyed.

ResourceLogs

array<object>

スタック内のリソースのログ。このパラメーターは、LogOption が Resource または All に設定されている場合に返されます。

説明

ログは、ALIYUN::ROS::ResourceCleaner タイプなど、特定のリソースタイプに対してのみ返されます。

array<object>

test

ResourceName

string

テンプレートで定義されているリソースの名前。

MyResourceCleaner

Logs

array<object>

リソースに関連付けられているすべてのログ。

object

test

Keys

array

リソースログのキーワード。

string

リソースログのキーワード。

ResourceDetails

Content

string

リソースログの内容。

[]

TemplateId

string

テンプレート ID。このパラメーターは、現在のスタックテンプレートがカスタムテンプレートまたは共有テンプレートの場合にのみ返されます。

テンプレートが共有テンプレートの場合、このパラメーターの値は TemplateARN の値と同じです。

a52f81be-496f-4e1c-a286-8852ab54****

TemplateVersion

string

テンプレートのバージョン。このパラメーターは、現在のスタックテンプレートがカスタムテンプレートまたは共有テンプレートの場合にのみ返されます。

テンプレートが共有テンプレートの場合、このパラメーターは VersionOption が AllVersions に設定されている場合にのみ返されます。

有効な値:v1 から v100。

v1

TemplateScratchId

string

リソースシナリオの ID。このパラメーターは、スタックの現在のテンプレートがリソースシナリオから生成された場合にのみ返されます。

ts-7f7a704cf71c49a6****

TemplateURL

string

テンプレート本文を含むファイルの URL。このパラメーターは、スタックの現在のテンプレートが URL からのものである場合にのみ返されます。URL は、HTTP または HTTPS の Web サーバー上、または Object Storage Service (OSS) バケット内にあるテンプレートを指すことができます。

oss://ros/template/demo

Interface

string

コンソールのユーザーインターフェイス (UI) の説明。

{}

ServiceManaged

boolean

スタックが管理対象スタックであるかどうかを示します。有効な値:

  • true

  • false

false

ServiceName

string

管理対象スタックが属するサービスの名前。

ACVS

OperationInfo

object

スタック操作でエラーが発生した場合に返される補足情報。

説明

このパラメーターは、少なくとも 1 つのサブパラメーターと共に、特定の条件下でのみ返されます。たとえば、別の Alibaba Cloud サービスの API 操作の呼び出しに失敗した場合に補足情報が返されます。

Code

string

エラーコード。

DependencyViolation

Message

string

エラーメッセージ。

There is still instance(s) in the specified security group.

RequestId

string

別の Alibaba Cloud サービスの API 操作を呼び出すために開始されたリクエストの ID。

071D6166-3F6B-5C7B-A1F0-0113FBB643A8

Action

string

別の Alibaba Cloud サービスに属する API 操作の名前。

DeleteSecurityGroup

ResourceType

string

操作エラーが発生したリソースのタイプ。

ALIYUN::ECS::SecurityGroup

LogicalResourceId

string

操作エラーが発生したリソースの論理 ID。

EcsSecurityGroup

OrderIds

array

注文 ID。このパラメーターは、サブスクリプションスタックを作成する際に手動支払いを設定した場合にのみ返されます。

string

注文 ID。

2161413696****

CheckedStackResourceCount

integer

ドリフト検出が実行されたリソースの数。

説明

このパラメーターは、スタックでの最新のドリフト検出が成功した場合にのみ返されます。

1

NotCheckedStackResourceCount

integer

ドリフト検出が実行されなかったリソースの数。

説明

このパラメーターは、スタックでの最新のドリフト検出が成功した場合にのみ返されます。

1

RollbackFailedRootReason

string

スタックの状態がロールバック失敗の場合、このフィールドには、ロールバックを引き起こした前の段階の実行失敗の原因が表示されます。

Resource UPDATE failed: Exception: resources.FailToCreate: FailToCreate: reason

成功レスポンス

JSONJSON

{
  "Status": "CREATE_COMPLETE",
  "Description": "Create a VPC.",
  "Parameters": [
    {
      "ParameterKey": "ALIYUN::Region",
      "ParameterValue": "cn-hangzhou"
    }
  ],
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F",
  "StatusReason": "Stack CREATE completed successfully",
  "ParentStackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf692****",
  "CreateTime": "2020-09-16T08:21:40",
  "DeletionProtection": "Disabled",
  "RootStackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf692****",
  "TemplateDescription": "Create a VPC.",
  "StackType": "ROS",
  "RamRoleName": "test-role",
  "UpdateTime": "2020-09-17T08:21:40",
  "Outputs": [
    [
      {
        "Description": "VPC ID",
        "OutputKey": "VpcId",
        "OutputValue": "vpc-bp1m6fww66xbntjyc****"
      }
    ]
  ],
  "DriftDetectionTime": "2020-09-16T09:21:40",
  "RegionId": "cn-hangzhou",
  "StackDriftStatus": "IN_SYNC",
  "NotificationURLs": [
    "[\"http://127.XX.XX.1:8080/x\", \"http://127.0.XX.XX:8080/y\"]"
  ],
  "DisableRollback": false,
  "StackName": "MyStack",
  "Tags": [
    {
      "Key": "usage",
      "Value": "test"
    }
  ],
  "TimeoutInMinutes": 10,
  "StackId": "c754d2a4-28f1-46df-b557-9586173a****",
  "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
  "ResourceProgress": {
    "TotalResourceCount": 2,
    "SuccessResourceCount": 1,
    "FailedResourceCount": 0,
    "InProgressResourceCount": 1,
    "PendingResourceCount": 0,
    "InProgressResourceDetails": [
      {
        "ResourceName": "WaitCondition",
        "ResourceType": "ALIYUN::ROS::WaitCondition",
        "ProgressValue": 5,
        "ProgressTargetValue": 10
      }
    ],
    "StackOperationProgress": 100,
    "StackActionProgress": 100
  },
  "Log": {
    "TerraformLogs": [
      {
        "Command": "apply",
        "Stream": "stdout",
        "Content": "Apply complete! Resources: 42 added, 0 changed, 0 destroyed."
      }
    ],
    "ResourceLogs": [
      {
        "ResourceName": "MyResourceCleaner",
        "Logs": [
          {
            "Keys": [
              "ResourceDetails"
            ],
            "Content": "[]"
          }
        ]
      }
    ]
  },
  "TemplateId": "a52f81be-496f-4e1c-a286-8852ab54****",
  "TemplateVersion": "v1",
  "TemplateScratchId": "ts-7f7a704cf71c49a6****",
  "TemplateURL": "oss://ros/template/demo",
  "Interface": "{}",
  "ServiceManaged": false,
  "ServiceName": "ACVS",
  "OperationInfo": {
    "Code": "DependencyViolation",
    "Message": "There is still instance(s) in the specified security group.",
    "RequestId": "071D6166-3F6B-5C7B-A1F0-0113FBB643A8",
    "Action": "DeleteSecurityGroup",
    "ResourceType": "ALIYUN::ECS::SecurityGroup",
    "LogicalResourceId": "EcsSecurityGroup"
  },
  "OrderIds": [
    "2161413696****"
  ],
  "CheckedStackResourceCount": 1,
  "NotCheckedStackResourceCount": 1,
  "RollbackFailedRootReason": "Resource UPDATE failed: Exception: resources.FailToCreate: FailToCreate: reason"
}

エラーコード

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

変更履歴

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