# 创建直播截图配置 - CreateSnapshotConfig #### 功能介绍 创建直播截图配置接口 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-live/live_03_0001.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-live/live_03_0013.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | live:snapshot:createRule | Write | - | - | - | - | #### URI POST /v1/{project_id}/stream/snapshot 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-live/live_03_0023.html)。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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信息。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain | 是 | String | **参数解释**： 直播推流域名 **约束限制**： 不涉及 **取值范围**： 字符长度为\[1-255\]位 **默认取值**： 不涉及 | | app_name | 是 | String | **参数解释**： 应用名称 **约束限制**： 不涉及 **取值范围**： 字符长度为\[1-128\]位 **默认取值**： 不涉及 | | auth_key | 否 | String | **参数解释**： 回调鉴权密钥值 **约束限制**： 若需要使用回调鉴权功能，请配置鉴权密钥，否则，留空即可。 **取值范围**： 字符长度为\[32,128\]位 **默认取值**： 不涉及 | | time_interval | 是 | Integer | **参数解释**： 截图频率，单位：秒 **约束限制**： 不涉及 **取值范围**： \[5,3600\] **默认取值**： 不涉及 | | object_write_mode | 是 | Integer | **参数解释**： 在OBS桶存储截图的方式 **约束限制**： 不涉及 **取值范围**： - 0：全保存模式，截图文件名中含时间戳，每条流的所有截图文件均会保存在存储对象里。示例：snapshot/{domain}/{app_name}/{stream_name}/{UnixTimestamp}.jpg - 1：覆盖模式，截图文件名不含时间戳，每条流只保存最新的截图文件，新的截图文件会覆盖原来的截图文件。示例：snapshot/{domain}/{app_name}/{stream_name}.jpg **默认取值：** 0 | | snapshot_mode | 否 | String | **参数解释**： 截图模式 **约束限制**： 不涉及 **取值范围**： - keyframe：I帧截图只选取、保存符合要求的I帧。 - nokeyframe：非I帧截图只选取、保存符合要求的非I帧。 - random：随机截图交替选取、保存符合要求的I帧及非I帧。 **默认取值**： keyframe **默认取值：** keyframe | | obs_location | 是 | [ObsFileAddr] object | **参数解释**： OBS存储位置信息 **约束限制**： 不涉及 | | call_back_enable | 否 | String | **参数解释**： 是否启用回调通知 **约束限制**： 不涉及 **取值范围**： - on：启用。 - off：不启用。 **默认取值**： 不涉及 | | call_back_url | 否 | String | **参数解释**： 通知服务器地址 **约束限制**： 必须是合法的URL且携带协议，协议支持http和https。截图完成后直播服务会向此地址推送截图状态信息 **取值范围**： 不涉及 **默认取值**： 不涉及 | | image_object_format | 否 | String | **参数解释**： 截图存储文件命名规则 **约束限制**： 仅支持jpg格式 - '{{.obs_object}}' OBS存储路径，即obs_location.object的值 - '{{.domain}}' 域名 - '{{.app}}' 应用名 - '{{.stream}}' 流名 其中实时截图模式下 - '{{.unix_time}}' 时间戳，秒 - '{{.unix_time_milli}}' 时间戳，毫秒 - '{{.fmt_time_utc}}' 格式化UTC时间, 格式：YYYYMMDDhhmmss, 如20060102070405 - '{{.fmt_time_local}}' 格式化本地时间, 格式：YYYYMMDDhhmmss，如20060102150405 必选一个时间类型模板 **取值范围**： 不涉及 **默认取值**： 不涉及 | | image_access_protocol | 否 | String | **参数解释**： 截图存储文件访问协议 **约束限制**： 仅支持http、https格式 **取值范围**： - http - https **默认取值**： 不涉及 | | image_access_domain | 否 | String | **参数解释**： 截图存储文件访问域名 **约束限制**： 不涉及 **取值范围**： 字符长度为\[0,255\]位 **默认取值**： 不涉及 | 表4ObsFileAddr | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | bucket | 是 | String | **参数解释**： OBS的bucket名称 **约束限制**： 不涉及 **取值范围**： 字符长度为\[1,64\]位 **默认取值**： 不涉及 | | location | 是 | String | **参数解释**： OBS Bucket所在的区域，且必须保持与使用的直播服务区域保持一致 **约束限制**： 不涉及 **取值范围**： 字符长度为\[1,128\]位 **默认取值**： 不涉及 | | object | 否 | String | **参数解释**： OBS对象路径，遵守OSS Object定义 **约束限制**： - 当用于指示input时，需要指定到具体对象 - 当用于指示output时，只需指定到截图结果期望存放的路径 **取值范围**： 字符长度为\[0,1024\]位 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 创建直播截图配置操作成功 **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | #### 请求示例 创建直播截图配置。 ``` POST 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代码示例如下。 - [Java] 创建直播截图配置。 ``` 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 CreateSnapshotConfigSolution { 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("")) .build(); CreateSnapshotConfigRequest request = new CreateSnapshotConfigRequest(); 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 { CreateSnapshotConfigResponse response = client.createSnapshotConfig(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()); } } } ``` - [Python] 创建直播截图配置。 ``` # 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("")) \ .build() try: request = CreateSnapshotConfigRequest() 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.create_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) ``` - [Go] 创建直播截图配置。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := live.LiveClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := live.NewLiveClient(hcClient) request := &model.CreateSnapshotConfigRequest{} objectObsLocation:= "/ffff/aa/" obsLocationbody := &model.ObsFileAddr{ Bucket: "cls-test", Location: "region1", Object: &objectObsLocation, } request.Body = &model.LiveSnapshotConfig{ ObsLocation: obsLocationbody, ObjectWriteMode: int32(1), TimeInterval: int32(5), AppName: "live", Domain: "play.example.huawei.com", } response, err := client.CreateSnapshotConfig(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Live/sdk?api=CreateSnapshotConfig)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 创建直播截图配置操作成功 | | 400 | 创建直播截图配置操作失败 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-live/ErrorCode.html)。