Querying IP Address ACLs_Authentication Management_Cloud Live API Reference

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. Range Length: 1 to 255 characters
auth_type	String	Definition Authentication mode. Range WHITE: IP address whitelist authentication. BLACK: IP address blacklist authentication. NONE: No authentication is performed.
ip_auth_list	String	Definition IP address blacklist. Range Array length: 0 to 2000

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.

Querying IP Address ACLs