更新时间:2025-09-04 GMT+08:00

查询代理实例访问控制

功能介绍

查询代理实例访问控制。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

String

参数解释

实例ID,此参数是实例的唯一标识。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值

不涉及。

proxy_id

String

参数解释

数据库代理ID,严格匹配UUID规则。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为po01,长度为36个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

响应参数

状态码: 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"
    } ]
  } ]
}

状态码

请参见状态码

错误码

请参见错误码