You can call this operation to query the details of stack instances associated with a stack group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetStackInstance

The operation that you want to perform. Set the value to GetStackInstance.

RegionId String Yes cn-hangzhou

The region ID of the stack. You can call the DescribeRegions operation to query the most recent region list.

StackGroupName String Yes MyStackGroup

The name of the stack group. The name must be unique in a region. The name can be up to 255 characters in length and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter.

StackInstanceAccountId String Yes 123456

The account to which the stack instance belongs.
StackInstanceRegionId String Yes cn-beijing

The region ID of the stack instance.

Response parameters

Parameter Type Example Description
RequestId String 14A07460-EBE7-47CA-9757-12CC4761D47A

The ID of the request.
StackInstance Struct

The details of the stack instance.
AccountId String 123456

The account to which the stack instance belongs.
DriftDetectionTime String 2020-02-27T07:47:47

The time when the last successful drift detection operation was initiated.
ParameterOverrides Array

The list of the override parameters.
ParameterKey String Amount

The name of the override parameter.
ParameterValue String 1

The value of the override parameter.
RegionId String cn-beijing

The region ID of the stack instance.
StackDriftStatus String IN_SYNC

The drift status of the stack in the last successful drift detection. Valid values:

  • DRIFTED: The stack has drifted.
  • NOT_CHECKED: No drift detection has been completed on the stack.
  • IN_SYNC: The stack is being synchronized.
StackGroupId String fd0ddef9-9540-4b42-a464-94f7783501d0

The ID of the stack group.
StackGroupName String MyStackGroup

The name of the stack group.
StackId String 35ad60e3-6a92-42d8-8812-f0700d450971

The ID of the stack corresponding to the stack instance.
Status String CURRENT

The status of the stack instance. Valid values:

  • CURRENT: The stack corresponding to the stack instance is up to date with the stack group.
  • OUTDATED: The stack corresponding to the stack instance is not up to date with the stack group. Possible causes are listed as follows:
    • When the CreateStackInstances operation is called to create stack instances, the corresponding stacks fail to be created.
    • When the UpdateStackInstances or UpdateStackGroup operation is called to update stack instances, the corresponding stacks fails to be updated, or only some of the stack instances are updated.
    • The operation is terminated.
StatusReason String User initiated stop

The reason that the stack has the current status.

Examples

Sample requests

http(s)://[Endpoint]/? Action=GetStackInstance
&RegionId=cn-hangzhou
&StackGroupName=MyStackGroup
&StackInstanceAccountId=123456
&StackInstanceRegionId=cn-beijing
&<Common request parameters>

Sample success responses

XML format 

<RequestId>B8A6B693-82C8-419D-8796-DE99EC33CFF9</RequestId>
<StackInstance>
    <Status>CURRENT</Status>
    <StatusReason/>
    <StackGroupId>fd0ddef9-9540-4b42-a464-94f7783501d0</StackGroupId>
    <AccountId>123456</AccountId>
    <StackGroupName>MyStackGroup</StackGroupName>
    <StackId>35ad60e3-6a92-42d8-8812-f0700d450971</StackId>
    <RegionId>cn-hangzhou</RegionId>
    <DriftDetectionTime>2020-02-27T07:47:47</DriftDetectionTime>
    <StackDriftStatus>IN_SYNC</StackDriftStatus>
</StackInstance>

JSON format 

{
	"RequestId": "B8A6B693-82C8-419D-8796-DE99EC33CFF9",
	"StackInstance": {
		"Status": "CURRENT",
		"StatusReason": "",
		"StackGroupId": "fd0ddef9-9540-4b42-a464-94f7783501d0",
		"ParameterOverrides": [],
		"AccountId": "123456",
		"StackGroupName": "MyStackGroup",
		"StackId": "35ad60e3-6a92-42d8-8812-f0700d450971",
		"RegionId": "cn-hangzhou",
		"DriftDetectionTime": "2020-02-27T07:47:47",
		"StackDriftStatus": "IN_SYNC"
	}
}

Error codes

For a list of error codes, visit the API Error Center.