修改直播截图配置
功能介绍
修改直播截图配置接口
调用方法
请参见如何调用API。
URI
PUT /v1/{project_id}/stream/snapshot
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain |
是 |
String |
直播推流域名 |
app_name |
是 |
String |
应用名称 |
auth_key |
否 |
String |
回调鉴权密钥值 长度范围:[32-128] 若需要使用回调鉴权功能,请配置鉴权密钥,否则,留空即可。 |
time_interval |
是 |
Integer |
截图频率 取值范围:[5-3600] 单位:秒 |
object_write_mode |
是 |
Integer |
在OBS桶存储截图的方式:
|
obs_location |
是 |
ObsFileAddr object |
OBS存储位置信息 |
call_back_enable |
否 |
String |
是否启用回调通知
|
call_back_url |
否 |
String |
通知服务器地址,必须是合法的URL且携带协议,协议支持http和https。截图完成后直播服务会向此地址推送截图状态信息。 |
响应参数
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
修改直播截图配置。
PUT https://{endpoint}/v1/{project_id}/stream/snapshot { "domain" : "play.example.huawei.com", "app_name" : "live", "time_interval" : 5, "object_write_mode" : 1, "obs_location" : { "bucket" : "cls-test", "location" : "region1", "object" : "/ffff/aa/" } }
响应示例
状态码: 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 58 |
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.*; public class UpdateSnapshotConfigSolution { 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(); UpdateSnapshotConfigRequest request = new UpdateSnapshotConfigRequest(); LiveSnapshotConfig body = new LiveSnapshotConfig(); ObsFileAddr obsLocationbody = new ObsFileAddr(); obsLocationbody.withBucket("cls-test") .withLocation("region1") .withObject("/ffff/aa/"); body.withObsLocation(obsLocationbody); body.withObjectWriteMode(1); body.withTimeInterval(5); body.withAppName("live"); body.withDomain("play.example.huawei.com"); request.withBody(body); try { UpdateSnapshotConfigResponse response = client.updateSnapshotConfig(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 41 42 43 |
# 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 = UpdateSnapshotConfigRequest() obsLocationbody = ObsFileAddr( bucket="cls-test", location="region1", object="/ffff/aa/" ) request.body = LiveSnapshotConfig( obs_location=obsLocationbody, object_write_mode=1, time_interval=5, app_name="live", domain="play.example.huawei.com" ) response = client.update_snapshot_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 48 49 |
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.UpdateSnapshotConfigRequest{} obsLocationbody := &model.ObsFileAddr{ Bucket: "cls-test", Location: "region1", Object: "/ffff/aa/", } request.Body = &model.LiveSnapshotConfig{ ObsLocation: obsLocationbody, ObjectWriteMode: int32(1), TimeInterval: int32(5), AppName: "live", Domain: "play.example.huawei.com", } response, err := client.UpdateSnapshotConfig(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
修改直播截图配置操作成功 |
400 |
修改直播截图配置操作失败 |
错误码
请参见错误码。