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

文档中心

访问控制

API Key

ListApiKeys - 获取 API 密钥列表

获取主账号或 IAM 用户的 API 密钥列表。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListApiKeys	要执行的操作，取值：ListApiKeys。
Version	String	是	2018-01-01	API的版本，取值：2018-01-01。
UserName	String	否	Bob	用户名。用于获取指定 IAM 用户的 API 密钥列表，未指定用户名时则获取当前请求身份的 API 密钥列表（即主账号请求时获取主账号自身的 API 密钥列表，IAM 用户请求时获取 IAM 用户自身的 API 密钥列表。注意：角色无法持有 API 密钥，因此角色请求时，必须传递 UserName 以获取指定 IAM 用户的 API 密钥列表）。
Limit	Integer	否	50	每页返回的最大记录数。
Offset	Integer	否	0	分页偏移量。

返回参数

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

参数	类型	示例值	描述
Total	Integer	1	API 密钥总数。
ApiKeys	Array of Object	请参考数据结构内具体参数示例值。	API 密钥列表。

请求示例

GET /?Action=ListApiKeys&Version=2018-01-01&UserName=Bob&Limit=50&Offset=0 HTTP/1.1
Host: iam.volcengineapi.com
X-Date: 20260314T054845Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260314/cn-beijing/iam/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20260314054845010225146063063CE58B",
    "Action": "ListApiKeys",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  },
  "Result": {
    "Total": 1,
    "ApiKeys": [
      {
        "Name": "my-api-key",
        "Id": "Ab3kX9mN******vQ",
        "Status": "active",
        "CreateDate": "20260314T054045Z",
        "UpdateDate": "20260314T054045Z"
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The parameter '%s' in request is invalid, error: %v.	无效参数！
404	UserNotExist	User '%s' does not exist.	用户不存在。

最近更新时间：2026.06.24 17:25:07

这个页面对您有帮助吗？

有用

无用

访问控制

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码