GetInstanceSummary - Lindorm - Alibaba Cloud Documentation Center

Retrieves an overview of the 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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 running instances and instances that are about to expire.	10
RunningCount	integer	The number of running instances.	9
RegionalSummary	array<object>	A collection of regional information.
	object	A collection of regional information.
LockingCount	integer	The number of instances that are about to expire in the `{RegionId}` region.	1
Total	integer	The total number of running instances and instances that are about to expire in the `{RegionId}` region.	6
RegionId	string	The region ID.	cn-hangzhou
RunningCount	integer	The number of running instances in the `{RegionId}` region.	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.