创建录制回调配置
功能介绍
创建录制回调配置接口
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/record/callbacks
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token,使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Authorization |
否 |
String |
使用AK/SK方式认证时必填,携带的鉴权信息。 |
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必填,请求的发生时间。 |
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必填,携带项目ID信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
publish_domain |
是 |
String |
直播推流域名 |
app |
是 |
String |
app名称。如果需要匹配任意应用则需填写*。录制规则匹配的时候,优先精确app匹配,如果匹配不到,则匹配* |
notify_callback_url |
否 |
String |
录制回调通知url地址 |
notify_event_subscription |
否 |
Array of strings |
订阅录制通知消息。消息类型。RECORD_NEW_FILE_START开始创建新的录制文件。RECORD_FILE_COMPLETE录制文件生成完成。RECORD_OVER录制结束。RECORD_FAILED表示录制失败。如果不填写,默认订阅RECORD_FILE_COMPLETE |
sign_type |
否 |
String |
加密类型,包含如下取值
不填写时,取默认值HMACSHA256 |
key |
否 |
String |
回调密钥,主要用于鉴权。为了保护用户数据信息安全,建议填写。 |
响应参数
状态码: 201
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称) |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
配置规则ID,在创建配置规则成功后服务端返回 |
publish_domain |
String |
直播推流域名 |
app |
String |
app名称。如果需要匹配任意应用则需填写*。录制规则匹配的时候,优先精确app匹配,如果匹配不到,则匹配* |
notify_callback_url |
String |
录制回调通知url地址 |
notify_event_subscription |
Array of strings |
订阅录制通知消息。消息类型。RECORD_NEW_FILE_START开始创建新的录制文件。RECORD_FILE_COMPLETE录制文件生成完成。RECORD_OVER录制结束。RECORD_FAILED表示录制失败。如果不填写,默认订阅RECORD_FILE_COMPLETE |
sign_type |
String |
加密类型,包含如下取值
|
create_time |
String |
创建时间,格式:yyyy-mm-ddThh:mm:ssZ,UTC时间。 在查询的时候返回 |
update_time |
String |
修改时间,格式:yyyy-mm-ddThh:mm:ssZ,UTC时间。 在查询的时候返回 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
此字段携带请求ID号,以便任务跟踪。格式为:request_id-timestamp-hostname(request_id在服务器端生成UUID,timestamp为当前时间戳,hostname为处理当前接口的服务器名称) |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
创建录制回调配置。
POST https://{endpoint}/v1/{project_id}/record/callbacks { "publish_domain" : "publish.example.com", "app" : "**", "notify_callback_url" : "https://mycallback.com.cn/record_notify", "notify_event_subscription" : [ "RECORD_FILE_COMPLETE" ] }
响应示例
状态码: 400
录制配置创建失败
{ "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal" }
SDK代码示例
SDK代码示例如下。
创建录制回调配置。
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 |
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 CreateRecordCallbackConfigSolution { 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(); CreateRecordCallbackConfigRequest request = new CreateRecordCallbackConfigRequest(); RecordCallbackConfigRequest body = new RecordCallbackConfigRequest(); List<RecordCallbackConfigRequest.NotifyEventSubscriptionEnum> listbodyNotifyEventSubscription = new ArrayList<>(); listbodyNotifyEventSubscription.add(RecordCallbackConfigRequest.NotifyEventSubscriptionEnum.fromValue("RECORD_FILE_COMPLETE")); body.withNotifyEventSubscription(listbodyNotifyEventSubscription); body.withNotifyCallbackUrl("https://mycallback.com.cn/record_notify"); body.withApp("**"); body.withPublishDomain("publish.example.com"); request.withBody(body); try { CreateRecordCallbackConfigResponse response = client.createRecordCallbackConfig(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()); } } } |
创建录制回调配置。
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 |
# 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 = CreateRecordCallbackConfigRequest() listNotifyEventSubscriptionbody = [ "RECORD_FILE_COMPLETE" ] request.body = RecordCallbackConfigRequest( notify_event_subscription=listNotifyEventSubscriptionbody, notify_callback_url="https://mycallback.com.cn/record_notify", app="**", publish_domain="publish.example.com" ) response = client.create_record_callback_config(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
创建录制回调配置。
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 |
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.CreateRecordCallbackConfigRequest{} var listNotifyEventSubscriptionbody = []model.RecordCallbackConfigRequestNotifyEventSubscription{ model.GetRecordCallbackConfigRequestNotifyEventSubscriptionEnum().RECORD_FILE_COMPLETE, } notifyCallbackUrlRecordCallbackConfigRequest:= "https://mycallback.com.cn/record_notify" request.Body = &model.RecordCallbackConfigRequest{ NotifyEventSubscription: &listNotifyEventSubscriptionbody, NotifyCallbackUrl: ¬ifyCallbackUrlRecordCallbackConfigRequest, App: "**", PublishDomain: "publish.example.com", } response, err := client.CreateRecordCallbackConfig(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
201 |
创建配置操作成功 |
400 |
录制配置创建失败 |
错误码
请参见错误码。