DescribeDatabases - ApsaraDB RDS - Alibaba Cloud Documentation Center

API ini digunakan untuk mengkueri informasi database dari instans RDS.

Deskripsi operasi

Mesin yang didukung

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

rds:DescribeDatabases

get

*DBInstance

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

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instans. Anda dapat memanggil DescribeDBInstances untuk mendapatkan ID.	rm-uf6wjk5****
DBName	string	No	Nama database.	testDB01
DBStatus	string	No	Status database. Nilai yang valid: Creating: Database sedang dibuat. Running: Database sedang digunakan. Deleting: Database sedang dihapus.	Creating
PageSize	integer	No	Jumlah catatan per halaman. Nilai yang valid: 30 50 100 Nilai default: 30.	30
PageNumber	integer	No	Nomor halaman. Nilai yang valid: bilangan bulat yang lebih besar dari 0 dan tidak melebihi nilai maksimum Integer. Nilai default: 1.	1

Elemen respons

Element	Type	Description	Example
	object	Detail parameter yang dikembalikan.
Databases	object
Database	array<object>	Daftar informasi database.
	array<object>	Detail informasi database.
Accounts	object
AccountPrivilegeInfo	array<object>	The information about the account. Each account has specific permissions on the database.
	object
Account	string	The account username.	test
AccountPrivilege	string	The permissions that the account has on the database. Valid values: ReadWrite: read and write permissions ReadOnly: read-only permissions DMLOnly: DML-only permissions DDLOnly: DDL-only permissions	DMLOnly
AccountPrivilegeDetail	string	The permission that the account has on the database.	SELECT
AdvancedInfo	object
AdvancedDbProperty	array<object>	The advanced information about the database. Catatan This parameter is returned only for instances that run SQL Server.
	object	The details of the advanced information about the database.	{ "allowedValues": [ "OFF", "ON" ], "databasePropertyName": "ansi_nulls", "allowModify": true, "excludeLock": "0", "currentValue": "OFF" }
BasicInfo	object
BasicDbProperty	array<object>	The basic information about the database. Catatan This parameter is returned only for instances that run SQL Server.
	object	The details of the basic information about the database.	{ "allowedValues": [ "CHECKSUM" ], "databasePropertyName": "page_verify", "allowModify": true, "excludeLock": "0", "currentValue": "CHECKSUM" }
CharacterSetName	string	The name of the character set.	utf8
Collate	string	The collation of the character set. The example value C indicates localization. Catatan This parameter is returned only for instances that run PostgreSQL.	C
ConnLimit	string	The limit on the number of concurrent requests. The value -1 indicates that the number of concurrent requests is unlimited. Catatan This parameter is returned only for instances that run PostgreSQL.	-1
Ctype	string	The type of the character set. Catatan This parameter is returned only for instances that run PostgreSQL.	en_US.utf8
DBDescription	string	The description of the database.	testdb
DBInstanceId	string	The ID of the instance to which the database belongs.	rm-uf6wjk5****
DBName	string	The database name.	testDB01
DBStatus	string	The database status. Valid values: Creating Running Deleting Cold	Creating
Engine	string	The database engine of the instance.	MySQL
PageNumber	integer	The page number of the page to return.	1
PageSize	integer	The number of entries per page.	30
RuntimeInfo	object
RuntimeDbProperty	array<object>	The runtime information about the database. Catatan This parameter is returned only for instances that run SQL Server.
	object	The details of the runtime information about the database.	{ "allowedValues": [], "databasePropertyName": "TotalDataSizeInMB", "allowModify": false, "currentValue": "5.38" }
Tablespace	string	The database tablespace. Catatan This parameter is returned only for instances that run PostgreSQL.	pg_default
TotalCount	integer	The total number of entries returned. Catatan This parameter is returned only for instances that run SQL Server.	5
DuckDBEnabled	boolean
RequestId	string	ID permintaan.	2603CA96-B17D-4903-BC04-61A2C829CD94

Contoh

Respons sukses

JSONformat

{
  "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"
}

Respons error

JSONformat

{
    "RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
    "HostId": "rds.aliyuncs.com",
    "Code": "UnsupportedOperation",
    "Message": "The specified action is not supported."
}

Kode kesalahan

HTTP status code	Error code	Error message
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.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.