You need to enable JavaScript to run this app.
导航
ListScenarios - 获取审核场景列表
最近更新时间:2025.04.15 20:51:42首次发布时间:2025.04.15 20:51:42
我的收藏
有用
有用
无用
无用

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

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringListScenarios接口名称。当前 API 的名称为 ListScenarios
VersionString2024-08-01接口版本。当前 API 的版本为 2024-08-01
PageNumberInteger1分页查询页码。取值范围为 [1,1000],默认值为 1
PageSizeInteger10分页查询数量。取值范围为 [1,500],默认值为 10。
ProjectNameString182701****608457项目名称。您可通过调用 ListProjects 接口,获取项目名称。

ScenarioName

String

A

审核场景名称,长度为 1 到 20 个字符。支持模糊搜索,英文不区分大小写。
支持以下字符:

  • 中文
  • 数字
  • 大写字母 A - Z
  • 小写字母 a - z

SortBy

String

CreatedTime

排序规则。默认值为 CreatedTime。取值如下:

  • CreatedTime:按照审核场景的创建时间排序
  • UpdatedTime:按照审核场景的最近修改时间排序

SortOrder

String

DESC

排序规则的顺序。默认值为 DESC。取值如下:

  • DESC:降序
  • ASC:升序

ScenarioType

Integer

2

审核场景类型。默认查询全部类型。取值如下:

  • 1:视频审核(暂不支持)
  • 2:直播审核

返回参数

参数类型示例值描述
PageNumberInteger1分页查询页码。
PageSizeInteger10分页查询数量。
TotalCountString1查询结果总数。
ScenariosArray of Scenarios-审核场景详情列表。

Scenarios

参数类型示例值描述
ScenarioIdLong1审核场景 ID。
ScenarioNameString场景 A审核场景名称。
ScenarioDescString场景 A 描述。审核场景描述。

ScenarioType

Integer

1

审核场景类型。取值如下:

  • 1:视频审核(暂不支持)
  • 2:直播审核
CreatedTimeLong1744012851审核场景创建时间。Unix 时间戳,单位为秒。
UpdatedTimeLong1744012851审核场景最近修改时间。Unix 时间戳,单位为秒。
RuleCountInteger1审核场景包含的规则数量。
TaskCountInteger1审核场景关联的任务数量。

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListScenarios&Version=2024-08-01&PageNumber=1&PageSize=10&ProjectName=182701****608457&ScenarioName=A&SortBy=CreatedTime&SortOrder=DESC&ScenarioType=2

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListScenarios",
        "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
            }
        ]
    }
}

错误码

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