GetInstanceSummary-阿里云帮助中心

Retrieves a summary of Lindorm instances in your account.

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

lindorm:GetInstanceSummary

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai

Response elements

Element	Type	Description	Example
	object
LockingCount	integer	The number of instances that are about to expire.	1
RequestId	string	The request ID.	1556DCB0-043A-4444-8BD9-CF4A68E7EE64
Total	integer	The total number of instances that are running or about to expire.	10
RunningCount	integer	The number of running instances.	9
RegionalSummary	array<object>	An array of region summaries.
	object	A region summary.
LockingCount	integer	The number of instances in `{RegionId}` that are about to expire.	1
Total	integer	The total number of instances in `{RegionId}` that are running or about to expire.	6
RegionId	string	The region ID.	cn-hangzhou
RunningCount	integer	The number of running instances in `{RegionId}`.	5

Examples

Success response

JSON format

{
  "LockingCount": 1,
  "RequestId": "1556DCB0-043A-4444-8BD9-CF4A68E7EE64",
  "Total": 10,
  "RunningCount": 9,
  "RegionalSummary": [
    {
      "LockingCount": 1,
      "Total": 6,
      "RegionId": "cn-hangzhou",
      "RunningCount": 5
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	Lindorm.Errorcode.ParameterInvaild	The parameter is invalid.
403	Lindorm.Errorcode.OperationDenied	You are not authorized to operate on the specified resource.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.