创建消费者API Key或AK_SK
更新时间:2026-09-21
该接口用于为指定消费者创建 API Key 或 AK/SK 认证凭证。消费者已有对应类型的授权规则时,创建后会刷新相关实例的鉴权配置。
注意事项:
- API Key 支持系统生成和自定义;自定义 API Key 在当前账号内必须唯一。
- AK/SK 由系统生成。
- 每个消费者可创建的凭证数量受账号配额限制。
请求结构
Plain Text
1POST /?action=CreateConsumerApiKeyOrAkSk HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "consumerId": consumerId,
7 "authorizationType": authorizationType,
8 "createType": createType,
9 "apiKey": apiKey
10}
请求头域
除公共头域外,无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| consumerId | String | 是 | RequestBody参数 | 消费者 ID |
| authorizationType | String | 是 | RequestBody参数 | 认证方式:API_KEY / AK_SK |
| createType | String | 否 | RequestBody参数 | 生成方式,仅认证方式为 API_KEY 时生效:System(系统生成)/ Custom(自定义) |
| apiKey | String | 否 | RequestBody参数 | 自定义 API Key,仅生成方式为 Custom 时必填 |
返回头域
除公共头域,无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| authorizationInfoId | String | 鉴权信息 ID,用于后续查询、重置、删除 |
| apiKey | String | API Key 明文,仅认证方式为 API_KEY 时返回;仅创建时返回一次,请及时保存 |
| ak | String | Access Key 明文,仅认证方式为 AK_SK 时返回 |
| sk | String | Secret Key 明文,仅认证方式为 AK_SK 时返回;仅创建时返回一次,请及时保存 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| MethodArgumentNotValidException | MethodArgumentNotValidException: consumerId must not be blank | 400 | 必填参数缺失或格式不合法,consumerId 不能为空 |
| HttpMessageNotReadable | Http Message Not Readable: JSON parse error | 400 | 请求体不是合法 JSON,无法解析,请检查 JSON 语法和字段类型 |
| ResourcePermissionDeny | Resource permission deny. | 401 | 无权限访问指定资源,请确认使用正确的账号凭证且资源属于当前账号 |
| ConsumerNotExist | Consumer not exist. | 404 | consumerId 对应的消费者不存在、不属于当前账号或已删除 |
| QuotaCheckError | There can be a maximum of 10 API Key. | 413 | 单个消费者的凭证数量已达上限,具体上限见错误描述 |
| ApiKeyRepeat | API Key already exists in this account. | 413 | API Key 已存在于当前账号下,请更换 |
| HttpMediaTypeException | HttpMediaTypeException: Content-Type 'text/plain' is not supported | 415 | 请求的 Content-Type 不受支持,请使用 application/json |
| DataPlaneSyncFailed | 配置已保存成功,但网关操作失败,请稍后重试或联系技术支持。 | 500 | 配置已写入控制面,但下发数据面失败,请稍后重试或联系技术支持 |
请求示例
Plain Text
1POST /?action=CreateConsumerApiKeyOrAkSk HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "consumerId": "consumer-a1b2c3d4",
7 "authorizationType": "API_KEY",
8 "createType": "System"
9}
返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "authorizationInfoId": "authorization_info-m3n4o5p6",
9 "apiKey": "ak-3f8e2d1c9b7a4e6f",
10 "ak": "",
11 "sk": ""
12}
评价此篇文章
