ListInstanceStatus - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Operation description

Retrieves the list of machines managed by SysOM.

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

sysom:ListInstanceStatus

list

*All Resource

*

None

Request syntax

GET /api/v1/am/instance/list_instance_status HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
current	integer	No	The current page number (starting from 1). This field is present when pagination is used.	1
pageSize	integer	No	The number of entries per page. Default value: 10.	10
instance	string	No	The instance ID.	i-wz9b9vucz1iubsz355rh
status	string	No	The instance status used to filter the instance list. If this parameter is specified, only instances in the specified status are returned. Valid values: Running : Running Offline : Offline	Running
region	string	No	The region ID.	cn-shenzhen

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID, which can be used for end-to-end diagnostics.	5BC79EF5-798B-5499-9683-4E14EBBBF712
code	string	The status code. `code == Success` indicates that the authorization was successful. Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.	Success
data	array<object>	The returned data.
	object	The returned data.
instance	string	The instance ID.	i-wz9d00ut2ska3mlyhn6j
region	string	The region ID.	cn-hangzhou
status	string	The running status of the instance. Valid values: Running: The instance is running. Offline: The instance is offline. Note An instance in the Offline status indicates that the heartbeat between the node and the SysOM server is lost. It does not mean that the corresponding ECS instance is not running.	Running
message	string	The error message. If `code == Success`, this field is empty. Otherwise, this field contains the request error information.	SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom
total	integer	The total number of records.	218

Examples

Success response

JSON format

{
  "RequestId": "5BC79EF5-798B-5499-9683-4E14EBBBF712",
  "code": "Success",
  "data": [
    {
      "instance": "i-wz9d00ut2ska3mlyhn6j",
      "region": "cn-hangzhou",
      "status": "Running"
    }
  ],
  "message": "SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom",
  "total": 218
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.