Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Database Proxy/ Configuring Access Control Rules
Updated on 2024-09-11 GMT+08:00
View PDF
Share

Configuring Access Control Rules

Function

This API is used to configure access control rules. Before calling this API:

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID, which is compliant with the UUID format.

proxy_id

Yes

String

Proxy instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token.

The value of X-Subject-Token in the response header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

type

Yes

String

Access control type. Values:

  • white: indicates the whitelist.
  • black: indicates the blacklist.

ip_list

Yes

Array of AccessControlRule objects

Array of IP addresses that control access. A maximum of 300 IP addresses or CIDR blocks can be added.
Table 4 AccessControlRule

Parameter

Mandatory

Type

Description

ip

Yes

String

IP address or CIDR block.

description

No

String

Remarks. Character length: 0–50. Angle brackets (<>) are not allowed.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

open_access_control

Boolean

Whether access control is enabled. Values:

  • true: enabled
  • false: disabled

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

Configuring access control rules

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/access-control

{
  "type" : "black",
  "ip_list" : [ {
    "ip" : "192.107.0.1",
    "description" : "black01"
  } ]
}

Example Response

Status code: 200

Success.

{
  "open_access_control" : false
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Database Proxy