tencent cloud

APIs

ModifyClusterDefendStatus

Download
Focus Mode
Font Size
Last updated: 2026-09-01 10:02:57

1. API Description

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

Modify the cluster protection status.

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: ModifyClusterDefendStatus.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
DefendStatus Yes Boolean

Protection switch

UnbindHostLicense No Boolean Whether to unbind the host License under the cluster when disabling protection
Enumeration values:
true: synchronously unbind host authorization from all nodes in a cluster
false: only stop container fees, nodes retain CWP protection
Default value: false.
Supplementary description: This parameter is valid only when DefendStatus=false (protection disabled).
OperatedMemberId.N No Array of String Member ID of the Called Group Account
MemberId.N No Array of String

Group account member id.

ClusterCaMD5List.N No Array of String

Cluster ca certificate md5 value, the unique identifier of the cluster

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 1

Input Example

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

{
    "DefendStatus": true,
    "ClusterCaMD5List": [
        "af9570*********b57b**d475974a859"
    ]
}

Output Example

{
    "Response": {
        "RequestId": "83d6bf79-ff89-4f23-9fb4-a58108fb4aad"
    }
}

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 Internal error.
InvalidParameter Parameter error.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback