tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

AddCLSTopicDomains

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

    1. API Description

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

    This API is used to add one or more domains to a specified log topic.

    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: AddCLSTopicDomains.
    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.
    LogsetId Yes String Logset ID
    TopicId Yes String Log topic ID
    DomainAreaConfigs.N Yes Array of DomainAreaConfig Region configuration for domains
    Channel No String Specifies whether to access CDN or ECDN. Valid values: cdn (default) and ecdn.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Adding one or more domains to a specified log topic

    Input Example

    https://cdn.tencentcloudapi.com/?Action=AddCLSTopicDomains
&LogsetId=6d04373b-ba59-4a4f-a96e-9fe53b59a536
&TopicId=d2256449-c6ff-421b-93ef-aa3a7dde2de2
&DomainAreaConfigs.0.Domain=a.b.com
&DomainAreaConfigs.0.Area.0=mainland
&DomainAreaConfigs.0.Area.1=overseas
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "57460798-8723-45e3-9c75-a0599ef9143a"
    }
}

    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.CdnConfigError Failed to update the domain name configuration.
    InternalError.CdnDbError Internal data error. Please submit a ticket for troubleshooting.
    InternalError.ClsInternalError CLS internal error.
    InternalError.RouteError Internal service error. Please submit a ticket for troubleshooting.
    InvalidParameter.CdnClsDuplicateTopic A duplicate topic is found.
    InvalidParameter.CdnClsTopicNameInvalid Invalid topic name.
    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.ClsInvalidParam Parameter error. Please check and try again.
    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.CdnHostNotExists Unable to find the domain name. Please make sure the domain name is correct.
    ResourceNotFound.ClsIndexNotExist The index does not exist.
    ResourceNotFound.ClsLogsetNotExist The logset does not exist.
    ResourceNotFound.ClsTopicNotExist The topic does not exist.
    UnauthorizedOperation.CdnClsNotRegistered This account is not authorized to activate CLS.
    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.
    UnsupportedOperation.ClsNotAllowed The operation is not allowed.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy