1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
获取关键词信息。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAuditKeywords。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Offset | 是 | Integer | 获取偏移量。 示例值:20 |
Limit | 是 | Integer | 单页条数,最大为100条,超过则按100条返回。 示例值:0 |
LibId | 是 | String | 关键词库 Id。 示例值:4c49c04f-6617-4705-b3ff-bedce642bfcb |
Content | 是 | String | 关键词搜索字段。 为空字符串时忽略。 示例值:黄暴 |
Labels.N | 否 | Array of Integer | 标签类别搜索。 示例值:[123,456] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Total | Integer | 关键词总条数。 示例值:1000 |
Infos | Array of AuditKeywordInfo | 关键词详情列表。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 直播审核获取关键词
直播审核获取关键词列表搜索。
输入示例
POST / HTTP/1.1
Host: live.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAuditKeywords
<公共请求参数>
{
"Limit": 0,
"Offset": 100,
"LibId": "4c49c04f-6617-4705-b3ff-bedce642bfcb",
"Content": "",
"Labels": []
}
输出示例
{
"Response": {
"Total": 0,
"Infos": [
{
"KeywordId": "415124487845454",
"Content": "content-name",
"CreateTime": "20240214",
"Label": "12"
}
],
"RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |