CheckInstanceSupport - 检查实例是否支持 - Alibaba Cloud Linux

接口说明

当前接口获取的实例列表是已经被 SysOM 纳管的机器列表，如果某个 ECS 实例存在但是没有被 SysOM 纳管，则不会出现在列表当中。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sysom:CheckInstanceSupport

none

*全部资源

*

无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求 Body
instances	array	否	需要检查的实例 ID 列表	["i-2zxxxxxx"]
	string	否	实例 ID	i-2zxxxxxx
region	string	否	实例所属 Region，务必保证 instances 中传递的所有实例 ID 都属于同一个 region	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	Schema of Response
code	string	状态码 `code == Success` 则代表授权成功；其它状态码代表授权失败，授权失败时查看 `message` 字段获取详细的错误信息；	Success
data	array<object>	返回数据。
	object	返回结果。
instance	string	ECS 实例 ID	i-wz9d00ut2ska3mlyhn6j
reason	string	当 success 为 false 时，该值不为空，表示不支持被纳管的原因	instance not found in ecs
support	boolean	是否支持被 SysOM 纳管 true：支持被 SysOM 纳管 false：不支持被 SysOM 纳管	true
message	string	错误信息，code != Success 时，在此处存放错误信息	SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom
requestId	string	Id of the request	2D693121-C925-5154-8DF6-C09A8B369822

示例

正常返回示例

JSON格式

{
  "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"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。