更新时间:2024-09-11 GMT+08:00

修改代理实例名称

功能介绍

修改代理实例名称。

URI

PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/rename

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一region下的project ID。

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

instance_id

String

实例ID,严格匹配UUID规则。

proxy_id

String

数据库代理ID,严格匹配UUID规则。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

内容类型。 取值:application/json。

X-Auth-Token

String

用户token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。默认en-us。

取值范围:

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

alias

String

修改代理实例的新名称。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

result

String

修改成功或者失败。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

修改代理实例名称

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/4785fc80386846f3ad2bf4e0cd53a4cein07/proxy/286a4a1a45e3400c907b51b0721377f9po01/rename

{
  "alias" : "newName"
}

响应示例

状态码: 200

Success.

{
  "result" : "success"
}

状态码

状态码

描述

200

Success.

400

Clinet error.

500

Server error.

错误码

请参见错误码