Querying the Password Complexity Policy Detection Report

Function

This API is used to query the password complexity policy detection report.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/baseline/password-complexity

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
host_name	No	String	Definition Server name. Constraints N/A Range The value can contain 0 to 128 characters. Default Value 0
host_ip	No	String	Definition Server IP address. Constraints N/A Range The value can contain 0 to 128 characters. Default Value 0
host_id	No	String	Definition Server ID. If this parameter is not specified, all the servers of the user are queried. Constraints N/A Range The value can contain 0 to 128 characters. Default Value 0
result_type	No	String	Definition Result type. Constraints N/A Range unhandled ignored Default Value unhandled
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Long	Definition Total number of records. Range N/A
data_list	Array of PwdPolicyInfoResponseInfo objects	Definition List of password complexity policy detection. Range N/A

**Table 5** PwdPolicyInfoResponseInfo
Parameter	Type	Description
host_id	String	Definition Server ID. Range N/A
host_name	String	Definition Server name. Range N/A
host_ip	String	Definition Server IP address (private IP address). This field is retained for compatibility purposes. Range N/A
private_ip	String	Definition Server private IP address. Range N/A
public_ip	String	Definition Server EIP. Range N/A
min_length	Boolean	Definition Whether the minimum password length meets the requirement. Range true: It meets the requirement. false: It does not meet the requirement.
uppercase_letter	Boolean	Definition Whether the uppercase letter setting meets the requirement. Range true: It meets the requirement. false: It does not meet the requirement.
lowercase_letter	Boolean	Definition Whether the lowercase letter setting meets the requirement. Range true: It meets the requirement. false: It does not meet the requirement.
number	Boolean	Definition Whether the number setting meets requirements. If it does, the value is true. If it does not, the value is false. Range true: It meets the requirement. false: It does not meet the requirement.
special_character	Boolean	Definition Whether the special character setting meets requirements. If it does, the value is true. If it does not, the value is false. Range true: It meets the requirement. false: It does not meet the requirement.
min_length_num	Integer	Definition Minimum length of a password defined in the password complexity policy. Range 8 - 26
min_uppercase_letter	Integer	Definition Minimum number of uppercase letters defined in the password complexity policy. Range 0 - 10
min_lowercase_letter	Integer	Definition Minimum number of lowercase letters defined in the password complexity policy. Range 0 - 10
min_number	Integer	Definition Minimum number of numbers defined in the password complexity policy. Range 0 - 10
min_special_character	Integer	Definition Minimum number of special characters defined in the password complexity policy. Range 0 - 10
update_time	Long	Definition Last scan time. Range N/A
suggestion	String	Definition Modification suggestion. Range N/A

Example Requests

Query the password complexity of the server whose enterprise project ID is xxx. Data on the first page (the first 10 records) is returned by default.

GET https://{endpoint}/v5/{project_id}/baseline/password-complexity?enterprise_project_id=xxx

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "host_id" : "76fa440a-5a08-43fa-ac11-d12183ab3a14",
    "host_ip" : "192.168.0.59",
    "private_ip" : "192.168.0.8",
    "public_ip" : "100.85.85.85",
    "host_name" : "ecs-6b96",
    "lowercase_letter" : false,
    "min_length" : true,
    "number" : false,
    "special_character" : false,
    "update_time" : 0,
    "suggestion" : "The password should contain at least 3 of the following character types: uppercase letters, lowercase letters, digits, and special characters. ",
    "uppercase_letter" : false
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Baseline Management

Previous topic: Ignoring or Unignoring Servers that Fail the Password Complexity Check

Next topic: Exploring Policy Group Check Items

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot