Querying the Weak Password Detection Result List
Function
This API is used to query the list of weak password detection results.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/baseline/weak-password-users
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. Minimum: 20 Maximum: 64 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. Minimum: 0 Maximum: 64 |
host_name |
No |
String |
Server name Minimum: 0 Maximum: 256 |
host_ip |
No |
String |
Server IP address Minimum: 0 Maximum: 256 |
user_name |
No |
String |
Name of the account using a weak password Minimum: 0 Maximum: 32 |
host_id |
No |
String |
Host ID. If this parameter is not specified, all hosts of a user are queried. Minimum: 0 Maximum: 64 |
limit |
No |
Integer |
Number of records on each page Minimum: 0 Maximum: 200 Default: 10 |
offset |
No |
Integer |
Offset, which specifies the start position of the record to be returned. Minimum: 0 Maximum: 2000000 Default: 0 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token, which can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Minimum: 32 Maximum: 2097152 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Long |
Total weak passwords Minimum: 0 Maximum: 2147483647 |
data_list |
Array of WeakPwdListInfoResponseInfo objects |
Weak password list Array Length: 0 - 2147483647 |
Parameter |
Type |
Description |
---|---|---|
host_id |
String |
Host ID Minimum: 0 Maximum: 64 |
host_name |
String |
Server name Minimum: 0 Maximum: 256 |
host_ip |
String |
Server IP address (private IP address). This field is not deleted for compatibility with users. Minimum: 0 Maximum: 256 |
private_ip |
String |
Server private IP address Minimum: 0 Maximum: 256 |
public_ip |
String |
Server public IP address Minimum: 0 Maximum: 256 |
weak_pwd_accounts |
Array of WeakPwdAccountInfoResponseInfo objects |
List of accounts with weak passwords Array Length: 0 - 2147483647 |
Parameter |
Type |
Description |
---|---|---|
user_name |
String |
Name of accounts with weak passwords Minimum: 0 Maximum: 32 |
service_type |
String |
Account type. The options are as follows:
Minimum: 0 Maximum: 32 |
duration |
Integer |
Validity period of a weak password, in days. Minimum: 0 Maximum: 2147483647 |
Example Requests
Query the weak password of servers 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/weak-password-users?enterprise_project_id=xxx
Example Responses
Status code: 200
Weak password check result
{ "total_num" : 2, "data_list" : [ { "host_id" : "caa958adxxxxxxa481", "host_name" : "ubuntu1", "host_ip" : "192.168.0.8", "private_ip" : "192.168.0.8", "public_ip" : "100.85.85.85", "weak_pwd_accounts" : [ { "user_name" : "localhost1", "service_type" : "system", "duration" : 2147483647 } ] }, { "host_id" : "caa958adxxxxxxa482", "host_name" : "ubuntu2", "host_ip" : "192.168.0.9", "private_ip" : "192.168.0.8", "public_ip" : "", "weak_pwd_accounts" : [ { "user_name" : "localhost2", "service_type" : "system", "duration" : 2147483647 } ] } ] }
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 48 49 50 51 52 |
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 ListWeakPasswordUsersSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListWeakPasswordUsersRequest request = new ListWeakPasswordUsersRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withHostName("<host_name>"); request.withHostIp("<host_ip>"); request.withUserName("<user_name>"); request.withHostId("<host_id>"); request.withLimit(<limit>); request.withOffset(<offset>); try { ListWeakPasswordUsersResponse response = client.listWeakPasswordUsers(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 32 33 34 35 36 37 |
# 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"] credentials = BasicCredentials(ak, sk) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListWeakPasswordUsersRequest() request.enterprise_project_id = "<enterprise_project_id>" request.host_name = "<host_name>" request.host_ip = "<host_ip>" request.user_name = "<user_name>" request.host_id = "<host_id>" request.limit = <limit> request.offset = <offset> response = client.list_weak_password_users(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 38 39 40 41 42 43 44 45 46 47 48 49 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListWeakPasswordUsersRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest hostNameRequest:= "<host_name>" request.HostName = &hostNameRequest hostIpRequest:= "<host_ip>" request.HostIp = &hostIpRequest userNameRequest:= "<user_name>" request.UserName = &userNameRequest hostIdRequest:= "<host_id>" request.HostId = &hostIdRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest response, err := client.ListWeakPasswordUsers(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 |
Weak password check result |
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