接口说明
对于支持精确匹配和模糊查询的字段,采用其他查询手段时,其返回的结果都将遵循该字段所支持的查询方式,例如,如果一个字段仅支持模糊查询,则通过多值查询方法获取的结果也是基于模糊匹配返回的。
获取命中数据条数限制说明如下:
-
方法一:分页遍历
对于命中的搜索结果,您可以通过设置分页参数“PageNo”(页码)和“PageSize”(每页显示的记录数)来逐步遍历最多 5000 条数据。如果搜索结果超出了 5000 条,为了保证有效地遍历数据,请调整搜索条件以缩小结果范围。需要注意的是,此方法无法遍历完整数据集。若要遍历更多数据,请参考方法二。
-
方法二:全量遍历(限音视频搜索)
此方法适用于视频和音频内容的搜索,支持遍历最多 200 万条的全部搜索结果。如果搜索结果数量超过 200 万条,您应该通过增加更多筛选条件来减少结果数量。使用此方法时,除了“PageNo”和“PageSize”,您还需使用“ScrollToken”参数实现分页。请注意,每次仅支持向后遍历最多 100 条记录。 使用“PageSize”为 20 为例,以下是分页逻辑:
- 若“PageNo”为 1,您可以查询接下来的最多 5 页数据。
- 若“PageNo”为 2,您可以查询接下来的最多 6 页数据。
请确保在搜索时合理设置分页参数,并根据结果集大小选择适当的遍历方法。若您翻页的数据将大于 1000 条时,为了您的查询更方便快捷我们推荐您使用方法 2 来进行数据处理。
流控信息
请求参数
字段名称 | 字段详情 |
---|---|
SearchTypestring | 搜索媒资数据类型。取值范围:展开详情 示例值:video |
Fieldsstring | 搜索结果中返回的媒资字段。展开详情 示例值:Title,CoverURL |
Matchstring | 过滤条件。语法规则,请参见搜索协议语法。 示例值:field = value |
SortBystring | 排序字段和排序顺序。多个使用半角逗号(,)分隔。取值:展开详情 示例值:CreationTime:Desc |
PageNointeger<int32> | 当前页码。默认值为 1。展开详情 示例值:1 |
PageSizeinteger<int32> | 每页返回的数据条数。默认值为 10,最大值为 100。 示例值:10 |
ScrollTokenstring | 翻页标识。长度为 32 个字符。展开详情 示例值:24e0fba7188fae707e146esa54**** |
返回参数
字段名称 | 字段详情 |
---|---|
RequestIdstring | 请求 ID。 示例值:3E0CEF83-FB09-4E34-BA1451814B03**** |
Totalinteger<int64> | 满足搜索条件的媒资信息总条数。 注意
请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。 示例值:10 |
ScrollTokenstring | 翻页标识。 示例值:24e0fba7188fae707e146esa54**** |
MediaListarray<object> | 媒资信息列表。 |
返回示例
变更历史
变更时间 | 变更内容概要 | 操作 | |
---|---|---|---|
2023-04-11 |