配置apig的api认证凭据-j9九游会登录
使用app认证的api,需要在api网关中创建一个凭据,以生成凭据id和密钥对(key、secret)。将创建的凭据绑定api后,才可以使用app认证调用api。客户端(api调用者)在调用api过程中,把密钥对配置在sdk中,api网关服务根据密钥对进行身份核对,完成鉴权。
使用无认证、华为iam认证的api、自定义认证,无需创建凭据。
前提条件
已创建app认证类型的api,如未创建,请。
约束与限制
- 每个实例最多创建50个凭据,每个凭据最多绑定1000个api。
- 一个凭据可以绑定多个app认证的api,一个app认证的api可以绑定多个凭据。
创建凭据
- 进入页面。
- 根据实际业务在左侧导航栏上方选择实例。
- 在左侧导航栏选择“api管理 > 凭据管理”。
- 单击“创建凭据”,根据下表参数说明,填写凭据信息。
表1 凭据信息 参数
说明
凭据名称
凭据的名称。支持英文、中文、数字、下划线,且只能以英文或中文开头,长度为3~64个字符。
描述
对凭据的介绍。长度为1-255个字符。
自定义配置
支持appkey(key)和appsecret(secret)自定义配置。appkey(key)和appsecret(secret)如果没有特殊需求,不建议使用“自定义配置”,系统会默认生成全局标识,可在凭据详情中查看。
appkey
凭据的key。用于身份标识,需要保证全局唯一。支持英文、数字、下划线、中划线,且只能以英文或数字开头,长度为8~200个字符。
appsecret
凭据的secret。用于身份验证。支持英文,数字,下划线,中划线,包括!@#%特殊字符,且只能以英文或数字开头,长度为8-128个字符。
- 单击“确定”,创建凭据。
- 创建凭据成功后,在凭据管理页面显示新建凭据和凭据id。
- 单击凭据名称,进入详情页面,查看key和secret。
- 凭据创建完成后,需要绑定api/授权api,将凭据和api关联起来,用户才能通过app认证调用关联的api。
绑定api/授权api
绑定api或授权api就是将api与凭据关联起来,apig可以根据凭据的密钥对进行身份鉴权,调用关联的api。
绑定api
- 在“凭据管理”页面,单击凭据名称,进入详情页面。
- 在“关联api”区域,单击“绑定api”。
- 选择授权环境、api分组和api。
- 单击“确定”。
如需解绑api,在api所在行单击“解绑”即可。
授权api
- 在左侧导航栏选择“api管理 > api分组”。
- 单击分组名称,进入“分组信息”页面。
- 在“api运行”页面,选择待授权的api,单击“更多 > 授权”。
- 单击“添加授权”。
- 选择api授权环境,查询并勾选凭据后,单击“确定”。在“授权历史”弹窗中展示已授权的凭据。
如果已授权的凭据需要解除授权,在凭据列表中凭据所在行单击“解除授权”。
重置secret
key唯一且不可重置,secret支持重置,将secret的值重新改变。重置完成后,原先的secret将失效,绑定此凭据的api将无法调用,请更新sdk中的密钥对,并重新调用api。
- 在左侧导航栏选择“api管理 > 凭据管理”。
- 单击凭据名称,进入凭据详情页面。
- 单击“重置secret”。
- 在弹窗中单击“确定”。
相关文档
- 完成api认证凭据创建后,您可以根据业务需求选择app认证类型进行api调用。具体操作,请参考章节。
- 如果您选择app认证类型中的简易认证类型,还需创建appcode。具体操作,请参考章节。
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨