ModifyCensorship

Last updated: 2021-06-04 17:31:37

1. API Description

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

This API is used to enable or disable the cluster operation approval feature.

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 parameter. The value used for this API: ModifyCensorship.
Version Yes String Common parameter. The value used for this API: 2019-08-23.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ClusterId Yes String Cluster ID
Censorship Yes Integer Whether to enable the operation approval feature for this cluster. Valid values: 0 (disable), 1 (enable)
Uins.N No Array of String Approver UIN list

3. Output Parameters

Parameter Name Type Description
ClusterId String Cluster ID
Uins Array of String Approver UIN list
Note: null may be returned for this field, indicating that no valid values can be obtained.
Censorship Integer Whether the operation approval feature is enabled for this cluster. Valid values: 0 (disabled), 1 (enabled)
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Disabling the cluster operation approval feature

Input Example

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

{
    "Uins": [
        "xx"
    ],
    "ClusterId": "xx",
    "Censorship": 0
}

Output Example

{
  "Response": {
    "Uins": [
      "xx"
    ],
    "ClusterId": "xx",
    "RequestId": "xx",
    "Censorship": 0
  }
}

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
AuthFailure CAM signature/authentication error
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.InvalidClusterName Invalid cluster name.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
UnauthorizedOperation Unauthorized operation.