文档首页/ 分布式数据库中间件 DDM/ API参考/ API（推荐）/ 实例管理/ 修改DDM实例名称
更新时间：2024-07-02 GMT+08:00
查看PDF
分享

修改DDM实例名称

功能介绍

修改DDM实例名称。

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT /v1/{project_id}/instances/{instance_id}/modify-name

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

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

instance_id

是

String

DDM实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务的“获取用户Token”接口来获取。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

DDM实例名称，命名要求如下。

  • 长度为4-64个字符。
  • 必须以字母开头。
  • 可以包含字母、数字、中划线、下划线，不能包含其它特殊字符。

最小长度：4

最大长度：64

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

name

String

DDM实例名称。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码。

externalMessage

String

错误信息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码。

externalMessage

String

错误信息。

请求示例

修改实例名称。

PUT https://{endpoint}/v1/{project_id}/instances/{instance_id}/modify-name

{
  "name" : "DDM-test-04"
}

响应示例

状态码： 200

OK

{
  "name" : "DDM-test-04"
}

状态码： 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

状态码： 500

server error

{
  "externalMessage" : "Server failure.",
  "errCode" : "DBS.200412"
}

状态码

状态码

描述

200

OK

400

bad request

500

server error

错误码

请参见错误码。

父主题： 实例管理

相关文档