调用GetStack接口查询资源栈信息。
本文将提供一个示例,为您查询杭州地域ID为4a6c9851-3b0f-4f5f-b4ca-a14bf691****
的资源栈信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetStack |
要执行的操作,取值:GetStack。 |
RegionId | String | 是 | cn-hangzhou |
资源栈所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
StackId | String | 是 | 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** |
资源栈ID。 |
ClientToken | String | 否 | 123e4567-e89b-12d3-a456-42665544**** |
保证请求的幂等性。 该值由客户端生成,并且必须全局唯一。 长度不超过64个字符,可包含英文字母、数字、短划线(-)和下划线(_)。 更多信息,请参见如何保证幂等性。 |
OutputOption | String | 否 | Disabled |
是否返回Outputs参数(资源栈输出列表)。取值:
|
关于公共请求参数的详情,请参见公共参数。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
CreateTime | String | 2019-08-01T04:07:39 |
资源栈创建时间。按照ISO8601标准表示,需使用UTC时间,格式:YYYY-MM-DDThh:mm:ss。 |
Description | String | my stack description |
资源栈的描述信息。 |
DisableRollback | Boolean | false |
当创建资源栈失败时,是否禁用回滚策略。取值:
|
NotificationURLs | List | ["http://127.XX.XX.1:8080/x", "http://127.0.XX.XX:8080/y"] |
接收资源栈事件的URL回调地址。 |
Outputs | List | [{"Description": "Instance ID","OutputKey": "InstanceId","OutputValue": "i-a****"}] |
资源栈输出列表。 说明 当OutputOption取值为Enabled时返回该参数。
|
Parameters | Array of Parameter |
资源栈入参。 |
|
ParameterKey | String | InstanceType |
参数名称。 |
ParameterValue | String | ecs.cm4.6xlarge |
参数值。 |
ParentStackId | String | 4a6c9851-3b0f-4f5f-b4ca-a14bf692**** |
父资源栈ID。 |
RegionId | String | cn-beijing |
要创建的资源栈所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
Status | String | CREATE_COMPLETE |
资源栈状态,取值:
|
StackId | String | 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** |
资源栈ID。 |
StackName | String | MyStack |
资源栈名称。 长度不超过255个字符,必须以数字或英文字母开头,可包含数字、英文字母、短划线(-)和下划线(_)。 |
UpdateTime | String | 2019-08-01T04:07:39 |
资源栈更新时间。按照ISO8601标准表示,需使用UTC时间,格式:YYYY-MM-DDThh:mm:ss。 |
StatusReason | String | Stack successfully created |
资源栈状态原因。 |
TemplateDescription | String | Some description |
资源栈描述。 |
TimeoutInMinutes | Integer | 10 |
创建资源栈的超时时间。单位:分钟。 |
RequestId | String | B288A0BE-D927-4888-B0F7-B35EF84B6E6F |
请求ID。 |
DeletionProtection | String | Enabled |
是否开启资源栈删除保护,取值:
说明 嵌套资源栈删除保护与根资源栈一致。
|
DriftDetectionTime | String | 2020-02-27T07:47:47 |
资源栈最近一次成功的偏差检测的时间。 |
RamRoleName | String | test-role |
RAM角色名称。ROS会扮演该角色创建资源栈,使用角色的凭证代表用户进行接口调用。 ROS始终将此角色用于资源栈上将进行的操作。只要用户有权在资源栈上进行操作,即使用户无权使用角色,ROS也会使用此角色,确保角色授予最少的权限。 如果用户未指定该值,ROS将使用以前与资源栈关联的角色。如果没有可用角色,ROS将使用从您的用户凭证中生成的临时凭证。 RAM角色名称最大长度为64个字节。 |
RootStackId | String | 4a6c9851-3b0f-4f5f-b4ca-a14bf692**** |
最顶层的资源栈的ID。当资源栈为嵌套资源栈时,会返回该属性。 |
StackDriftStatus | String | IN_SYNC |
资源栈最近一次成功的偏差检测中的资源栈的状态,取值:
|
StackType | String | ROS |
资源栈类型,取值:
|
Tags | Array of Tag |
资源栈的标签。 |
|
Key | String | usage |
资源栈的标签键。 |
Value | String | test |
资源栈的标签值。 |
示例
请求示例
http(s)://ros.aliyuncs.com/?Action=GetStack
&RegionId=cn-hangzhou
&StackId=4a6c9851-3b0f-4f5f-b4ca-a14bf691****
&<公共请求参数>
正常返回示例
XML
格式
<GetStackResponse>
<CreationTime>2019-08-01T04:07:39</CreationTime>
<Description>No description</Description>
<DisableRollback>false</DisableRollback>
<NotificationURLs>http://127.0.XX.XX:8080/x</NotificationURLs>
<NotificationURLs>http://127.0.XX.XX:8080/y</NotificationURLs>
<Outputs>
<Description>Instance ID</Description>
<OutputKey>InstanceId</OutputKey>
<OutputValue>i-a****</OutputValue>
</Outputs>
<Parameters>
<ParameterKey>InstanceType</ParameterKey>
<ParameterValue>ecs.cm4.6xlarge</ParameterValue>
</Parameters>
<RegionId>cn-hangzhou</RegionId>
<StackId>4a6c9851-3b0f-4f5f-b4ca-a14bf691****</StackId>
<StackName>MyStack</StackName>
<Status>CREATE_COMPLETE</Status>
<StatusReason>Stack successfully created</StatusReason>
<TemplateDescription>Some description</TemplateDescription>
<TimeoutInMinutes>10</TimeoutInMinutes>
<UpdatedTime>2019-08-01T04:07:39</UpdatedTime>
<ParentStackId>4a6c9851-3b0f-4f5f-b4ca-a14bf692****</ParentStackId>
<DriftDetectionTime>2020-02-27T07:47:47</DriftDetectionTime>
<StackDriftStatus>IN_SYNC</StackDriftStatus>
<RamRoleName>test-role</RamRoleName>
<DeletionProtection>Enabled</DeletionProtection>
<RootStackId>4a6c9851-3b0f-4f5f-b4ca-a14bf692****</RootStackId>
<Tags>
<Value>test</Value>
<Key>usage</Key>
</Tags>
<StackType>ROS</StackType>
<RequestId>B288A0BE-D927-4888-B0F7-B35EF84B6E6F</RequestId>
</GetStackResponse>
JSON
格式
{
"CreationTime": "2019-08-01T04:07:39",
"Description": "No description",
"DisableRollback": false,
"NotificationURLs": [
"http://127.0.XX.XX:8080/x",
"http://127.0.XX.XX:8080/y"
],
"Outputs": [
{
"Description": "Instance ID",
"OutputKey": "InstanceId",
"OutputValue": "i-a****"
}
],
"Parameters": [
{
"ParameterKey": "InstanceType",
"ParameterValue": "ecs.cm4.6xlarge"
}
],
"RegionId": "cn-hangzhou",
"StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****",
"StackName": "MyStack",
"Status": "CREATE_COMPLETE",
"StatusReason": "Stack successfully created",
"TemplateDescription": "Some description",
"TimeoutInMinutes": 10,
"UpdatedTime": "2019-08-01T04:07:39",
"ParentStackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf692****",
"DriftDetectionTime": "2020-02-27T07:47:47",
"StackDriftStatus": "IN_SYNC",
"RamRoleName": "test-role",
"DeletionProtection": "Enabled",
"RootStackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf692****",
"Tags": [
{
"Value": "test",
"Key": "usage"
}
],
"StackType": "ROS",
"RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F"
}
错误码
访问错误中心查看更多错误码。
HttpCode |
错误码 |
错误信息 |
描述 |
---|---|---|---|
404 |
StackNotFound |
The Stack ({name}) could not be found. |
资源栈不存在。name为资源栈名称或ID。 |