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

あるリージョンでクロスリージョンバックアップ機能が有効になっているインスタンスと、それらのインスタンスのクロスリージョンバックアップ設定を照会します。

操作説明

サポートされるデータベースエンジン

MySQL
PostgreSQL
SQL Server

今すぐお試しください

この 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:DescribeCrossRegionBackupDBInstance

get

*DBInstance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。	cn-hangzhou
DBInstanceId	string	任意	インスタンス ID。1 回のリクエストで最大 30 個のインスタンス ID を指定できます。複数のインスタンス ID を入力する場合は、コンマ (,) で区切ります。	rm-uf6wjk5****
PageSize	integer	任意	1 ページあたりに返すエントリ数。デフォルト値：30。	30
PageNumber	integer	任意	返すページ番号。有効な値：0 以外の正の整数。デフォルト値：1。	1

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
Items	object
Item	array<object>	クロスリージョンバックアップ設定。
	object
BackupEnabled	string	インスタンスのクロスリージョンバックアップ機能のステータス。有効な値： Disable Enable	Enable
BackupEnabledTime	string	インスタンスでクロスリージョンバックアップが有効になった時刻。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。時刻は協定世界時 (UTC) で表示されます。	2019-06-12T05:44:21Z
CrossBackupRegion	string	クロスリージョンバックアップファイルが保存されるターゲットリージョンの ID。	cn-shanghai
CrossBackupType	string	インスタンスのクロスリージョンバックアップファイルを保存するために使用されるポリシー。デフォルト値：1。値 1 は、すべてのクロスリージョンバックアップファイルが保存されることを示します。	1
DBInstanceDescription	string	インスタンス名。長さは 2～256 文字である必要があります。値には、文字、数字、アンダースコア (_)、ハイフン (-) を使用でき、先頭は文字である必要があります。説明値の先頭に http:// または https:// を使用することはできません。	testdb
DBInstanceId	string	インスタンス ID。	rm-uf6wjk5****
DBInstanceStatus	string	インスタンスステータス。詳細については、「インスタンスステータス」をご参照ください。	Running
Engine	string	インスタンスのデータベースエンジン。	MySQL
EngineVersion	string	データベースエンジンバージョン。	5.6
LockMode	string	インスタンスのロックステータス。有効な値： Unlock：インスタンスはロックされていません。 ManualLock：インスタンスは手動でロックされています。 LockByExpiration：インスタンスは有効期限が切れると自動的にロックされます。 LockByRestoration：インスタンスはロールバックされる前に自動的にロックされます。 LockByDiskQuota：ストレージ容量が使い果たされ、インスタンスにアクセスできなくなったため、インスタンスは自動的にロックされます。	Unlock
LogBackupEnabled	string	インスタンスのクロスリージョンログバックアップ機能のステータス。有効な値： Disable Enable	Enable
LogBackupEnabledTime	string	インスタンスでクロスリージョンログバックアップ機能が有効になった時刻。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。時刻は協定世界時 (UTC) で表示されます。	2019-06-12T05:44:21Z
RetentType	integer	インスタンスのクロスリージョンバックアップファイルを保持するために使用されるポリシー。クロスリージョンバックアップは、指定された保持期間に基づいてのみ保持できます。デフォルト値：1。	1
Retention	integer	インスタンスのクロスリージョンバックアップファイルが保持される日数。有効な値：7～1825。	15
ItemsNumbers	integer	クロスリージョンバックアップ設定で返されたアイテムの総数。	1
PageNumber	integer	ページ番号。ページは 1 から始まります。デフォルト値：1。	1
PageSize	integer	1 ページあたりのエントリ数。デフォルト値：30。	30
RegionId	string	リージョン ID。	cn-hangzhou
RequestId	string	リクエスト ID。	33517002-182D-40BE-93EC-610BD3381045
TotalRecords	integer	返されたエントリの総数。	100

例

成功レスポンス

JSONJSON

{
  "Items": {
    "Item": [
      {
        "BackupEnabled": "Enable",
        "BackupEnabledTime": "2019-06-12T05:44:21Z",
        "CrossBackupRegion": "cn-shanghai",
        "CrossBackupType": "1",
        "DBInstanceDescription": "testdb",
        "DBInstanceId": "rm-uf6wjk5****",
        "DBInstanceStatus": "Running",
        "Engine": "MySQL",
        "EngineVersion": "5.6",
        "LockMode": "Unlock",
        "LogBackupEnabled": "Enable",
        "LogBackupEnabledTime": "2019-06-12T05:44:21Z",
        "RetentType": 1,
        "Retention": 15
      }
    ]
  },
  "ItemsNumbers": 1,
  "PageNumber": 1,
  "PageSize": 30,
  "RegionId": "cn-hangzhou",
  "RequestId": "33517002-182D-40BE-93EC-610BD3381045",
  "TotalRecords": 100
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameters.Format	Specified parameter is not valid.
400	InvalidRegion.Format	Specified Region 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	CrossBackupNotSupport	Specified region not support cross region backup.
403	IncorrectDBInstanceEngine	Current DB Instance engine 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	InvalidPage.notFound	Page not found.
404	InvalidUser.NotFound	Specified user does not exist.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.

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

変更履歴

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

ApsaraDB RDS:DescribeCrossRegionBackupDBInstance