设置访问控制规则
URI
POST /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/access-control
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户在某一Region下的project ID。 获取方法请参见获取项目ID。 |
instance_id |
是 |
String |
实例ID,严格匹配UUID规则。 |
proxy_id |
是 |
String |
数据库代理ID,严格匹配UUID规则。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
X-Language |
否 |
String |
请求语言类型。默认en-us。 取值范围:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
是 |
String |
访问控制方式。 取值:
|
ip_list |
是 |
Array of AccessControlRule objects |
控制访问的IP地址数组,最多可添加300个IP地址或网段。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
open_access_control |
Boolean |
是否已开启访问控制。 取值:
|
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
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 }
状态码
请参见状态码。
错误码
请参见错误码。