CheckInstanceSupport - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Operation description

The instance list returned by this operation contains only instances that are already managed by SysOM. If an ECS instance exists but is not managed by SysOM, it does not appear in the list.

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:CheckInstanceSupport

none

*All Resource

*

None

Request syntax

POST /api/v1/am/supportInstanceList/checkInstanceSupport HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
instances	array	No	The list of instance IDs to check.	["i-2zxxxxxx"]
	string	No	The instance ID.	i-2zxxxxxx
region	string	No	The region to which the instances belong. Make sure that all instance IDs specified in instances belong to the same region.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Schema of Response
code	string	The status code. If `code == Success`, the authorization is successful. Other status codes indicate authorization failed. Check the `message` field for the detailed fault information.	Success
data	array<object>	The response data.
	object	The response result.
instance	string	The ECS instance ID.	i-wz9d00ut2ska3mlyhn6j
reason	string	The reason why the instance is not supported for management. This value is not empty when support is false.	instance not found in ecs
support	boolean	Indicates whether the instance is supported for management by SysOM. true: The instance is supported for management by SysOM. false: The instance is not supported for management by SysOM.	true
message	string	The error message. This field contains detailed error information when code is not Success.	SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom
requestId	string	Id of the request	2D693121-C925-5154-8DF6-C09A8B369822

Examples

Success response

JSON format

{
  "code": "Success",
  "data": [
    {
      "instance": "i-wz9d00ut2ska3mlyhn6j",
      "reason": "instance not found in ecs",
      "support": true
    }
  ],
  "message": "SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom",
  "requestId": "2D693121-C925-5154-8DF6-C09A8B369822\n"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.