tencent cloud

All product documents
Tencent Cloud EdgeOne
DocumentationTencent Cloud EdgeOneAPI DocumentationContent Identifier APIsDescribeContentIdentifiers
DescribeContentIdentifiers
Download PDF
Last updated: 2025-02-19 19:34:35
DescribeContentIdentifiers
Last updated: 2025-02-19 19:34:35
Download PDF

1. API Description

Domain name for API request: teo.intl.tencentcloudapi.com.

Batch query content identifiers, which can be filtered by ID, description, status, or Tag. Deleted content identifiers queried by status are retained for only three months. This feature is only open to the allowlist.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeContentIdentifiers.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region No String Common Params. This parameter is not required.
Offset No Integer The offset of paginated query. default value: 0.
Limit No Integer Limit on paginated queries. default value: 20. maximum value: 100.
Filters.N No Array of AdvancedFilter Filter conditions. the upper limit for filters is 20, and the upper limit for filters.values is 20. if this parameter is not filled in, the content identifiers with permissions under the current appid are returned by default. detailed filtering conditions are as follows:
  • description: filter by content identifier description in batches; for example: test;
  • content-id: filter by content identifier id in batches; for example: eocontent-2noz78a8ev6k;
  • tag-key: filter by Tag key;
  • tag-value: filter by Tag value;
  • status: filter by content identifier status. valid values: active: active; deleted: deleted.
    • only description supports fuzzy query, other fields require precise query.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of content identifiers that meet the filter conditions.
    ContentIdentifiers Array of ContentIdentifier Detailed content identifier list.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying Content Identifier Information

    This example shows you how to query content identifiers by specifying an ID.

    Input Example

    POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeContentIdentifiers
<Common request parameters>

{
    "Filters": [
        {
            "Name": "content-id",
            "Values": [
                "eocontent-27q0p0sali16"
            ],
            "Fuzzy": false
        }
    ]
}

    Output Example

    {
    "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. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback

    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

    Submit a Ticket
    7x24 Phone Support
    Hong Kong, China
    +852 800 906 020 (Toll Free)
    United States
    +1 844 606 0804 (Toll Free)
    United Kingdom
    +44 808 196 4551 (Toll Free)
    Canada
    +1 888 605 7930 (Toll Free)
    Australia
    +61 1300 986 386 (Toll Free)
    EdgeOne hotline
    +852 300 80699
    More local hotlines coming soon