文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 数据库代理> 设置访问控制规则
更新时间：2023-11-28 GMT+08:00
在线调试
CLI示例
查看PDF

设置访问控制规则

功能介绍

设置访问控制规则。

URI

POST /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/access-control

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

instance_id

是

String

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

proxy_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参数

参数

是否必选

参数类型

描述

type

是

String

访问控制方式。 取值：

  • white：表示白名单。
  • black：表示黑名单。

ip_list

是

Array of AccessControlRule objects

控制访问的IP地址数组，最多可添加300个IP地址或网段。
表4 AccessControlRule

参数

是否必选

参数类型

描述

ip

是

String

IP地址或网段。

description

否

String

备注。备注长度范围是0到50个字符，不能包含<>。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

open_access_control

Boolean

是否已开启访问控制。 取值：

  • true：开启。
  • false：关闭。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

设置访问控制规则。

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/access-control
{
  "type" : "black",
  "ip_list" : [ {
    "ip" : "192.107.0.1",
    "description" : "black01"
  } ]
}

响应示例

状态码： 200

Success.

{
  "open_access_control" : false
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 数据库代理