Querying the Password Complexity Policy Detection Report
Function
This API is used to query the password complexity policy detection report.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/baseline/password-complexity
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 |
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
Default Value unhandled |
limit |
No |
Integer |
Parameter description: Number of records displayed on each page. Constraints: N/A Options: 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
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
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 |
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
|
uppercase_letter |
Boolean |
Definition Whether the uppercase letter setting meets the requirement. Range
|
lowercase_letter |
Boolean |
Definition Whether the lowercase letter setting meets the requirement. Range
|
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
|
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
|
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 } ] }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ListPasswordComplexitySolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListPasswordComplexityRequest request = new ListPasswordComplexityRequest(); try { ListPasswordComplexityResponse response = client.listPasswordComplexity(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListPasswordComplexityRequest() response = client.list_password_complexity(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListPasswordComplexityRequest{} response, err := client.ListPasswordComplexity(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot