Configuring Access Control Rules

Function

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

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

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. If the following response body is returned for calling the API used to obtain a user token, the request is successful. After the request is processed, the value of X-Subject-Token in the message header is the token value.
X-Language	No	String	Request language type. The default value is en-us. Value: en-us zh-cn

**Table 3** Request body parameter
Parameter	Mandatory	Type	Description
type	Yes	String	Access control mode. Value: 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. Value: 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"
  } ]
}