API DescribeAccounts untuk mengkueri akun database - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Mengkueri informasi akun database instans Database Apsara for MongoDB.

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

dds:DescribeAccounts

get

*Instans.

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instans.	dds-bp1fd530f271****
AccountName	string	No	Nama akun.	root

Elemen respons

Element	Type	Description	Example
	object
Accounts	object
Account	array<object>	Daftar informasi akun.
	array<object>
AccountDescription	string	Deskripsi akun. Catatan Parameter ini hanya dikembalikan setelah Anda memanggil operasi ModifyAccountDescription untuk mengatur deskripsi akun.	Administrator
AccountName	string	Nama akun.	root
AccountStatus	string	Status akun. Nilai valid: Unavailable: Akun tidak tersedia. Available: Akun tersedia.	Available
CharacterType	string	Tipe peran akun. Nilai valid: db: Peran shard. cs: Peran config server. mongos: Peran Mongos (Proxy Layanan). logic: Instans kluster sharded. normal: Instans replica set.	mongos
DBInstanceId	string	ID instans tempat akun berada.	dds-bp1fd530f271****
DBName	string	Database tempat akun berada.	admin
Roles	object
Role	array<object>	Daftar izin akun.
	object	Izin akun.
DBName	string	Database yang diotorisasi untuk peran.	admin
Role	string		read
RequestId	string	ID permintaan.	B562A65B-39AB-4EE8-8635-5A222054FB35

Contoh

Respons sukses

JSONformat

{
  "Accounts": {
    "Account": [
      {
        "AccountDescription": "管理员",
        "AccountName": "root",
        "AccountStatus": "Available",
        "CharacterType": "mongos",
        "DBInstanceId": "dds-bp1fd530f271****",
        "DBName": "admin",
        "Roles": {
          "Role": [
            {
              "DBName": "admin",
              "Role": "read"
            }
          ]
        }
      }
    ]
  },
  "RequestId": "B562A65B-39AB-4EE8-8635-5A222054FB35"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
403	ResponseEmptyError	The Response is empty, maybe server request timeout.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.