查看OpenAPI文檔

在調用OpenAPI前，建議您先閱讀對應接口文檔，了解、學習調用該接口所需要的參數及權限等，更多信息請參見API概覽。

創建RAM用戶并完成授權

如您已創建RAM用戶且已完成授權，可跳過此步驟。

1. 創建RAM用戶：

   1. 訪問RAM用戶列表，單擊創建用戶。

   2. 設置登錄名稱為hitsdb-openapi-operator，選擇訪問方式為使用永久 AccessKey 訪問。

   3. 單擊確定，創建RAM用戶并保存AccessKey ID與AccessKey Secret信息。

2. 完成授權：

   1. 訪問RAM用戶列表，單擊目標RAM用戶操作列的添加權限。

   2. 在文本框中搜索AliyunLindorm，選擇AliyunLindormReadOnlyAccess策略。

      說明

      AliyunLindormReadOnlyAccess策略擁有查詢Lindorm實例的操作權限，您也可以按需選擇AliyunLindormFullAccess權限（具有查詢、修改Lindorm實例的完全控制權限）或進行自定義策略，更多信息請參見授權信息。

   3. 單擊確認新增授權，完成授權操作。

調用OpenAPI

本文介紹阿里云Java語言SDK方式調用OpenAPI，其他語言SDK的用法也類似，更多信息請參見云原生多模數據庫Lindorm版SDK。

準備環境

下載并安裝JDK 8。如您已安裝Java，查看Java版本的命令示例：java -version。

配置環境變量

配置環境變量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_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_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET，并寫入已準備好的AccessKey ID和AccessKey Secret。然后重啟Windows系統。

安裝依賴

在Maven項目的pom.xml中添加以下依賴。

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>hitsdb20200615</artifactId>
  <version>3.0.6</version>
</dependency>

下載示例代碼

1. 訪問GetInstanceIpWhiteList，進入該接口在OpenAPI門戶的調試地址。

2. 在左側的參數配置頁簽，填寫需要的參數信息。本示例需在InstanceId參數中輸入實例ID，例如ld-bp1kq0x9jogz6****。

3. 在右側的SDK示例頁簽，選擇Java語言，單擊下載完整工程按鈕，下載示例代碼包。

4. 本地解壓并到將示例項目導入Java集成開發工具。

運行代碼

運行sample目錄下的Sample.java文件。

返回示例如下。

{
	"InstanceId":"ld-bp1kq0x9jogz6****",
	"IpList":["192.***.*.0"],
	"RequestId":"D0E46BB4-FA32-5B19-A537-6B1B72451807"}
}