Mendeskripsikan database dalam Kluster PolarDB Basis Data Relasional Cloud-Native di ENS.
Coba sekarang
Test
RAM authorization
Sintaks permintaan
POST HTTP/1.1Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| DBClusterId |
string |
Yes |
ID Kluster. |
pc-************** |
| DBName |
string |
No |
Nama database. |
test_db |
| PageNumber |
integer |
No |
Nomor halaman. Nilai harus berupa bilangan bulat yang lebih besar dari 0 dan tidak melebihi nilai maksimum tipe data Integer. Nilai default: 1. |
1 |
| PageSize |
integer |
No |
Jumlah entri yang dikembalikan pada setiap halaman. Nilai valid:
Nilai default: 30. |
30 |
| MaxResults |
integer |
No |
Jumlah maksimum entri yang dikembalikan untuk permintaan saat ini. |
10 |
| NextToken |
string |
No |
Token kueri. Atur nilai ini ke nilai NextToken yang dikembalikan dari panggilan API sebelumnya. Jika tidak ada hasil lagi, jangan tentukan parameter ini. |
212db86sca4384811e0b5e8707e****** |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| PageRecordCount |
integer |
The number of entries returned on the current page. |
7 |
| Databases |
array<object> |
The details of the databases. |
|
|
array<object> |
|||
| DBDescription |
string |
The description of the database. |
test_des |
| DBStatus |
string |
The status of the database. Valid values:
|
Running |
| DBName |
string |
The name of the database. |
test_db |
| Engine |
string |
The database engine type. Valid values:
|
MySQL |
| MasterID |
string |
The ID of the primary node that corresponds to the database in a Multi-master Cluster (Database/Table) edition cluster. |
2 |
| CharacterSetName |
string |
The character set. |
utf8mb4 |
| Accounts |
array<object> |
The details of the database accounts. Catatan
If the cluster is a PolarDB for MySQL cluster, privileged accounts are not included. |
|
|
object |
|||
| PrivilegeStatus |
string |
The authorization status. Valid values:
|
Empowered |
| AccountStatus |
string |
The status of the account. Valid values:
|
Available |
| AccountPrivilege |
string |
The permissions of the account. Valid values:
|
ReadOnly |
| AccountName |
string |
The account name. Catatan
If the cluster is a PolarDB for MySQL cluster, privileged accounts are not included. |
test_acc |
| RequestId |
string |
The request ID. |
2FED790E-FB61-4721-8C1C-07C627****** |
| PageNumber |
integer |
The page number. |
1 |
| MaxResults |
integer |
The maximum number of entries returned for the current request. |
10 |
| NextToken |
string |
The query token. This is the NextToken value from the previous API call. If there are no more results, do not specify this parameter. |
212db86sca4384811e0b5e8707e****** |
Contoh
Respons sukses
JSONformat
{
"PageRecordCount": 7,
"Databases": [
{
"DBDescription": "test_des",
"DBStatus": "Running",
"DBName": "test_db",
"Engine": "MySQL",
"MasterID": "2",
"CharacterSetName": "utf8mb4",
"Accounts": [
{
"PrivilegeStatus": "Empowered",
"AccountStatus": "Available",
"AccountPrivilege": "ReadOnly",
"AccountName": "test_acc"
}
]
}
],
"RequestId": "2FED790E-FB61-4721-8C1C-07C627******",
"PageNumber": 1,
"MaxResults": 10,
"NextToken": "212db86sca4384811e0b5e8707e******"
}Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | |
| 400 | InvalidPageSize.Malformed | The specified parameter PageSize is not valid. | |
| 400 | InvalidPageNumber.Malformed | The specified parameter PageNumber is not valid. | |
| 400 | Database.ConnectError | db instance %s connect failed, please check instance status and database processlist | |
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | |
| 404 | InvalidDBClusterId.NotFound | The DBInstanceId provided does not exist in our records. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.