Configuring Primary/Standby Stream Settings for a Domain Name
Function
This API is used to configure 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
PUT /v1/{project_id}/domain/stream-backup
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
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. |
| 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 |
| stream_backup_enable | Yes | Boolean | Definition Primary/standby stream switch. Constraints N/A Range Default Value false |
Response Parameters
Status code: 200
| 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 Default Value false |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Example Requests
Configures primary/secondary stream settings for a domain name.
PUT https://{endpoint}/v1/{project_id}/domain/stream-backup
{
"publish_domain" : "live.push.example.com",
"stream_backup_enable" : true
} Example Responses
Status code: 200
Request succeeded.
{
"publish_domain" : "live.push.example.com",
"stream_backup_enable" : true
} Status code: 400
Request failed.
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal"
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Request succeeded. |
| 400 | Request 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.
