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

文档中心

立即注册

导航

CreateAccessKey - 创建访问密钥

最近更新时间：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	是	CreateAccessKey	要执行的操作，取值：CreateAccessKey。
Version	String	是	2018-01-01	API的版本，取值：2018-01-01。
UserName	String	否	Bob	用户名。用于给指定的IAM用户创建密钥，未指定用户名时则为当前请求身份创建密钥（即主账号请求时为主账号自身创建密钥，IAM用户请求时为IAM用户自身创建密钥。注意：角色不支持为自身创建密钥）。当IAM用户拥有密钥自管理权限时（AccessKeySelfManageAccess），如需为自身创建密钥则需要在请求中传递自身的UserName。

返回参数

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

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

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202409121935323DA060AB77F02B0CC4A5",
    "Action": "CreateAccessKey",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  },
  "Result": {
    "AccessKey": {
      "AccessKeyId": "AKLTZjIwYzBjYzczNWQ4NDkwN******3NzViZTgzZDAxYjE",
      "SecretAccessKey": "WmprME5EaG1OR1psT1dZM05EZzRP******ek1EWXlOREF4WWpjME16Yw==",
      "UserName": "Bob",
      "CreateDate": "20240912T113532Z",
      "UpdateDate": "20240912T113532Z",
      "Status": "active"
    }
  }
}

错误码

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

状态码	错误码	错误信息	说明
404	UserNotExist	User '%s' cannot be found.	用户不存在。
409	AccessKeyLimitExceeded	Exceed account accessKey quota: '%d'	密钥数量达到上限。