GetStack API で ROS スタック詳細を取得 - Resource Orchestration Service - Alibaba Cloud - Resource Orchestration Service

スタック情報を照会します。

操作説明

この Topic では、中国 (杭州) リージョンで 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 (デフォルト): Outputs パラメーターを返します。 Disabled: Outputs パラメーターを返しません。説明 Outputs の計算には時間がかかります。Outputs 情報が不要な場合は、OutputOption を Disabled に設定して API の応答速度を向上させてください。	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: スタックの削除に失敗しました。 DELETE_COMPLETE: スタックが削除されました。 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	スタックが作成された時間。時間は UTC+0 で表示され、末尾の Z を含まない ISO 8601 標準に従います。フォーマット: YYYY-MM-DDThh:mm:ss。	2020-09-16T08:21:40
DeletionProtection	string	スタックの削除保護が有効かどうかを示します。有効な値: Enabled: 削除保護が有効です。 Disabled: 削除保護が無効です。この場合、コンソールまたは DeleteStack 操作を呼び出してスタックをリリースできます。説明ネストされたスタックの削除保護メカニズムは、ルートスタックと同じです。	Disabled
RootStackId	string	ルートスタック ID。このパラメーターは、スタックがネストされたスタックの場合にのみ返されます。	4a6c9851-3b0f-4f5f-b4ca-a14bf692****
TemplateDescription	string	テンプレートの説明。	Create a VPC.
StackType	string	スタックタイプ。有効な値: ROS: スタックは ROS テンプレートを使用します。 Terraform: スタックは Terraform テンプレートを使用します。	ROS
RamRoleName	string	RAM ロール名。Resource Orchestration Service (ROS) はこのロールを引き受けてスタックを作成し、ロールの認証情報を使用してユーザーに代わって API オペレーションを呼び出します。 ROS は常にこのロールを使用してスタックに対するすべての操作を実行します。ユーザーがスタックに対する操作を実行する権限を持っている限り、ユーザーがロールを使用する権限を持っていなくても、ROS はこのロールを使用します。これにより、ロールが最小権限を付与することが保証されます。値が指定されていない場合、ROS は以前にスタックに関連付けられたロールを使用します。使用可能なロールがない場合、ROS はユーザーの認証情報から生成された一時的な認証情報を使用します。 RAM ロール名の長さは最大 64 バイトです。	test-role
UpdateTime	string	スタックが最後に更新された時間。時間は UTC+0 で表示され、末尾の Z を含まない ISO 8601 標準に従います。フォーマット: YYYY-MM-DDThh:mm:ss。	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	リソースの総数。説明このパラメーターは、ShowResourceProgress が EnabledIfCreateStack に設定されている場合にのみ返されます。	2
SuccessResourceCount	integer	正常に処理されたリソースの数。説明このパラメーターは、ShowResourceProgress が EnabledIfCreateStack に設定されている場合にのみ返されます。	1
FailedResourceCount	integer	処理に失敗したリソースの数。説明このパラメーターは、ShowResourceProgress が EnabledIfCreateStack に設定されている場合にのみ返されます。	0
InProgressResourceCount	integer	処理中のリソースの数。説明このパラメーターは、ShowResourceProgress が EnabledIfCreateStack に設定されている場合にのみ返されます。	1
PendingResourceCount	integer	処理待ちのリソースの数。説明このパラメーターは、ShowResourceProgress が EnabledIfCreateStack に設定されている場合にのみ返されます。	0
InProgressResourceDetails	array<object>	処理中のリソースの進捗詳細のリスト。説明このパラメーターは、ShowResourceProgress が EnabledIfCreateStack に設定されている場合にのみ返されます。
	object	処理中のリソースの進捗詳細。
ResourceName	string	リソース名。	WaitCondition
ResourceType	string	リソースタイプ。	ALIYUN::ROS::WaitCondition
ProgressValue	number	リソースの現在の進捗値。	5
ProgressTargetValue	number	リソースの目標進捗値。	10
StackOperationProgress	number	スタック操作の進捗パーセント値。有効値: 0～100。例: スタック作成時、値は 0 から始まり増加します。作成が成功すると、値は 100 に達します。作成が失敗してロールバックが開始されると、値は減少します。ロールバックが成功すると、値は 0 に達します。このパラメーターは、スタックのステータスが作成中かロールバック中かに関係なく、作成操作の全体的な進捗を示します。説明このパラメーターは、ShowResourceProgress が PercentageOnly に設定されている場合にのみ返されます。	100
StackActionProgress	number	スタックアクションの進捗パーセント値。有効値: 0～100。例: スタック作成時、値は 0 から始まり増加します。作成が成功すると、値は 100 に達します。作成が失敗してロールバックが開始されると、値は別の値 (100 からリソース作成が失敗した時の進捗値を引いた値) から始まり増加します。ロールバックが成功すると、値は 100 に達します。スタック作成時、このパラメーターは作成アクションの進捗を示します。スタックロールバック時、このパラメーターはロールバックアクションの進捗をタグ付けして示します。説明このパラメーターは、ShowResourceProgress が PercentageOnly に設定されている場合にのみ返されます。	100
Log	object	スタック関連の出力ログ。
TerraformLogs	array<object>	Terraform 出力ログ。このパラメーターは Terraform スタックの場合にのみ返されます。このパラメーターは、LogOption が指定されていない場合、または LogOption が Stack または All に設定されている場合に返されます。説明このパラメーターは実行中のスタックには返されません。このパラメーターは、スタックに対する最新の操作 (作成、継続作成、更新、または削除) のログを示します。
	object	test。
Command	string	実行された Terraform コマンドの名前。有効な値は次のとおりです。 apply plan destroy version これらのコマンドの詳細については、「 Command 」をご参照ください。	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 には、Web サーバー (HTTP または HTTPS) または Alibaba Cloud OSS バケットが含まれます。	oss://ros/template/demo
Interface	string	インターフェイスの説明。	{}
ServiceManaged	boolean	スタックがマネージドスタックかどうかを示します。有効な値: true: スタックはマネージドスタックです。 false: スタックはマネージドスタックではありません。	false
ServiceName	string	マネージドスタックが属するサービス名。	ACVS
OperationInfo	object	スタック操作中にエラーが発生した場合に返される補足情報。説明このプロパティは特定のケースでのみ返され、少なくとも 1 つのサブプロパティを含みます。例えば、別のクラウドサービスの API 呼び出し時にエラーが発生した場合などです。フォーマットには少なくとも 1 つのサブプロパティが含まれます。
Code	string	エラーコード。	DependencyViolation
Message	string	エラーメッセージ。	There is still instance(s) in the specified security group.
RequestId	string	別のクラウドサービスへの API 呼び出しのリクエスト ID。	071D6166-3F6B-5C7B-A1F0-0113FBB643A8
Action	string	別のクラウドサービスで呼び出した 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"
}

エラーコード

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

変更履歴

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