Gunakan DescribeAccounts untuk mengkueri informasi akun database - PolarDB - Alibaba Cloud - PolarDB

Mengkueri akun database Kluster PolarDB Basis Data Relasional Cloud-Native.

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

polardb:DescribeAccounts

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	ID kluster.	pc-***************
AccountName	string	No	Nama akun.	test_acc
NodeType	string	No	Tipe node. Diperlukan saat Anda mengkueri akun node pencarian PolarDB Basis Data Relasional Cloud-Native Search.	Search
PageNumber	integer	No	Nomor halaman dari halaman yang dikembalikan. Nilai harus berupa bilangan bulat yang lebih besar dari 0. Nilai default adalah 1.	1
PageSize	integer	No	Jumlah entri yang dikembalikan per halaman. Nilai valid: 30 50 100 Nilai default adalah 30.	30

Elemen respons

Element	Type	Description	Example
	object
PageRecordCount	integer	The number of entries returned per page.	1
RequestId	string	The request ID.	155462B9-205F-4FFC-BB43-4855FE******
PageNumber	integer	The page number. Pages start from page 1.	1
Accounts	array<object>	The details of the account.
	array<object>
AccountDescription	string	The description of the database account.	test
AccountStatus	string	The status of the database account. Valid values: Creating: The account is being created. Available: The account is available. Deleting: The account is being deleted.	Available
AccountLockState	string	The lock status of the account. Valid values: UnLock: The account is not locked. Lock: The account is locked.	UnLock
AccountPasswordValidTime	string	The validity period of the password.	undefined
AccountType	string	The type of the account. Valid values: Normal: standard account. Super: privileged account. ReadOnly: global read-only account.	Normal
DatabasePrivileges	array<object>	The list of database permissions that are granted to the account.
	object
AccountPrivilege	string	The permissions of the account.	ReadOnly
DBName	string	The database name.	DBtest
AccountName	string	The name of the database account.	test_acc

Contoh

Respons sukses

JSONformat

{
  "PageRecordCount": 1,
  "RequestId": "155462B9-205F-4FFC-BB43-4855FE******",
  "PageNumber": 1,
  "Accounts": [
    {
      "AccountDescription": "test",
      "AccountStatus": "Available",
      "AccountLockState": "UnLock",
      "AccountPasswordValidTime": "undefined",
      "AccountType": "Normal",
      "DatabasePrivileges": [
        {
          "AccountPrivilege": "ReadOnly",
          "DBName": "DBtest"
        }
      ],
      "AccountName": "test_acc"
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message
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
400	Account.QueryError	Instance %s query account error
400	Connect.Timeout	Service can not connect to instance temporarily.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
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.