API Key管理接口（永久有效）
更新时间：2025-07-09
API Key管理接口（永久有效）
权限说明
API Key管理接口受到权限管控，请先授权子用户：IAMManageAPIKeyPolicy，授权请参考：子用户授权
主账号和系统管理员可以管理账号下所有子用户的API Key，拥有IAMManageAPIKeyPolicy权限的子用户可以管理自己的API Key
认证说明
请求头域中的Authorization头，是标准的百度云AK/SK签名
数据类型
API Key
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | API Key在的标识 |
| tokenId | String | API Key本身 |
| name | String | API Key名称 |
| userId | String | API Key 归属的子用户 |
| services | List | API Key 授权的服务列表 |
| createTime | String | API Key 创建时间 |
| updateTime | String | API Key 更新时间 |
| domainId | String | API Key 归属的账户 |
| acl | String | API Key 授权策略 |
| + acl: id | String | id |
| + acl: version | String | "v2" |
| + acl: accessControlList | List | ACL entry |
| ++ acl: accessControlList: service | String | 目前支持的产品千帆Model Builder "bce:wenxinfactory", 千帆AppBuidler "bce:ai_apaas", 通用人工智能 "bce:console_ai" |
| ++ acl: accessControlList: region | String | 固定值， "global" |
| ++ acl: accessControlList: resource | List | 资源，具体格式看产品线 |
| ++ acl: accessControlList: permission | List | 权限,具体格式看产品线 |
| ++ acl: accessControlList: effect | String | 固定值，"Allow" |
1. 创建API Key（永久有效）
接口描述
创建一个永久有效的API Key。具有管理员权限的子用户或者主账号可以给其他子用户创建永久有效的API Key
请求结构
Plain Text
1 POST /v1/apikey/create
2 Host: iam.bj.baidubce.com
3 Authorization: authorization string
4
5 {
6 RequestBody
7 }请求头域
除公共头域（详见认证机制说明）外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| userId | String | RequestBody参数 | 子用户Id | 否， 不传就是当前用户 |
| acl | String | RequestBody参数 | ACL策略 | 是 |
| name | String | RequestBody参数 | APIKey名称 | 否， 不传会默认生成 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
API Key 对象
请求示例
Plain Text
1 POST /v1/apikey/create
2 Host: iam.bj.baidubce.com
3 Authorization: authorization string
4
5 {
6 "userId": "3754****cbb8d",
7 "acl": {
8 "version": "v2",
9 "id": "random",
10 "accessControlList": [
11 {
12 "service": "bce:ai_apaas",
13 "region": "global",
14 "resource": ["app/46484bef-3fe4-4b15-96fc-01bd6e0e6217"],
15 "permission": ["UseApp", "ReadApp"],
16 "effect": "Allow"
17 },
18 {
19 "service": "bce:wenxinfactory",
20 "region": "global",
21 "resource": [
22 "app/app-MufgWEI5"
23 ],
24 "effect": "Allow",
25 "permission": [
26 "*"
27 ]
28 }
29 ]
30 }
31 }响应示例
Plain Text
1HTTP/1.1 201 Created
2Server: BWS
3X-Bce-Request-Id: 007b7962-1c78-46cb-8ca2-996f819b1ccd
4Content-Type: application/json;charset=UTF-8
5
6{
7 "success": true,
8 "status": 200,
9 "result": {
10 "id": "FuHFcZuhMZR4Ztt2X2IFg",
11 "tokenId": "bce-v3/ALTAK-*****ab9c6a027",
12 "userId": "3754****cbb8d",
13 "appId": "",
14 "accessKey": "ALTAK-****PYva",
15 "status": 1,
16 "type": "api_key",
17 "services": [
18 "WENXINFACTORY",
19 "AI_APAAS"
20 ],
21 "createTime": "2025-07-07T03:45:19.468Z",
22 "domainId": "8a45a****9b079",
23 "acl": {
24 "id": "2NR2Of8Q6vYa2yFqIg5nd",
25 "version": "v2",
26 "accessControlList": [
27 {
28 "service": "bce:ai_apaas",
29 "region": "global",
30 "resource": [
31 "app/46484bef-3fe4-4b15-96fc-01bd6e0e6217"
32 ],
33 "effect": "Allow",
34 "permission": [
35 "UseApp",
36 "ReadApp"
37 ]
38 },
39 {
40 "service": "bce:wenxinfactory",
41 "region": "global",
42 "resource": [
43 "app/app-MufgWEI5"
44 ],
45 "effect": "Allow",
46 "permission": [
47 "*"
48 ]
49 }
50 ]
51 },
52 "name": "APIKey-20250707114519",
53 "resources": {
54 "wenxinfactory": [
55 "app/app-MufgWEI5"
56 ],
57 "ai_apaas": [
58 "app/46484bef-3fe4-4b15-96fc-01bd6e0e6217"
59 ]
60 },
61 "policy_type": "Custom",
62 "user_defined": true
63 }
64}2. 更新API Key（永久有效）
接口描述
更新一个永久有效API Key的ACL。具有管理员权限的子用户或者主账号可以给其他子用户更新API Key
请求结构
Plain Text
1 POST /v1/apikey/update
2 Host: iam.bj.baidubce.com
3 Authorization: authorization string
4
5 {
6 RequestBody
7 }请求头域
除公共头域（详见认证机制说明）外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| userId | String | RequestBody参数 | 子用户Id | 否，如果apikey归属其他子用户则必填 |
| id | String | RequestBody参数 | APIKey ID | 是 |
| acl | String | RequestBody参数 | ACL策略 | 是 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
API Key 对象
请求示例
Plain Text
1 POST /v1/apikey/update
2 Host: iam.bj.baidubce.com
3 Authorization: authorization string
4
5 {
6 "userId": "3754d05b0cd045f696ecee543d0cbb8d",
7 "id": "QrAelpxAFA41NuknoLGav",
8 "acl": {
9 "id": "UJz2g8a7sn4InD4ggPB2P",
10 "version": "v2",
11 "accessControlList": [
12 {
13 "service": "bce:console_ai",
14 "region": "global",
15 "resource": [
16 "app/audio_voice_assistant_get"
17 ],
18 "effect": "Allow",
19 "permission": [
20 "*"
21 ]
22 }
23 ]
24 }
25 }响应示例
Plain Text
1HTTP/1.1 200 OK
2Server: BWS
3X-Bce-Request-Id: e0a81c19-b1c4-42c1-b867-8e992dd657d5
4Content-Type: application/json;charset=UTF-8
5
6{
7 "success": true,
8 "status": 200,
9 "result": {
10 "id": "QrAelpxAFA41NuknoLGav",
11 "tokenId": "bce-v3/ALTAK******7a3b",
12 "userId": "3754d05b0cd045f696ecee543d0cbb8d",
13 "appId": "",
14 "accessKey": "ALTAK-7****1Baeo72",
15 "status": 1,
16 "type": "api_key",
17 "services": [
18 "CONSOLE_AI"
19 ],
20 "createTime": "2025-07-07T07:22:39.000Z",
21 "updateTime": "2025-07-07T07:22:38.000Z",
22 "domainId": "8a45a****9b079",
23 "acl": {
24 "id": "JlhyjZNS76EUXi4kzCs21",
25 "version": "v2",
26 "accessControlList": [
27 {
28 "service": "bce:console_ai",
29 "region": "global",
30 "resource": [
31 "app/audio_voice_assistant_get"
32 ],
33 "effect": "Allow",
34 "permission": [
35 "*"
36 ]
37 }
38 ]
39 },
40 "name": "APIKey-20250707152238",
41 "resources": {
42 "console_ai": [
43 "app/audio_voice_assistant_get"
44 ]
45 },
46 "policy_type": "CUSTOM",
47 "user_defined": true
48 }
49}3. 查询API Key详情（永久有效）
接口描述
获取一个永久有效API Key的详细信息。具有管理员权限的子用户或者主账号可以查询其他子用户API Key
请求结构
Plain Text
1 POST /v1/apikey/detail
2 Host: iam.bj.baidubce.com
3 Authorization: authorization string
4
5 {
6 RequestBody
7 }请求头域
除公共头域（详见认证机制说明）外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| userId | String | RequestBody参数 | 子用户Id | 否，如果apikey归属其他子用户则必填 |
| id | String | RequestBody参数 | APIKey ID | 是 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
API Key 对象
请求示例
Plain Text
1 POST /v1/apikey/detail
2 Host: iam.bj.baidubce.com
3 Authorization: authorization string
4
5 {
6 "userId": "3754d05b0cd045f696ecee543d0cbb8d",
7 "id": "FuHFcZuhMZR4Ztt2X2IFg"
8 }响应示例
Plain Text
1HTTP/1.1 200 OK
2Server: BWS
3X-Bce-Request-Id: e0a81c19-b1c4-42c1-b867-8e992dd657d5
4Content-Type: application/json;charset=UTF-8
5
6{
7 "success": true,
8 "status": 200,
9 "result": {
10 "id": "FuHFcZuhMZR4Ztt2X2IFg",
11 "tokenId": "bce-v3/ALTAK******a027",
12 "userId": "3754d05b0cd045f696ecee543d0cbb8d",
13 "appId": "",
14 "accessKey": "ALTAK-aT******K2qDQj1nPYva",
15 "status": 1,
16 "type": "api_key",
17 "services": [
18 "AI_APAAS",
19 "WENXINFACTORY"
20 ],
21 "createTime": "2025-07-07T03:45:19.000Z",
22 "updateTime": "2025-07-07T03:45:19.000Z",
23 "expireTime": "1970-01-01T00:00:00.000Z",
24 "lastUsedTime": "1970-01-01T00:00:00.000Z",
25 "domainId": "8a45ad915ce34e41a3ae3661ba09b079",
26 "acl": {
27 "id": "2NR2Of8Q6vYa2yFqIg5nd",
28 "version": "v2",
29 "accessControlList": [
30 {
31 "service": "bce:ai_apaas",
32 "region": "global",
33 "resource": [
34 "app/46484bef-3fe4-4b15-96fc-01bd6e0e6217"
35 ],
36 "effect": "Allow",
37 "permission": [
38 "UseApp",
39 "ReadApp"
40 ]
41 },
42 {
43 "service": "bce:wenxinfactory",
44 "region": "global",
45 "resource": [
46 "app/app-MufgWEI5"
47 ],
48 "effect": "Allow",
49 "permission": [
50 "*"
51 ]
52 }
53 ]
54 },
55 "name": "APIKey-20250707114519",
56 "resources": {
57 "wenxinfactory": [
58 "app/app-MufgWEI5"
59 ],
60 "ai_apaas": [
61 "app/46484bef-3fe4-4b15-96fc-01bd6e0e6217"
62 ]
63 },
64 "user_defined": true
65 }
66}4. 解码API Key（永久有效）
接口描述
获取一个永久有效API Key的详细信息。具有管理员权限的子用户或者主账号可以解码其他子用户API Key
请求结构
Plain Text
1 POST /v1/apikey/decrypt
2 Host: iam.bj.baidubce.com
3 Authorization: authorization string
4
5 {
6 RequestBody
7 }请求头域
除公共头域（详见认证机制说明）外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| userId | String | RequestBody参数 | 子用户Id | 否，如果apikey归属其他子用户则必填 |
| id | String | RequestBody参数 | APIKey ID | 是 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
简化版 API Key 对象
请求示例
Plain Text
1 POST /v1/apikey/decrypt
2 Host: iam.bj.baidubce.com
3 Authorization: authorization string
4
5 {
6 "userId": "3754d05b0cd045f696ecee543d0cbb8d",
7 "id": "FuHFcZuhMZR4Ztt2X2IFg"
8 }响应示例
Plain Text
1HTTP/1.1 200 OK
2Server: BWS
3X-Bce-Request-Id: 1852114e-6281-405e-b861-94f5e4e89bd6
4Content-Type: application/json;charset=UTF-8
5
6 {
7 "success": true,
8 "status": 200,
9 "result": {
10 "id": "FuHFcZuhMZR4Ztt2X2IFg",
11 "userId": "3754d05b0cd045f696ecee543d0cbb8d",
12 "name": "APIKey-20250707114519",
13 "tokenId": "bce-v3/ALTAK-aT3D9GNVGK2qDQj1nPYva/4f45c2a0e551eaad43d60j87d8e5090cb9c6a027",
14 "createTime": "2025-07-07T03:45:19.000Z",
15 "service": [
16 "AI_APAAS",
17 "WENXINFACTORY"
18 ]
19 }5. 获取永久有效API Key列表
接口描述
获取一个用户的永久有效API Key列表。具有管理员权限的子用户或者主账号可以获取其他子用户API Key列表
请求结构
Plain Text
1 POST /v1/apikey/list
2 Host: iam.bj.baidubce.com
3 Authorization: authorization string
4
5 {
6 RequestBody
7 }请求头域
除公共头域（详见认证机制说明）外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| userId | String | RequestBody参数 | 子用户Id | 否，如果apikey归属其他子用户则必填 |
| service | List | RequestBody参数 | 筛选条件['AI_APAAS', 'WENXINFACTORY', 'CONSOLE_AI']， APIKey 归属服务，多个service是或的关系 | 否 |
| pageNo | int | RequestBody参数 | 页码，从1开始 | 否 默认 1 |
| pageSize | int | RequestBody参数 | 每页大小 | 否，默认10 |
| orderBy | String | RequestBody参数 | 排序字段 | 只按createTime，不传即可 |
| order | String | RequestBody参数 | 排序类型 | 只按倒序，不传即可 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
简化版 API Key 对象列表
请求示例
Plain Text
1 POST /v1/apikey/list
2 Host: iam.bj.baidubce.com
3 Authorization: authorization string
4
5{
6 "userId": "3754d05b0cd045f696ecee543d0cbb8d",
7 "service": ["AI_APAAS"]
8}响应示例
Plain Text
1HTTP/1.1 200 OK
2Server: BWS
3X-Bce-Request-Id: 1852114e-6281-405e-b861-94f5e4e89bd6
4Content-Type: application/json;charset=UTF-8
5
6{
7 "success": true,
8 "status": 200,
9 "page": {
10 "orderBy": "",
11 "order": "",
12 "pageNo": 1,
13 "pageSize": 10,
14 "totalCount": 1,
15 "result": [
16 {
17 "id": "HdcGpPuMDERwbQsMUZgst",
18 "userId": "3754d05b0cd045f696ecee543d0cbb8d",
19 "name": "APIKey-20250707153105",
20 "tokenId": "bce-v3/ALTAK******f5be",
21 "createTime": "2025-07-07T07:31:06.000Z",
22 "service": [
23 "AI_APAAS",
24 "WENXINFACTORY"
25 ]
26 }
27 ]
28 }
29}6. 删除API Key（永久有效）
接口描述
删除用户的永久有效API Key。具有管理员权限的子用户或者主账号可以删除其他子用户API Key
请求结构
Plain Text
1 POST /v1/apikey/delete
2 Host: iam.bj.baidubce.com
3 Authorization: authorization string
4
5 {
6 RequestBody
7 }请求头域
除公共头域（详见认证机制说明）外，无其它特殊头域。
请求参数
| 名称 | 类型 | 位置 | 描述 | 是否必须 |
|---|---|---|---|---|
| userId | String | RequestBody参数 | 子用户Id | 否，如果apikey归属其他子用户则必填 |
| id | String | RequestBody参数 | APIKey ID | 是 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
Plain Text
1{
2 "success": true,
3 "status": 200
4}请求示例
Plain Text
1 POST /v1/apikey/delete
2 Host: iam.bj.baidubce.com
3 Authorization: authorization string
4
5{
6 "userId": "3754d05b0cd045f696ecee543d0cbb8d",
7 "id": "FuHFcZuhMZR4Ztt2X2IFg"
8}响应示例
Plain Text
1HTTP/1.1 200 OK
2Server: BWS
3X-Bce-Request-Id: 6d7d5369-9b3f-4e91-be61-e83377bf763a
4Content-Type: application/json;charset=UTF-8
5
6{
7 "success": true,
8 "status": 200
9}