Help Center/ Live/ Cloud Live API Reference/ Authentication Management/ Querying Supported Areas of a Streaming Domain Name
Updated on 2026-04-22 GMT+08:00
View PDF

Querying Supported Areas of a Streaming Domain Name

Function

This API is used to query supported areas of a streaming domain name.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/domain/geo-blocking

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

play_domain

Yes

String

Definition

Streaming domain name.

Constraints

N/A

Range

Length: 1 to 255 characters

Default Value

N/A

Request Parameters

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.

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

Parameter

Type

Description

play_domain

String

Definition

Streaming domain name.

Range

Length: 1 to 255 characters

apps

Array of GeoBlockingConfigInfo objects

Definition

Application list. Array length: 0 to 100.
Table 6 GeoBlockingConfigInfo

Parameter

Type

Description

app

String

Definition

Application name.

Constraints

N/A

Range

Length: 1 to 128 characters

Default Value

N/A

area_whitelist

Array of strings

Definition

Region restriction list.

Constraints

An empty list means no restrictions. All region codes consist of two uppercase letters, except for China. For details about the code format, see ISO 3166-1. alpha-2.

Examples:

  • CN-IN: Chinese mainland

  • CN-HK: Hong Kong (China)

  • CN-MO: Macao (China)

  • CN-TW: Taiwan (China)

  • BR: Brazil

Range

N/A

Default Value

N/A

Status code: 400

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

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

GET https://{endpoint}/v1/{project_id}/domain/geo-blocking?play_domain=play.example.huawei.com

Example Responses

Status code: 200

Supported areas queried.

{
  "play_domain" : "play.example.huawei.com",
  "apps" : [ {
    "app" : "live,",
    "area_whitelist" : [ "CN-IN", "CN-HK", "CN-MO", "CN-TW", "BR" ]
  } ]
}

Status code: 400

Query supported areas failed.

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

Status Codes

Status Code

Description

200

Supported areas queried.

400

Query supported areas failed.

Error Codes

See Error Codes.

Parent Topic: Authentication Management