Help Center/ Live/ Cloud Live API Reference/ Domain Name Management/ Querying the Streaming Domain Name Delay
Updated on 2024-09-27 GMT+08:00

Querying the Streaming Domain Name Delay

Function

Queries the streaming domain name delay.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/domain/delay

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 body parameters

Parameter

Type

Description

play_domain

String

Streaming domain name.

delay_config

Array of DelayConfig objects

Live delay configuration.

Table 5 DelayConfig

Parameter

Type

Description

app

String

Application name. The default value is live.

delay

Integer

Indicates the delay, in ms.

The options are as follows:

  • 2000 (low)

  • 4000 (medium)

  • 6000 (high)

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

Queries the streaming domain name delay.

GET https://{endpoint}/v1/{project_id}/domain/delay?play_domain=pull.example.test.com

Example Responses

Status code: 200

Streaming domain name delay queried.

{
  "play_domain" : "pull.example.test.com",
  "delay_config" : [ {
    "app" : "live",
    "delay" : 6000
  } ]
}

Status code: 400

Invalid parameter.

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

Status Codes

Status Code

Description

200

Streaming domain name delay queried.

400

Invalid parameter.

Error Codes

See Error Codes.