ListAccessKeys - 获取访问密钥列表--访问控制-火山引擎

文档中心

立即注册

导航

ListAccessKeys - 获取访问密钥列表

最近更新时间：2024.09.14 14:54:46首次发布时间：2021.02.23 10:42:32

获取主账号或IAM用户的密钥列表。因安全原因，该接口不返回Secret Access Key，请在首次创建密钥时保存好Secret Access Key。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListAccessKeys	要执行的操作，取值：ListAccessKeys。
Version	String	是	2018-01-01	API的版本，取值：2018-01-01。
UserName	String	否	Bob	用户名。用于获取指定IAM用户的密钥列表，未指定用户名时则获取当前请求身份的密钥列表（即主账号请求时获取主账号自身的密钥列表，IAM用户请求时获取IAM用户自身的密钥列表。注意：角色无法持有密钥，因此角色请求时，必须传递UserName以获取指定IAM用户的密钥列表）。当IAM用户拥有密钥自管理权限时（AccessKeySelfManageAccess），如需获取自身的密钥则需要在请求中传递自身的UserName。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
AccessKeyMetadata	Array of Object	请参考数据结构内具体参数示例值。	密钥列表中的密钥的数据结构。因安全原因，不包含Secret Access Key，请在首次创建密钥时保存好Secret Access Key。

请求示例

GET /?Action=ListAccessKeys&Version=2018-01-01 HTTP/1.1
Host: iam.volcengineapi.com
X-Date: 20240912T115911Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240912/cn-beijing/iam/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240912195918128095224216B0AAEF",
    "Action": "ListAccessKeys",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  },
  "Result": {
    "AccessKeyMetadata": [
      {
        "AccessKeyId": "AKLTZjIwYzBjYzczNWQ4NDkwN******3NzViZTgzZDAxYjE",
        "UserName": "Bob",
        "Status": "active",
        "UpdateDate": "20240912T113532Z",
        "CreateDate": "20240912T113532Z"
      }
    ]
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。