更新时间:2024-10-09 GMT+08:00

认证鉴权

调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。

  • AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。获取终端节点,请参考终端节点

    调用“中东-阿布扎比-OP5”Region的对象存储服务(OBS)、数据接入服务(DIS)、自然语言处理(NLP)、文字识别(OCR)或图像识别(Image Recognition)首先需要新建用户并生成AK/SK,再通过AK/SK认证和终端节点(请参考:https://docs.g42cloud.com/zh-cn/endpoint/index.html)调用API。

  • Token认证:通过Token认证调用请求。

    通过终端节点和Token调用API。不支持调用“中东-阿布扎比-OP5”Region的对象存储服务(OBS)、数据接入服务(DIS)、自然语言处理(NLP)、文字识别(OCR)和图像识别(Image Recognition)。

AK/SK认证

  • AK/SK签名认证方式仅支持消息体大小12MB以内,12MB以上的请求请使用Token认证。
  • 通过AK/SK获取的Token有效期最短为15分钟。
  • AK/SK既可以使用永久访问密钥中的AK/SK,也可以使用临时访问密钥中的AK/SK,但使用临时访问密钥的AK/SK时需要额外携带“X-Security-Token”字段,字段值为临时访问密钥的security_token。

AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。

  • AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。
  • SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。
使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见《API签名指南》。
  • 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。
  • 客户端必须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。

    API网关除了校验时间格式外,还会校验该时间值与网关收到请求的时间差,如果时间差大于15分钟,API网关将拒绝请求。

新建用户并生成AK/SK

  1. 登录API网关控制台。
  2. 在顶部导航栏中选择“中东-阿布扎比-OP5”Region。
  3. 选择“管理与部署 > 统一身份认证服务”。
  4. 在“用户”页面,单击“创建用户”。

    1. 配置用户基本信息。

      填写用户信息,“凭证类型”选择“访问密钥”并输入密码,单击“下一步”。

    2. (可选)加入用户组。

      选择用户组,如果没有用户组可单击“创建用户组”。

    3. 单击“创建用户”。

  5. 弹出“下载访问密钥”框,单击“确定”。

    用户创建成功,并下载“credentials.csv”文件,即AK/SK文件。

Token认证

  • Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。
  • 使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失败。

Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。

Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。

{ 
    "auth": { 
        "identity": { 
            "methods": [ 
                "password" 
            ], 
            "password": { 
                "user": { 
                    "name": "username", 
                    "password": "********", 
                    "domain": { 
                        "name": "domainname" 
                    } 
                } 
            } 
        }, 
        "scope": { 
            "project": { 
                "name": "xxxxxxxx" 
            } 
        } 
    } 
}

获取Token后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。

POST https://{apig_endpoint}/v2/{project_id}/v2/{project_id}/apigw/instances/{instance_id}/api-groups
Content-Type: application/json
X-Auth-Token: ABCDEFJ....