Querying the Delay Settings for a Streaming Domain Name
Function
This API is used to query the delay settings for streaming domain name.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/domain/delay
| 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 | Definition Streaming domain name. Constraints N/A Range Length: 1 to 255 characters Default Value N/A |
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 |
|---|---|---|
| play_domain | String | Definition Streaming domain name. Range Length: 1 to 255 characters |
| delay_config | Array of DelayConfig objects | Definition Live delay configuration. |
| Parameter | Type | Description |
|---|---|---|
| app | String | Definition Application name. Range Length: 0 to 128 characters Default value: live |
| delay | Integer | Definition Delay, in ms. Range |
Status code: 400
| 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.