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

Querying Supported Areas of a Streaming Domain Name

Function

Queries supported areas of a streaming domain name.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

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

Streaming domain name.

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

Streaming domain name.

apps

Array of GeoBlockingConfigInfo objects

Applications.
Table 6 GeoBlockingConfigInfo

Parameter

Type

Description

app

String

Application name.

area_whitelist

Array of strings

List of supported areas. An empty list indicates no restriction.

The values of all region codes, except that of China, contain two uppercase letters. For the code format, see ISO 3166-1alpha-2

(https://www.iso.org/obp/ui/#search/code/).

Some options are as follows:

  • CN-IN: Chinese mainland

  • CN-HK: Hong Kong (China)

  • CN-MO: Macao (China)

  • CN-TW: Taiwan (China)

  • BR: Brazil

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.