文档首页/ 数据安全中心 DSC/ API参考/ API/ 数据流转/ 查询实例列表 - ListCollectInstances
更新时间：2026-10-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询实例列表 - ListCollectInstances

功能介绍

功能介绍：查询实例列表

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

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

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

URI

POST /v1/{project_id}/logtrace/collect-instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。可参考获取项目ID获取。

约束限制：

不涉及

取值范围：

以IAM服务接口返回值为准，字符长度32-32，满足正则匹配"^[a-z0-9]{32}$"

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

IAM服务查询用户Token接口为准

默认取值：

不涉及

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

instances

Array of InstanceVo objects

参数解释：

实例列表

取值范围：

不涉及
表4 InstanceVo

参数

参数类型

描述

instance_id

String

参数解释：

实例ID

取值范围：

不涉及

instance_name

String

参数解释：

实例名称

取值范围：

不涉及

status

String

参数解释：

操作结果状态

取值范围：

不涉及

instance_type

String

参数解释：

实例类型

取值范围：

不涉及

last_heartbeat_time

Long

参数解释：

最后心跳时间

取值范围：

不涉及

log_trace_switch

Boolean

参数解释：

日志追踪开关

取值范围：

true-是，false-否

project_id

String

参数解释：

项目ID

取值范围：

不涉及

status_enum

String

参数解释：

状态枚举

取值范围：

不涉及

status_msg

String

参数解释：

状态信息

取值范围：

不涉及

请求示例

{ }

响应示例

状态码：200

{
  "instances" : [ {
    "instance_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
    "instance_name" : "dbss-instance-01",
    "status" : "dbss-instance-01"
  }, {
    "instance_id" : "0d2468ac-3a9e-4b2f-8c5d-1f7a2b3c4d5e",
    "instance_name" : "dbss-instance-01",
    "status" : "dbss-instance-01"
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

父主题： 数据流转

相关文档