文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 主机管理/ 查询每个主机的终端节点的创建状态 - ShowEndpointStatus
更新时间:2025-10-31 GMT+08:00
分享

查询每个主机的终端节点的创建状态 - ShowEndpointStatus

功能介绍

查询每个主机的终端节点的创建状态

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v5/{project_id}/host-management/vpc-endpointes/batch-query

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

host_id_list

Array of strings

参数解释:

主机id列表

取值范围:

字符长度1-64位

vpc_id_list

Array of strings

参数解释:

VpcId列表

取值范围:

字符长度1-64位

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data_list

Array of HostStatusInfo objects

参数解释

服务器状态的列表

约束限制:

不涉及

表5 HostStatusInfo

参数

参数类型

描述

host_id

String

参数解释:

服务器ID

取值范围:

字符长度1-64位

host_name

String

参数解释:

服务器名称

取值范围:

字符长度1-128位

public_ip

Array of strings

参数解释:

弹性公网IP地址

private_ip

Array of strings

参数解释:

私有IP地址

status

String

参数解释:

服务器状态

取值范围:

字符长度1-128位

vpc_id

String

参数解释:

Vpc标识Id

取值范围:

字符长度1-128位

请求示例

查询每个主机的终端节点的创建状态

GET https://{endpoint}/v5/{project_id}/host-management/vpc-endpointes/batch-query

{
  "host_id_list" : [ "xxxxxxxx" ],
  "vpc_id_list" : [ "xxxxxxxx" ]
}

响应示例

状态码:200

请求已成功

{
  "data_list" : [ {
    "host_id" : "12336789"
  }, {
    "host_name" : "name"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档