配置APIG的AIAPIKey认证
APIG支持AI API(Artificial Intelligence Application Programming Interface,人工智能应用编程接口)通过AIAPIKey进行鉴权认证。这种方式不仅能够高效地控制AI API的访问权限,还能够实现对多租户场景下的精细权限管理。
AIAPIKey认证指在调用API时,HTTP请求头部消息增加一个参数Authorization,而不需要对请求内容签名,API网关也仅校验AIAPIKey,不校验请求签名,从而实现快速响应。
前提条件
- 已创建APP认证类型的AI API。如未创建,请创建API。
- 已创建凭据,并且关联账号ID和项目ID,以及关联APP认证类型的AI API。如未创建,请配置APIG的API认证凭据。
- 已开启ai_api_key认证方式开关。如未开启,请配置APIG实例参数。
约束与限制
添加AIAPIKey
- 进入API网关控制台页面。
- 根据实际业务在左侧导航栏上方选择实例。
- 在左侧导航栏选择“API管理 > 凭据管理”。
- 单击凭据名称,进入凭据详情页面。
- 在“AIAPIKeys”区域,单击“添加AIAPIKey”。
- 根据下表参数说明,在弹窗中配置AIAPIKey。
表1 配置AIAPIKey 参数
说明
生成方式
选择AIAPIKey的生成方式。
- 自动生成:由系统随机生成AIAPIKey。
- 手动输入:自定义AIAPIKey。
AIAPIKey
仅手动输入方式需要填写AIAPIKey的值。
支持大小写字母、数字,以及+/=-_等特殊字符,长度为8~128个字符。
别名
AIAPIKey的别名,可用于区分AIAPIKey。支持英文、数字、下划线、中划线,长度为1~100个字符。
- 单击“确定”。
- AIAPIKey添加完成后,您可以使用AIAPIKey进行API请求的认证。
发送请求时,增加请求头部参数“Authorization”,省略请求签名相关信息。
以Curl方式为例,增加头部参数名称:“Authorization”,参数值填“Bearer 已添加的AIAPIKey”。
curl -X GET "https://api.exampledemo.com/testapi" -H "content-type: application/json" -H "host: api.exampledemo.com" -H "Authorization: Bearer OGUwYzlk******ThlMTBlMzdjMQ=="
相关文档
如果您希望通过API添加AIAPIKey,请参考创建AIAPIKey。