Query stack group operation information using GetStackGroupOperation - Resource Orchestration Service - Alibaba Cloud - Resource Orchestration Service

Queries the details of a specified stack group operation in an Alibaba Cloud region.

Operation description

This topic provides an example to query the details of an operation whose ID is 6da106ca-1784-4a6f-a7e1-e723863d**** for an existing stack group named MyStackGroup that uses the self-managed permissions mode in the China (Hangzhou) region.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ros:GetStackGroupOperation

get

*StackGroupOperation

acs:ros:{#regionId}:{#accountId}:stackgroupoperation/{#OperationId}

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
OperationId	string	Yes	The operation ID. You can call the ListStackGroupOperations operation to obtain the operation ID.	6da106ca-1784-4a6f-a7e1-e723863d****

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

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	14A07460-EBE7-47CA-9757-12CC4761D47A
StackGroupOperation	object	The details of the stack group operation.
Status	string	The operation status. Valid values: RUNNING: The operation is in progress. SUCCEEDED: The operation succeeded. FAILED: The operation failed. STOPPING: The operation is being stopped. STOPPED: The operation is stopped.	SUCCEEDED
StackGroupId	string	The stack group ID.	fd0ddef9-9540-4b42-a464-94f77835****
Action	string	The operation action. Valid values: CREATE: create UPDATE: update DELETE: delete DETECT_DRIFT: drift detection	DELETE
CreateTime	string	The start time of the operation.	2020-01-20T09:22:3
RetainStacks	boolean	Indicates whether to retain stacks. When you delete a stack instance, you can choose to delete or retain the stack to which the instance points. Valid values: true: Only the stack instance is deleted, and the corresponding stack is retained. false: Both the stack instance and the corresponding stack are deleted. Proceed with caution. Note This parameter is returned only when you delete a stack instance.	true
StackGroupName	string	The stack group name.	MyStackGroup
OperationId	string	The stack group operation ID.	6da106ca-1784-4a6f-a7e1-e723863d****
OperationDescription	string	The operation description. Note This parameter is returned only when you call the CreateStackInstances operation to create stack instances and specify the OperationDescription request parameter.	Create stack instance in hangzhou
StackGroupDriftDetectionDetail	object	The drift detection details. Note This parameter is returned only when you perform a drift detection operation.
DriftDetectionTime	string	The time when drift detection was performed. The time follows the YYYY-MM-DDThh:mm:ss format.	2020-02-27T07:47:47
TotalStackInstancesCount	integer	The total number of stack instances.	2
FailedStackInstancesCount	integer	The number of stack instances for which drift detection failed.	0
DriftDetectionStatus	string	The drift detection status. Valid values: COMPLETED: Drift detection on the stack group is complete, and drift detection on all stack instances succeeded. FAILED: Drift detection on the stack group is complete, and the number of stack instances for which drift detection failed exceeds the specified threshold. PARTIAL_SUCCESS: Drift detection on the stack group is complete, and drift detection on some stack instances failed, but the number of failed instances does not exceed the threshold. IN_PROGRESS: Drift detection on the stack group is in progress. STOPPED: Drift detection on the stack group is canceled by the user.	COMPLETED
StackGroupDriftStatus	string	The drift status of the stack group. Valid values: DRIFTED: At least one stack instance has drifted. NOT_CHECKED: No successful drift detection has been performed on the stack group. IN_SYNC: All stack instances are in sync.	DRIFTED
InProgressStackInstancesCount	integer	The number of stack instances for which drift detection is in progress.	0
InSyncStackInstancesCount	integer	The number of stack instances that are in sync.	1
CancelledStackInstancesCount	integer	The number of stack instances for which drift detection is canceled.	0
DriftedStackInstancesCount	integer	The number of stack instances that have drifted.	1
OperationPreferences	object	The operation preferences.
MaxConcurrentCount	integer	The maximum concurrent accounts. This is the number of accounts in which stack deployment can be performed concurrently in each region. Valid values: 1 to 20. Note Only one of the MaxConcurrentCount and MaxConcurrentPercentage parameters is returned.	1
FailureToleranceCount	integer	The failure tolerance count. This is the number of accounts in which stack deployments can fail in each region before the operation stops in the region. If the operation stops in a region, it does not continue in other regions. Valid values: 0 to 20. Note Only one of the FailureToleranceCount and FailureTolerancePercentage parameters is returned.	1
MaxConcurrentPercentage	integer	The maximum percentage of concurrent accounts. This is the percentage of accounts in which stacks can be deployed concurrently in each region out of the total number of accounts. Valid values: 1 to 100. Note Only one of the MaxConcurrentCount and MaxConcurrentPercentage parameters is returned.	10
RegionIdsOrder	array	The list of regions in the order of execution for the operation.
	string	The list of regions in the order of execution for the operation.	["cn-hangzhou","cn-beijing"]
FailureTolerancePercentage	integer	The failure tolerance percentage. This is the percentage of accounts in which stack deployments can fail in each region out of the total number of accounts before the operation stops in the region. Valid values: 0 to 100. Note Only one of the FailureToleranceCount and FailureTolerancePercentage parameters is returned.	10
EndTime	string	The end time of the operation.	2020-01-20T09:22:4
ExecutionRoleName	string	The name of the RAM execution role assumed by the administrator role (AliyunROSStackGroupAdministrationRole) when you create a stack group with self-managed permissions. If you do not specify this parameter, the default value AliyunROSStackGroupExecutionRole is returned.	AliyunROSStackGroupExecutionRole
AdministrationRoleName	string	The name of the RAM administrator role assumed by Resource Orchestration Service (ROS) when you create a stack group with self-managed permissions. If you do not specify this parameter, the default value AliyunROSStackGroupAdministrationRole is returned.	AliyunROSStackGroupAdministrationRole
DeploymentTargets	object	The deployment targets of stack instances when the service-managed permissions mode is used.
RdFolderIds	array	The IDs of the folders in the resource directory.
	string	The IDs of the folders in the resource directory.	["fd-4PvlVLOL8v"]
AccountIds	array	The IDs of the member accounts in the resource directory. Note This parameter is returned only when you call the UpdateStackInstances operation to update stack instances and specify the AccountIds request parameter.
	string	The IDs of the member accounts in the resource directory. Note This parameter is returned only when you call the UpdateStackInstances operation to update stack instances and specify the AccountIds request parameter.	["151266687691**","141261387191**"]

Examples

Success response

JSON format

{
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "StackGroupOperation": {
    "Status": "SUCCEEDED",
    "StackGroupId": "fd0ddef9-9540-4b42-a464-94f77835****",
    "Action": "DELETE",
    "CreateTime": "2020-01-20T09:22:3",
    "RetainStacks": true,
    "StackGroupName": "MyStackGroup",
    "OperationId": "6da106ca-1784-4a6f-a7e1-e723863d****",
    "OperationDescription": "Create stack instance in hangzhou",
    "StackGroupDriftDetectionDetail": {
      "DriftDetectionTime": "2020-02-27T07:47:47",
      "TotalStackInstancesCount": 2,
      "FailedStackInstancesCount": 0,
      "DriftDetectionStatus": "COMPLETED",
      "StackGroupDriftStatus": "DRIFTED",
      "InProgressStackInstancesCount": 0,
      "InSyncStackInstancesCount": 1,
      "CancelledStackInstancesCount": 0,
      "DriftedStackInstancesCount": 1
    },
    "OperationPreferences": {
      "MaxConcurrentCount": 1,
      "FailureToleranceCount": 1,
      "MaxConcurrentPercentage": 10,
      "RegionIdsOrder": [
        "[\"cn-hangzhou\",\"cn-beijing\"]"
      ],
      "FailureTolerancePercentage": 10
    },
    "EndTime": "2020-01-20T09:22:4",
    "ExecutionRoleName": "AliyunROSStackGroupExecutionRole",
    "AdministrationRoleName": "AliyunROSStackGroupAdministrationRole",
    "DeploymentTargets": {
      "RdFolderIds": [
        "[\"fd-4PvlVLOL8v\"]"
      ],
      "AccountIds": [
        "[\"151266687691****\",\"141261387191****\"]"
      ]
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.