配置APIG的API认证凭据
使用APP认证的API,需要在API网关中创建一个凭据,以生成凭据ID和密钥对(Key、Secret)。将创建的凭据绑定API后,才可以使用APP认证调用API。客户端(API调用者)在调用API过程中,把密钥对替换SDK中的密钥对,API网关服务根据密钥对进行身份核对,完成鉴权。关于使用APP认证的方法,具体请参考《开发指南》。
![](https://support.huaweicloud.com/usermanual-apig/public_sys-resources/note_3.0-zh-cn.png)
使用无认证、华为IAM认证的API、自定义认证,无需创建凭据。
约束与限制
- 每个实例最多创建50个凭据,每个凭据最多绑定1000个API。
- 一个凭据可以绑定多个APP认证的API,一个APP认证的API可以绑定多个凭据。
创建凭据
- 进入API网关控制台页面。
- 根据实际业务在左侧导航栏上方选择实例。
- 在左侧导航栏选择“API管理 > 凭据管理”。
- 单击“创建凭据”,根据下表参数说明,填写凭据信息。
表1 凭据信息 参数
说明
凭据名称
凭据的名称。支持英文、中文、数字、下划线,且只能以英文或中文开头,长度为3~64个字符。
描述
对凭据的介绍。长度为1~255个字符。
支持AppKey(Key)和AppSecret(Secret)自定义配置。AppKey是身份标识,需要保证全局唯一。如果没有特殊需求,不建议使用“自定义配置”,系统会默认生成全局标识,可在凭据详情中查看。
- 单击“确定”,创建凭据。
- 创建凭据成功后,在凭据管理页面显示新建凭据和凭据ID。
- 单击凭据名称,进入详情页面,查看key和Secret。
绑定API/授权API
绑定API或授权API就是将API与凭据关联起来,APIG可以根据凭据的密钥对进行身份鉴权,调用关联的API。
绑定API
- 在“凭据管理”页面,单击凭据名称,进入详情页面。
- 在“关联API”区域,单击“绑定API”。
- 选择授权环境、API分组和API。
- 单击“确定”。
如需解绑API,在API所在行单击“解绑”即可。
授权API
- 在左侧导航栏选择“API管理 > API分组”。
- 单击分组名称,进入“分组信息”页面。
- 在“API运行”页面,选择待授权的API,单击“更多 > 授权”。
- 单击“添加授权”。
- 选择API授权环境,查询并勾选凭据后,单击“确定”。在“授权历史”弹窗中展示已授权的凭据。
如果已授权的凭据需要解除授权,在凭据列表中凭据所在行单击“解除授权”。