Ringkasan API DescribeReplicaSetRole - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Mengambil informasi peran dan detail koneksi untuk instans MongoDB.

Deskripsi operasi

This operation applies to replica set instances and single-node instances. It does not apply to 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:DescribeReplicaSetRole

get

*Instance

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instans.	dds-bpxxxxxxxx

Elemen respons

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	DB4A0595-FCA9-437F-B2BB-25DBFC009D3E
DBInstanceId	string	The instance ID.	dds-bpxxxxxxxx
ReplicaSets	object	Details of the replica set.
ReplicaSet	array<object>	A list of nodes in the replica set.
	object	The details of a node.
ConnectionPort	string	The port used to connect to the node.	3717
ReplicaSetRole	string	The role of the node in the replica set. Primary: Primary node. Secondary: Secondary node.	Primary
ExpiredTime	string	The remaining time, in seconds, for the classic network endpoint.	1209582
ConnectionDomain	string	The endpoint used to connect to the node.	dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com
NetworkType	string	The network type. VPC: Virtual private cloud (VPC). Classic: Classic network. Public: Internet.	VPC
RoleId	string	The ID of the node's role.	651xxxxx
ConnectionType	string	The connection type.	SRV
ConnectionStringSuffix	string	The domain name suffix for the connection string.	.mongodb.rds.aliyuncs.com

Contoh

Respons sukses

JSONformat

{
  "RequestId": "DB4A0595-FCA9-437F-B2BB-25DBFC009D3E",
  "DBInstanceId": "dds-bpxxxxxxxx",
  "ReplicaSets": {
    "ReplicaSet": [
      {
        "ConnectionPort": "3717",
        "ReplicaSetRole": "Primary",
        "ExpiredTime": "1209582",
        "ConnectionDomain": "dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
        "NetworkType": "VPC",
        "RoleId": "651xxxxx",
        "ConnectionType": "SRV"
      }
    ]
  },
  "ConnectionStringSuffix": ".mongodb.rds.aliyuncs.com\n"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
403	Forbidden	User not authorized to operate on the specified resource.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.