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

查询代理实例访问控制

功能介绍

查询代理实例访问控制。

URI

GET /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/ipgroup

表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

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

enable_ip_group

Boolean

允许访问控制或者不允许 true | false。

type

String

白名单或者黑名单 'white' | 'black'

ip_group

ProxyIpGroupDetail object

白名单或黑名单详细信息。

表4 ProxyIpGroupDetail

参数

参数类型

描述

id

String

ipGroup的id。

name

String

ipGroup的名称。

ip_list

Array of IpGroupItem objects

ipGroup内部的ip列表。

表5 IpGroupItem

参数

参数类型

描述

ip

String

ip或者网段。

description

String

ip的描述。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询代理实例访问控制。

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/4785fc80386846f3ad2bf4e0cd53a4cein07/proxy/286a4a1a45e3400c907b51b0721377f9po01/ipgroup

响应示例

状态码: 200

Success.

{
  "enable_ip_group" : false,
  "type" : "black",
  "ip_group" : [ {
    "id" : "a4217ac4-12cd-4fb3-acfc-db4a4a1896ea",
    "name" : "PROXY-8c72c1b6985f414da0cfbc76ad7effc1po01_elbIpGroup",
    "ip_list" : [ {
      "ip" : "192.127.0.1",
      "description" : "proxy ipgroup"
    }, {
      "ip" : "192.127.0.2",
      "description" : "proxy ipgroup"
    } ]
  } ]
}

状态码

状态码

描述

200

Success.

400

Clinet error.

500

Server error.

错误码

请参见错误码