批量查询内容标识符

最近更新时间:2024-12-23 11:34:32

我的收藏

1. 接口描述

接口请求域名: teo.tencentcloudapi.com 。

批量查询内容标识符,可以根据 ID、描述、状态或者标签过滤。按照状态查询被删除的内容标识符仅保留三个月。该功能仅白名单开放。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeContentIdentifiers。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,此参数为可选参数。
Offset Integer 分页查询偏移量。默认值:0。
Limit Integer 分页查询限制数目。默认值:20,最大值:100。
Filters.N Array of AdvancedFilter 过滤条件,Filters 的上限为 20,Filters.Values 的上限为 20。该参数不填写时,默认返回当前 AppId 下有权限的内容标识符。详细的过滤条件如下:
  • description:按照内容标识符描述批量进行过滤;例如:test;
  • content-id:按照内容标识符 ID 批量进行过滤;例如:eocontent-2noz78a8ev6k;
  • tag-key:按照标签键进行过滤;
  • tag-value: 按照标签值进行过滤;
  • status:按照内容标识符状态进行过滤,取值有:active:生效中;deleted:已删除。
  • 仅支持按照 description 模糊查询,其余字段需要精准查询。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合过滤条件的内容标识符总数。
    ContentIdentifiers Array of ContentIdentifier 内容标识符详细内容列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询内容标识符信息

    指定 ID 查询内容标识符

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeContentIdentifiers
    <公共请求参数>
    
    {
        "Filters": [
            {
                "Name": "content-id",
                "Values": [
                    "eocontent-27q0p0sali16"
                ],
                "Fuzzy": false
            }
        ]
    }

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "RequestId": "3c140219-cfe9-470e-b341-907877d6fb03",
            "ContentIdentifiers": [
                {
                    "ContentId": "eocontent-27q0p0sali16",
                    "Description": "content-test",
                    "PlanId": "edgeone-2ycvs8ml4zpq",
                    "ReferenceCount": 10,
                    "Tags": [
                        {
                            "TagKey": "test",
                            "TagValue": "ct"
                        }
                    ],
                    "CreatedOn": "2023-10-05T15:30:45Z",
                    "ModifiedOn": "2023-10-05T15:30:45Z",
                    "DeletedOn": null,
                    "Status": "active"
                }
            ]
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码