使用阿里雲CLI調用資料災備OpenAPI - Data Management

本文以調用資料災備DescribeBackupPlanBilling介面查看備份計劃計費資訊為例，為您介紹使用阿里雲CLI調用資料災備OpenAPI的操作步驟。

前置概念

阿里雲CLI（Alibaba Cloud Command Line Interface）是基於OpenAPI構建的通用命令列工具，您可以通過阿里雲CLI實現自動化管理和維護資料災備。更多資訊，請參見什麼是阿里雲 CLI。

當您需要使用CLI調用API完成相對複雜的任務時，建議將CLI整理成Shell指令碼後再執行，以提高效率。

步驟一：安裝阿里雲CLI

使用阿里雲CLI前，您需要先安裝阿里雲CLI。阿里雲CLI為使用者提供了Windows、Linux和macOS三種作業系統下的安裝服務，請根據您使用裝置的作業系統選擇對應的安裝服務。

Cloud Shell中預裝了阿里雲CLI，且自動為您配置身份憑證，無需手動操作。您可在Cloud Shell中調試阿里雲CLI命令。更多資訊，請參見什麼是雲命令列。

步驟二：配置阿里雲CLI

重要

阿里雲帳號（主帳號）擁有所有產品OpenAPI的管理和存取權限，風險很高。強烈建議您建立RAM使用者（子帳號），並依據最小化許可權原則授予許可權，使用RAM使用者身份訪問OpenAPI。資料災備支援的權限原則，請參見資料災備（DBS）系統權限原則參考及資料災備（DBS）自訂權限原則參考。

使用阿里雲CLI之前，您需要在阿里雲CLI中配置身份憑證、地區ID等資訊。阿里雲CLI支援多種身份憑證，詳情請參見配置與管理身份憑證。阿里雲CLI支援使用RAM使用者的AccessKey資訊配置AK類型身份憑證，具體操作步驟如下：

建立一個RAM使用者，並建立AccessKey，以便後續配置身份憑證使用。具體操作，請參見建立RAM使用者及建立AccessKey。
為RAM使用者授權。本文樣本需授予RAM使用者唯讀訪問資料災備的許可權AliyunDBSReadOnlyAccess。具體操作，請參見管理RAM使用者的許可權。
擷取可用的地區ID，以便後續配置身份憑證使用。阿里雲CLI將使用您指定的地區發起OpenAPI調用。資料災備的可用地區請參見服務存取點。
說明
使用阿里雲CLI過程中您可使用--region選項指定地區發起命令調用，該選項在使用時將忽略預設身份憑證配置及環境變數設定中的地區資訊。詳情請參見命令列選項。
使用RAM使用者的AccessKey配置AK類型憑證，設定檔命名為AkProfile。具體操作，請參見配置與管理身份憑證。

步驟三：產生CLI命令樣本

在OpenAPI門戶中，訪問DescribeBackupPlanBilling調試地址。
在參數配置地區，填寫 BackupPlanId（備份計劃ID）和 ShowStorageType（是否展示儲存類型）參數，然後單擊右側的 CLI樣本 Tab，即可產生對應的 CLI 命令，例如 aliyun dbs DescribeBackupPlanBilling --region cn-hangzhou。單擊命令右側的運行或複製按鈕即可執行或複製該命令。
在參數配置中輸入請求參數，單擊CLI樣本頁簽，查看產生的CLI樣本。
複製CLI樣本或在Cloud Shell中快速執行：
- 單擊運行命令按鈕，可喚出Cloud Shell並快速完成命令調試。
- 單擊複製按鈕，將CLI樣本複製到剪貼簿中，可粘貼至本地Shell工具中運行或用於編輯自動化命令列指令碼。
說明
複製CLI樣本到本地Shell工具中進行調試時請注意參數格式。關於阿里雲CLI命令參數使用格式的詳細資料，請參見理解命令列參數。
OpenAPI門戶產生樣本中會預設添加--region選項，複製命令到本地調用時阿里雲CLI將忽略預設身份憑證配置及環境變數設定中的地區資訊，優先使用指定的地區調用命令，您可根據需要對該選項進行刪除或保留。

步驟四：調用資料災備（DBS）OpenAPI

說明

阿里雲CLI內整合資料災備2019-03-06版本OpenAPI，若您需要使用其他版本OpenAPI，請使用--force選項及--version選項發起強制調用。具體操作，請參見強制調用介面。
OpenAPI門戶在為資料災備2021-01-01版本OpenAPI產生命令樣本時會自動添加--force選項及--version選項，無需手動更改。
更多可用API資訊，請參見API概覽（2019-03-06）及API概覽（2021-01-01）。

樣本一：擷取OpenAPI列表

以下樣本將為您展示如何使用--help選項擷取支援阿里雲CLI調用的資料災備2019-03-06OpenAPI列表。

執行以下命令。
```
aliyun dbs --help
```

預期輸出。

Product: Dbs ()
Version: 2019-03-06
Available Api List:
  ConfigureBackupPlan
  CreateAndStartBackupPlan
  CreateBackupPlan
  CreateFullBackupSetDownload
  CreateGetDBListFromAgentTask
  CreateIncrementBackupSetDownload
  CreateRestoreTask

樣本二：查看備份計劃計費資訊

以下樣本將為您展示如何使用阿里雲CLI調用資料災備的DescribeBackupPlanBilling介面，查看指定備份計劃的計費資訊。更多介面資訊，請參見查看備份計劃計費資訊。

執行命令。

aliyun dbs DescribeBackupPlanBilling --BackupPlanId 'dbstooi01ex****' --ShowStorageType true

輸出結果。

{
  "HttpStatusCode": 200,
  "RequestId": "DD7BC7F5-4E3A-5DF3-BFF9-831503C4D9E3",
  "Success": true,
  "Item": {
    "BuyCreateTimestamp": 1658372830000,
    "FullStorageSize": 151,
    "BuyExpiredTimestamp": 1661097600000,
    "BuySpec": "micro",
    "QuotaEndTimestamp": 1659283200000,
    "IsExpired": true,
    "QuotaStartTimestamp": 1656604800000,
    "TotalFreeBytes": 858993459200,
    "PaiedBytes": 0,
    "UsedFullBytes": 0,
    "IsFreeBytesUnlimited": true,
    "ContStorageSize": 10437039,
    "BuyChargeType": "PREPAY",
    "UsedIncrementBytes": 9406734
  }
}

說明

若調用資料災備OpenAPI後返回錯誤，您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確。

您可以記錄下調用返回的RequestID或SDK報錯資訊，通過阿里雲OpenAPI診斷平台進行自助診斷。