All Products
Search
Document Center

Resource Orchestration Service:ListStackGroupOperationResults

Last Updated:Jun 14, 2024

Queries the results of an operation on a stack group.

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.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
ros:ListStackGroupOperationResultsLIST
  • All Resources
    *
    none
none

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 ID of the operation.

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

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

The number of entries to return on each page.

  • Valid values: 1 to 50.
  • Default value: 10.
10
PageNumberlongNo

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 parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of results.

1
RequestIdstring

The ID of the request.

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

The number of entries returned per page.

1
PageNumberinteger

The page number of the returned page.

1
StackGroupOperationResultsobject []

The details of the results of the operation.

Statusstring

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
StatusReasonstring

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
AccountIdstring

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****
RegionIdstring

The region ID of the stack instance.

cn-beijing
RdFolderIdstring

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 codeError messageHTTP status codeDescription
InvalidParameterThe specified parameter {name} is invalid, {reason}.400The error message returned because the specified parameter is invalid. name indicates the parameter name. reason indicates the reason for the error.

Examples

Sample success responses

JSONformat

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

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

Change history

Change timeSummary of changesOperation
No change history