Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Database Proxy/ Querying Access Control Settings of a Proxy Instance

Updated on 2025-09-04 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Access Control Settings of a Proxy Instance

Function

This API is used to query access control settings of a proxy instance. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A
proxy_id	Yes	String	Definition Proxy instance ID, which is compliant with the UUID format. Constraints N/A Range The value contains 36 characters with a suffix of po01. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
enable_ip_group	Boolean	Definition Whether to enable access control. Range true: Access control is enabled. false: Access control is disabled.
type	String	Definition Whitelist or blacklist. Range white: whitelist black: blacklist
ip_group	ProxyIpGroupDetail object	Definition Whitelist or blacklist details.

**Table 4** ProxyIpGroupDetail
Parameter	Type	Description
id	String	Definition ID of an IP address group. Range N/A
name	String	Definition Name of an IP address group. Range N/A
ip_list	Array of IpGroupItem objects	Definition IP addresses in an IP address group.

**Table 5** IpGroupItem
Parameter	Type	Description
ip	String	Definition IP address or CIDR block. Range N/A
description	String	Definition Description of the IP address. Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying access control settings of a proxy instance

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

Example Response

Status code: 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"
    } ]
  } ]
}