tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeClusterPasswordComplexity

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

1. API Description

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

This API is used to query the details of 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: 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.
ClusterId Yes String Cluster ID

3. Output Parameters

Parameter Name Type Description
ValidatePasswordDictionary ParamInfo Data dictionary parameter Note: This field may return null, indicating that no valid values can be obtained.
ValidatePasswordLength ParamInfo The length of the password Note: This field may return null, indicating that no valid values can be obtained.
ValidatePasswordMixedCaseCount ParamInfo Number of case-sensitive characters Note: This field may return null, indicating that no valid values can be obtained.
ValidatePasswordNumberCount ParamInfo Number of digits Note: This field may return null, indicating that no valid values can be obtained.
ValidatePasswordPolicy ParamInfo Password level Note: This field may return null, indicating that no valid values can be obtained.
ValidatePasswordSpecialCharCount ParamInfo Number of symbols Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the details of password complexity for a cluster

Input Example

https://cynosdb.tencentcloudapi.com/?Action=DescribeAccountPrivileges&ClusterId=cynosdbmysql-xxxxxxxx&Host=xxx&AccountName=xxx&Db=xxx&Type=table&TableName=xx&<common request parameters>cynosdbmysql-bzxxrmtq"}

Output Example

{    "Response": {        "RequestId": "7613eed6-5eb5-4d17-ae69-dd93c44d7ad4",        "ValidatePasswordDictionary": {            "CurrentValue": "",            "Default": "",            "Description": "The dictionary words that validate_password uses for checking passwords.",            "EnumValue": [],            "IsGlobal": 0,            "MatchType": "",            "MatchValue": "",            "Max": "0",            "Min": "0",            "ModifiableInfo": {},            "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": [],            "IsGlobal": 0,            "MatchType": "",            "MatchValue": "",            "Max": "256",            "Min": "8",            "ModifiableInfo": {},            "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": [],            "IsGlobal": 0,            "MatchType": "",            "MatchValue": "",            "Max": "50",            "Min": "1",            "ModifiableInfo": {},            "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": [],            "IsGlobal": 0,            "MatchType": "",            "MatchValue": "",            "Max": "50",            "Min": "1",            "ModifiableInfo": {},            "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"            ],            "IsGlobal": 0,            "MatchType": "",            "MatchValue": "",            "Max": "2",            "Min": "0",            "ModifiableInfo": {},            "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. "The minimum number of nonalphanumeric characters that validate_password requires passwords to have if the password policy is MEDIUM or stronger. "",            "MatchValue": "",            "Max": "50",            "Min": "1",            "ModifiableInfo": {},            "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

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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy