文档首页/ API网关 APIG/ API参考/ 专享版API（V2）/ 专享版-凭据管理/ 创建AIAPIKey - CreateAiApiKey
更新时间：2026-04-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建AIAPIKey - CreateAiApiKey

功能介绍

创建AIAPIKey，适用于AI场景下的API Key认证。

接口约束

AIAPIKey功能，需要开启白名单后才可以使用。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    apig:app:addAiApiKey

    Write

    instance *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    -

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/ai-api-keys

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID，在API网关控制台的“实例信息”中获取。

app_id

是

String

凭据编号

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

ai_api_key

否

String

AIAPIKey值，不指定具体值时，由后台自动生成随机字符串。

支持大小写英文字母、数字，以及+-_/=特殊字符，长度为8~128个字符。

最小长度：8

最大长度：128

alias

否

String

AIAPIKey的别名。支持大小写字母，数字，下划线，中划线，长度为1~100个字符。

最小长度：1

最大长度：100

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

ai_api_key

String

AIAPIKey值，不指定具体值时，由后台自动生成随机字符串。

支持大小写英文字母、数字，以及+-_/=特殊字符，长度为8~128个字符。

最小长度：8

最大长度：128

alias

String

AIAPIKey的别名。支持大小写字母，数字，下划线，中划线，长度为1~100个字符。

最小长度：1

最大长度：100

app_id

String

凭据编号。

最小长度：32

最大长度：36

create_time

String

创建时间。

id

String

AIAPIKey编号。

最小长度：32

最大长度：36

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

创建一个手动输入的AIAPIKey

{
  "ai_api_key" : "GjOD3g80AABuuFeEJpVQADBlAjBh3UzC7i3gFxUDb5pWBz9wUcw9+8/bFZ1B",
  "alias" : "test1"
}

响应示例

状态码：200

Created

  • 示例 1

    {
  "ai_api_key" : "GjOD3g80AABuuFeEJpVQADBlAjBh3UzC7i3gFxUDb5pWBz9wUcw9+8/bFZ1B",
  "alias" : "test1",
  "app_id" : "9ed8b7fe84224de681e7d7a5587e76dc",
  "create_time" : "2020-07-24T02:37:24.835128293Z",
  "id" : "32dc8ca22d1b4b9cb94022186880576b"
}

  • 示例 2

    {
  "ai_api_key" : "GjOD3g80AABuuFeEJpVQADBlAjBh3UzC7i3gFxUDb5pWBz9wUcw9+8/bFZ1B",
  "alias" : "",
  "app_id" : "9ed8b7fe84224de681e7d7a5587e76dc",
  "create_time" : "2020-07-24T02:37:24.835128293Z",
  "id" : "32dc8ca22d1b4b9cb94022186880576b"
}

状态码：400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:app_id. Please refer to the support documentation"
}

状态码：401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

状态码：404

Not Found

{
  "error_code" : "APIG.3004",
  "error_msg" : "App 9ed8b7fe84224de681e7d7a5587e76dc does not exist"
}

状态码：500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

状态码

状态码

描述

200

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 专享版-凭据管理

相关文档