更新时间:2025-01-24 gmt 08:00

python-九游平台

本节以intellij idea版本为例,介绍如何在python环境中集成api请求签名的sdk。您可以直接导入示例工程体验,然后参考调用说明部分将签名sdk集成到您的应用中。

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

准备环境

  • 获取并安装intellij idea 2018.3.5或以上版本,可至下载。
  • 获取并安装python安装包(可使用2.7.9 或3.x,包含2.7.9),可至下载。
    python安装完成后,在命令行中使用pip安装“requests”库。
    pip install requests

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

  • 在idea中安装python插件,如下图所示。

获取sdk

解压后目录结构如下:

名称

说明

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系统为例在本地将已设置为环境变量。
      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)
    

相关文档

网站地图