Help Center/ Host Security Service/ API Reference/ API Description/ Baseline Management/ Querying the Password Complexity Policy Detection Report
Updated on 2024-01-31 GMT+08:00

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

User project ID

Minimum: 1

Maximum: 256

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project ID

Minimum: 0

Maximum: 256

host_name

No

String

Server name

Minimum: 0

Maximum: 128

host_ip

No

String

Server IP address

Minimum: 0

Maximum: 128

host_id

No

String

Server ID. If this parameter is not specified, all hosts of a user are queried.

Minimum: 0

Maximum: 128

limit

No

Integer

Number of records displayed on each page. The default value is 10.

Minimum: 0

Maximum: 200

Default: 10

offset

No

Integer

Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

Minimum: 0

Maximum: 2000000

Default: 0

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

x-auth-token

Yes

String

User token. It 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: 1

Maximum: 32768

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Long

Total number of password complexity policies

Minimum: 0

Maximum: 2147483647

data_list

Array of PwdPolicyInfoResponseInfo objects

List of password complexity policy detection

Array Length: 0 - 2147483647

Table 5 PwdPolicyInfoResponseInfo

Parameter

Type

Description

host_id

String

Server ID (displayed when the cursor is placed on a server name)

Minimum: 0

Maximum: 64

host_name

String

Server name

Minimum: 0

Maximum: 256

host_ip

String

Server IP address

Minimum: 0

Maximum: 256

min_length

Boolean

Minimum password length

uppercase_letter

Boolean

Uppercase letter

lowercase_letter

Boolean

Lowercase letter

number

Boolean

Digital

special_character

Boolean

Special characters

suggestion

String

Modification suggestion

Minimum: 0

Maximum: 65534

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

Password complexity policy check report

{
  "total_num" : 1,
  "data_list" : [ {
    "host_id" : "76fa440a-5a08-43fa-ac11-d12183ab3a14",
    "host_ip" : "192.168.0.59",
    "host_name" : "ecs-6b96",
    "lowercase_letter" : false,
    "min_length" : true,
    "number" : false,
    "special_character" : false,
    "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

Password complexity policy check report

Error Codes

See Error Codes.