Help Center/ Live/ Cloud Live API Reference/ Authentication Management/ Querying the URL Validation Configuration of a Specified Domain Name

Updated on 2024-09-27 GMT+08:00

View PDF

Querying the URL Validation Configuration of a Specified Domain Name

Function

API for querying the URL validation configuration of a specified domain name

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/guard/key-chain

**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
domain	Yes	String	Domain names, including the ingest domain name and 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 body parameters
Parameter	Type	Description
key	String	URL validation value, which consists of 32 characters, including uppercase letters, lowercase letters, and digits. The value cannot contain only digits or letters.
auth_type	String	Signing method. The options are as follows: d_sha256: signing method D, which uses the HMAC-SHA256 algorithm. This method is recommended. c_aes: signing method C, which uses the symmetric encryption algorithm b_md5: signing method B, which uses the MD5 algorithm a_md5: signing method A, which uses the MD5 algorithm NOTE: Signing methods A, B, and C have security risks. Signing method D is more secure and recommended.
timeout	Integer	Timeout interval of URL validation. Value range: [60, 2,592,000], that is, 1 minute to 30 days Unit: second Maximum difference between the request time carried in the authentication information and the time when Live receives the request. This parameter is used to check whether the Live ingest URL or streaming URL has expired.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error description

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error description

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error description

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error description

Example Requests

Queries the URL validation configuration of a specified domain name.

GET https://{endpoint}/v1/{project_id}/guard/key-chain?domain=play.example.huawei.com

Example Responses

Status code: 200

Query succeeded.

{
  "key" : "IbBIzklRGCyMEd18oPV9sxAuuwNIzT81",
  "auth_type" : "d_sha256",
  "timeout" : 3600
}

Status code: 400

Parameter verification failed.

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

Status code: 401

The API is not authorized to access resources.

{
  "error_code" : "LIVE.100011003",
  "error_msg" : "Unauthorized access to the interface, please contact the main account administrator to open the interface permissions"
}

Status code: 404

The resource to be accessed does not exist. For example, the domain name does not exist.

{
  "error_code" : "LIVE.103011019",
  "error_msg" : "The resource to access is not exists"
}

Status code: 500

Internal service error

{
  "error_code" : "LIVE.100011005",
  "error_msg" : "Server internal error, please try again later or contact customer service staff to help solve"
}

Status Codes

Status Code	Description
200	Query succeeded.
400	Parameter verification failed.
401	The API is not authorized to access resources.
404	The resource to be accessed does not exist. For example, the domain name does not exist.
500	Internal service error