ListVideoScenarios - 获取视频质检场景列表--企业直播-火山引擎

文档中心

企业直播

视频质检 API

ListVideoScenarios - 获取视频质检场景列表

调用 ListVideoScenarios 接口，获取指定视频质检项目下所有已创建的审核场景列表，包括审核场景 ID、名称，以及包含的规则数量等。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：确保当前账号已开通质检服务。若当前账号为子账号，请同时确保主账号已在直播质检平台为该子账号授权，详见为子账号授权。否则账号将提示“暂无使用权限,请联系客服人员申请开通”。

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=ListVideoScenarios&Version=2024-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListVideoScenarios`	接口名称。当前 API 的名称为 `ListVideoScenarios`。
Version	String	是	`2024-08-01`	接口版本。当前 API 的版本为 `2024-08-01`。
PageNumber	Integer	否	`1`	分页查询页码。取值范围为 [1,1000]，默认值为 `1`。
PageSize	Integer	否	`10`	分页查询数量。取值范围为 [1,500]，默认值为 10。
ProjectName	String	是	`1827016328608457`	视频质检项目名称。您可通过调用 ListProjects 接口获取 ProjectName。
ScenarioName	String	否	`A`	审核场景名称，长度为 1 到 20 个字符。支持模糊搜索，英文不区分大小写。支持以下字符：中文数字大写字母 A - Z 小写字母 a - z
SortBy	String	否	`CreatedTime`	排序规则。默认值为 `CreatedTime`。取值如下： `CreatedTime`：按照审核场景的创建时间排序 `UpdatedTime`：按照审核场景的最近修改时间排序
SortOrder	String	否	`DESC`	排序规则的顺序。默认值为 `DESC`。取值如下： `DESC`：降序 `ASC`：升序

返回参数

参数	类型	示例值	描述
PageNumber	Integer	`1`	分页查询页码。
PageSize	Integer	`10`	分页查询数量。
TotalCount	String	`1`	查询结果总数。
Scenarios	Array of Scenarios	`-`	视频质检项目中的审核场景详情列表。

Scenarios

参数	类型	示例值	描述
ScenarioId	Long	`1`	审核场景 ID。
ScenarioName	String	`场景 A`	审核场景名称。
ScenarioDesc	String	`场景 A 描述。`	审核场景描述。
ScenarioType	Integer	`1`	审核场景类型。固定取值为 `1`，表示对视频进行审核。
CreatedTime	Long	`1744012851`	审核场景创建时间。Unix 时间戳，单位为秒。
UpdatedTime	Long	`1744012851`	审核场景最近修改时间。Unix 时间戳，单位为秒。
RuleCount	Integer	`1`	审核场景包含的规则数量。
TaskCount	Integer	`1`	审核场景关联的任务数量。

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListVideoScenarios&Version=2024-08-01&PageNumber=1&PageSize=10&ProjectName=1827016328608457&ScenarioName=A&SortBy=CreatedTime&SortOrder=DESC

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListVideoScenarios",
        "Version": "2024-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": "1",
        "Scenarios": [
            {
                "ScenarioId": 1,
                "ScenarioName": "场景 A",
                "ScenarioDesc": "场景 A 描述。",
                "ScenarioType": 1,
                "CreatedTime": 1744012851,
                "UpdatedTime": 1744012851,
                "RuleCount": 1,
                "TaskCount": 1
            }
        ]
    }
}

错误码

访问公共错误码和错误码获取详细信息。

最近更新时间：2026.06.11 11:04:30

这个页面对您有帮助吗？

有用

无用

企业直播

注意事项 #

请求说明 #

请求参数 #

Query #

返回参数 #

Scenarios #

请求示例 #

返回示例 #

错误码 #