更新时间:2024-08-29 GMT+08:00
分享

认证鉴权

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

  • Token认证:通过Token认证调用请求。
  • AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。

Token认证

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

  • Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。
  • 如果您的华为云账号已升级为华为账号,将不支持获取账号Token。建议为您自己创建一个IAM用户,获取IAM用户的Token。

获取Token方法:

Token可通过调用“获取Token”接口获取,接口调用示例如下。

  • 伪码
    POST https://iam.cn-southwest-2.myhuaweicloud.com/v3/auth/tokens
    Content-Type: application/json
    { 
        "auth": { 
            "identity": { 
                "methods": [ 
                    "password" 
                ], 
                "password": { 
                    "user": { 
                        "name": "username", //IAM用户名
                        "password": "********", //IAM用户密码
                        "domain": { 
                            "name": "domainname" //账号名
                        } 
                    } 
                } 
            }, 
            "scope": { 
                "project": { 
                    "name": "cn-southwest-2" //盘古大模型当前部署在“西南-贵阳一”区域,取值为cn-southwest-2
                } 
            } 
        } 
    }
  • Python
    import requests
    import json
    
    url = "https://iam.cn-southwest-2.myhuaweicloud.com/v3/auth/tokens"
    payload = json.dumps({
      "auth": {
        "identity": {
          "methods": [
            "password"
          ],
          "password": {
            "user": {
              "name": "username",
              "password": "********",
              "domain": {
                "name": "domainname"
              }
            }
          }
        },
        "scope": {
          "project": {
            "name": "cn-north-4"
          }
        }
      }
    })
    headers = {
      'Content-Type': 'application/json'
    }
    
    response = requests.request("POST", url, headers=headers, data=payload)
    
    print(response.headers["X-Subject-Token"])

获取Token步骤:

本示例中,通过使用Postman软件获取Token。

  1. 登录“我的凭证 > API凭证”页面,获取user name、domain name、project id。
    由于盘古大模型当前部署在“西南-贵阳一”区域,需要获取与“西南-贵阳一”区域对应的project id。
    图1 获取user name、domain name、project id
  2. 打开Postman,新建一个POST请求,并输入“西南-贵阳一”区域的“获取Token”接口。并填写请求Header参数。
    • 接口地址为:https://iam.cn-southwest-2.myhuaweicloud.com/v3/auth/tokens
    • 请求Header参数名为Content-Type,参数值为application/json
    图2 填写获取Token接口
  3. 填写“获取token”接口的请求体。在Postman中选择“Body > raw”选项,参考图3复制并填入以下代码,并填写user name、domain name、password。
    { 
        "auth": { 
            "identity": { 
                "methods": [ 
                    "password" 
                ], 
                "password": { 
                    "user": { 
                        "name": "username", //IAM用户名
                        "password": "********", //华为云账号密码
                        "domain": { 
                            "name": "domainname" //账号名
                        } 
                    } 
                } 
            }, 
            "scope": { 
                "project": { 
                    "name": "cn-southwest-2" //盘古大模型当前部署在“西南-贵阳一”区域,取值为cn-southwest-2
                } 
            } 
        } 
    }
    图3 填写请求Body
  4. 单击Postman界面“Send”按钮,发送请求。当接口返回状态为201时,表示Token接口调用成功,此时单击“Headers”选项,找到并复制“X-Subject-Token”参数对应的值,该值即为需要获取的Token。
    图4 获取Token

您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333

AK/SK认证

AK/SK签名认证方式仅支持消息体大小12M以内,12M以上的请求请使用Token认证。

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

  • AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。
  • SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。

使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南

如果之前没有生成过AK/SK,可登录“我的凭证”界面,选择访问密钥 > 新增访问密钥来获取。

签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。

AK/SK获取方式请参考获取AK/SK

相关文档