Referensi API ModifyAccountDescription - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Deskripsi operasi

This operation is not supported for sharded cluster instances.

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

update

*Instance

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instans.	dds-bp2356****
AccountName	string	Yes	Nama akun yang deskripsinya akan diubah.	root
AccountDescription	string	Yes	Deskripsi akun. Deskripsi harus dimulai dengan huruf dan tidak boleh dimulai dengan http:// atau https://. Deskripsi harus terdiri dari 2 hingga 256 karakter, dan dapat berisi huruf, angka, garis bawah (_), dan tanda hubung (-).	superadmin
CharacterType	string	No	Tipe akun yang deskripsinya dapat Anda ubah. Nilai valid: db: akun shard cs: akun Configserver normal (default): akun replica set (tersedia) Catatan Anda hanya dapat mengatur parameter ini ke normal.	normal

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	The request ID.	59DE9FC2-7B40-45CF-9011-7327A8A771A2

Contoh

Respons sukses

JSONformat

{
  "RequestId": "59DE9FC2-7B40-45CF-9011-7327A8A771A2"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidAccountDescription.Malformed	Specified parameter AccountDescription is not valid.
400	InvalidAccountName.NotFound	Specified account name does not exist.
400	InsType.NotSupport	Specified instance type dose not support this operation.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.