文档首页/ API签名指南/ API签名指南/ AK/SK签名认证操作指导/ 签名SDK与demo/ Python
更新时间：2024-07-19 GMT+08:00
查看PDF
分享

Python

本节以IntelliJ IDEA版本为例，介绍如何在Python环境中集成API请求签名的SDK。您可以直接导入示例工程体验，然后参考调用说明部分将签名SDK集成到您的应用中。

签名SDK只包含签名功能，不包含云服务的SDK功能，云服务SDK请参见SDK。

准备环境

  • 获取并安装IntelliJ IDEA 2018.3.5或以上版本，可至IntelliJ IDEA官方网站下载。
  • 获取并安装Python安装包（可使用2.7.9+或3.X，包含2.7.9），可至Python官方下载页面下载。
    Python安装完成后，在命令行中使用pip安装“requests”库。 
    pip install requests

    如果pip安装requests遇到证书错误，请下载并使用Python执行此文件，升级pip，然后再执行以上命令安装。

  • 在IDEA中安装Python插件，如下图所示。

获取SDK

点此下载SDK与Demo。

解压后目录结构如下：

名称

说明

apig_sdk\__init__.py

SDK代码

apig_sdk\signer.py

main.py

示例代码

licenses\license-requests

第三方库license文件

示例工程导入

  1. 打开IDEA，选择菜单“File > New > Project”。

    弹出“New Project”对话框，选择“Python”，单击“Next”。

  2. 再次单击“Next”，弹出以下对话框。单击“...”，在弹出的对话框中选择解压后的SDK路径，单击“Finish”。

  3. 完成工程创建后，目录结构如下。

请求签名与API调用

  1. 在命令行中，使用pip安装“requests”库。 

    1
    		 
    pip install requests

  2. 在工程中引入apig_sdk。 

    1
2
    		 
    from apig_sdk import signer
import requests

  3. 生成一个新的Signer，填入AK和SK。

    1. 本示例以AK和SK保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。
      1. 打开终端，输入以下命令打开环境变量配置文件。

        vi ~/.bashrc

      2. 设置环境变量，保存文件并退出编辑器。 
        export HUAWEICLOUD_SDK_AK="已获取AK值" 
export HUAWEICLOUD_SDK_SK="已获取SK值"
      3. 输入以下命令使配置文件生效。

        source ~/.bashrc

    2. 生成一个新的Signer，填入已设置的环境变量。 
      1
2
3
4
5
6
      		 
      sig = signer.Signer()
# Set the AK/SK to sign and authenticate the request.
# Directly writing AK/SK in code is risky. For security, encrypt your AK/SK and store them in the configuration file or environment variables.
# In this example, the AK/SK are stored in environment variables for identity authentication. Before running this example, set environment variables HUAWEICLOUD_SDK_AK and HUAWEICLOUD_SDK_SK.
sig.Key = os.getenv('HUAWEICLOUD_SDK_AK')
sig.Secret = os.getenv('HUAWEICLOUD_SDK_SK')

  4. 生成一个新的Request，指定域名、方法名、请求uri和body。

    以虚拟私有云服务的查询VPC列表接口为例，HTTP方法为GET，域名（Endpoint）为service.region.example.com，请求URI：/v1/77b6a44cba5143ab91d13ab9a8ff44fd/vpcs?limit=1 
    1
2
3
    		 
    # The following example shows how to set the request URL and parameters to query a VPC list.
r = signer.HttpRequest("GET", "https://{service}.region.example.com/v1/77b6a44cba5143ab91d13ab9a8ff44fd/vpcs?limit=1")
# r.body = "{\"a\":1}"

  5. 添加需要签名的请求消息头，或者其他用途的头域，如多项目场景中添加X-Project-Id，或者全局服务场景中添加X-Domain-Id。如果添加多个请求消息头，使用英文逗号分隔。 

    1
    		 
    r.headers = {"X-Project-Id": "xxx"}

  6. 进行签名，执行此函数会在请求参数中添加用于签名的X-Sdk-Date头和Authorization头。 

    1
    		 
    sig.Sign(r)
    • X-Sdk-Date是一个必须参与签名的请求消息头参数。
    • 您无需关注哪些消息头参数参与了签名，由SDK自行完成。

  7. 访问API，查看访问结果。 

    1
2
3
    		 
    resp = requests.request(r.method, r.scheme + "://" + r.host + r.uri, headers=r.headers, data=r.body)
print(resp.status_code, resp.reason)
print(resp.content)

父主题： 签名SDK与demo

相关文档