All Products
Search
Document Center

Resource Orchestration Service:GetStackGroupOperation

Last Updated:Jul 17, 2024

Queries the information about a stack group operation in an Alibaba Cloud region.

Operation description

In this example, the information about the stack group operation whose ID is 6da106ca-1784-4a6f-a7e1-e723863d**** is queried. The stack group named MyStackGroup 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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
OperationIdstringYes

The operation ID. You can call the ListStackGroupOperations operation to query the operation ID.

6da106ca-1784-4a6f-a7e1-e723863d****

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

14A07460-EBE7-47CA-9757-12CC4761D47A
StackGroupOperationobject

The information about the stack group operation.

Statusstring

The state of the operation.

Valid values:

  • RUNNING
  • SUCCEEDED
  • FAILED
  • STOPPING
  • STOPPED
SUCCEEDED
StackGroupIdstring

The ID of the stack group.

fd0ddef9-9540-4b42-a464-94f77835****
Actionstring

The operation type.

Valid values:

  • CREATE
  • UPDATE
  • DELETE
  • DETECT_DRIFT
DELETE
CreateTimestring

The time when the operation was initiated.

2020-01-20T09:22:3
RetainStacksboolean

Indicates whether stacks are retained when the associated stack instances are deleted. When you delete a stack instance, you can choose to delete or retain the stack with which the stack instance is associated.

Valid values:

  • true: Stacks are retained when the associated stack instances are deleted.
  • false: Stacks are deleted when the associated stack instances are deleted. Proceed with caution.
Note This parameter is returned only if you delete stack instances.
true
StackGroupNamestring

The name of the stack group.

MyStackGroup
OperationIdstring

The operation ID.

6da106ca-1784-4a6f-a7e1-e723863d****
OperationDescriptionstring

The description of the operation.

Note This parameter is returned only if OperationDescription is specified when the CreateStackInstances operation is called to create stack instances.
Create stack instance in hangzhou
StackGroupDriftDetectionDetailobject

The information about drift detection.

Note This parameter is returned only if drift detection is performed.
DriftDetectionTimestring

The time when drift detection was performed.

2020-02-27T07:47:47
TotalStackInstancesCountinteger

The number of stack instances.

2
FailedStackInstancesCountinteger

The number of stack instances that failed drift detection.

0
DriftDetectionStatusstring

The drift detection state.

Valid values:

  • COMPLETED: Drift detection is performed on the stack group and all stack instances passed the drift detection.
  • FAILED: Drift detection is performed on the stack group. The number of stack instances that failed the drift detection exceeds the specified threshold.
  • PARTIAL_SUCCESS: Drift detection is performed on the stack group. The number of stack instances that failed the drift detection does not exceed the specified threshold.
  • IN_PROGRESS: Drift detection is being performed on the stack group.
  • STOPPED: Drift detection is canceled for the stack group.
COMPLETED
StackGroupDriftStatusstring

The drift state of the stack group.

Valid values:

  • DRIFTED: At least one stack instance in the stack group has drifted.
  • NOT_CHECKED: No successful drift detection is performed in the stack group.
  • IN_SYNC: All the stack instances in the stack group are being synchronized.
DRIFTED
InProgressStackInstancesCountinteger

The number of stack instances on which drift detection was being performed.

0
InSyncStackInstancesCountinteger

The number of stack instances that were being synchronized.

1
CancelledStackInstancesCountinteger

The number of stack instances for which drift detection was canceled.

0
DriftedStackInstancesCountinteger

The number of stack instances that have drifted.

1
OperationPreferencesobject

The operation settings.

MaxConcurrentCountinteger

The maximum number of accounts within which stacks are deployed at the same time in each region.

Valid values: 1 to 20.

Note Only one of MaxConcurrentCount and MaxConcurrentPercentage can be returned.
1
FailureToleranceCountinteger

The number of accounts within which stack operation failures are allowed to occur in each region. If the value of this parameter is exceeded in a region, Resource Orchestration Service (ROS) stops the operation in the region. If the operation is stopped in one region, the operation is no longer performed in other regions.

Valid values: 0 to 20.

Note Only one of FailureToleranceCount and FailureTolerancePercentage can be returned.
1
MaxConcurrentPercentageinteger

The percentage of the maximum number of accounts within which stacks are deployed at the same time to the total number of accounts in each region.

Valid values: 1 to 100.

Note Only one of MaxConcurrentCount and MaxConcurrentPercentage can be returned.
10
RegionIdsOrderarray

The regions in the order of operation execution.

string

The region in the order of operation execution.

["cn-hangzhou","cn-beijing"]
FailureTolerancePercentageinteger

The percentage of the number of accounts within which stack operation failures are allowed to occur to the total number of accounts in each region. If the value of this parameter is exceeded in a region, ROS stops the operation in the region.

Valid values: 0 to 100.

Note Only one of FailureToleranceCount and FailureTolerancePercentage can be returned.
10
EndTimestring

The time when the operation ended.

2020-01-20T09:22:4
ExecutionRoleNamestring

The name of the RAM role that you specify for the execution account when you create the self-managed stack group. The administrator role AliyunROSStackGroupAdministrationRole assumes the execution role to perform operations. If this parameter is not specified, the default value AliyunROSStackGroupExecutionRole is returned.

AliyunROSStackGroupExecutionRole
AdministrationRoleNamestring

The name of the RAM role that you specify for the administrator account when you create the self-managed stack group. ROS assumes the administrator role to perform operations. If this parameter is not specified, the default value AliyunROSStackGroupAdministrationRole is returned.

AliyunROSStackGroupAdministrationRole
DeploymentTargetsobject

The destinations to deploy stack instances when the stack is granted service-managed permissions.

RdFolderIdsarray

The IDs of the folders in the resource directory.

string

The ID of the folder in the resource directory.

["fd-4PvlVLOL8v"]
AccountIdsarray

The IDs of the members in the resource directory.

Note This parameter is returned only if AccountIds is specified when the UpdateStackInstances operation is called to update stack instances.
string

The ID of the member in the resource directory.

Note This parameter is returned only if AccountIds is specified when the UpdateStackInstances opeation is called to update stack instances.
["151266687691****","141261387191****"]

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change timeSummary of changesOperation
No change history