查询账号登录策略
功能介绍
该接口可以用于查询账号登录策略。
URI
GET /v5/login-policy
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
login_policy |
LoginPolicy object |
登录策略。 |
参数 |
参数类型 |
描述 |
---|---|---|
user_validity_period |
Integer |
如果IAM用户在该值设置的有效期(天)内未登录,则被停用,不适用于根用户。 |
custom_info_for_login |
String |
登录提示信息。 |
lockout_duration |
Integer |
IAM用户登录锁定时长(分钟)。 |
login_failed_times |
Integer |
限定时间内登录失败次数。 |
period_with_login_failures |
Integer |
限定时间长度(分钟)。 |
session_timeout |
Integer |
登录会话失效时间。 |
show_recent_login_info |
Boolean |
是否显示最近一次的登录信息。 |
allow_address_netmasks |
Array of AllowAddressNetmask objects |
允许访问的IP地址或网段。 |
allow_ip_ranges |
Array of AllowIpRange objects |
允许访问的IP地址区间。 |
参数 |
参数类型 |
描述 |
---|---|---|
address_netmask |
String |
IP地址或网段,例如"192.168.0.1/24"。 最大长度:50 |
description |
String |
描述信息,不能包含特定字符"@"、"#"、"%"、"&"、"<"、">"、"\"、"$"、"^"和"*"的字符串。 最大长度:255 |
参数 |
参数类型 |
描述 |
---|---|---|
ip_range |
String |
IP地址区间,例如"0.0.0.0-255.255.255.255"。 最大长度:50 |
description |
String |
描述信息,不能包含特定字符"@"、"#"、"%"、"&"、"<"、">"、"\"、"$"、"^"和"*"的字符串。 最大长度:255 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误信息。 |
request_id |
String |
请求ID。 |
encoded_authorization_message |
String |
加密后的认证失败信息,可以通过STS5解密接口进行解密。 |
请求示例
查询账号登录策略。
GET https://{endpoint}/v5/login-policy
响应示例
状态码:200
请求成功。
{ "login_policy" : { "user_validity_period" : 0, "custom_info_for_login" : "info", "lockout_duration" : 15, "login_failed_times" : 5, "period_with_login_failures" : 15, "session_timeout" : 60, "show_recent_login_info" : false, "allow_address_netmasks" : [ { "address_netmask" : "192.168.0.1/24", "description" : "description" } ], "allow_ip_ranges" : [ { "ip_range" : "0.0.0.0-255.255.255.255", "description" : "description" } ] } }
状态码
状态码 |
描述 |
---|---|
200 |
请求成功。 |
403 |
没有操作权限。 |
错误码
请参见错误码。