Call ListStackGroupOperationResults to query a stack group operation - Resource Orchestration Service - Alibaba Cloud - Resource Orchestration Service

Operation description

In this example, the operation ID 6da106ca-1784-4a6f-a7e1-e723863d∗∗∗∗ is set to query the results of an operation on a stack group named MyStackGroup. The stack group is granted self-managed permissions and created 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:ListStackGroupOperationResults

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 ID of the operation. You can call the ListStackGroupOperations operation to query the operation ID.	6da106ca-1784-4a6f-a7e1-e723863d****
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.	10
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1

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

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of results.	1
RequestId	string	The ID of the request.	14A07460-EBE7-47CA-9757-12CC4761D47A
PageSize	integer	The number of entries returned per page.	1
PageNumber	integer	The page number of the returned page.	1
StackGroupOperationResults	array<object>	The details of the results of the operation.
	object
Status	string	The status of the operation. Valid values: RUNNING: The operation is being performed. SUCCEEDED: The operation succeeded. FAILED: The operation failed. STOPPING: The operation is being stopped. STOPPED: The operation is stopped.	SUCCEEDED
StatusReason	string	The reason why the operation is in a specific state. Note This parameter is returned only when stack instances are in the OUTDATED state.	User initiated operation
AccountId	string	The ID of the account to which the stack instance belongs. If the stack group has self-managed permissions, the stack instance belongs to an Alibaba Cloud account. If the stack group has service-managed permissions, the stack instance belongs to a member account in the resource directory. Note For more information about the account, see Overview.	175458090349****
RegionId	string	The region ID of the stack instance.	cn-beijing
RdFolderId	string	The folder ID of the resource directory. Note This parameter is returned only when the stack group is granted service-managed permissions.	"fd-4PvlVLOL8v"

Error code	Error message	HTTP status code	Description
InvalidParameter	The specified parameter {name} is invalid, {reason}.	400	The error message returned because the specified parameter is invalid. name indicates the parameter name. reason indicates the reason for the error.

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "PageSize": 1,
  "PageNumber": 1,
  "StackGroupOperationResults": [
    {
      "Status": "SUCCEEDED",
      "StatusReason": "User initiated operation",
      "AccountId": "175458090349****",
      "RegionId": "cn-beijing",
      "RdFolderId": "\"fd-4PvlVLOL8v\""
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.