文档

使用OpenAPI示例

更新时间:

本文为您介绍使用OpenAPI创建定向分组的完整示例。

查看OpenAPI文档

阅读API概览,选择创建定向分组的OpenAPI:AddDirectionalGroup 。请您根据文档,了解调用该接口需要准备的数据和权限。

用户身份管理

身份

您可以使用阿里云账号(主账号)、RAM用户、RAM角色调用该接口,有关各种身份的差异,请参见概述。本案例中,使用RAM用户进行接口调用。

登录RAM访问控制,创建一个仅允许API调用的RAM用户,并记录AccessKey信息。具体操作,请参见创建RAM用户

授权

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

  2. 选择权限区块中输入关键字linkcard进行搜索,选择AliyunLinkCardFullAccess策略。

    说明

    AliyunLinkCardFullAccess:管理物联网卡(LC)的权限。

    AliyunLinkCardReadOnlyAccess:只读管理物联网卡(LC)的权限。

    如何创建自定义权限,请参见授权信息

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

凭证

在创建RAM用户时会默认生成一个AccessKey,可直接使用。您也可以进入到对应的RAM用户详情页面,在认证管理页签,单击创建AccessKey,创建一个新的AccessKey。具体操作,请参见创建AccessKey

调用OpenAPI

本文以Python语言为例,为您介绍OpenAPI的调用方法。

准备Python环境

  1. 下载并安装Python。

    Python 3的下载地址,请参见Python 3

  2. 查看Python版本。

    • Linux和macOS系统

      打开终端,输入命令python --version

    • Windows系统

      • 在Python的安装路径下,双击python.exe。

      • 打开命令提示符页面。

        通过键盘快捷键Win+R打开运行对话框,在输入框中输入命令python,单击确定

配置环境变量

为避免将AccessKey硬编码到业务代码中带来的安全风险,本示例采用配置环境变量的方法管理AccessKey。

  • 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系统

    新建环境变量文件,添加环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET,并写入已准备好的AccessKey ID和AccessKey Secret。然后重启Windows系统。

安装依赖

pip install alibabacloud_credentials
pip install alibabacloud_linkcard20210520==1.0.10
pip install alibabacloud_tea_console

下载示例代码

  1. 在OpenAPI门户,访问AddDirectionalGroup接口的调试地址

  2. 输入定向分组名称,然后单击发起调用

  3. 调用成功后,单击SDK示例页签,选择Python语言,然后单击下载完整工程,下载Python语言的SDK示例。

  4. 在本地解压Python示例代码包,并进入alibabacloud_sample目录。

运行代码

执行以下命令。

python sample.py

得到如下输出结果:

{
	"headers": {
		"date": "Thu, 10 Aug 2023 09:32:36 GMT",
		"content-type": "application/json;charset=utf-8",
		"content-length": "108",
		"connection": "keep-alive",
		"keep-alive": "timeout=25",
		"access-control-allow-origin": "*",
		"access-control-expose-headers": "*",
		"x-acs-request-id": "C378813C-FE74-5649-A36D-DE8F0******",
		"x-acs-trace-id": "e8251c94f4931e03480ebd170******",
		"etag": "1AoDYJ5m6Ox/nFKr4sa+M5g8"
	},
	"statusCode": 200,
	"body": {
		"Data": 10000004493,
		"LocalizedMessage": "",
		"RequestId": "C378813C-FE74-5649-A36D-DE8F08******",
		"Success": true
	}
}

  • 本页导读 (1)
文档反馈