创建只读节点 - CreateGaussMySqlReadonlyNode
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /v3/{project_id}/instances/{instance_id}/nodes/enlarge
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
|
instance_id |
是 |
String |
参数解释: 实例ID,此参数是实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
X-Language |
否 |
String |
参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: 默认取值: en-us。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
priorities |
是 |
Array of integers |
参数解释: 指定创建的只读节点故障倒换优先级。 数字越小,优先级越大,即故障倒换时,主节点会优先倒换到优先级高的只读节点上,优先级相同的只读节点选为主节点的概率相同。最多支持9个只读节点设置故障倒换优先级,超过9个的只读节点优先级默认为-1,表示不会参与倒换。可通过修改节点的故障倒换优先级来进行调整。 约束限制: 不涉及。 取值范围: 1-16。 默认取值: 不涉及。 |
|
is_auto_pay |
否 |
String |
参数解释: 是否自动从客户的账户中支付。 约束限制: 创建包年/包月实例时可指定,此字段不影响自动续订的支付方式。 取值范围: 默认取值: true。 |
|
availability_zones |
否 |
Array of strings |
参数解释: 可用区。可指定可用区创建只读节点,不传该参数时默认为自动选择可用区。 约束限制: 该参数目前处于公测阶段,如需使用,请提交工单联系客服人员申请权限。 调用查询数据库规格 - ShowGaussMySqlFlavors获取,其中az_status中的key为availability_zone。 注:指定可用区创建只读节点,可能由于资源不足创建失败。 取值范围: 调用查询数据库规格 - ShowGaussMySqlFlavors获取,其中az_status中的key为availability_zone。 默认取值: 不涉及。 |
响应参数
状态码: 201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
instance_id |
String |
参数解释: 实例ID,此参数是实例的唯一标识。 取值范围: 不涉及。 |
|
node_names |
Array of strings |
参数解释: 节点名称列表。 |
|
job_id |
String |
参数解释: 创建只读节点的任务ID。 仅创建按需只读节点时会返回该参数。 取值范围: 不涉及。 |
|
order_id |
String |
参数解释: 订单号,创建包年包月只读节点时返回该参数。 取值范围: 不涉及。 |
状态码: 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误消息。 |
状态码: 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误消息。 |
请求示例
为实例创建只读节点。
POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/nodes/enlarge
{
"priorities" : [ 1, 2 ]
}
响应示例
状态码: 201
Success.
{
"instance_id" : "ba62a0b83a1b42bfab275829d86ac0fdin07",
"node_names" : [ "gauss-ccf5_node03" ],
"job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"
}
状态码
请参见状态码。
错误码
请参见错误码。