Modifying Channel Recording Information
Function
Modifies channel recording information.
URI
PUT /v1/{project_id}/ott/channels/record-settings
| 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 | Request time. 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 | 
|---|---|---|---|
| domain | Yes | String | Ingest domain name of a channel. | 
| app_name | Yes | String | Group name or application name. | 
| id | Yes | String | Unique ID of a channel. This parameter is mandatory. | 
| record_settings | No | record_settings object | Catch-up TV configuration. | 
| Parameter | Mandatory | Type | Description | 
|---|---|---|---|
| rollingbuffer_duration | No | Integer | Maximum catch-up TV recording duration. The recording is continuous in this period. This parameter is mandatory. Unit: second. The value 0 indicates that recording is not supported. The maximum recording duration is 14 days. | 
Response Parameters
Status code: 200
| Parameter | Type | Description | 
|---|---|---|
| result_code | String | Error code | 
| result_msg | String | Error message | 
| domain | String | Ingest domain name | 
| app_name | String | Group name or application name. This parameter is mandatory. | 
| id | String | (Mandatory) Unique ID of a channel. | 
Status code: 400
| Parameter | Type | Description | 
|---|---|---|
| result_code | String | Error code. | 
| result_msg | String | Error description. | 
| domain | String | Ingest domain name. | 
| app_name | String | Group name or application name. This parameter is mandatory. | 
| id | String | Unique ID of a channel. This parameter is mandatory. | 
Example Requests
PUT https://{endpoint}/v1/{project_id}/ott/channels/record-settings
{
  "domain" : "push.testott.hls.com",
  "app_name" : "ott",
  "id" : "test",
  "record_settings" : {
    "rollingbuffer_duration" : 3600
  }
}
 Example Responses
Status code: 200
Demo Information
{
  "result_code" : "LIVE.100000000",
  "result_msg" : "SUCCESS",
  "domain" : "push.testott.hls.com",
  "app_name" : "ott",
  "id" : "test"
}
  Status code: 400
Error response
{
  "result_code" : "LIVE.103011019",
  "result_msg" : "The resource to access is not exists",
  "domain" : "push.testott.hls.com",
  "app_name" : "ott",
  "id" : "test2"
}
 Status Codes
| Status Code | Description | 
|---|---|
| 200 | Demo Information | 
| 400 | Error response | 
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.
 
    