Modifying a Recording Template
Function
This API is used to modify a recording template. The modified recording template only takes effect for streams that are pushed after the template is modified.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
live:record:updateRule
Write
-
-
-
-
URI
PUT /v1/{project_id}/record/rules/{id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
| id | Yes | String | Template ID, which is returned after the template is created. |
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 |
| app | Yes | String | Definition Application name. Constraints To match all applications, set this parameter to a wildcard character (). Exact application matching takes precedence. If no match is found, the wildcard () rule is applied. Range Length: 1 to 128 characters Default Value N/A |
| stream | Yes | String | Definition Stream name. Constraints Stream name. To match all streams, set this parameter to a wildcard character (). Exact stream matching takes precedence. If no match is found, the wildcard () rule is applied. Range Length: 1 to 512 characters Default Value N/A |
| record_type | No | String | Definition Recording type. Constraints N/A Range
Default value: CONTINUOUS_RECORD |
| default_record_config | Yes | DefaultRecordConfig object | Definition Default recording template settings. Constraints N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| record_format | Yes | Array of strings | Definition Recording format. Constraints Supported formats include FLV, HLS, and MP4. These values must be in uppercase. |
| obs_addr | Yes | RecordObsFileAddr object | Definition Information of your bucket where recordings are stored. Constraints N/A |
| hls_config | No | HLSRecordConfig object | Definition HLS configuration. Constraints N/A |
| flv_config | No | FLVRecordConfig object | Definition FLV configuration. Constraints N/A |
| mp4_config | No | MP4RecordConfig object | Definition MP4 configuration. Constraints N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| bucket | Yes | String | Definition OBS bucket name. Constraints Length: 1 to 256 characters Range N/A Default Value N/A |
| location | Yes | String | Definition ID of the region where the OBS bucket is located. Constraints N/A Range N/A Default Value N/A |
| object | Yes | String | Definition OBS object path, which complies with the OBS Object definition. If this parameter is left empty, recordings will be saved to the root directory. Constraints Length: 1 to 1,024 characters Range N/A Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| X-request-id | String | Request ID for task tracing. Format: request_id-timestamp-hostname. (request_id is the UUID generated on the server. timestamp indicates the current timestamp, and hostname is the name of the server that processes the current API.) |
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition Template ID, which is returned by the server. This parameter is not required for creation or modification. Range N/A |
| publish_domain | String | Definition Ingest domain name. Range Length: 1 to 255 characters |
| app | String | Definition Application name. Range Length: 1 to 128 characters Exact application matching takes precedence. If no match is found, the wildcard (*) rule is applied. |
| stream | String | Definition Stream name. Range Length: 1 to 512 characters Exact stream matching takes precedence. If no match is found, the wildcard (*) rule is applied. |
| record_type | String | Definition Recording type. Range
Default value: CONTINUOUS_RECORD |
| default_record_config | DefaultRecordConfig object | Definition Default recording template settings. |
| create_time | String | Definition Creation time in the format of yyyy-mm-ddThh:mm:ssZ (UTC time). It is returned in the response. Range N/A |
| update_time | String | Definition Modification time in the format of yyyy-mm-ddThh:mm:ssZ (UTC time). It is returned in the response. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| record_format | Array of strings | Definition Recording format. Constraints Supported formats include FLV, HLS, and MP4. These values must be in uppercase. |
| obs_addr | RecordObsFileAddr object | Definition Information of your bucket where recordings are stored. Constraints N/A |
| hls_config | HLSRecordConfig object | Definition HLS configuration. Constraints N/A |
| flv_config | FLVRecordConfig object | Definition FLV configuration. Constraints N/A |
| mp4_config | MP4RecordConfig object | Definition MP4 configuration. Constraints N/A |
| Parameter | Type | Description |
|---|---|---|
| bucket | String | Definition OBS bucket name. Constraints Length: 1 to 256 characters Range N/A Default Value N/A |
| location | String | Definition ID of the region where the OBS bucket is located. Constraints N/A Range N/A Default Value N/A |
| object | String | Definition OBS object path, which complies with the OBS Object definition. If this parameter is left empty, recordings will be saved to the root directory. Constraints Length: 1 to 1,024 characters Range N/A Default Value N/A |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| X-request-id | String | Request ID for task tracing. Format: request_id-timestamp-hostname. (request_id is the UUID generated on the server. timestamp indicates the current timestamp, and hostname is the name of the server that processes the current API.) |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error description. |
Example Requests
Modifies a recording template.
PUT https://{endpoint}/v1/{project_id}/record/rule/e89b76xxxxxx3425ui80af501cdxxxxxx
{
"publish_domain" : "publish.example.com",
"app" : "live",
"stream" : "*",
"record_type" : "CONTINUOUS_RECORD",
"default_record_config" : {
"record_format" : [ "HLS", "FLV" ],
"hls_config" : {
"record_cycle" : 3600,
"record_prefix" : "Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}",
"record_ts_prefix" : "{file_start_time_unix}-{file_end_time_unix}-{ts_sequence_number}",
"record_slice_duration" : 10,
"record_max_duration_to_merge_file" : 0
},
"flv_config" : {
"record_cycle" : 9000,
"record_prefix" : "Record/{publish_domain}/{app}/{record_format}/{stream}_{file_start_time}/{file_start_time}",
"record_max_duration_to_merge_file" : 0
},
"obs_addr" : {
"bucket" : "mybucket",
"location" : "region1",
"object" : "record/"
}
}
} Example Responses
Status code: 400
Failed to modify the recording template.
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal"
} SDK Sample Code
The SDK sample code is as follows.
Modifies a recording rule.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.live.v1.region.LiveRegion; import com.huaweicloud.sdk.live.v1.*; import com.huaweicloud.sdk.live.v1.model.*; import java.util.List; import java.util.ArrayList; public class UpdateRecordRuleSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); LiveClient client = LiveClient.newBuilder() .withCredential(auth) .withRegion(LiveRegion.valueOf("<YOUR REGION>")) .build(); UpdateRecordRuleRequest request = new UpdateRecordRuleRequest(); request.withId("{id}"); RecordRuleRequest body = new RecordRuleRequest(); FLVRecordConfig flvConfigDefaultRecordConfig = new FLVRecordConfig(); flvConfigDefaultRecordConfig.withRecordCycle(9000) .withRecordPrefix("Record/{publish_domain}/{app}/{record_format}/{stream}_{file_start_time}/{file_start_time}") .withRecordMaxDurationToMergeFile(0); HLSRecordConfig hlsConfigDefaultRecordConfig = new HLSRecordConfig(); hlsConfigDefaultRecordConfig.withRecordCycle(3600) .withRecordPrefix("Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}") .withRecordTsPrefix("{file_start_time_unix}-{file_end_time_unix}-{ts_sequence_number}") .withRecordSliceDuration(10) .withRecordMaxDurationToMergeFile(0); RecordObsFileAddr obsAddrDefaultRecordConfig = new RecordObsFileAddr(); obsAddrDefaultRecordConfig.withBucket("mybucket") .withLocation(RecordObsFileAddr.LocationEnum.fromValue("region1")) .withObject("record/"); List<VideoFormatVar> listDefaultRecordConfigRecordFormat = new ArrayList<>(); listDefaultRecordConfigRecordFormat.add(VideoFormatVar.fromValue("HLS")); listDefaultRecordConfigRecordFormat.add(VideoFormatVar.fromValue("FLV")); DefaultRecordConfig defaultRecordConfigbody = new DefaultRecordConfig(); defaultRecordConfigbody.withRecordFormat(listDefaultRecordConfigRecordFormat) .withObsAddr(obsAddrDefaultRecordConfig) .withHlsConfig(hlsConfigDefaultRecordConfig) .withFlvConfig(flvConfigDefaultRecordConfig); body.withDefaultRecordConfig(defaultRecordConfigbody); body.withRecordType(RecordRuleRequest.RecordTypeEnum.fromValue("CONTINUOUS_RECORD")); body.withStream("*"); body.withApp("live"); body.withPublishDomain("publish.example.com"); request.withBody(body); try { UpdateRecordRuleResponse response = client.updateRecordRule(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Modifies a recording rule.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdklive.v1.region.live_region import LiveRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdklive.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = LiveClient.new_builder() \ .with_credentials(credentials) \ .with_region(LiveRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateRecordRuleRequest() request.id = "{id}" flvConfigDefaultRecordConfig = FLVRecordConfig( record_cycle=9000, record_prefix="Record/{publish_domain}/{app}/{record_format}/{stream}_{file_start_time}/{file_start_time}", record_max_duration_to_merge_file=0 ) hlsConfigDefaultRecordConfig = HLSRecordConfig( record_cycle=3600, record_prefix="Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}", record_ts_prefix="{file_start_time_unix}-{file_end_time_unix}-{ts_sequence_number}", record_slice_duration=10, record_max_duration_to_merge_file=0 ) obsAddrDefaultRecordConfig = RecordObsFileAddr( bucket="mybucket", location="region1", object="record/" ) listRecordFormatDefaultRecordConfig = [ "HLS", "FLV" ] defaultRecordConfigbody = DefaultRecordConfig( record_format=listRecordFormatDefaultRecordConfig, obs_addr=obsAddrDefaultRecordConfig, hls_config=hlsConfigDefaultRecordConfig, flv_config=flvConfigDefaultRecordConfig ) request.body = RecordRuleRequest( default_record_config=defaultRecordConfigbody, record_type="CONTINUOUS_RECORD", stream="*", app="live", publish_domain="publish.example.com" ) response = client.update_record_rule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Modifies a recording rule.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := live.NewLiveClient( live.LiveClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateRecordRuleRequest{} request.Id = "{id}" recordPrefixFlvConfig:= "Record/{publish_domain}/{app}/{record_format}/{stream}_{file_start_time}/{file_start_time}" recordMaxDurationToMergeFileFlvConfig:= int32(0) flvConfigDefaultRecordConfig := &model.FlvRecordConfig{ RecordCycle: int32(9000), RecordPrefix: &recordPrefixFlvConfig, RecordMaxDurationToMergeFile: &recordMaxDurationToMergeFileFlvConfig, } recordPrefixHlsConfig:= "Record/{publish_domain}/{app}/{record_type}/{record_format}/{stream}_{file_start_time}/{file_start_time}" recordTsPrefixHlsConfig:= "{file_start_time_unix}-{file_end_time_unix}-{ts_sequence_number}" recordSliceDurationHlsConfig:= int32(10) recordMaxDurationToMergeFileHlsConfig:= int32(0) hlsConfigDefaultRecordConfig := &model.HlsRecordConfig{ RecordCycle: int32(3600), RecordPrefix: &recordPrefixHlsConfig, RecordTsPrefix: &recordTsPrefixHlsConfig, RecordSliceDuration: &recordSliceDurationHlsConfig, RecordMaxDurationToMergeFile: &recordMaxDurationToMergeFileHlsConfig, } obsAddrDefaultRecordConfig := &model.RecordObsFileAddr{ Bucket: "mybucket", Location: model.GetRecordObsFileAddrLocationEnum().REGION1, Object: "record/", } var listRecordFormatDefaultRecordConfig = []model.VideoFormatVarRecordFormat{ model.GetVideoFormatVarRecordFormatEnum().HLS, model.GetVideoFormatVarRecordFormatEnum().FLV, } defaultRecordConfigbody := &model.DefaultRecordConfig{ RecordFormat: listRecordFormatDefaultRecordConfig, ObsAddr: obsAddrDefaultRecordConfig, HlsConfig: hlsConfigDefaultRecordConfig, FlvConfig: flvConfigDefaultRecordConfig, } recordTypeRecordRuleRequest:= model.GetRecordRuleRequestRecordTypeEnum().CONTINUOUS_RECORD request.Body = &model.RecordRuleRequest{ DefaultRecordConfig: defaultRecordConfigbody, RecordType: &recordTypeRecordRuleRequest, Stream: "*", App: "live", PublishDomain: "publish.example.com", } response, err := client.UpdateRecordRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | Recording template modified. |
| 400 | Failed to modify the recording template. |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot