查询口令复杂度策略检测报告 - ListPasswordComplexity
功能介绍
查询口令复杂度策略检测报告
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/baseline/password-complexity
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
|
host_name |
否 |
String |
参数解释: 服务器名称 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 0 |
|
host_ip |
否 |
String |
参数解释: 服务器IP地址 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 0 |
|
host_id |
否 |
String |
参数解释: 主机id,不赋值时,查租户所有主机 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 0 |
|
result_type |
否 |
String |
参数解释: 结果类型 约束限制: 不涉及 取值范围:
默认取值: unhandled |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
offset |
否 |
Integer |
参数解释: 偏移量:指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0,最大值2000000 默认取值: 默认为0 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Long |
参数解释: 记录总数 取值范围: 不涉及 |
|
data_list |
Array of PwdPolicyInfoResponseInfo objects |
参数解释: 口令复杂度策略检测列表 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
host_id |
String |
参数解释: 主机id 取值范围: 不涉及 |
|
host_name |
String |
参数解释: 服务器名称 取值范围: 不涉及 |
|
host_ip |
String |
参数解释: 服务器IP(私有IP),为兼容用户使用,不删除此字段 取值范围: 不涉及 |
|
private_ip |
String |
参数解释: 服务器私有IP 取值范围: 不涉及 |
|
public_ip |
String |
参数解释: 服务器公网IP 取值范围: 不涉及 |
|
min_length |
Boolean |
参数解释: 口令最小长度的设置是否符合要求 取值范围:
|
|
uppercase_letter |
Boolean |
参数解释: 大写字母的设置是否符合要求 取值范围:
|
|
lowercase_letter |
Boolean |
参数解释: 小写字母的设置是否符合要求 取值范围:
|
|
number |
Boolean |
参数解释: 数字的设置是否符合要求,符合为true,不符合为false 取值范围:
|
|
special_character |
Boolean |
参数解释: 特殊字符的设置是否符合要求,符合为true,不符合为false 取值范围:
|
|
min_length_num |
Integer |
参数解释: 复杂口令策略中定义的口令最小长度 取值范围: 8 - 26 |
|
min_uppercase_letter |
Integer |
参数解释: 复杂口令策略中定义的最少包含的大写字母数 取值范围: 0 - 10 |
|
min_lowercase_letter |
Integer |
参数解释: 复杂口令策略中定义的最少包含的小写字母数 取值范围: 0 - 10 |
|
min_number |
Integer |
参数解释: 复杂口令策略中定义的最少包含的数字数 取值范围: 0 - 10 |
|
min_special_character |
Integer |
参数解释: 复杂口令策略中定义的最少包含的特殊字母数 取值范围: 0 - 10 |
|
update_time |
Long |
参数解释: 最近扫描时间 取值范围: 不涉及 |
|
suggestion |
String |
参数解释: 修改建议 取值范围: 不涉及 |
请求示例
查询企业项目id为xxx下的主机口令复杂度检测结果。默认返回第一页(前10条)数据。
GET https://{endpoint}/v5/{project_id}/baseline/password-complexity?enterprise_project_id=xxx
响应示例
状态码:200
请求已成功
{
"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
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。