CreateApiKey - 创建 API 密钥--访问控制-火山引擎

文档中心

访问控制

API Key

CreateApiKey - 创建 API 密钥

为主账号或 IAM 用户创建 API 密钥。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	CreateApiKey	要执行的操作，取值：CreateApiKey。
Version	String	是	2018-01-01	API的版本，取值：2018-01-01。
UserName	String	否	Bob	用户名。用于给指定的 IAM 用户创建 API 密钥，未指定用户名时则为当前请求身份创建 API 密钥（即主账号请求时为主账号自身创建 API 密钥，IAM 用户请求时为 IAM 用户自身创建 API 密钥。注意：角色不支持为自身创建 API 密钥）。
Name	String	否	my-api-key	API 密钥名称。
PermissionsBoundary	String	否	{"Statement":[{"Effect":"Allow","Action":["ecs:"],"Resource":[""]}]}	权限边界策略文档。JSON 格式的策略字符串。仅主账号的 API 密钥支持设置权限边界，IAM 用户的 API 密钥不支持。

返回参数

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

参数	类型	示例值	描述
ApiKey	Object	请参考数据结构内具体参数示例值。	API 密钥的数据结构。

请求示例

POST /?Action=CreateApiKey&Version=2018-01-01 HTTP/1.1
Host: iam.volcengineapi.com
Content-Type: application/x-www-form-urlencoded
X-Date: 20260314T054045Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260314/cn-beijing/iam/request, SignedHeaders=content-type;host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

UserName=Bob&Name=my-api-key

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20260314054045010225146063063CE58B",
    "Action": "CreateApiKey",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  },
  "Result": {
    "ApiKey": {
      "Name": "my-api-key",
      "Id": "Ab3kX9mN******vQ",
      "Secret": "VxeyJrIj**************************************c2lneZ",
      "Status": "active",
      "CreateDate": "20260314T054045Z",
      "UpdateDate": "20260314T054045Z"
    }
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter	The parameter '%s' in request is invalid, error: %v.	无效参数！
404	UserNotExist	User '%s' does not exist.	用户不存在。
409	LimitExceeded	Exceeded `%s` quota, quota: `%s`.	API 密钥数量达到上限。

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

这个页面对您有帮助吗？

有用

无用

访问控制

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码