后端密钥管理
所有文档

          API网关

          后端密钥管理


          为保证后端收到的请求来源可靠,网关提供后端密钥签名验证功能,创建密钥并将密钥绑定到具体的API上即可开启后端签名。

          image.png

          开启后端密钥后,网关会在请求后端时增加具体的签名验证信息,然后后端在本地也进行相应的签名计算并与网关的签名信息进行比较。 后端密钥通过自定义的key和secret做签名计算,有关签名生成算法的具体介绍,请参看鉴权认证机制。请注意,网关后端密钥中的key和secret,分别对应参考资料中的AK、SK。

          创建后端密钥

          在智能云console界面中网关类目下,选择后端密钥管理后可以进行后端密钥创建。

          image.png

          • 每个用户可以创建的后端密钥数量为30个,如您需要创建更多的后端密钥,请提工单。
          • 一个账户下的后端密钥名称是唯一的。
          • key如果不填写,则网关会自动生成一个32位字符的key。
          • secret如果不填写,则网关会自动生成一个64位字符的随机secret。

          编辑和删除后端密钥

          image.png

          在后面密钥列表页面,您可以分页查看已经创建的后端密钥,并且可以对后端密钥进行编辑和删除。

          • 编辑时,会要求重新输入后端密钥的secret。如您想变更除secret之外的其他属性,请先记录原有的secret,在编辑时重新填入。
          • 删除一个后端密钥时,请您确定当前后端密钥没有绑定的API,否则会删除不成功。

          后端密钥详情与管理

          在后端密钥列表页点击后端密钥的名字,您可以进入该后端密钥详情页中。

          image.png

          在详情页,您可以查看该后端密钥的key和secret。除此之外,在详情页还可以查看该后端密钥具体绑定的API,同时也可以对API进行查看和解绑操作。

          • 查看secret需要进行短信验证。

          将后端密钥与API绑定

          后端密钥只有在绑定具体的API之后才会生效,您可以在后端密钥列表页进行API绑定。

          image.png

          在列表页点击绑定API之后,可以进行API绑定。

          image.png

          在绑定API的详情页中,您可以选择某个分组下、某个环境中的API。

          将后端密钥与API解绑

          在后端密钥详情页中,您可以进行API解绑操作。

          image.png

          在详情页中,可以对单个API进行解绑,也可以对已经绑定的API进行选择之后进行批量解绑。

          后端验证API的签名信息

          在API与后端密钥绑定之后,网关会在转发请求的时候将签名放在请求头X-Bce-Gateway-Auth中。所以在后端进行签名校验的时候,您应该获取上述header信息之后与您所计算的签名信息进行比较。具体的签名生成算法请参考鉴权认证机制

          说明:此处生成的认证字符串版本为v1。

          上一篇
          私有网络VPC开放API
          下一篇
          API的导入导出