DescribeRoleZoneInfo - Tair (Redis® OSS-Compatible) - Alibaba Cloud Documentation Center

Melakukan kueri peran, jenis, versi minor, dan zona dari setiap node dalam instance ApsaraDB for Tair (kompatibel dengan Redis OSS).

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

kvstore:DescribeRoleZoneInfo

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instance. Anda dapat memanggil operasi DescribeInstances untuk melakukan kueri ID dari instance.	r-t4nlenc2p04uvb****
QueryType	integer	No	Jenis node yang ingin Anda kueri. Nilai yang valid: 0: node proxy. Catatan Parameter ini hanya didukung untuk instance dengan arsitektur cluster atau arsitektur read/write splitting. 1: node data. Ini adalah nilai default.	0
PageNumber	integer	No	Nomor halaman. Nilainya harus lebih besar dari 0 dan tidak boleh melebihi nilai maksimum yang didukung oleh tipe data Integer. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri yang dikembalikan pada setiap halaman. Nilai yang valid: 10, 20, dan 50. Nilai default: 10.	10

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	224B97FB-A275-4EAC-86E9-8922FEA2****
PageNumber	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri yang dikembalikan per halaman.	10
TotalCount	integer	Jumlah total entri yang dikembalikan.	2
Node	object
NodeInfo	array<object>	Detail dari setiap node dalam instance.
	object
DefaultBandWidth	integer	The default bandwidth of the node. Unit: MB/s.	96
CurrentMinorVersion	string	The minor version of the node.	redis-5.0_0.3.10
CurrentBandWidth	integer	The current bandwidth of the node, which consists of the default bandwidth and the increased bandwidth. Unit: MB/s. Catatan You can call the EnableAdditionalBandwidth operation to specify the increased bandwidth. You can also use this parameter to calculate the increased bandwidth. For example, if the default bandwidth of the node is 96 MB/s and the returned value of this parameter is 100, the increased bandwidth is 4 MB/s.	100
InsType	integer	Indicates whether the node is a read replica. If the node is a read replica, 3 is returned. Catatan If the node is not a read replica, no value is returned.	3
IsLatestVersion	integer	Indicates whether the minor version is the latest version. Valid values: 0: The minor version is not the latest version. 1: The minor version is the latest version. Catatan To update the minor version, call the ModifyInstanceMinorVersion operation.	1
InsName	string	The ID of the node.	r-t4nlenc2p04uvb****
NodeType	string	The node type. Valid values: db: data node. proxy: proxy node. normal: regular node. This value is returned when the instance runs in the standard architecture.	normal
ZoneId	string	The ID of the zone.	cn-hangzhou-b
IsOpenBandWidthService	boolean	Indicates whether the bandwidth of the node is increased. Valid values: true: The bandwidth of the node is not increased. false: The bandwidth of the node is increased.	true
CustinsId	string	The ID of the data shard.	30381****
Role	string	The role of the node. Valid values: master: master node slave: replica node	master
NodeId	string	This parameter is used only for internal maintenance of instances.	10065****

Contoh

Respons sukses

JSONformat

{
  "RequestId": "224B97FB-A275-4EAC-86E9-8922FEA2****",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 2,
  "Node": {
    "NodeInfo": [
      {
        "DefaultBandWidth": 96,
        "CurrentMinorVersion": "redis-5.0_0.3.10",
        "CurrentBandWidth": 100,
        "InsType": 3,
        "IsLatestVersion": 1,
        "InsName": "r-t4nlenc2p04uvb****",
        "NodeType": "normal",
        "ZoneId": "cn-hangzhou-b",
        "IsOpenBandWidthService": true,
        "CustinsId": "30381****",
        "Role": "master",
        "NodeId": "10065****"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.