DescribeBackups - ApsaraDB RDS - Alibaba Cloud ドキュメントセンター

この API は、RDS インスタンスのバックアップセットリストを表示するために使用されます。

操作説明

サポートされるエンジン

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

rds:DescribeBackups

get

DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。 DescribeDBInstances 操作を呼び出して、インスタンス ID を照会できます。	rm-uf6wjk5****
BackupId	string	任意	バックアップセットの ID。	327329803
BackupStatus	string	任意	バックアップセットのステータス。有効な値： Success Failed	Success
BackupMode	string	任意	バックアップモード。有効な値： Automated Manual	Automated
StartTime	string	任意	照会する時間範囲の開始時刻。時間は ISO 8601 標準に準拠した yyyy-MM-ddTHH:mmZ 形式で指定します。時刻は協定世界時 (UTC) である必要があります。	2011-06-01T16:00Z
EndTime	string	任意	照会する時間範囲の終了時刻。終了時刻は開始時刻より後である必要があります。時間は ISO 8601 標準に準拠した yyyy-MM-ddTHH:mmZ 形式で指定します。時刻は協定世界時 (UTC) である必要があります。説明タイムアウトを避けるために、できるだけ短い時間範囲を指定することを推奨します。	2011-06-15T16:00Z
PageSize	integer	任意	ページあたりのエントリ数。有効な値： 30 50 100 デフォルト値： 30。	30
PageNumber	integer	任意	返されるページ番号。有効な値：ゼロ以外の正の整数。デフォルト値： 1。	1
BackupType	string	任意	バックアップタイプ。有効な値： FullBackup：完全バックアップ IncrementalBackup：増分バックアップ	FullBackup

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
Items	object
Backup	array<object>	返されたバックアップセット。
	array<object>	返されたバックアップセットの詳細。
BackupDownloadLinkByDB	object
BackupDownloadLinkByDB	array<object>	個々のデータベースのバックアップセットをダウンロードできる URL で構成される配列。
	object
DataBase	string	データベースの名前。	dbs
DownloadLink	string	バックアップセットをダウンロードできるパブリック URL。	https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1
IntranetDownloadLink	string	バックアップセットをダウンロードできる内部 URL。	https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1
BackupDownloadURL	string	インターネット経由でバックアップセットをダウンロードするために使用される URL。バックアップセットをダウンロードできない場合は、null が返されます。説明例えば、ApsaraDB RDS for SQL Server インスタンスの BackupMethod が Snapshot に設定されている場合、null 文字列が返されます。	http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/****
BackupEndTime	string	バックアップタスクの終了時刻。時刻は ISO 8601 標準に準拠した yyyy-MM-ddTHH:mmZ 形式で表示されます。時刻は協定世界時 (UTC) で表示されます。	2019-02-13T12:20:00Z
BackupId	string	バックアップセットの ID。	321020562
BackupInitiator	string	バックアップタスクの開始元。有効な値： System User	System
BackupIntranetDownloadURL	string	内部ネットワーク経由でバックアップセットをダウンロードするために使用される URL。バックアップセットをダウンロードできない場合は、null が返されます。説明例えば、ApsaraDB RDS for SQL Server インスタンスの BackupMethod が Snapshot に設定されている場合、null 文字列が返されます。	http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/****
BackupMethod	string	バックアップセットの生成に使用されるメソッド。有効な値： Logical：論理バックアップ Physical：物理バックアップ Snapshot：スナップショットバックアップ	Physical
BackupMode	string	バックアップセットのバックアップモード。有効な値： Automated Manual	Automated
BackupSize	integer	データバックアップファイルのサイズ。単位：バイト。	2167808
BackupStartTime	string	バックアップの開始時刻。時刻は ISO 8601 標準に準拠した yyyy-MM-ddTHH:mmZ 形式で表示されます。時刻は協定世界時 (UTC) で表示されます。	2019-02-03T12:20:00Z
BackupStatus	string	バックアップセットの状態。	Success
BackupType	string	バックアップセットのバックアップタイプ。有効な値： FullBackup IncrementalBackup	FullBackup
Checksum	string	チェックサム。このパラメーターの値は、CRC64 アルゴリズムを使用して計算されます。	1835830439****
ConsistentTime	integer	バックアップセット内のデータが整合している時点。このパラメーターの戻り値はタイムスタンプです。説明インスタンスが MySQL 5.6 を実行している場合、タイムスタンプが返されます。それ以外の場合は、値 0 が返されます。	1576506856
CopyOnlyBackup	string	バックアップセットのバックアップモード。有効な値： 0：標準モード。このモードは、完全バックアップと増分バックアップをサポートします。 1：コピーのみモード。このモードは、完全バックアップのみをサポートします。説明このパラメーターは、インスタンスが SQL Server を実行している場合にのみ返されます。	0
DBInstanceId	string	インスタンス ID。	rm-uf6wjk5****
Encryption	string	バックアップセットに関する暗号化情報。	{}
Engine	string	データベースエンジンのタイプ。有効な値： MySQL SQLServer PostgreSQL MariaDB	MySQL
EngineVersion	string	データベースエンジンのバージョン。	8.0
HostInstanceID	string	バックアップセットを生成するインスタンスの ID。このパラメーターは、バックアップセットを生成するインスタンスがプライマリインスタンスかセカンダリインスタンスかを示します。	5882781
IsAvail	integer	バックアップセットが利用可能かどうかを示します。有効な値： 0：バックアップセットは利用できません。 1：バックアップセットは利用可能です。	1
MetaStatus	string	個々のデータベースまたはテーブルを復元するために使用されるバックアップセットのステータス。有効な値： OK：データバックアップファイルは正常です。 LARGE：データバックアップファイルには異常に多数のテーブルが含まれています。個々のデータベースまたはテーブルの復元には使用できません。 EMPTY：データバックアップファイルは、失敗したバックアップタスクから生成されました。説明空の文字列が返された場合、データバックアップファイルは個々のデータベースまたはテーブルの復元に使用できません。	OK
StorageClass	string	バックアップセットのストレージクラス。有効な値： 0：通常ストレージ 1：アーカイブストレージ	0
StoreStatus	string	バックアップセットを削除できるかどうかを示します。有効な値： Enabled：バックアップセットは削除できます。 Disabled：バックアップセットは削除できません。	Disabled
ExpectExpireTime	string	バックアップセットの有効期限。yyyy-MM-ddTHH:mmZ (UTC 時間) 形式。説明この値は、バックアップ保持期間が設定されている SQL Server インスタンスの単一データベースのバックアップに対してのみ返されます。	2025-06-17T12:10:23Z
PageNumber	string	返されたページのページ番号。	1
PageRecordCount	string	現在のページのバックアップセット数。	30
RequestId	string	リクエスト ID。	1A6D328C-84B8-40DC-BF49-6C73984D7494
TotalEcsSnapshotSize	integer	インスタンスのスナップショットチェーンのサイズ。単位：バイト。	0
TotalRecordCount	string	返されたエントリの総数。	100

例

成功レスポンス

JSONJSON

{
  "Items": {
    "Backup": [
      {
        "BackupDownloadLinkByDB": {
          "BackupDownloadLinkByDB": [
            {
              "DataBase": "dbs",
              "DownloadLink": "https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1",
              "IntranetDownloadLink": "https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1"
            }
          ]
        },
        "BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/****",
        "BackupEndTime": "2019-02-13T12:20:00Z",
        "BackupId": "321020562",
        "BackupInitiator": "System",
        "BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/****",
        "BackupMethod": "Physical",
        "BackupMode": "Automated",
        "BackupSize": 2167808,
        "BackupStartTime": "2019-02-03T12:20:00Z",
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "Checksum": "1835830439****",
        "ConsistentTime": 1576506856,
        "CopyOnlyBackup": "0",
        "DBInstanceId": "rm-uf6wjk5****",
        "Encryption": "{}",
        "Engine": "MySQL",
        "EngineVersion": "8.0",
        "HostInstanceID": "5882781",
        "IsAvail": 1,
        "MetaStatus": "OK",
        "StorageClass": "0",
        "StoreStatus": "Disabled",
        "ExpectExpireTime": "2025-06-17T12:10:23Z"
      }
    ]
  },
  "PageNumber": "1",
  "PageRecordCount": "30",
  "RequestId": "1A6D328C-84B8-40DC-BF49-6C73984D7494",
  "TotalEcsSnapshotSize": 0,
  "TotalRecordCount": "100"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidRestoreTime.Malformed	The requested restoreTime param is invalid, or the requested restoreTime is not within the scope of the instance backup.
400	InvalidPageNumbers.Malformed	Specified page number is not valid.
400	InvalidStartTime.Format	Specified start time is not valid.
400	InvalidEndTime.Format	Specified end time is not valid.
400	InvalidParameterCombination	The end time must be greater than the start time
400	InvalidDBinstanceClass.ValueNotSupported	The specified parameter DBinstanceClass is invalid.
400	InvalidBackupSetLocation.Format	Specified backup set location is not valid.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.
403	InvalidMaxRecordsPerPage.Malformed	Specified record number is not valid.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
404	InvalidDBInstanceName.NotFound	The database instance does not exist.
404	InvalidDBInstance.NotFound	The specified instance does not exist or is not supported.
404	Request.NotFound	The requested resource is not available.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	HostInfo.NotFound	The specified host info is not found.

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

変更履歴

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