调用 ListScenarios
接口,获取指定项目下所有已创建的审核场景列表,包括审核场景 ID、名称,以及包含的规则数量等。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListScenarios | 接口名称。当前 API 的名称为 ListScenarios 。 |
Version | String | 是 | 2024-08-01 | 接口版本。当前 API 的版本为 2024-08-01 。 |
PageNumber | Integer | 否 | 1 | 分页查询页码。取值范围为 [1,1000],默认值为 1 。 |
PageSize | Integer | 否 | 10 | 分页查询数量。取值范围为 [1,500],默认值为 10。 |
ProjectName | String | 是 | 182701****608457 | 项目名称。您可通过调用 ListProjects 接口,获取项目名称。 |
ScenarioName | String | 否 |
| 审核场景名称,长度为 1 到 20 个字符。支持模糊搜索,英文不区分大小写。
|
SortBy | String | 否 |
| 排序规则。默认值为
|
SortOrder | String | 否 |
| 排序规则的顺序。默认值为
|
ScenarioType | Integer | 否 |
| 审核场景类型。默认查询全部类型。取值如下:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageNumber | Integer | 1 | 分页查询页码。 |
PageSize | Integer | 10 | 分页查询数量。 |
TotalCount | String | 1 | 查询结果总数。 |
Scenarios | Array of Scenarios | - | 审核场景详情列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ScenarioId | Long | 1 | 审核场景 ID。 |
ScenarioName | String | 场景 A | 审核场景名称。 |
ScenarioDesc | String | 场景 A 描述。 | 审核场景描述。 |
ScenarioType | Integer |
| 审核场景类型。取值如下:
|
CreatedTime | Long | 1744012851 | 审核场景创建时间。Unix 时间戳,单位为秒。 |
UpdatedTime | Long | 1744012851 | 审核场景最近修改时间。Unix 时间戳,单位为秒。 |
RuleCount | Integer | 1 | 审核场景包含的规则数量。 |
TaskCount | Integer | 1 | 审核场景关联的任务数量。 |
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 } ] } }