Querying IP Address ACLs

This API is used to query the IP address blacklist or whitelist of an ingest or streaming domain name.

For details, see Calling APIs.

GET /v1/{project_id}/guard/ip

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
domain	Yes	String	Definition Domain name. Constraints N/A Range Length: 1 to 255 characters Default Value N/A

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. This parameter is mandatory when token authentication is used. The token 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 user token.
Authorization	No	String	Authentication information. This parameter is mandatory for AK/SK authentication.
X-Sdk-Date	No	String	Time when the request is sent. This parameter is mandatory for AK/SK authentication.
X-Project-Id	No	String	Project ID. This parameter is mandatory for AK/SK authentication.

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Request ID for task tracing. Format: request_id-timestamp-hostname. (request_id is the UUID generated on the server. timestamp is the current timestamp. hostname is the name of the server that processes the current request.)

**Table 5** Response body parameters
Parameter	Type	Description
domain	String	Definition Domain name. Constraints N/A Range Length: 1 to 255 characters Default Value N/A
auth_type	String	Definition Authentication mode. Constraints N/A Range WHITE: IP address whitelist authentication. BLACK: IP address blacklist authentication. NONE: No authentication is performed. Default Value N/A
ip_auth_list	String	Definition IP address blacklist. Constraints Use semicolons (;) to separate IP addresses, for example, 192.168.0.0;192.168.0.8. A maximum of 1,000 IP addresses can be configured. IP address ranges can be added. For example, 127.0.0.1/24 indicates that the first 24 bits of the subnet mask are valid. The remaining 8 bits (32 – 24) represents the host ID. The subnet can accommodate 254 hosts (2^8 – 2). Therefore, 127.0.0.1/24 represents the IP address range from 127.0.0.1 to 127.0.0.255. Range Array length: 0 to 2000 Default Value N/A

Status code: 400

**Table 6** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Request ID for task tracing. Format: request_id-timestamp-hostname. (request_id is the UUID generated on the server. timestamp is the current timestamp. hostname is the name of the server that processes the current request.)

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

GET https://{endpoint}/v1/{project_id}/guard/ip?domain=play.example.huawei.com

Status code: 200

IP address ACLs queried.

{
  "domain" : "play.example.huawei.com",
  "auth_type" : "WHITE",
  "ip_auth_list" : "192.168.0.0;192.168.0.8"
}

Status code: 400

Query IP address ACLs failed.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

Status Code	Description
200	IP address ACLs queried.
400	Query IP address ACLs failed.

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.