Querying Supported Areas of a Streaming Domain Name
Function
Queries supported areas of a streaming domain name.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/domain/geo-blocking
|
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 |
|---|---|---|---|
|
play_domain |
Yes |
String |
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 |
|---|---|---|
|
play_domain |
String |
Streaming domain name. |
|
apps |
Array of GeoBlockingConfigInfo objects |
Applications. |
|
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:
|
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}/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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
