DescribeIncrementBackupList - - Alibaba Cloud ドキュメントセンター

Database Backup Service (DBS) の増分バックアップジョブのリストを照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dbs:DescribeIncrementBackupList

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
BackupPlanId	string	必須	バックアップスケジュールの ID。このパラメーターを取得するには、DescribeBackupPlanList 操作を呼び出します。	dbsqdss5tmh****
PageSize	integer	任意	各ページに表示するレコード数。有効な値：30、50、100。説明デフォルト値は 30 です。	30
PageNum	integer	任意	ページ番号。値は 0 以上で、整数の最大値を超えることはできません。デフォルト値は 0 です。	1
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。これにより、重複したリクエストの送信を防ぎます。	ETnLKlblzczshOTUbOCzxxxxxxx
ShowStorageType	boolean	任意	ストレージクラスを表示するかどうかを指定します。有効な値： true false 説明デフォルト値：true。	true
StartTimestamp	integer	任意	バックアップの開始を表す UNIX タイムスタンプ。	1570701361528
EndTimestamp	integer	任意	バックアップの終了を表す UNIX タイムスタンプ。	1570701361600

レスポンスフィールド

フィールド	型	説明	例
	object
HttpStatusCode	integer	HTTP ステータスコード。	200
PageNum	integer	ページ番号。	0
RequestId	string	リクエスト ID。	A5D52069-E8AA-5056-8C5C-654C3610****
ErrCode	string	エラーコード。	Param.NotFound
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true
ErrMessage	string	エラーメッセージ。	The specified parameter %s value is not valid.
TotalPages	integer	総ページ数。	1
TotalElements	integer	増分バックアップジョブの総数。	1
PageSize	integer	各ページのレコード数。	30
Items	object
IncrementBackupFile	array<object>	増分バックアップジョブの詳細。
	object	増分バックアップジョブの詳細。
EndTime	integer	バックアップの終了を表す UNIX タイムスタンプ。	1648434713000
BackupSetExpiredTime	integer	バックアップセットの有効期限を表す UNIX タイムスタンプ。	1711506719000
StartTime	integer	バックアップの開始を表す UNIX タイムスタンプ。	1648433764000
StorageMethod	string	ストレージクラス。有効な値： Standard：標準 IA：低頻度アクセス (IA) Archive：アーカイブストレージ UNKNOWN：不明。通常、これはジョブが完了していない場合のステータスです。	Standard
BackupSetJobId	string	バックアップセットジョブの ID。	1hv5g9wk4****
BackupSetId	string	バックアップセットの ID。	mysql-bin.00****
BackupStatus	string	バックアップジョブのステータス。有効な値： INIT：未開始 FILLING：バックアップ中 COMPLETED：完了 UNCOMPLETED：未完了	FILLING
SourceEndpointIpPort	string	データベースのエンドポイント。	172.1XX.103.1:4XXX
BackupSize	integer	バックアップサイズ。	18535

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "PageNum": 0,
  "RequestId": "A5D52069-E8AA-5056-8C5C-654C3610****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 30,
  "Items": {
    "IncrementBackupFile": [
      {
        "EndTime": 1648434713000,
        "BackupSetExpiredTime": 1711506719000,
        "StartTime": 1648433764000,
        "StorageMethod": "Standard",
        "BackupSetJobId": "1hv5g9wk4****",
        "BackupSetId": "mysql-bin.00****",
        "BackupStatus": "FILLING",
        "SourceEndpointIpPort": "172.1XX.103.1:4XXX",
        "BackupSize": 18535
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	Request.Forbidden	Have no Permissions

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

変更履歴

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