# 查询录制规则列表 - ListRecordRules #### 功能介绍 查询录制规则列表接口，通过指定条件，查询满足条件的录制规则列表。 #### 调用方法 请参见[如何调用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:record:listRules | Read | - | - | - | - | #### URI GET /v1/{project_id}/record/rules 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-live/live_03_0023.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | publish_domain | 否 | String | **参数解释**： 直播推流域名 **约束限制**： 不涉及 **取值范围**： 字符长度为\[1-255\]位 **默认取值**： 不涉及 | | app | 否 | String | **参数解释**： 应用名称 **约束限制**： 不涉及 **取值范围**： 字符长度为\[1-128\]位 **默认取值**： 不涉及 | | stream | 否 | String | **参数解释**： 流名称 **约束限制**： 不涉及 **取值范围**： 字符长度为\[1-512\]位 **默认取值**： 不涉及 | | record_type | 否 | String | **参数解释**： 录制类型 **约束限制**： 不涉及 **取值范围**： - CONTINUOUS_RECORD：持续录制，在该规则类型配置后，只要有流推送到录制系统，就触发录制。 - COMMAND_RECORD：命令录制，在该规则类型配置后，在流推送到录制系统后，租户需要通过[命令控制](https://support.huaweicloud.com/api-live/RunRecord.html)该流的录制开始和结束。 **默认取值**： 不涉及 | | offset | 否 | Integer | **参数解释**： 偏移量，表示从此偏移量开始查询 **约束限制**： 不涉及 **取值范围：** 0\~4096 **默认取值：** 0 | | limit | 否 | 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响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-id | String | 此字段携带请求ID号，以便任务跟踪。格式为：request_id-timestamp-hostname（request_id在服务器端生成UUID，timestamp为当前时间戳，hostname为处理当前接口的服务器名称） | 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释**： 总条目数 **取值范围：** 0\~1024000 | | record_config | Array of [RecordRule] objects | **参数解释**： 录制配置数组 | 表6RecordRule | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 规则ID，由服务端返回。创建或修改的时候不携带 **取值范围**： 不涉及 | | publish_domain | String | **参数解释**： 直播推流域名 **取值范围**： 字符长度为\[1-255\]位 | | app | String | **参数解释**： 应用名称。 **取值范围**： 字符长度为\[1-128\]位。录制规则匹配的时候，优先精确app匹配，如果匹配不到，则匹配\*。 | | stream | String | **参数解释**： 流名称。 **取值范围**： 字符长度为\[1-512\]位。录制规则匹配的时候，优先精确stream匹配，如果匹配不到，则匹配\*。 | | record_type | String | **参数解释**： 录制类型 **取值范围**： - CONTINUOUS_RECORD：持续录制，在该规则类型配置后，只要有流推送到录制系统，就触发录制。 - COMMAND_RECORD：命令录制，在该规则类型配置后，在流推送到录制系统后，租户需要通过[命令控制](https://support.huaweicloud.com/api-live/RunRecord.html)该流的录制开始和结束。 | | default_record_config | [DefaultRecordConfig] object | **参数解释**： 默认录制规则配置 | | create_time | String | **参数解释**： 创建时间，格式：yyyy-mm-ddThh:mm:ssZ，UTC时间。 在查询的时候返回 **取值范围**： 不涉及 | | update_time | String | **参数解释**： 修改时间，格式：yyyy-mm-ddThh:mm:ssZ，UTC时间。 在查询的时候返回 **取值范围**： 不涉及 | 表7DefaultRecordConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | record_format | Array of strings | **参数解释**： 录制格式 | | obs_addr | [RecordObsFileAddr] object | **参数解释**： 录制保存的租户的桶信息 | | hls_config | [HLSRecordConfig] object | **参数解释**： HLS配置规则 | | flv_config | [FLVRecordConfig] object | **参数解释**： FLV配置规则 | | mp4_config | [MP4RecordConfig] object | **参数解释**： MP4配置规则 | 表8RecordObsFileAddr | 参数 | 参数类型 | 描述 | |:---|:---|:---| | bucket | String | **参数解释**： OBS的bucket名称 **取值范围**： 不涉及 | | location | String | **参数解释**： OBS Bucket所在RegionID **取值范围**： 不涉及 | | object | String | **参数解释**： OBS对象路径，遵守OBS Object定义。如果为空则保存到根目录 **取值范围**： 不涉及 | 表9HLSRecordConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | record_cycle | Integer | **参数解释**： 周期录制时长，单位：秒 **取值范围：** 0\~43200 | | record_prefix | String | **参数解释**： 录制m3u8文件,含路径和文件名的前缀 **取值范围**： 字符长度为\[1,512\]位 | | record_ts_prefix | String | **参数解释**： 录制ts文件名的前缀 **取值范围**： 字符长度为\[1,512\]位 | | record_slice_duration | Integer | **参数解释**： 录制HLS时ts的切片时长，非必填。 **取值范围：** 2\~60 | | record_max_duration_to_merge_file | Integer | **参数解释**： 录制HLS文件拼接时长，如果流中断超过该时间，则生成新文件，单位：秒 **取值范围：** -1\~300 | 表10FLVRecordConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | record_cycle | Integer | **参数解释**： 周期录制时长，单位：秒 **取值范围：** 0\~21600 | | record_prefix | String | **参数解释**： 录制FLV文件，含路径和文件名的前缀 **取值范围**： 字符长度为\[1,512\]位 | | record_max_duration_to_merge_file | Integer | **参数解释**： 录制FLV文件拼接时长，单位：秒 **取值范围：** 0\~300 | 表11MP4RecordConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | record_cycle | Integer | **参数解释**： 周期录制时长，单位：秒 **取值范围：** 0\~21600 | | record_prefix | String | **参数解释**： 录制文件含路径和文件名的前缀 **取值范围**： 字符长度为\[1,512\]位 | | record_max_duration_to_merge_file | Integer | **参数解释**： 录制mp4文件拼接时长，单位：秒 **取值范围：** 0\~300 | **状态码：400** 表12响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-id | String | 此字段携带请求ID号，以便任务跟踪。格式为：request_id-timestamp-hostname（request_id在服务器端生成UUID，timestamp为当前时间戳，hostname为处理当前接口的服务器名称） | 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | #### 请求示例 查询录制规则列表。 ``` GET https://live.hwcloud.com/v1/{project_id}/record/rules?publish_domain=xxx ``` #### 响应示例 **状态码：200** 查询录制配置成功 ``` { "total" : 1, "record_config" : [ { "id" : "42810594c2fc9xxxx36b7784c76a06e8", "publish_domain" : "publish.example.com", "app" : "live", "stream" : "*", "record_type" : "CONTINUOUS_RECORD", "default_record_config" : { "record_format" : [ "HLS" ], "obs_addr" : { "bucket" : "mybucket", "location" : "region1", "object" : "record/" }, "hls_config" : { "record_cycle" : 900, "record_prefix" : "record-publish_domain-app-stream-file_start_time_unix/record-publish_domain-app-stream-file_start_time_unix", "record_ts_prefix" : "{stream}-{file_start_time_unix}-{file_end_time_unix}-{ts_sequence_number}", "record_slice_duration" : 10, "record_max_duration_to_merge_file" : 60 } } } ] } ``` **状态码：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 ListRecordRulesSolution { 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(); ListRecordRulesRequest request = new ListRecordRulesRequest(); try { ListRecordRulesResponse response = client.listRecordRules(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 = ListRecordRulesRequest() response = client.list_record_rules(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.ListRecordRulesRequest{} response, err := client.ListRecordRules(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=ListRecordRules)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询录制配置成功 | | 400 | 参数错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-live/ErrorCode.html)。