tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ListClsLogTopics

Last updated: 2023-12-01 16:39:43

    1. API Description

    Domain name for API request: cdn.tencentcloudapi.com.

    This API is used to display the list of log topics. Note: a logset can contain up to 10 log topics.

    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: ListClsLogTopics.
    Version Yes String Common Params. The value used for this API: 2018-06-06.
    Region No String Common Params. This parameter is not required for this API.
    Channel No String Specifies whether to access CDN or ECDN. Valid values: cdn (default) and ecdn.

    3. Output Parameters

    Parameter Name Type Description
    Logset LogSetInfo Information of logsets in the Shanghai region
    Topics Array of TopicInfo Information of log topics in the Shanghai region
    Note: this field may return null, indicating that no valid values can be obtained.
    ExtraLogset Array of ExtraLogset Information on logsets in regions except Shanghai
    Note: this field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the list of log topics

    Input Example

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

{
    "Channel": "cdn"
}

    Output Example

    {
    "Response": {
        "RequestId": "44d5b2d4-092c-4a4a-971e-07d9e536ccc1",
        "Logset": {
            "AppId": 1242424252,
            "Channel": "cdn",
            "Region": "ap-shanghai",
            "LogsetId": "44d5b2d4-092c-4a4a-971e-07d9e536ccc3",
            "LogsetName": "cdn_logset",
            "IsDefault": 1,
            "LogsetSavePeriod": 7,
            "CreateTime": "2020-09-22 00:00:00",
            "RegionEn": "ap-shanghai",
            "Deleted": "no"
        },
        "Topics": [
            {
                "TopicId": "def811bf-867e-405c-bbc2-2a3aea45be21",
                "TopicName": "cdn_topic",
                "Enabled": 1,
                "CreateTime": "2020-09-22 00:00:00",
                "Deleted": "no"
            },
            {
                "TopicId": "e0f6809f-026f-4287-b33f-8041a82188cf",
                "TopicName": "cdn_topic2",
                "Enabled": 1,
                "CreateTime": "2020-09-22 00:00:00",
                "Deleted": "no"
            },
            {
                "TopicId": "fcfb346d-100d-454c-adc6-bdf2a2af0515",
                "TopicName": "cdn_topic1",
                "Enabled": 1,
                "CreateTime": "2020-09-22 00:00:00",
                "Deleted": "no"
            }
        ],
        "ExtraLogset": [
            {
                "Logset": {
                    "AppId": 1306270566,
                    "Channel": "cdn",
                    "LogsetId": "de5965b4-b371-4a5e-86ad-f2d2f9988a4d",
                    "LogsetName": "cloud_cdn_logset_oversea",
                    "IsDefault": 0,
                    "LogsetSavePeriod": 7,
                    "CreateTime": "2021-10-20 17:22:21",
                    "Region": "ap-singapore",
                    "RegionEn": "ap-singapore",
                    "Deleted": "no"
                },
                "Topics": [
                    {
                        "TopicId": "a9619e5a-2387-46bd-83c8-89b133f20f4a",
                        "TopicName": "jory-test",
                        "Enabled": 1,
                        "CreateTime": "2021-10-27 15:17:10",
                        "Deleted": "no",
                        "Channel": "cdn"
                    },
                    {
                        "TopicId": "58474924-8b34-4e26-aa03-b23202007ea6",
                        "TopicName": "jory-oversea",
                        "Enabled": 1,
                        "CreateTime": "2021-10-26 21:06:24",
                        "Deleted": "no",
                        "Channel": "cdn"
                    }
                ]
            }
        ]
    }
}

    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

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InternalError.CamSystemError Authentication system internal error.
    InternalError.CdnDbError Internal data error. Please submit a ticket for troubleshooting.
    InternalError.CdnSystemError System error. Please submit a ticket for troubleshooting.
    InternalError.ClsInternalError CLS internal error.
    InternalError.InvalidErrorCode Service internal error. Please submit a ticket for troubleshooting.
    InternalError.ProxyServer Internal service error. Please submit a ticket for troubleshooting.
    InvalidParameter.CdnClsDuplicateTopic A duplicate topic is found.
    InvalidParameter.CdnClsTopicNotExist The CLS topic does not exist.
    InvalidParameter.CdnParamError Parameter error. Please see the sample parameters in the documentation.
    InvalidParameter.ClsIndexConflict Index conflict.
    InvalidParameter.ClsIndexRuleEmpty The index rule is empty.
    InvalidParameter.ClsInvalidContent Invalid content.
    InvalidParameter.ClsInvalidContentType Invalid Content-Type.
    InvalidParameter.ClsLogsetConflict Logset conflict.
    InvalidParameter.ClsLogsetEmpty The logset is empty.
    InvalidParameter.ClsLogsetNotEmpty The logset is not empty.
    InvalidParameter.ClsMissingAuthorization No authorization information.
    InvalidParameter.ClsMissingContent Lost content.
    InvalidParameter.ClsSyntaxError Syntax error.
    InvalidParameter.ClsTopicClosed The topic has been closed.
    InvalidParameter.ClsTopicConflict Topic conflict.
    LimitExceeded.CdnClsTooManyTopics This account has created too many topics.
    LimitExceeded.ClsLogSizeExceed The log size exceeds the limit.
    LimitExceeded.ClsLogsetExceed The number of logsets exceeds the limit.
    LimitExceeded.ClsTopicExceed The number of topics exceeds the limit.
    ResourceNotFound.CdnUserNotExists The CDN service has not been activated. Please activate it first before using this API.
    ResourceNotFound.ClsIndexNotExist The index does not exist.
    ResourceNotFound.ClsLogsetNotExist The logset does not exist.
    ResourceNotFound.ClsTopicNotExist The topic does not exist.
    UnauthorizedOperation.CdnCamUnauthorized No CAM policy is configured for the sub-account.
    UnauthorizedOperation.CdnClsNotRegistered This account is not authorized to activate CLS.
    UnauthorizedOperation.CdnUserIsSuspended The CDN service has been suspended. Please restart it and try again.
    UnauthorizedOperation.ClsInvalidAuthorization Invalid authorization.
    UnauthorizedOperation.ClsServiceNotActivated You have not activated CLS service. Please activate it in the CLS console first.
    UnauthorizedOperation.ClsUnauthorized Authorization failed.
    UnauthorizedOperation.OperationTooOften Too many calling attempts.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy