设置数据库代理ALT开关 - SwitchGaussMySqlProxyAlt
功能介绍
开启或关闭数据库代理ALT。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/alt
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 |
| instance_id | 是 | String | 参数解释： 实例ID，此参数是用户创建实例的唯一标识。 获取方法：登录管理控制台，选择实例管理页签，在实例列表查找目标实例ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为36个字符。 默认取值： 不涉及。 |
| proxy_id | 是 | String | 参数解释： 数据库代理ID，严格匹配UUID规则。 获取方法：登录管理控制台，单击实例名称，选择数据库代理页签，在代理实例列表查找代理ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为36个字符。 默认取值： 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释： 用户Token。 通过调用IAM服务获取用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| X-Language | 否 | String | 参数解释： 语言。 约束限制： 不涉及。 取值范围： 默认取值： en-us。 |
| Content-Type | 是 | String | 参数解释： 内容类型。 约束限制： 不涉及。 取值范围： application/json。 默认取值： 不涉及。 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 参数解释： 任务ID。 取值范围： 不涉及。 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误消息。 |
状态码：500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误消息。 |
请求示例
-
PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/proxy/0f46fc46396e4fb19a0cb52f578e9511po01/alt { "alt_enabled" : true, "alt_for_readonly" : true } -
PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/proxy/0f46fc46396e4fb19a0cb52f578e9511po01/alt { "alt_enabled" : false, "alt_for_readonly" : false }
响应示例
状态码：200
Success.
{
"job_id" : "a4217ac4-12cd-4fb3-acfc-db4a4a1896ea"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | Success. |
| 400 | Clinet error. |
| 500 | Server error. |
错误码
请参见错误码。
