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

指定されたバックアップセットから復元できるデータベースとテーブルの情報をクエリします。

操作説明

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

MySQL

説明

この操作は、ローカルディスクを使用する RDS High-availability Edition で MySQL 8.0、MySQL 5.7、および MySQL 5.6 を実行する RDS インスタンスで利用できます。

説明

RestoreTable 操作を呼び出して ApsaraDB RDS for MySQL インスタンスの個別のデータベースまたはテーブルを復元する前に、この操作を呼び出して復元可能なデータベースとテーブルの情報をクエリできます。詳細については、「ApsaraDB RDS for MySQL インスタンスの個別のデータベースとテーブルの復元」をご参照ください。

今すぐお試しください

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

get

*DBInstance

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

rds:ResourceTag
rds:ResourceTag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、生成されたトークンが異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。	ETnLKlblzczshOTUbOCz****
DBInstanceId	string	必須	インスタンス ID。 DescribeDBInstances 操作を呼び出して、インスタンス ID をクエリできます。	rm-uf6wjk5****
RestoreType	string	任意	使用する復元方法。有効な値： BackupSetID：バックアップセットからデータが復元されます。この値を使用する場合は、BackupSetID パラメーターも指定する必要があります。 RestoreTime：データは特定の時点に復元されます。この値を使用する場合は、RestoreTime パラメーターも指定する必要があります。デフォルト値： BackupSetID。	BackupSetID
BackupSetID	integer	任意	データを復元するバックアップセットの ID。 DescribeBackups 操作を呼び出して、データバックアップファイルの ID をクエリできます。説明このパラメーターは、RestoreType パラメーターを BackupSetID に設定する場合に必要です。	14***
RestoreTime	string	任意	データを復元する時点。指定する時点は、現在の時刻より前である必要があります。時刻は、yyyy-MM-ddTHH:mm:ssZ の形式で ISO 8601 標準で指定します。時刻は協定世界時 (UTC) である必要があります。 DescribeBackups 操作を呼び出して、復元可能な時間範囲をクエリできます。説明このパラメーターは、RestoreType パラメーターを RestoreTime に設定する場合に指定する必要があります。	2019-05-30T03:29:10Z
GetDbName	string	任意	クエリするデータベースの名前。このパラメーターの値に基づいて完全一致が実行され、一致したデータベースの名前と、そのデータベースに含まれるすべてのテーブルの名前が返されます。説明このパラメーターを空のままにすると、インスタンス上に作成されたすべてのデータベースが返されます。	testdb1
Pattern	string	任意	クエリするデータベースの名前。このパラメーターの値に基づいてあいまい一致が実行され、一致したデータベースの名前のみが返されます。説明たとえば、値を `test` に設定すると、`testdb1` と `testdb2` が返されます。その後、GetDbName パラメーターを指定して、目的のデータベース内のテーブルをクエリできます。	test
PageSize	integer	任意	各ページで返すエントリ数。デフォルト値： 1。説明このパラメーターは、PageIndex パラメーターを指定した場合にのみ有効になります。	1
PageIndex	integer	任意	返すページ番号。有効な値：ゼロ以外の正の整数。** デフォルト値： 1。説明このパラメーターは、PageSize** パラメーターを指定した場合にのみ有効になります。	1
ResourceGroupId	string	任意	リソースグループ ID。	rg-acfmy****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
DBInstanceName	string	インスタンス名。	rm-uf6wjk5****
Items	object
Meta	array<object>	バックアップセットにデータが含まれているデータベースとテーブルに関する情報。
	object
Database	string	データベース名。	testdb1
Size	string	テーブルサイズ。単位：KB。	64
Tables	string	テーブル名。	test1
PageNumber	integer	返されたページのページ番号。	1
PageRecordCount	integer	ページごとに返されるエントリ数。	1
RequestId	string	リクエスト ID。	60F9A12A-16B8-4728-B099-4CA38D32C31C
TotalPageCount	integer	返されたページの総数。	1
TotalRecordCount	integer	返されたエントリの総数。	1

例

成功レスポンス

JSONJSON

{
  "DBInstanceName": "rm-uf6wjk5****",
  "Items": {
    "Meta": [
      {
        "Database": "testdb1",
        "Size": "64",
        "Tables": "test1"
      }
    ]
  },
  "PageNumber": 1,
  "PageRecordCount": 1,
  "RequestId": "60F9A12A-16B8-4728-B099-4CA38D32C31C",
  "TotalPageCount": 1,
  "TotalRecordCount": 1
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	NoAvailableDisasterRestoreBakset	No available disaster restore bakset
400	InvalidPageSize	The page size is invalid
400	InvalidPageIndex	The page index is invalid
400	InvalidRestoreTime.Format	Specified restore time 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	InvalidMeta.Empty	Meta information is empty.
403	InvalidMeta.TooLarge	Meta information is too large.
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.
403	IncorrectEngineVersion	Current engine version does not support operations.
403	InvalidBackupLogStatus	Current backup log enable status 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	InvalidBackupSetID.NotFound	Specified backup set ID does not exist.
404	InvalidParameters.Format	Specified parameter({}) is not valid.
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.

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

変更履歴

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