# 查询直播转码模板 - ShowTranscodingsTemplate #### 功能介绍 查询直播转码模板 #### 调用方法 请参见[如何调用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:transcode:listTranscodingsTemplate | Read | - | - | - | - | #### URI GET /v1/{project_id}/template/transcodings 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-live/live_03_0023.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain | 是 | String | **参数解释**： 直播域名 **约束限制**： 不涉及 **取值范围**： 字符长度为\[1-255\]位 **默认取值**： 不涉及 | | app_name | 否 | String | **参数解释**： 应用名称 **约束限制**： 不涉及 **取值范围**： 字符长度为\[0-128\]位 **默认取值**： 不涉及 | | page | 否 | Integer | **参数解释**： 分页编号 **约束限制**： 不涉及 **取值范围：** ≥0 **默认取值：** 0 | | size | 否 | Integer | **参数解释**： 每页记录数 **约束限制**： 不涉及 **取值范围：** 1\~100 **默认取值：** 10 | #### 请求参数 表3请求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信息。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释**： 查询结果的app数量 **取值范围**： 不涉及 | | domain | String | **参数解释**： 直播推流域名 **取值范围**： 字符长度为\[1-255\]位 | | templates | Array of [AppQualityInfo] objects | **参数解释**： 转码模板 | 表5AppQualityInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | app_name | String | **参数解释**： 应用名称 **取值范围**： 字符长度为\[1-128\]位 | | quality_info | Array of [QualityInfo] objects | **参数解释**： 视频质量信息 | 表6QualityInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | quality | String | **参数解释**： 转码规格 **取值范围**： - lud：超高清，系统缺省名称。 - lhd：高清，系统缺省名称。 - lsd：标清，系统缺省名称。 - lld：流畅，系统缺省名称。 - userdefine：视频质量自定义。填写userdefine时，templateName字段不能为空。 | | templateName | String | **参数解释**： 自定义模板名称 **取值范围**： 字符长度为\[0-32\]位 | | PVC | String | **参数解释**： 是否使用窄带高清转码 **取值范围**： - off：不启用 - on：启用 | | hdlb | String | **参数解释**： 是否启用高清低码，较PVC相比画质增强 **取值范围**： - off：不开启高清低码。 - on：开启高清低码。 | | codec | String | **参数解释**： 视频编码格式 **取值范围**： - H264：使用H.264。 - H265：使用H.265。 | | width | Integer | **参数解释**： 视频的长边。其中，横屏为宽（即长边），竖屏为高。单位：像素 **取值范围**： - codec的取值为H264时，width建议取值范围为\[32,3840\]，且必须为2整数倍。 - codec的取值为H265时，width建议取值范围为\[320,3840\]，且必须为2的整数倍。 | | height | Integer | **参数解释**： 视频的短边。其中，横屏为宽，竖屏为高（即短边）。单位：像素。 **取值范围**： - codec的取值为H264时，height建议取值范围为\[32,2160\]，且必须为2的整数倍。 - codec的取值为H265时，height建议取值范围为\[240,2160\]，且必须为2的整数倍。 | | bitrate | Integer | **参数解释**： 转码视频的码率。单位：Kbps。 **取值范围**： \[40,30000\]。 | | video_frame_rate | Integer | **参数解释**： 转码视频帧率。单位：fps。 **取值范围**： \[0,60\]，0表示保持帧率不变。 | | protocol | String | **参数解释**： 转码输出支持的协议类型 **取值范围**： - RTMP | | iFrameInterval | Integer | **参数解释**： 最大I帧间隔，单位：帧数 **取值范围**： \[0,500\] | | gop | Integer | **参数解释**： 按时间设置I帧间隔，单位：秒 **取值范围：** 0\~10 | | bitrate_adaptive | String | **参数解释**： 自适应码率参数 **取值范围**： - off：关闭码率自适应，目标码率按设定的码率输出。 - minimum：目标码率按设定码率和源文件码率最小值输出（即码率不上扬）。 - adaptive：目标码率按源文件码率自适应输出。 | | i_frame_policy | String | **参数解释**： 编码输出I帧策略 **取值范围**： - auto：I帧按设置的gop时长输出。 - strictSync：编码输出I帧完全和源保持一致（源是I帧则编码输出I帧，源不是I帧则编码非I帧），设置该参数后gop时长设置无效 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | #### 请求示例 查询直播转码模板。 ``` GET https://{endpoint}/v1/{project_id}/template/transcodings?domain=play.example.com&app_name=live&page=0&size=10 ``` #### 响应示例 **状态码：200** 直播转码模板查询成功 ``` { "domain" : "play.example.com", "total" : 1, "templates" : [ { "app_name" : "live", "quality_info" : [ { "quality" : "lsd", "hdlb" : "off", "codec" : "H264", "width" : 1920, "height" : 1080, "bitrate" : 4500, "video_frame_rate" : 20, "gop" : 4 }, { "quality" : "userdefine", "templateName" : "yourTemplateName", "hdlb" : "off", "codec" : "H264", "width" : 1920, "height" : 1080, "bitrate" : 4500, "video_frame_rate" : 20, "gop" : 4 } ] } ] } ``` **状态码：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 ShowTranscodingsTemplateSolution { 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(); ShowTranscodingsTemplateRequest request = new ShowTranscodingsTemplateRequest(); try { ShowTranscodingsTemplateResponse response = client.showTranscodingsTemplate(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 = ShowTranscodingsTemplateRequest() response = client.show_transcodings_template(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.ShowTranscodingsTemplateRequest{} response, err := client.ShowTranscodingsTemplate(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=ShowTranscodingsTemplate)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 直播转码模板查询成功 | | 400 | 直播转码模板查询失败 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-live/ErrorCode.html)。