tencent cloud

Feedback

OpenClusterPasswordComplexity

Last updated: 2023-08-23 14:23:00

1. API Description

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

This API is used to enable the password complexity for a cluster.

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: OpenClusterPasswordComplexity.
Version Yes String Common Params. The value used for this API: 2019-01-07.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ClusterId Yes String Cluster ID
ValidatePasswordLength Yes Integer Password length
ValidatePasswordMixedCaseCount Yes Integer Number of letters
ValidatePasswordSpecialCharCount Yes Integer Number of symbols
ValidatePasswordNumberCount Yes Integer Number of digits
ValidatePasswordPolicy Yes String Password strength. Valid values: MEDIUM, STRONG.
ValidatePasswordDictionary.N No Array of String Data dictionary

3. Output Parameters

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

4. Example

Example1 Enabling the password complexity for a cluster

Input Example

POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: OpenClusterPasswordComplexity<common request parameters>{    "ValidatePasswordLength": 0,    "ValidatePasswordMixedCaseCount": 0,    "ValidatePasswordDictionary": [        "admin"    ],    "ClusterId": "cynosdbmysql-abcdxxxx",    "ValidatePasswordNumberCount": 0,    "ValidatePasswordSpecialCharCount": 0,    "ValidatePasswordPolicy": "MEDIUM"}

Output Example

{
    "Response": {
        "RequestId": "128046",
        "FlowId": "123"
    }
}

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
FailedOperation.OperationFailedError Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.DbOperationFailed Failed to query the database.
InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
OperationDenied.ClusterStatusDeniedError For the cluster in this status, the operation is not allowed.
OperationDenied.ServerlessClusterStatusDenied For the serverless cluster in this status, the operation is not allowed.
ResourceNotFound.ClusterNotFoundError The cluster does not exist.
ResourceUnavailable.InstanceLockFail Failed to lock the instance, so the operation cannot be performed temporarily.
ResourceUnavailable.InstanceStatusAbnormal The instance is exceptional, so the operation cannot be performed temporarily.
UnauthorizedOperation.PermissionDenied CAM authentication failed.