GetStackInstance - Resource Orchestration Service - Alibaba Cloud Documentation Center

Queries the information about a stack instance that is associated with a stack group.

Operation description

In this example, the information about a stack instance associated with a stack group named MyStackGroup is queried. The stack instance is deployed in the China (Beijing) region within the 151266687691**** Alibaba Cloud account. The stack group is granted self-managed permissions and deployed in the China (Hangzhou) region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ros:GetStackInstance	get	StackInstance acs:ros:{#regionId}:{#accountId}:stackinstance/{#StackGroupName}/{#StackInstanceAccountId}/{#StackInstanceRegionId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the stack group. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
StackGroupName	string	Yes	The name of the stack group. The name must be unique within 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.	MyStackGroup
StackInstanceAccountId	string	Yes	The ID of the destination account to which the stack belongs. If the stack group is granted self-managed permissions, the stack belongs to an Alibaba Cloud account. If the stack group is granted service-managed permissions, the stack belongs to a member in a resource directory. Note For more information about the destination account, see Overview .	151266687691****
StackInstanceRegionId	string	Yes	The region ID of the stack.	cn-beijing
OutputOption	string	No	Specifies whether to return the Outputs parameter. The Outputs parameter specifies the outputs of the stack. Valid values: Enabled: returns the Outputs parameter. Disabled (default): does not return the Outputs parameter. Note The Outputs parameter requires a long period of time to calculate. If you do not require the outputs of the stack, we recommend that you set OutputOption to Disabled to improve the response speed of the API operation.	Disabled

For more information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	B8A6B693-82C8-419D-8796-DE99EC33CFF9
StackInstance	object	The information about the stack.
Status	string	The state of the stack. Valid values: CURRENT: The stack is up-to-date with the stack group. OUTDATED: The stack is not up-to-date with the stack group. Stacks are in the OUTDATED state due to the following possible reasons: When the CreateStackInstances operation is called to create stacks, the stacks fail to be created. When the UpdateStackInstances or UpdateStackGroup operation is called to update stacks, the stacks fail to be updated, or only specific stacks are updated. The creation or update operation is not complete.	CURRENT
StackGroupId	string	The ID of the stack group.	fd0ddef9-9540-4b42-a464-94f77835****
StackId	string	The stack ID. Note This parameter is returned only if the stack is in the CURRENT state.	35ad60e3-6a92-42d8-8812-f0700d45****
DriftDetectionTime	string	The time when the most recent successful drift detection was performed on the stack group. Note This parameter is returned only if drift detection is performed on the stack group.	2020-02-27T07:47:47
StackDriftStatus	string	The state of the stack when the most recent successful drift detection was performed on the stack group. Valid values: DRIFTED: The stack has drifted. NOT_CHECKED: No successful drift detection is performed on the stack. IN_SYNC: The stack is being synchronized. Note This parameter is returned only if drift detection is performed on the stack group.	IN_SYNC
StatusReason	string	The reason why the stack instance is in the OUTDATED state. Note This parameter is returned only if the stack instance is in the OUTDATED state.	User initiated stop
ParameterOverrides	array<object>	The parameters that are used to override specific parameters.
	object
ParameterKey	string	The name of the parameter that is used to override a specific parameter.	Amount
ParameterValue	string	The value of the parameter that is used to override a specific parameter.	1
StackGroupName	string	The name of the stack group.	MyStackGroup
AccountId	string	The ID of the destination account to which the stack belongs.	151266687691****
RegionId	string	The region ID of the stack.	cn-beijing
RdFolderId	string	The ID of the folder in the resource directory. Note This parameter is returned only if the stack group is granted service-managed permissions.	fd-4PvlVLOL8v
Outputs	array<object>	The outputs of the stack. Note This parameter is returned if OutputOption is set to Enabled.
	object	The output of the stack. Note This parameter is returned if OutputOption is set to Enabled.	[{'OutputKey': 'rds_connection_string', 'OutputValue': 'rm-gw868n4lzy0i7kzx3.mysql.germany.rds.aliyuncs.com'}]

Examples

Sample success responses

JSONformat

{
  "RequestId": "B8A6B693-82C8-419D-8796-DE99EC33CFF9",
  "StackInstance": {
    "Status": "CURRENT",
    "StackGroupId": "fd0ddef9-9540-4b42-a464-94f77835****",
    "StackId": "35ad60e3-6a92-42d8-8812-f0700d45****",
    "DriftDetectionTime": "2020-02-27T07:47:47",
    "StackDriftStatus": "IN_SYNC",
    "StatusReason": "User initiated stop",
    "ParameterOverrides": [
      {
        "ParameterKey": "Amount",
        "ParameterValue": "1"
      }
    ],
    "StackGroupName": "MyStackGroup",
    "AccountId": "151266687691****",
    "RegionId": "cn-beijing",
    "RdFolderId": "fd-4PvlVLOL8v",
    "Outputs": [
      {
        "test": "test",
        "test2": 1
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-02-21	The request parameters of the API has changed. The response structure of the API has changed	View Change Details