文档首页/ 数据安全中心 DSC/ API参考/ API/ 数据流转/ 查询实例列表 - ShowCollectInstances
更新时间:2026-11-13 GMT+08:00
分享

查询实例列表 - ShowCollectInstances

功能介绍

功能介绍:查询实例列表。查询前会先刷新各类型(DBSS、ADG)实例列表,然后返回当前 project 下的数据流转实例;GET 与 POST 两种方法等价。

响应:请求成功返回HTTP 200及实例列表。

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

instances

Array of InstanceVo objects

参数解释:

实例列表

取值范围:

不涉及

表4 InstanceVo

参数

参数类型

描述

instance_id

String

参数解释:

实例ID

取值范围:

不涉及

instance_name

String

参数解释:

实例名称

取值范围:

不涉及

status

String

参数解释:

实例状态展示值(国际化文案,由 status_enum 转换得到)

取值范围:

未开通、开通中、关闭中、开通失败、关闭失败、运行中、离线、异常

instance_type

String

参数解释:

实例类型

取值范围:

DBSS、ADG

last_heartbeat_time

Long

参数解释:

最后心跳时间,毫秒级Unix时间戳,表示实例最近一次上报心跳的时间点

取值范围:

不涉及

log_trace_switch

Boolean

参数解释:

日志追踪开关

取值范围:

true-是,false-否

project_id

String

参数解释:

项目ID

取值范围:

不涉及

status_enum

String

参数解释:

实例状态枚举

取值范围:

  • NOT_OPENED-未开通

  • OPENING-开通中

  • CLOSING-关闭中

  • OPEN_FAILED-开通失败

  • CLOSE_FAILED-关闭失败

  • RUNNING-运行中

  • OFFLINE-离线

  • KAFKA_ABNORMAL-异常(Kafka连接异常)

status_msg

String

参数解释:

状态说明,由 status_enum 转换得到;仅 OFFLINE、KAFKA_ABNORMAL 有值,其余状态为 null

取值范围:

  • 超过2个周期未接收到心跳信息。-OFFLINE

  • Kafka连接异常。-KAFKA_ABNORMAL

请求示例

无

响应示例

状态码:200

{
  "instances" : [ {
    "project_id" : "2b31ed5200000ebedb6e570000000000",
    "instance_type" : "DBSS",
    "instance_name" : "dbss-instance-01",
    "instance_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
    "status_enum" : "RUNNING",
    "status" : "运行中",
    "status_msg" : null,
    "last_heartbeat_time" : 1700000000000,
    "log_trace_switch" : true
  }, {
    "project_id" : "2b31ed5200000ebedb6e570000000000",
    "instance_type" : "ADG",
    "instance_name" : "adg-instance-01",
    "instance_id" : "0d2468ac-3a9e-4b2f-8c5d-1f7a2b3c4d5e",
    "status_enum" : "OFFLINE",
    "status" : "离线",
    "status_msg" : "超过2个周期未接收到心跳信息。",
    "last_heartbeat_time" : 1699990000000,
    "log_trace_switch" : true
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档