PolarDB バックアップログ取得用の DescribeBackupLogs API リファレンス - PolarDB

バックアップログのリストをクエリし、そのダウンロード URL を返します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeBackupLogs

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。	pc-**************
StartTime	string	必須	クエリする時間範囲の開始時刻。時刻のフォーマットは `YYYY-MM-DDThh:mmZ` です。時刻は UTC です。	2020-02-01T15:00Z
EndTime	string	必須	クエリする時間範囲の終了時刻。終了時刻は開始時刻より後である必要があります。時刻のフォーマットは `YYYY-MM-DDThh:mmZ` です。時刻は UTC です。	2020-02-12T15:00Z
BackupRegion	string	任意	バックアップリージョン。	cn-hangzhou
PageSize	integer	任意	各ページに返すエントリ数。有効な値： 30 50 100 デフォルト値は 30 です。	30
PageNumber	integer	任意	ページ番号。値は 0 より大きい整数で、Integer データ型の最大値を超えないようにする必要があります。デフォルト値は 1 です。	1

レスポンスフィールド

フィールド	型	説明	例
	object
TotalRecordCount	string	エントリの総数。	2
PageRecordCount	string	現在のページで返されるエントリ数。	2
RequestId	string	リクエスト ID。	ADAC63DB-0691-4ECE-949A-FAEA68******
PageNumber	string	ページ番号。	1
Items	object
BackupLog	array<object>	バックアップログの詳細。
	object
BackupLogId	string	バックアップログ ID。	1111111111
IntranetDownloadLink	string	バックアップログの内部ダウンロード URL。	http://***********.oss-cn-hangzhou-internal.aliyuncs.com
LinkExpiredTime	string	ダウンロード URL の有効期限。	2020-02-14T08:40:50Z
BackupLogStartTime	string	バックアップログの開始時刻。時刻のフォーマットは `YYYY-MM-DD'T'HH:mm:ssZ` です。時刻は UTC です。	2020-02-12T03:54:43Z
BackupLogEndTime	string	バックアップログの終了時刻。時刻のフォーマットは `YYYY-MM-DD'T'HH:mm:ssZ` です。時刻は UTC です。	2020-02-12T03:55:31Z
DownloadLink	string	バックアップログのパブリックダウンロード URL。	http://***********.oss-cn-hangzhou.aliyuncs.com
BackupLogSize	string	バックアップログファイルのサイズ (バイト単位)。	1073741824
BackupLogName	string	バックアップログファイルの名前。	ib_logfile1

例

成功レスポンス

JSONJSON

{
  "TotalRecordCount": "2",
  "PageRecordCount": "2",
  "RequestId": "ADAC63DB-0691-4ECE-949A-FAEA68******",
  "PageNumber": "1",
  "Items": {
    "BackupLog": [
      {
        "BackupLogId": "1111111111",
        "IntranetDownloadLink": "http://***********.oss-cn-hangzhou-internal.aliyuncs.com",
        "LinkExpiredTime": "2020-02-14T08:40:50Z",
        "BackupLogStartTime": "2020-02-12T03:54:43Z",
        "BackupLogEndTime": "2020-02-12T03:55:31Z",
        "DownloadLink": "http://***********.oss-cn-hangzhou.aliyuncs.com",
        "BackupLogSize": "1073741824",
        "BackupLogName": "ib_logfile1"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。