DisableClsLogTopic

Download PDF

Last updated: 2024-12-05 15:38:31

DisableClsLogTopic

Last updated: 2024-12-05 15:38:31

Download PDF

1. API Description

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

This API is used to stop publishing to a log topic. Note: after a log topic is disabled, all logs of the domain names bound to it will no longer be published to the topic, and the logs that have already been published will be retained. This action will take effect within 5–15 minutes.

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: DisableClsLogTopic.
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
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, 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 Stopping publishing to a log topic

Input Example

https://cdn.intl.tencentcloudapi.com/?Action=DisableClsLogTopic
&Channel=cdn
&LogsetId=6d04373b-ba59-4a4f-a96e-9fe53b59a536
&TopicId=d2256449-c6ff-421b-93ef-aa3a7dde2de2
&<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

Tencent Cloud CLI 3.0

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.CdnDbError	Internal data error. Please submit a ticket for troubleshooting.
InternalError.ClsInternalError	CLS internal error.
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.ClsInvalidAuthorization	Invalid authorization.
UnauthorizedOperation.ClsUnauthorized	Authorization failed.
UnauthorizedOperation.OperationTooOften	Too many calling attempts.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud