文档

使用OpenAPI示例

更新时间:

本文以Python语言为例,为您介绍如何使用阿里云OpenAPI的SDK开发包。

查看OpenAPI文档

在调用OpenAPI前,建议您阅读对应接口文档,了解、学习调用该接口所需要的参数及权限等,更多详情请参见API概览

创建RAM用户并完成授权

说明

如您已创建RAM用户且已完成授权,可跳过此步骤。

  1. 创建RAM用户。

    1. 访问RAM用户列表,单击创建用户

    2. 设置登录名称dypls-openapi-operator,选择访问方式OpenAPI 调用访问

    3. 单击确定,创建RAM用户并保存AccessKey ID与AccessKey Secret信息。

  2. 完成授权。

    1. 访问RAM用户列表,单击目标RAM用户操作列的添加权限

    2. 在文本框中搜索Aliyundypls,选择AliyunDyplsReadOnlyAccess策略。

      重要

      AliyunDyplsReadOnlyAccess拥有实际的操作权限,您也可以按需选择AliyunDyplsFullAccess权限(具有访问、查看权限)或进行自定义策略,更多详情请参见通过脚本编辑模式创建自定义权限策略

    3. 单击确定,完成授权操作。

调用OpenAPI

本文介绍阿里云Python语言SDK方式调用OpenAPI,其他语言SDK的用法也类似,更多信息请参见号码隐私保护SDK

准备Python环境

下载并安装Python 3。如您已安装Python,查看Python版本的命令示例:python --version

配置环境变量

配置环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET

  • Linux和macOS系统配置方法:将以下命令中的<access_key_id><access_key_secret>替换为您自己的AccessKey ID和AccessKey Secret,输入到终端运行。

    export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id>
    export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>
  • Windows系统配置方法:

    1. 新建环境变量文件,添加环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET,并写入已准备好的AccessKey ID和AccessKey Secret。

    2. 重启Windows系统。

安装依赖

在终端设备中,逐条运行如下命令,安装环境依赖。

pip3 install alibabacloud_credentials
pip install alibabacloud_dyplsapi20170525
pip3 install alibabacloud_tea_console

下载示例代码

以下操作以调用BindAxb接口为例,您可以在OpenAPI门户选择需要调用的接口。

  1. 访问BindAxb,进入该接口在OpenAPI门户的调试地址。

  2. 在左侧的参数配置页签,填写需要的参数信息,本示例需在服务地址中选择华东1(杭州)

  3. 在右侧的SDK示例页签,选择Python语言,单击下载完整工程按钮,下载示例代码包。

  4. 本地解压并进入alibabacloud_sample目录。

运行代码

执行以下命令:

python sample.py

返回示例如下:

 [
        LOG
    ] {
        "headers": {
            "date": "Fri, 07 Jul 2023 07:07:52 GMT", 
            "content-type": "application/json;charset=utf-8", 
            "content-length": "115", 
            "connection": "keep-alive", 
            "keep-alive": "timeout=25", 
            "access-control-allow-origin": "*", 
            "access-control-expose-headers": "*", 
            "x-acs-request-id": "8C87CFDC-F3EF-55E3-9661-BCBA1FF3****", 
            "x-acs-trace-id": "4ef68ba273fa232c203d83737198****", 
            "etag": "1P+Uo9nOE01KYKLpAKl1****"
        }, 
            
        "statusCode": 200,
        "body": {
            {
                "SecretBindDTO": {
                    "Extension": "1998320****",
                    "SecretNo": "1705552****",
                    "SubsId": "100011****464511"
                },
                "Message": "OK",
                "RequestId": "4A2568E1-7D83-5491-8DEF-600D8AFF97E7",
                "Code": "OK"
                }
            }
        }
  • 本页导读 (1)
文档反馈