查询资源栈信息。
接口说明
本文将提供一个示例，查询杭州地域ID为c754d2a4-28f1-46df-b557-9586173a****的资源栈信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ros:GetStack | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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信息，建议您将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 |
关于公共请求参数的详情，请参见公共参数。
返回参数
示例
正常返回示例
JSON格式
{
"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
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||
|---|---|---|---|---|
| 2023-08-11 | OpenAPI 返回结构发生变更 | 看变更集 | ||
| ||||
| 2023-07-13 | OpenAPI 返回结构发生变更 | 看变更集 | ||
| ||||
| 2023-07-13 | OpenAPI 返回结构发生变更 | 看变更集 | ||
| ||||
| 2023-05-18 | OpenAPI 返回结构发生变更 | 看变更集 | ||
| ||||
| 2022-02-22 | OpenAPI 返回结构发生变更 | 看变更集 | ||
|
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 404 | StackNotFound | The Stack ({name}) could not be found. | 资源栈不存在。name为资源栈名称或ID。 |