实例新增只读节点
接口说明
DDS副本集实例新增只读节点。
约束说明
- 该接口目前仅支持副本集实例和3.4版本集群实例。
- 一个副本集实例最多能新增5个只读节点。
- 集群实例一个shard最多新增5个只读节点。
- 集群实例一次只支持对一个shard添加只读节点。
- 集群实例不支持设置同步延迟时间,默认0。
- 该接口既支持包年包月实例,也支持按需实例。
调试
您可以在API Explorer中调试该接口。
URI
- URI格式
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/readonly-node
- URI样例
https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/readonly-node
表1 请求参数 参数
是否必选
参数类型
描述
project_id
是
String
租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。
instance_id
是
String
表2 请求Header参数 参数
是否必选
参数类型
描述
X-Auth-Token
是
String
从IAM服务获取的用户Token。请参考认证鉴权。
请求参数
- 参数说明
表3 请求Body参数 参数
是否必选
参数类型
描述
spec_code
是
String
资源规格编码。获取方法请参见查询数据库规格中参数的值。示例:dds.mongodb.c6.large.4.rr。
num
是
Integer
待新增只读节点个数。取值范围:1~5。
delay
否
Integer
同步延迟时间。取值范围:0~1200毫秒。默认取值为0。
is_auto_pay
否
Boolean
新增包年包月实例的只读节点时可指定,表示是否自动从账户中支付,此字段不影响自动续订的支付方式。
- true,表示自动从账户中支付。
- false,表示手动从账户中支付,默认为该方式。
请求示例
副本集实例新增只读节点,spec_code为dds.mongodb.c6.large.4.rr,新增只读节点数为1,delay为0
POST https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/readonly-node { "spec_code": "dds.mongodb.c6.large.4.rr", "num" : 1, "delay" : 0 }
响应参数
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
任务ID。 |
order_id |
String |
订单ID,仅扩容包年包月实例的节点数量时返回该参数。 |
响应示例
{ "job_id" : "4008c8914b624785a02ab7966d4d" }
状态码
详情请参见状态码。
错误码
详情请参见错误码。