Resource Orchestration Service (ROS) のスタックに関する情報をクエリします。
操作説明
この例では、中国 (杭州) リージョンにある ID が c754d2a4-28f1-46df-b557-9586173a**** のスタックに関する情報をクエリします。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ros:GetStack |
get |
*stack
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| StackId |
string |
必須 |
スタック ID。 |
c754d2a4-28f1-46df-b557-9586173a**** |
| RegionId |
string |
必須 |
スタックが属するリージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。 |
cn-hangzhou |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。 |
123e4567-e89b-12d3-a456-42665544**** |
| OutputOption |
string |
任意 |
Outputs を返すかどうかを指定します。有効な値:
説明
Outputs パラメーターの計算には長い時間がかかります。スタックの Outputs が不要な場合は、GetStack 操作の応答速度を向上させるために、OutputOption を Disabled に設定することを推奨します。 |
Disabled |
| ShowResourceProgress |
string |
任意 |
ResourceProgress に関する情報を返すかどうかを指定します。有効な値:
説明
ROS スタックと Terraform スタックがサポートされています。スタックの作成、再開、更新、削除、インポート、ロールバック操作がサポートされています。
説明
作成操作中、スタックは次のいずれかの状態になります:CREATE_IN_PROGRESS、CREATE_COMPLETE、CREATE_FAILED、CREATE_ROLLBACK_IN_PROGRESS、CREATE_ROLLBACK_COMPLETE、CREATE_ROLLBACK_FAILED。 |
Disabled |
| LogOption |
string |
任意 |
ログを返すためのオプション。有効な値:
|
Stack |
共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| Status |
string |
スタックの状態。有効な値:
|
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 |
スタックの削除保護が有効になっているかどうかを示します。有効な値:
説明
ネストされたスタックの削除保護は、そのルートスタックの削除保護と同じです。 |
Disabled |
| RootStackId |
string |
ルートスタックの ID。指定されたスタックがネストされたスタックの場合、このパラメーターが返されます。 |
4a6c9851-3b0f-4f5f-b4ca-a14bf692**** |
| TemplateDescription |
string |
テンプレートの説明。 |
Create a VPC. |
| StackType |
string |
スタックタイプ。有効な値:
|
ROS |
| RamRoleName |
string |
Resource Access Management (RAM) ロールの名前。ROS は RAM ロールを引き受けてスタックを作成し、そのロールの認証情報を使用して Alibaba Cloud サービスの API を呼び出します。 |
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 |
最後に成功したドリフト検出が実行されたスタックの状態。有効な値:
|
IN_SYNC |
| NotificationURLs |
array |
スタックイベントを受信するためのコールバック URL。 |
|
|
string |
スタックイベントを受信するためのコールバック URL。 |
["http://127.XX.XX.1:8080/x", "http://127.0.XX.XX:8080/y"] |
|
| DisableRollback |
boolean |
スタックの作成に失敗した場合にロールバックが無効になるかどうかを示します。有効な値:
|
false |
| StackName |
string |
スタック名。 |
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 |
リソースの総数。 説明
このパラメーターは、 |
2 |
| SuccessResourceCount |
integer |
作成されたリソースの数。 説明
このパラメーターは、 |
1 |
| FailedResourceCount |
integer |
作成に失敗したリソースの数。 説明
このパラメーターは、 |
0 |
| InProgressResourceCount |
integer |
作成中のリソースの数。 説明
このパラメーターは、 |
1 |
| PendingResourceCount |
integer |
作成されるリソースの数。 説明
このパラメーターは、 |
0 |
| InProgressResourceDetails |
array<object> |
作成中のリソースの進捗詳細。 説明
このパラメーターは、 |
|
|
object |
|||
| ResourceName |
string |
リソース名。 |
WaitCondition |
| ResourceType |
string |
リソースタイプ。 |
ALIYUN::ROS::WaitCondition |
| ProgressValue |
number |
リソースの現在の進捗値。 |
5 |
| ProgressTargetValue |
number |
リソースの目標進捗値。 |
10 |
| StackOperationProgress |
number |
スタックの全体的な作成進捗率 (パーセンテージ)。有効な値:0~100。 スタック作成操作中、値は 0 から 100 に向かって徐々に増加します。スタックが作成されると、値は 100 に達します。スタックの作成に失敗すると、スタックリソースのロールバックが開始され、値は徐々に減少します。スタックリソースがロールバックされると、値は 0 に減少します。このパラメーターは、スタックの作成中かロールバック中かに関わらず、全体的な作成進捗のみを示します。 説明
このパラメーターは、 |
100 |
| StackActionProgress |
number |
スタックの作成またはロールバックの進捗率 (パーセンテージ)。有効な値:0~100。 スタック作成操作中、値は 0 から 100 に向かって徐々に増加します。スタックが作成されると、値は 100 に達します。スタックの作成に失敗すると、スタックリソースのロールバックが開始され、値は残りの進捗率 (100 - スタック作成失敗時に生成された進捗値) から徐々に増加します。スタックリソースがロールバックされると、値は 100 に増加します。このパラメーターは、スタック作成操作中の作成進捗を示し、スタックロールバック操作中のロールバック進捗を示します。 説明
このパラメーターは、 |
100 |
| Log |
object |
スタックのログ。 |
|
| TerraformLogs |
array<object> |
Terraform スタックの実行時に生成されるログ。このパラメーターは Terraform スタックに対してのみ返されます。LogOption が空または Stack または All に設定されている場合に返されます。 説明
このパラメーターは、実行中のスタックに対しては返されません。ログは、作成、再開、更新、削除など、スタックに対する最新の操作から生成されます。 |
|
|
object |
test |
||
| Command |
string |
実行される Terraform コマンドの名前。有効な値:
Terraform コマンドの詳細については、「Basic CLI Features」をご参照ください。 |
apply |
| Stream |
string |
出力ストリーム。有効な値:
|
stdout |
| Content |
string |
コマンド実行後に返される出力ストリームの内容。 |
Apply complete! Resources: 42 added, 0 changed, 0 destroyed. |
| ResourceLogs |
array<object> |
スタック内のリソースのログ。このパラメーターは、LogOption が Resource または All に設定されている場合に返されます。 説明
ログは、 |
|
|
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 |
スタックが管理対象スタックであるかどうかを示します。有効な値:
|
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"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。