ListInstanceStatus - 获取纳管实例状态 - Alibaba Cloud Linux

接口说明

本接口用于获取被 SysOM 纳管的机器列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

sysom:ListInstanceStatus

list

*全部资源

*

无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
current	integer	否	页码分页时存在该字段，表示当前页（从 1 开始）	1
pageSize	integer	否	每页返回数目，默认 pageSize=10	10
instance	string	否	实例 ID。	i-wz9b9vucz1iubsz355rh
status	string	否	根据状态过滤实例列表，如果指定了本字段，将会过出对应状态的实例列表枚举值： Running : Running Offline : Offline	Running
region	string	否	地域 ID。	cn-shenzhen

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID，可用于全链路诊断	5BC79EF5-798B-5499-9683-4E14EBBBF712
code	string	状态码 `code == Success` 则代表授权成功；其它状态码代表授权失败，授权失败时查看 `message` 字段获取详细的错误信息；	Success
data	array<object>	返回数据
	object	返回数据
instance	string	实例 ID。	i-wz9d00ut2ska3mlyhn6j
region	string	地域 ID。	cn-hangzhou
status	string	实例的运行状态，取值： Running：正在运行 Offline：离线说明处于 Offline 状态的实例代表节点到 SysOM 服务端的心跳丢失，并不代表对应的 ECS 实例没有运行。	Running
message	string	错误信息如果 `code == Success`，则本字段为空；否则本字段包含请求错误信息。	SysomOpenAPIAssumeRoleException: EntityNotExist.Role The role not exists: acs:ram::xxxxx:role/aliyunserviceroleforsysom
total	integer	总记录数	218

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

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