DescribeBackup API による Cassandra クラスターバックアップ状態の取得 - Cassandra

この操作を呼び出して、バックアップの概要をクエリできます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストパラメータ

パラメータ	タイプ	必須	例	説明
Action	String	はい	DescribeBackup	実行する操作。値を DescribeBackup に設定します。
BackupId	String	はい	2020010121****	バックアップの ID。
BackupType	String	はい	Incremental	バックアップのタイプ。有効な値： full: 完全バックアップ。 Incremental: 増分バックアップ。
ClusterId	String	はい	cds-bp11tjzh50****78	バックアップ対象クラスターの ID。
DataCenterId	String	はい	cn-hangzhou-g	クラスター内のバックアップ対象データセンターの ID。

レスポンスパラメータ

パラメータ	タイプ	例	説明
Backup	Struct		バックアッププランの概要情報。
BackupId	String	2020010121****	バックアップの ID。
BackupType	String	Incremental	バックアップのタイプ。有効な値： full: 完全バックアップ。 Incremental: 増分バックアップ。
ClusterId	String	cds-bp11tjzh50****7v	バックアップ対象クラスターの ID。
DataCenterId	String	cn-hangzhou-g	クラスター内のバックアップ対象データセンターの ID。
Details	String	{"name": "cds-uf6m0bod**6159-20200226", "start": "2020-02-26 01:57:05", "end": "2020-02-26 02:12:50", "completeNodes": ["cds-uf6m0bod4159-1-core-002.cassandra.rds.aliyuncs.com", "cds-uf6m0bov6159-1-core-001.cassandra.rds.aliyuncs.com", "cds-uf6m0bod**6159-1-core-003.cassandra.rds.aliyuncs.com"], "incompleteNodes": [], "missingNodes": [], "files": 923, "size": 149016650}	バックアップの詳細。
EndTime	String	2020-01-01 21:48:54Z	バックアップタスクの終了時刻。時刻は ISO 8601 標準 (yyyy-MM-ddThh:mm:ssZ 形式) に従います。時刻は UTC で表示され、Z で表されます。
Size	Long	149016650	バックアップのサイズ。
StartTime	String	2020-01-01 21:48:40Z	バックアップタスクの開始時刻。時刻は ISO 8601 標準 (yyyy-MM-ddThh:mm:ssZ 形式) に従います。時刻は UTC で表示され、Z で表されます。
Status	String	Succeeded	バックアップのステータス。有効な値： Succeeded: バックアップが作成されました。 Failed: バックアップの作成に失敗しました。
RequestId	String	200FB963-9359-4CAD-90B7-96395C88FD9D	リクエストの ID。

例

リクエストの例

http(s)://[Endpoint]/? Action=DescribeBackup
&BackupId=2020010121****
&BackupType=Incremental
&ClusterId=cds-bp11tjzh50****78
&DataCenterId= cn-hangzhou-g
&<共通リクエストパラメータ>

正常なレスポンスの例

XML 形式

<DescribeBackupResponse>
      <RequestId>FA04A743-6C3F-4C06-A2B7-6B75B9D3D18C</RequestId>
      <Backup>
            <Status>Succeeded</Status>
            <DataCenterId>cn-shanghai-e</DataCenterId>
            <Details>{"name": "cds-uf6m0bod****6159-20200226", "start": "2020-02-26 01:57:05", "end": "2020-02-26 02:12:50", "completeNodes": ["cds-uf6m0bod****6159-1-core-002.cassandra.rds.aliyuncs.com", "cds-uf6m0bod****6159-1-core-001.cassandra.rds.aliyuncs.com", "cds-uf6m0bod****6159-1-core-003.cassandra.rds.aliyuncs.com"], "incompleteNodes": [], "missingNodes": [], "files": 923, "size": 149016650}
    </Details>
            <EndTime>2020-02-26T02:12:50Z</EndTime>
            <ClusterId>cds-uf6m0bo****v6159</ClusterId>
            <Size>149016650</Size>
            <StartTime>2020-02-26T01:57:00Z</StartTime>
            <BackupId>20200226</BackupId>
            <BackupType>Incremental</BackupType>
      </Backup>
</DescribeBackupResponse>

JSON 形式

{
  "RequestId": "FA04A743-6C3F-4C06-A2B7-6B75B9D3D18C",
  "Backup": {
    "Status": "Succeeded",
    "DataCenterId": "cn-shanghai-e",
    "Details": "{\"name\": \"cds-uf6m0bod****6159-20200226\", \"start\": \"2020-02-26 01:57:05\", \"end\": \"2020-02-26 02:12:50\", \"completeNodes\": [\"cds-uf6m0bod****6159-1-core-002.cassandra.rds.aliyuncs.com\", \"cds-uf6m0bod****6159-1-core-001.cassandra.rds.aliyuncs.com\", \"cds-uf6m0bod****6159-1-core-003.cassandra.rds.aliyuncs.com\"], \"incompleteNodes\": [], \"missingNodes\": [], \"files\": 923, \"size\": 149016650}\n",
    "EndTime": "2020-02-26T02:12:50Z",
    "ClusterId": "cds-uf6m0bo****v6159",
    "Size": 149016650,
    "StartTime": "2020-02-26T01:57:00Z",
    "BackupId": "20200226",
    "BackupType": "Incremental"
  }
}

エラーコード

エラーコードのリストについては、API エラーセンターをご覧ください。