Querying IP Address ACLs
Function
Queries the IP address blacklist or whitelist of an ingest or streaming domain name.
-
Blacklist: Specified IP addresses or network segments are not allowed.
-
Whitelist: Only specified IP addresses or network segments are allowed.
-
Default: All IP addresses or network segments are allowed.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/guard/ip
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
domain |
Yes |
String |
Ingest or streaming domain name. |
Request 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. |
Response Parameters
Status code: 200
|
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.) |
|
Parameter |
Type |
Description |
|---|---|---|
|
domain |
String |
Ingest or streaming domain name. |
|
auth_type |
String |
Authentication mode. The options are as follows:
|
|
ip_auth_list |
String |
IP address blacklist. Use semicolons (;) to separate IP addresses, for example, 192.168.0.0;192.168.0.8. A maximum of 100 IP addresses are allowed. IP network segments can be added. For example, 127.0.0.1/24 indicates that the first 24 bits of a subnet mask are valid. That is, 8bit (32–24) is used to indicate the host ID. The subnet can contain 254 hosts (28 – 2). Therefore, 127.0.0.1/24 indicates that the IP network segment ranges from 127.0.0.1 to 127.0.0.255. |
Status code: 400
|
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.) |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error Code |
|
error_msg |
String |
Error description |
Example Requests
GET https://{endpoint}/v1/{project_id}/guard/ip?domain=play.example.huawei.com
Example Responses
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 Codes
|
Status Code |
Description |
|---|---|
|
200 |
IP address ACLs queried. |
|
400 |
Query IP address ACLs failed. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
