ListSummaries - Resource Orchestration Service - Alibaba Cloud Documentation Center

Queries for an overview.

Operation description

Usage notes

This topic provides an example of how to query a list of stacks 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:ListSummaries

get

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

Option

string

Output information options.

Valid values:

StackDetail :
StackDetail
Overview :
Overview

StackDetail

Response elements

Element	Type	Description	Example
	object
RegionSummaries	array<object>	Statistics about the number of Resource Orchestration Service (ROS) resources in each region.
	array<object>	Statistics about the number of ROS resources in each region.
StackGroupCount	string	The number of stack groups.	1
RegionId	string	The region ID.	cn-hangzhou
StackCount	string	The number of stacks.	1
StackDetails	array<object>	Stack details.
	object	Stack details.
Count	string	The number of stacks.	1
BriefStatus	string	The brief status of the stack. Valid values: IN_PROGRESS: In progress (including creation, update, deletion, rollback, import creation, and import update in progress). COMPLETE: Complete (including successful creation, update, deletion, rollback, import creation, and import update). FAILED: Failed (including failed creation, update, deletion, rollback, import creation, and import update).	COMPLETE
TemplateScratchCount	integer	The number of resource scenarios.	1
CenterSummary	object	Statistics about the number of central ROS resources.
TemplateCount	string	The number of templates.	2
RegisteredResourceTypeCount	integer	The number of registered resource types.	3
RequestId	string	The request ID.	B842BB91-A004-59CC-83E3-C961567FCBC8

Examples

Success response

JSON format

{
  "RegionSummaries": [
    {
      "StackGroupCount": "1",
      "RegionId": "cn-hangzhou",
      "StackCount": "1",
      "StackDetails": [
        {
          "Count": "1",
          "BriefStatus": "COMPLETE"
        }
      ],
      "TemplateScratchCount": 1
    }
  ],
  "CenterSummary": {
    "TemplateCount": "2",
    "RegisteredResourceTypeCount": 3
  },
  "RequestId": "B842BB91-A004-59CC-83E3-C961567FCBC8"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.