文档

使用OpenAPI示例

更新时间:

本文介绍如何使用阿里云Python语言和Java语言SDK开发包,调用云原生多模数据库 Lindorm的GetInstanceIpWhiteList接口(获取实例的访问白名单)。

查看OpenAPI文档

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

创建RAM用户并完成授权

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

  1. 创建RAM用户:

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

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

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

  2. 完成授权:

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

    2. 在文本框中搜索AliyunLindorm,选择AliyunLindormReadOnlyAccess策略。

      说明

      AliyunLindormReadOnlyAccess策略拥有查询Lindorm实例的操作权限,您也可以按需选择AliyunLindormFullAccess权限(具有查询、修改Lindorm实例的完全控制权限)或进行自定义策略,更多信息请参见授权信息

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

调用OpenAPI

本文介绍阿里云Python语言和Java语言SDK方式调用OpenAPI,其他语言SDK的用法也类似,更多信息请参见云原生多模数据库Lindorm版SDK

您可以根据需求,选择如下任意一种语言,执行对应的操作。

准备环境

  • Java:下载并安装JDK 8。如您已安装Java,查看Java版本的命令示例:java -version

  • 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系统:新建环境变量文件,添加环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET,并写入已准备好的AccessKey ID和AccessKey Secret。然后重启Windows系统。

安装依赖

  • Java:在Maven项目的pom.xml中添加以下依赖。

    <dependency>
      <groupId>com.aliyun</groupId>
      <artifactId>hitsdb20200615</artifactId>
      <version>3.0.6</version>
    </dependency>
  • Python:在终端设备中,逐条运行如下命令,安装环境依赖。

    pip install alibabacloud_credentials
    pip install alibabacloud_hitsdb20200615
    pip install alibabacloud_tea_console

下载示例代码

  • Java

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

    2. 在左侧的参数配置页签,填写需要的参数信息。本示例需在InstanceId参数中输入实例ID,例如ld-bp1kq0x9jogz6****

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

    4. 本地解压并到将示例项目导入Java集成开发工具。

  • Python

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

    2. 在左侧的参数配置页签,填写需要的参数信息。本示例需在InstanceId参数中输入实例ID,例如ld-bp1kq0x9jogz6****

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

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

运行代码

  • Java

    运行sample目录下的Sample.java文件。

  • Python

    执行以下命令。

    python sample.py

返回示例如下。

{
	"InstanceId":"ld-bp1kq0x9jogz6****",
	"IpList":["192.***.*.0"],
	"RequestId":"D0E46BB4-FA32-5B19-A537-6B1B72451807"}
}
  • 本页导读 (1)
文档反馈