DescribeDatabases - 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:DescribeDatabases

get

*DBInstance

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

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。DescribeDBInstances 操作を呼び出してこの ID を取得できます。	rm-uf6wjk5****
DBName	string	任意	データベースの名前。	testDB01
DBStatus	string	任意	データベースのステータス。有効値： Creating：データベースはプロビジョニング中です。 Running：データベースは実行中です。 Deleting：データベースは削除中です。	Creating
PageSize	integer	任意	各ページに返すエントリ数。有効値： 30 50 100 デフォルト：30。	30
PageNumber	integer	任意	ページ番号。有効値：0 より大きい整数。デフォルト：1。	1

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターの詳細。
Databases	object
Database	array<object>	データベースのリスト。
	array<object>	データベースの詳細。
Accounts	object
AccountPrivilegeInfo	array<object>	データベースに対する権限を持つアカウントのリスト。
	object	アカウントの詳細。
Account	string	アカウント名。	test
AccountPrivilege	string	データベースに対するアカウントの権限。有効値： ReadWrite：読み書き権限。 ReadOnly：読み取り専用権限。 DMLOnly：DML のみの権限。 DDLOnly：DDL のみの権限。	DMLOnly
AccountPrivilegeDetail	string	アカウントがデータベースに対して持つ特定の権限。	SELECT
AdvancedInfo	object
AdvancedDbProperty	array<object>	データベースの高度なプロパティ。説明このパラメーターは、SQL Server を実行するインスタンスに対してのみ返されます。
	object	高度なデータベースプロパティの詳細。	{ "allowedValues": [ "OFF", "ON" ], "databasePropertyName": "ansi_nulls", "allowModify": true, "excludeLock": "0", "currentValue": "OFF" }
BasicInfo	object
BasicDbProperty	array<object>	データベースの基本プロパティ。説明このパラメーターは、SQL Server を実行するインスタンスに対してのみ返されます。
	object	基本的なデータベースプロパティの詳細。	{ "allowedValues": [ "CHECKSUM" ], "databasePropertyName": "page_verify", "allowModify": true, "excludeLock": "0", "currentValue": "CHECKSUM" }
CharacterSetName	string	データベースの文字セット。	utf8
Collate	string	データベースの照合順序。値 `C` は、標準の C 照合順序を指定します。説明このパラメーターは、PostgreSQL を実行するインスタンスに対してのみ返されます。	C
ConnLimit	string	同時接続の最大数。値 -1 は、接続数が無制限であることを示します。説明このパラメーターは、PostgreSQL を実行するインスタンスに対してのみ返されます。	-1
Ctype	string	文字型。説明このパラメーターは、PostgreSQL を実行するインスタンスに対してのみ返されます。	en_US.utf8
DBDescription	string	データベースの説明。	testdb
DBInstanceId	string	インスタンス ID。	rm-uf6wjk5****
DBName	string	データベース名。	testDB01
DBStatus	string	データベースのステータス。有効値： Creating：データベースは作成中です。 Running：データベースは実行中です。 Deleting：データベースは削除中です。 Cold：データベースはコールドストレージにあります。	Creating
Engine	string	インスタンスのデータベースエンジン。	MySQL
PageNumber	integer	ページ番号。	1
PageSize	integer	ページあたりのエントリ数。	30
RuntimeInfo	object
RuntimeDbProperty	array<object>	データベースのランタイムプロパティ。説明このパラメーターは、SQL Server を実行するインスタンスに対してのみ返されます。
	object	ランタイムデータベースプロパティの詳細。	{ "allowedValues": [], "databasePropertyName": "TotalDataSizeInMB", "allowModify": false, "currentValue": "5.38" }
Tablespace	string	データベースの表領域。説明このパラメーターは、PostgreSQL を実行するインスタンスに対してのみ返されます。	pg_default
TotalCount	integer	エントリの総数。説明このパラメーターは、SQL Server を実行するインスタンスに対してのみ返されます。	5
DuckDBEnabled	boolean
RequestId	string	リクエスト ID。	2603CA96-B17D-4903-BC04-61A2C829CD94

例

成功レスポンス

JSONJSON

{
  "Databases": {
    "Database": [
      {
        "Accounts": {
          "AccountPrivilegeInfo": [
            {
              "Account": "test",
              "AccountPrivilege": "DMLOnly",
              "AccountPrivilegeDetail": "SELECT"
            }
          ]
        },
        "AdvancedInfo": {
          "AdvancedDbProperty": [
            {
              "allowedValues": [
                "OFF",
                "ON"
              ],
              "databasePropertyName": "ansi_nulls",
              "allowModify": true,
              "excludeLock": "0",
              "currentValue": "OFF"
            }
          ]
        },
        "BasicInfo": {
          "BasicDbProperty": [
            {
              "allowedValues": [
                "CHECKSUM"
              ],
              "databasePropertyName": "page_verify",
              "allowModify": true,
              "excludeLock": "0",
              "currentValue": "CHECKSUM"
            }
          ]
        },
        "CharacterSetName": "utf8",
        "Collate": "C",
        "ConnLimit": "-1",
        "Ctype": "en_US.utf8",
        "DBDescription": "testdb",
        "DBInstanceId": "rm-uf6wjk5****",
        "DBName": "testDB01",
        "DBStatus": "Creating",
        "Engine": "MySQL",
        "PageNumber": 1,
        "PageSize": 30,
        "RuntimeInfo": {
          "RuntimeDbProperty": [
            {
              "allowedValues": [],
              "databasePropertyName": "TotalDataSizeInMB",
              "allowModify": false,
              "currentValue": "5.38"
            }
          ]
        },
        "Tablespace": "pg_default",
        "TotalCount": 5,
        "DuckDBEnabled": false
      }
    ]
  },
  "RequestId": "2603CA96-B17D-4903-BC04-61A2C829CD94"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	%s	DB Operation Failed:%s.
400	Database.ConnectError	Database connect error. please check instance status and database processlist
400	InvalidDBInstanceStatus.NotSupport	The Specified instance status is not supported to query account list.
400	Database.QueryError	Query Db failed, please check input value and instance status.
400	SqlExcutionFailed	Database is in transition. Try the statement later.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ConcurrentLimit	The request processing has been concurrent limit.
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	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	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.
400	InvalidCharacter.DbOrAccount	The database name or account name contains invalid characters.
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	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	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.
408	NetworkOrSqlTimeoutError	Failed to create login due to potential SQL Server overload or other issues that may cause the login creation fail. Please retry later.

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

変更履歴

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