All Products
Search
Document Center

Tair (Redis® OSS-Compatible):DescribeLogicInstanceTopology

Last Updated:Jun 12, 2026

Melakukan kueri topologi logis instans ApsaraDB for Tair (kompatibel dengan Redis).

Deskripsi operasi

Operasi ini hanya didukung untuk instans dengan arsitektur cluster dan pemisahan baca/tulis.

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

get

*全部资源

*

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

ID instans.

r-bp1zxszhcgatnx****

Elemen respons

Element

Type

Description

Example

object

InstanceId

string

ID instans.

r-bp1zxszhcgatnx****

RequestId

string

ID permintaan.

794120D1-E0CF-4713-BAE4-EBAEA04506AF

RedisProxyList

object

NodeInfo

array<object>

Detail proxy, termasuk informasi tentang node proxy.

object

Capacity

string

The storage capacity of the node. Unit: MB.

5120

Connection

string

The maximum number of connections.

320000

NodeType

string

The node type. Valid values:

  • proxy: proxy node

  • db: data node

proxy

Bandwidth

string

The bandwidth throttling of the node. Unit: MB/s.

96

NodeId

string

The ID of the node.

r-bp10noxlhcoim2****-proxy-3#542****

RedisShardList

object

NodeInfo

array<object>

Detail shard, termasuk informasi tentang subnode seperti NodeInfo.

object

Capacity

string

The storage capacity of the node. Unit: MB.

2048

Connection

string

The maximum number of connections.

10000

NodeType

string

The node type. Valid values:

  • proxy: proxy node

  • db: data node

db

Bandwidth

string

The bandwidth throttling of the node. Unit: MB/s.

96

NodeId

string

The ID of the node.

r-bp10noxlhcoim2****-db-0#688****

SubInstanceType

string

子实例类型,返回值:

  • master:主节点类型。

  • readonly:只读实例类型。

master

Contoh

Respons sukses

JSONformat

{
  "InstanceId": "r-bp1zxszhcgatnx****",
  "RequestId": "794120D1-E0CF-4713-BAE4-EBAEA04506AF",
  "RedisProxyList": {
    "NodeInfo": [
      {
        "Capacity": "5120",
        "Connection": "320000",
        "NodeType": "proxy",
        "Bandwidth": "96",
        "NodeId": "r-bp10noxlhcoim2****-proxy-3#542****"
      }
    ]
  },
  "RedisShardList": {
    "NodeInfo": [
      {
        "Capacity": "2048",
        "Connection": "10000",
        "NodeType": "db",
        "Bandwidth": "96",
        "NodeId": "r-bp10noxlhcoim2****-db-0#688****",
        "SubInstanceType": "master"
      }
    ]
  }
}

Respons error

JSONformat

{
  "RedisShardList":
    {"NodeInfo":[{
  "NodeId":"r-xxxxxxxxxxxxxxx-proxy-3#5425423",
  "NodeType":"proxy",
   "Capacity":"5120",
   "Connection":"320000",
   "Bandwidth":96
				 }]},
  "InstanceId":"r-xxxxxxxxxxxxxxx",
  "RequestId":"5F749626-2B6A-4DC2-A010-B51F7C33084E"
 }

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.