文档

ListWorkerInstances - 查询传输实例列表

更新时间:

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

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
Specsarray

实例规格集合。

string

传输实例的规格。

枚举值:
  • oms.g2m.smalloms.g2m.small
  • oms.g2m.mediumoms.g2m.medium
  • oms.g2m.largeoms.g2m.large
  • oms.g2m.xlargeoms.g2m.xlarge
oms.g2m.small
InstanceNamestring

传输实例的名称。

i4katz****
SourceTypestring

源端的类型,包括 OCEANBASE、KAFKA、ROCKETMQ、POLARDB_X_1、TIDB 和 POLARDB_X_2。

OCEANBASE
DestTypestring

目标端的类型,包括 OCEANBASE、KAFKA、ROCKETMQ、POLARDB_X_1、POLARDB_X_2 和 TIDB。

KAFKA
OnlyBindableboolean

是否仅查询可以绑定的实例,默认为 true。

true
PageNumberinteger

页序号,分页查询时生效。

1
PageSizeinteger

页大小,分页查询时生效。

10

返回参数

名称类型描述示例值
object

返回结果。

Successboolean

是否调用成功。

true
ErrorDetailobject

错误详情。

Codestring

错误码(新)。

200
Levelstring

包括 FATAL、ERROR、WARNING 和 CRITICAL。

FATAL
Messagestring

错误描述(新)。

successful
ExtraContextobject

用于填充 Message 中的占位符。

any

用于填充 Message 中的占位符。

null
MessageMcmsKeystring

错误信息的 Key。

null
MessageMcmsContextobject

用于填充 MessageMcmsKey 中的占位符。

string

用于填充 MessageMcmsKey 中的占位符。

null
Reasonstring

错误原因。

null
ReasonMcmsKeystring

错误原因的 Key。

null
ReasonMcmsContextobject

错误原因的上下文。

string

错误原因的上下文。

null
Proposalstring

建议(新)。

null
ProposalMcmsKeystring

建议内容的 Key。

null
ProposalMcmsContextobject

建议内容的上下文。

string

建议内容的上下文。

null
UpstreamErrorDetailany

上游错误详情,用于处理 HTTP 请求。

null
Codestring

错误码(旧)。

200
Messagestring

错误描述。

successful
Advicestring

建议。

null
RequestIdstring

请求 ID。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
PageNumberinteger

页序号,分页查询时生效。

1
PageSizeinteger

页大小,分页查询时生效。

10
TotalCountlong

总数,分页查询时生效。

237
Coststring

请求耗时,单位为秒。

71
Dataobject []

传输实例的信息。

Idstring

传输实例的 ID。

g_i4katzv***
Specstring

传输实例的规格。

枚举值:
  • oms.g2m.smalloms.g2m.small
  • oms.g2m.mediumoms.g2m.medium
  • oms.g2m.largeoms.g2m.large
  • oms.g2m.xlargeoms.g2m.xlarge
oms.g2m.small
Namestring

传输实例的名称。

i4wa71k****
Statusstring

传输实例的状态。

ONLINE
Regionstring

地域。

null
ProjectIdstring

项目的 ID。

np_4kb18w****
ProjectNamestring

项目的名称。

j_migration_cloud-kafkavpc-ob
ProjectTypestring

项目的类型。

MIGRATION
GmtCreatestring

创建时间,以 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-07API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (0)