文档首页/数据复制服务 DRS/API参考/API v3（不再推广）/公共接口管理/查询可用的Node规格 - ListAvailableNodeTypes
更新时间：2025-12-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询可用的Node规格 - ListAvailableNodeTypes

功能介绍

查询可用的Node规格。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v3/{project_id}/node-type

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

engine_type

是

String

DRS任务引擎类型。

取值：

  • mysql：MySQL到MySQL迁移，MySQL到MySQL同步
  • mongodb：MongoDB到DDS迁移
  • cloudDataGuard-mysql：MySQL到MySQL灾备
  • gaussdbv5：GaussDB同步
  • mysql-to-kafka：MySQL到Kafka同步
  • taurus-to-kafka：TaurusDB到Kafka同步
  • gaussdbv5ha-to-kafka：GaussDB集中式版到Kafka同步
  • postgresql：PostgreSQL到PostgreSQL同步
  • oracle-to-gaussdbv5：Oracle-GaussDB 分布式版
  • oracle-to-gaussdbv5ha：Oracle-GaussDB 集中式版
  • gaussdbv5-to-oracle：GaussDB 分布式版-Oracle
  • gaussdbv5ha-to-oracle：GaussDB 集中式版-Oracle
  • gaussdbv5-to-kafka：GaussDB 分布式版-Kafka

详细取值可参考引擎类型说明。

db_use_type

是

String

迁移场景。

取值：

  • migration：实时迁移
  • sync：实时同步
  • cloudDataGuard：实时灾备

job_direction

是

String

迁移方向。

取值：

  • up：入云
  • down：出云
  • non-dbs：自建

is_use_sellout_info

否

Boolean

是否查询资源售罄情况

缺省值：false

is_multi_write

否

Boolean

是否是双主灾备

缺省值：false

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

否

String

指定类型为application/json。

缺省值：application/json

X-Auth-Token

是

String

从IAM服务获取的用户Token。

X-Language

否

String

请求语言类型。

缺省值：en-us

枚举值：

  • en-us
  • zh-cn

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

node_types

Array of objects

Node规格列表。

详情请参见表5。

表5 node_types字段数据结构说明

参数

参数类型

描述

node_type

String

规格类型

is_sellout

Boolean

是否售罄

请求示例

查询可用的Node规格

https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/node_type?db_use_type=sync&engine_type=mysql&job_direction=up&is_multi_write=false&is_use_sellout_info=true

响应示例

状态码：200

OK

{
  "node_types" : [ {
    "is_sellout" : false,
    "node_type" : "micro"
  }, {
    "is_sellout" : false,
    "node_type" : "small"
  }, {
    "is_sellout" : false,
    "node_type" : "medium"
  }, {
    "is_sellout" : false,
    "node_type" : "high"
  }, {
    "is_sellout" : false,
    "node_type" : "xlarge"
  } ]
}

状态码：400

Bad Request

{
  "error_code" : "DRS.M00202",
  "error_msg" : "The value of job_direction is invalid."
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题：公共接口管理