查看OpenAPI文檔

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

創建RAM用戶并完成授權

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

1. 創建RAM用戶：

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

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

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

2. 完成授權：

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

   2. 在文本框中搜索AliyunADB，選擇AliyunADBReadOnlyAccess策略。

      說明

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

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

調用OpenAPI

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

準備Python環境

下載并安裝Python 3。如您已安裝Python，查看Python版本的命令示例：python --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系統。

安裝依賴

在終端設備中，逐條運行如下命令，安裝環境依賴。

pip install alibabacloud_credentials
pip install alibabacloud_adb20190315
pip install alibabacloud_tea_console

下載示例代碼

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

2. 在左側的參數配置頁簽，填寫需要的參數信息，本示例需在RegionId參數中輸入cn-hangzhou。

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

4. 本地解壓并進入alibabacloud_sample目錄。

運行代碼

執行以下命令。

python sample.py

返回示例如下。

[
  LOG
] {
  "headers":{
    "date":"Tue, 01 Aug 2023 02:05:31 GMT",
    "content-type":"application/json;charset=utf-8",
    "content-length":"1042","connection":"keep-alive",
    "keep-alive":"timeout=25","vary":"Accept-Encoding",
    "access-control-allow-origin":"*",
    "access-control-expose-headers":"*",
    "x-acs-request-id":"A239D19A-3862-52A9-8D85-09E65F07****",
    "x-acs-trace-id":"a1f567557dc98fb5f368346302e6****",
    "etag":"1uiSaYPuCXwyGD9ECHaa****"
  },
  "statusCode":200,
  "body":{
    "Items":{
      "DBCluster":[
        {
          "Category":"MIXED_STORAGE",
          "CommodityCode":"ads",
          "ComputeResource":"32Core128GBNEW",
          "ConnectionString":"am-bp1255hwaziiskcnu9****.ads.aliyuncs.com",
          "CreateTime":"2023-07-31T05:40:36Z",
          "DBClusterDescription":"am-bp1255hwaziis****",
          "DBClusterId":"am-bp1255hwaziis****",
          "DBClusterNetworkType":"VPC",
          "DBClusterStatus":"Running",
          "DBClusterType":"Common",
          "DBNodeClass":"E32",
          "DBNodeCount":1,
          "DBNodeStorage":100,
          "DBVersion":"3.0",
          "DiskType":"cloud_essd",
          "DtsJobId":"",
          "ElasticIOResource":1,
          "Engine":"AnalyticDB",
          "ExecutorCount":2,
          "LockMode":"Unlock",
          "LockReason":"",
          "Mode":"flexible",
          "PayType":"Postpaid",
          "Port":"3306",
          "RdsInstanceId":"",
          "RegionId":"cn-hangzhou",
          "ResourceGroupId":"rg-acfmz7u4zzr****",
          "StorageResource":"24Core192GB",
          "Tags":{"Tag":[]},
          "VPCCloudInstanceId":"am-bp1255hwaziis****-controller",
          "VPCId":"vpc-bp1ov7as4yvz4kxei****",
          "VSwitchId":"vsw-bp14jupk2fa0avw8v****",
          "ZoneId":"cn-hangzhou-h"
        }
      ]
    },
    "PageNumber":1,
    "PageSize":30,
    "RequestId":"A239D19A-3862-52A9-8D85-09E65F07B98C","TotalCount":1
  }
}