列举全部MFA设备 - ListMfaDevicesV5

功能介绍

该接口可以用于列举全部MFA设备。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
iam:mfa:listMFADevicesV5	List	mfa *	-	-	-

URI

GET /v5/mfa-devices

表1 Query参数
参数	是否必选	参数类型	描述
user_id	否	String	IAM用户ID。
limit	否	Integer	每页显示的条目数量，范围为1到200条，默认为100条。最小值：1 最大值：200 缺省值：100
marker	否	String	分页标记，长度为4到400个字符，只包含字母、数字、"+"、"/"、"="、"-"和"_"的字符串。最小长度：4 最大长度：400

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
mfa_devices	Array of MfaDeviceMetadata objects	虚拟MFA设备列表。
page_info	PageInfo object	分页信息。

表3 MfaDeviceMetadata
参数	参数类型	描述
serial_number	String	MFA设备序列号。
user_id	String	IAM用户ID。
enabled	Boolean	虚拟MFA设备是否开启。

表4 PageInfo
参数	参数类型	描述
next_marker	String	如果存在，则表示还有后续的条目未显示在当前返回体中。请使用该值作为下一次请求的分页标记参数以获得下一页信息。请反复调用该接口直至该字段不存在。
current_count	Integer	本页返回条目数量。

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误信息。

状态码：403

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误信息。
request_id	String	请求ID。
encoded_authorization_message	String	加密后的认证失败信息，可以通过STS5解密接口进行解密。

请求示例

列举全部MFA设备。
```
GET https://{endpoint}/v5/mfa-devices
```

列举IAM用户xxx的全部MFA设备。

GET https://{endpoint}/v5/mfa-devices?user_id=xxx

响应示例

状态码：200

请求成功。

{
  "mfa_devices" : [ {
    "serial_number" : "iam::accountid:mfa:name",
    "user_id" : "xxx",
    "enabled" : true
  } ],
  "page_info" : {
    "next_marker" : "marker",
    "current_count" : 1
  }
}