文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 数据库代理> 关闭数据库代理
更新时间：2024-04-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

关闭数据库代理

功能介绍

关闭数据库代理。

调用方法

请参见如何调用API。

URI

DELETE /v3/{project_id}/instances/{instance_id}/proxy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

instance_id

是

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

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

X-Language

否

String

请求语言类型。默认en-us。 取值范围：

  • en-us

  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

proxy_ids

否

Array of strings

数据库代理ID列表。

如果实例只开启了一个代理，可不传该字段；如果实例开启了多个代理，则必须指定要关闭的代理。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

关闭数据库代理。

DELETE https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxy

{
  "proxy_ids" : [ "151c14381ac14ecfb9703a745b992677po01" ]
}

响应示例

状态码： 200

Success.

{
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 数据库代理
分享：

    相关文档

    相关产品