Help Center/ Live/ Cloud Live API Reference/ Authentication Management/ Modifying an IP Address ACL
Updated on 2024-09-27 GMT+08:00
View PDF

Modifying an IP Address ACL

Function

Modifies the IP address ACL of an ingest or streaming domain name. Currently, only IPv4 addresses are supported.

  • 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

PUT /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.

Request Parameters

Table 2 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

domain

Yes

String

Ingest or streaming domain name.

auth_type

Yes

String

Authentication mode.

The options are as follows:

  • WHITE: IP address whitelist authentication.

  • BLACK: IP address blacklist authentication.

  • NONE: No authentication is performed.

ip_auth_list

Yes

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.

Response Parameters

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.)

Status code: 400

Table 5 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 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

PUT https://{endpoint}/v1/{project_id}/guard/ip

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

Example Responses

Status code: 400

Set the IP address blacklist failed.

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

Status Codes

Status Code

Description

200

IP address blacklist set.

400

Set the IP address blacklist failed.

Error Codes

See Error Codes.

Parent Topic: Authentication Management