Help Center/ Live/ Cloud Live API Reference/ Domain Name Management/ Querying the Primary/Standby Stream Settings for a Domain Name
Updated on 2026-04-22 GMT+08:00
View PDF

Querying the Primary/Standby Stream Settings for a Domain Name

Function

This API is used to query the primary/secondary stream settings for a domain name. It allows multiple streams to be pushed under the same stream name, with priorities assigned sequentially. Stream priorities can also be reorganized manually.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/domain/stream-backup

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

publish_domain

Yes

String

Definition

Ingest domain name.

Constraints

N/A

Range

Length: 1 to 255 characters

Default Value

N/A

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

publish_domain

String

Definition

Ingest domain name.

Constraints

N/A

Range

Length: 1 to 255 characters

Default Value

N/A

stream_backup_enable

Boolean

Definition

Primary/standby stream switch.

Constraints

N/A

Range

  • true: The primary/standby stream function is enabled.

  • false: The primary/standby stream function is disabled.

Default Value

false

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

Queries the primary/standby stream settings for a domain name.

GET https://{endpoint}/v1/{project_id}/domain/stream-backup?publish_domain=live.push.example.com

Example Responses

Status code: 200

Querying the primary/standby stream setting of a domain name succeeded.

{
  "publish_domain" : "live.push.example.com",
  "stream_backup_enable" : true
}

Status code: 400

Invalid parameter.

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

Status Codes

Status Code

Description

200

Querying the primary/standby stream setting of a domain name succeeded.

400

Invalid parameter.

Error Codes

See Error Codes.

Parent Topic: Domain Name Management