ListWorkerInstances - 查询传输实例列表 - 云数据库 OceanBase

本接口用于查询传输实例列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Specs	array	否	实例规格集合。
	string	否	传输实例的规格。枚举值： oms.g2m.small：oms.g2m.small。 oms.g2m.medium：oms.g2m.medium。 oms.g2m.large：oms.g2m.large。 oms.g2m.xlarge：oms.g2m.xlarge。	oms.g2m.small
InstanceName	string	否	传输实例的名称。	i4katz****
SourceType	string	否	源端的类型，包括 OCEANBASE、KAFKA、ROCKETMQ、POLARDB_X_1、TIDB 和 POLARDB_X_2。	OCEANBASE
DestType	string	否	目标端的类型，包括 OCEANBASE、KAFKA、ROCKETMQ、POLARDB_X_1、POLARDB_X_2 和 TIDB。	KAFKA
OnlyBindable	boolean	否	是否仅查询可以绑定的实例，默认为 true。	true
PageNumber	integer	否	页序号，分页查询时生效。	1
PageSize	integer	否	页大小，分页查询时生效。	10

返回参数

名称	类型	描述	示例值
	object	返回结果。
Success	boolean	是否调用成功。	true
ErrorDetail	object	错误详情。
Code	string	错误码（新）。	200
Level	string	包括 FATAL、ERROR、WARNING 和 CRITICAL。	FATAL
Message	string	错误描述（新）。	successful
ExtraContext	object	用于填充 Message 中的占位符。
	any	用于填充 Message 中的占位符。	null
MessageMcmsKey	string	错误信息的 Key。	null
MessageMcmsContext	object	用于填充 MessageMcmsKey 中的占位符。
	string	用于填充 MessageMcmsKey 中的占位符。	null
Reason	string	错误原因。	null
ReasonMcmsKey	string	错误原因的 Key。	null
ReasonMcmsContext	object	错误原因的上下文。
	string	错误原因的上下文。	null
Proposal	string	建议（新）。	null
ProposalMcmsKey	string	建议内容的 Key。	null
ProposalMcmsContext	object	建议内容的上下文。
	string	建议内容的上下文。	null
UpstreamErrorDetail	any	上游错误详情，用于处理 HTTP 请求。	null
Code	string	错误码（旧）。	200
Message	string	错误描述。	successful
Advice	string	建议。	null
RequestId	string	请求 ID。	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
PageNumber	integer	页序号，分页查询时生效。	1
PageSize	integer	页大小，分页查询时生效。	10
TotalCount	long	总数，分页查询时生效。	237
Cost	string	请求耗时，单位为秒。	71
Data	array<object>	传输实例的信息。
Data	object
Id	string	传输实例的 ID。	g_i4katzv***
Spec	string	传输实例的规格。枚举值： oms.g2m.small：oms.g2m.small。 oms.g2m.medium：oms.g2m.medium。 oms.g2m.large：oms.g2m.large。 oms.g2m.xlarge：oms.g2m.xlarge。	oms.g2m.small
Name	string	传输实例的名称。	i4wa71k****
Status	string	传输实例的状态。	ONLINE
Region	string	地域。	null
ProjectId	string	项目的 ID。	np_4kb18w****
ProjectName	string	项目的名称。	j_migration_cloud-kafkavpc-ob
ProjectType	string	项目的类型。	MIGRATION
GmtCreate	string	创建时间，以 UTC + 0 时区的时间格式展示。	2023-07-14T20:49:53

示例

正常返回示例

JSON格式

{
  "Success": true,
  "ErrorDetail": {
    "Code": "200\n",
    "Level": "FATAL",
    "Message": "successful\n",
    "ExtraContext": {
      "key": "null"
    },
    "MessageMcmsKey": "null",
    "MessageMcmsContext": {
      "key": "null"
    },
    "Reason": "null",
    "ReasonMcmsKey": "null",
    "ReasonMcmsContext": {
      "key": "null"
    },
    "Proposal": "null\n",
    "ProposalMcmsKey": "null",
    "ProposalMcmsContext": {
      "key": "null"
    },
    "UpstreamErrorDetail": "null"
  },
  "Code": "200",
  "Message": "successful",
  "Advice": "null",
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 237,
  "Cost": "71",
  "Data": [
    {
      "Id": "g_i4katzv***",
      "Spec": "oms.g2m.small",
      "Name": "i4wa71k****",
      "Status": "ONLINE",
      "Region": "null",
      "ProjectId": "np_4kb18w****",
      "ProjectName": "j_migration_cloud-kafkavpc-ob",
      "ProjectType": "MIGRATION",
      "GmtCreate": "2023-07-14T20:49:53\n"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-05-07	API 内部配置变更，不影响调用	查看变更详情