DescribeClusterPasswordComplexity

最后更新时间：2025-11-13 20:51:30

DescribeClusterPasswordComplexity

最后更新时间： 2025-11-13 20:51:30

1. API Description

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

This API is used to view the cluster password complexity details.

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: DescribeClusterPasswordComplexity.
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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
ClusterId	Yes	String	Cluster ID

3. Output Parameters

Parameter Name	Type	Description
ValidatePasswordDictionary	ParamInfo	Data dictionary parameter.
ValidatePasswordLength	ParamInfo	Specifies the password length.
ValidatePasswordMixedCaseCount	ParamInfo	Case-Sensitive character count.
ValidatePasswordNumberCount	ParamInfo	Number of digits.
ValidatePasswordPolicy	ParamInfo	Password level.
ValidatePasswordSpecialCharCount	ParamInfo	Number of special characters.
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 View Cluster Password Complexity Details

Input Example

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

{
    "ClusterId": "cynosdbmysql-mwg7212w"
}

Output Example

{
    "Response": {
        "RequestId": "7651f1c0-3429-11ef-81fc-6fec1c9e2c66",
        "ValidatePasswordDictionary": {
            "CurrentValue": "",
            "Default": "",
            "Description": "The dictionary words that validate_password uses for checking passwords.",
            "EnumValue": [],
            "Func": "",
            "FuncPattern": "",
            "IsFunc": false,
            "IsGlobal": 0,
            "MatchType": "",
            "MatchValue": "",
            "Max": "0",
            "Min": "0",
            "ModifiableInfo": {
                "IsModifiable": 0
            },
            "NeedReboot": 0,
            "ParamName": "validate_password_txsql_dictionary",
            "ParamType": "string"
        },
        "ValidatePasswordLength": {
            "CurrentValue": "0",
            "Default": "8",
            "Description": "The minimum number of characters that validate_password requires passwords to have.",
            "EnumValue": [],
            "Func": "",
            "FuncPattern": "",
            "IsFunc": false,
            "IsGlobal": 0,
            "MatchType": "",
            "MatchValue": "",
            "Max": "256",
            "Min": "8",
            "ModifiableInfo": {
                "IsModifiable": 0
            },
            "NeedReboot": 0,
            "ParamName": "validate_password_length",
            "ParamType": "integer"
        },
        "ValidatePasswordMixedCaseCount": {
            "CurrentValue": "0",
            "Default": "1",
            "Description": "The minimum number of lowercase and uppercase characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger.",
            "EnumValue": [],
            "Func": "",
            "FuncPattern": "",
            "IsFunc": false,
            "IsGlobal": 0,
            "MatchType": "",
            "MatchValue": "",
            "Max": "50",
            "Min": "1",
            "ModifiableInfo": {
                "IsModifiable": 0
            },
            "NeedReboot": 0,
            "ParamName": "validate_password_mixed_case_count",
            "ParamType": "integer"
        },
        "ValidatePasswordNumberCount": {
            "CurrentValue": "0",
            "Default": "1",
            "Description": "The minimum number of numeric (digit) characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger. ",
            "EnumValue": [],
            "Func": "",
            "FuncPattern": "",
            "IsFunc": false,
            "IsGlobal": 0,
            "MatchType": "",
            "MatchValue": "",
            "Max": "50",
            "Min": "1",
            "ModifiableInfo": {
                "IsModifiable": 0
            },
            "NeedReboot": 0,
            "ParamName": "validate_password_number_count",
            "ParamType": "integer"
        },
        "ValidatePasswordPolicy": {
            "CurrentValue": "LOW",
            "Default": "MEDIUM",
            "Description": "The password policy enforced by validate_password.",
            "EnumValue": [
                "MEDIUM",
                "STRONG"
            ],
            "Func": "",
            "FuncPattern": "",
            "IsFunc": false,
            "IsGlobal": 0,
            "MatchType": "",
            "MatchValue": "",
            "Max": "2",
            "Min": "0",
            "ModifiableInfo": {
                "IsModifiable": 0
            },
            "NeedReboot": 0,
            "ParamName": "validate_password_policy",
            "ParamType": "enum"
        },
        "ValidatePasswordSpecialCharCount": {
            "CurrentValue": "0",
            "Default": "1",
            "Description": "The minimum number of nonalphanumeric characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger. ",
            "EnumValue": [],
            "Func": "",
            "FuncPattern": "",
            "IsFunc": false,
            "IsGlobal": 0,
            "MatchType": "",
            "MatchValue": "",
            "Max": "50",
            "Min": "1",
            "ModifiableInfo": {
                "IsModifiable": 0
            },
            "NeedReboot": 0,
            "ParamName": "validate_password_special_char_count",
            "ParamType": "integer"
        }
    }
}

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
FailedOperation.GetOssInfoError	Failed to query the details of a read-write instance
FailedOperation.OperationFailedError	Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.DbOperationFailed	Failed to query the database.
OperationDenied.ClusterOpNotAllowedError	The current cluster does not allow the operation.
OperationDenied.InstanceStatusDeniedError	For the instance 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.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud