GetChangeSet を使用して変更セットの詳細を取得する方法 - ROS - Alibaba Cloud -

指定された変更セットの詳細を、オプションで関連するテンプレートの詳細も含めて返します。

操作説明

このトピックでは、China (Hangzhou) リージョンで ID が 4c11658d-bd47-4dd0-ba64-727edc62**** の変更セットをクエリする例を示します。

今すぐお試しください

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

get

スタック

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ShowTemplate	ブール値	任意	テンプレートを返すかどうかを指定します。有効な値： true：テンプレートが返されます。 false (デフォルト) ：テンプレートは返されません。	false
RegionId	文字列	必須	変更セットが属するリージョン ID です。DescribeRegions API を呼び出して、Alibaba Cloud リージョンの最新リストを取得できます。	cn-hangzhou
ChangeSetId	文字列	必須	変更セット ID です。	4c11658d-bd47-4dd0-ba64-727edc62****

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

レスポンスフィールド

フィールド	型	説明	例
	オブジェクト	返されるデータ。
Status	文字列	変更セットのステータス。	CREATE_COMPLETE
Changes	array<object>	変更セット内の変更。	例をご参照ください。
	オブジェクト	変更セット内の 1 つの変更。詳細については、「変更セットのデータ構造」をご参照ください。	例をご参照ください。
Description	文字列	変更セットの説明。	これはデモです。
Parameters	array<object>	スタックのパラメーター。
	オブジェクト	スタックの 1 つのパラメーター。
ParameterKey	文字列	パラメーターの名前。	ALIYUN::Region
ParameterValue	文字列	パラメーターの値。	cn-hangzhou
RequestId	文字列	リクエスト ID。	3766EE04-76DD-50F9-9C23-3AF136CD5708
StatusReason	文字列	変更セットのステータスが異常な場合の理由。	too many changes.
CreateTime	文字列	変更セットが作成された時刻。時刻は UTC で、`YYYY-MM-DDThh:mm:ss` 形式です。	2021-12-01T02:20:56
TemplateBody	文字列	変更セットのテンプレート本文。説明このパラメーターは、`ShowTemplate` が `true` に設定されている場合にのみ返されます。	{"ROSTemplateFormatVersion": "2015-09-01"}
ChangeSetName	文字列	変更セットの名前。	ChangeSet_template
ChangeSetId	文字列	変更セットの ID。	4c11658d-bd47-4dd0-ba64-727edc62****
ExecutionStatus	文字列	変更セットの実行ステータス。	AVAILABLE
ChangeSetType	文字列	変更セットのタイプ。	UPDATE
RegionId	文字列	リージョン ID。	cn-hangzhou
DisableRollback	ブール値	スタックの作成または更新が失敗した場合にロールバックを無効にするかどうかを示します。	false
StackName	文字列	変更セットが属するスタックの名前。	stack_2021-10-13
TimeoutInMinutes	整数	スタックを作成または更新する際のタイムアウト期間。	60
StackId	文字列	変更セットが属するスタックの ID。	a486fc19-ebb7-4ce9-a70b-554a7c3d****
Log	オブジェクト	変更セットのログ。
TerraformLogs	array<object>	Terraform 出力ログ。このパラメーターは、Terraform ベースのスタックの変更セットの場合にのみ返されます。説明変更セットの作成中は、このパラメーターは使用できません。ログは作成が完了した後にのみ生成されるためです。
	オブジェクト	Terraform ログエントリ。
Command	文字列	実行された Terraform コマンドの名前。有効な値： apply plan destroy version コマンドの詳細については、「コマンド」をご参照ください。	apply
Stream	文字列	出力ストリーム。有効な値： `stdout`：標準出力 `stderr`：標準エラー出力	stdout
Content	文字列	コマンドが指定されたストリームに書き込んだ内容。	Apply complete! Resources: 42 added, 0 changed, 0 destroyed.
Tags	array<object>	変更セットのタグ。
	オブジェクト	変更セットに適用される 1 つのタグ。
Key	文字列	タグのキー。	usage
Value	文字列	タグの値。	test
ResourceGroupId	文字列	リソースグループの ID。リソースグループの詳細については、「リソースグループとは」をご参照ください。	rg-acfmxazb4ph6aiy****

例

成功レスポンス

JSONJSON

{
  "Status": "CREATE_COMPLETE",
  "Changes": [
    {
      "test": "test",
      "test2": 1
    }
  ],
  "Description": "これはデモです。",
  "Parameters": [
    {
      "ParameterKey": "ALIYUN::Region",
      "ParameterValue": "cn-hangzhou"
    }
  ],
  "RequestId": "3766EE04-76DD-50F9-9C23-3AF136CD5708",
  "StatusReason": "変更が多すぎます。",
  "CreateTime": "2021-12-01T02:20:56",
  "TemplateBody": "{\"ROSTemplateFormatVersion\": \"2015-09-01\"}",
  "ChangeSetName": "ChangeSet_template",
  "ChangeSetId": "4c11658d-bd47-4dd0-ba64-727edc62****",
  "ExecutionStatus": "AVAILABLE",
  "ChangeSetType": "UPDATE",
  "RegionId": "cn-hangzhou",
  "DisableRollback": false,
  "StackName": "stack_2021-10-13",
  "TimeoutInMinutes": 60,
  "StackId": "a486fc19-ebb7-4ce9-a70b-554a7c3d****",
  "Log": {
    "TerraformLogs": [
      {
        "Command": "apply",
        "Stream": "stdout",
        "Content": "適用完了！リソース：42 個追加、0 個変更、0 個破棄。"
      }
    ]
  },
  "Tags": [
    {
      "Key": "usage",
      "Value": "test"
    }
  ],
  "ResourceGroupId": "rg-acfmxazb4ph6aiy****"
}

エラーコード

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

変更履歴

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