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

Mengkueri informasi tentang satu atau beberapa instans ApsaraDB for Redis (kompatibel dengan Tair).

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

list

DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/*

DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah instans. Catatan Saat memanggil API ini, jika parameter Tag ditentukan, parameter ini wajib diisi.	cn-hangzhou
InstanceIds	string	No	ID instans yang akan dikueri. Catatan Untuk menentukan beberapa ID instans, pisahkan dengan koma (,). Maksimal 30 ID instans dapat ditentukan dalam satu permintaan.	r-bp1zxszhcgatnx****
InstanceStatus	string	No	Status instans. Nilai valid: Normal: normal. Creating: sedang dibuat. Changing: sedang diubah. Inactive: dinonaktifkan. Flushing: sedang dibersihkan. Released: dirilis. Transforming: sedang ditransformasi. Migrating: sedang dimigrasi. BackupRecovering: sedang dipulihkan dari cadangan. MinorVersionUpgrading: versi minor sedang ditingkatkan. NetworkModifying: jenis jaringan sedang diubah. SSLModifying: SSL sedang diubah. MajorVersionUpgrading: versi utama sedang ditingkatkan. Instans dapat diakses secara normal. Catatan Untuk informasi selengkapnya tentang status instans, lihat Status dan dampak instans.	Normal
ChargeType	string	No	Metode penagihan. Nilai valid: PrePaid: langganan. PostPaid: bayar sesuai pemakaian.	PostPaid
NetworkType	string	No	Jenis jaringan instans. Nilai valid: CLASSIC: jaringan klasik. VPC: virtual private cloud (VPC).	CLASSIC
EngineVersion	string	No	Versi engine yang kompatibel dengan Redis pada instans. Nilai valid: 2.8, 4.0, 5.0, 6.0, dan 7.0.	4.0
InstanceClass	string	No	Tipe instans. Untuk informasi selengkapnya, lihat Tipe instans.	redis.master.small.default
VpcId	string	No	ID VPC.	vpc-bp1nme44gek34slfc****
VSwitchId	string	No	ID vSwitch.	vsw-bp1e7clcw529l773d****
PageNumber	integer	No	Nomor halaman daftar instans. Halaman dimulai dari 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri maksimum per halaman. Nilai maksimum: 50. Nilai default: 30.	30
InstanceType	string	No	Kategori instans. Nilai valid: Tair: Tair (Edisi Enhanced) Redis: ApsaraDB for Redis Edisi Komunitas Memcache.	Redis
SearchKey	string	No	Kata kunci yang digunakan untuk pencarian fuzzy berdasarkan nama instans atau ID instans.	apitest
ArchitectureType	string	No	Tipe arsitektur. Nilai valid: cluster: kluster. standard: standar. rwsplit: read/write splitting.	standard
Expired	string	No	Status kedaluwarsa instans. Nilai valid: true: kedaluwarsa. false: belum kedaluwarsa.	false
ZoneId	string	No	ID zona.	cn-hongkong-b
ResourceGroupId	string	No	ID kelompok sumber daya. Catatan Anda dapat memanggil API ListResourceGroups atau menggunakan konsol untuk mendapatkan daftar ID kelompok sumber daya. Untuk informasi selengkapnya, lihat Melihat informasi dasar kelompok sumber daya.	rg-acfmyiu4ekp****
GlobalInstance	boolean	No	Apakah akan memfilter instans anak dari instans terdistribusi dari daftar instans yang dikembalikan. Nilai valid: true: hanya mengembalikan informasi instans anak. false: tidak mengembalikan informasi instans anak.	true
EditionType	string	No	Edisi instans. Nilai valid: Community: ApsaraDB for Redis Edisi Komunitas. Enterprise: Tair Edisi Enhanced.	Enterprise
PrivateIp	string	No	Alamat IP privat VPC.	172.16.49.***
Tag	array<object>	No	Tag instans.
	object	No	Objek.
Value	string	No	Nilai tag. Nilai dan kunci tag bersama-sama membentuk pasangan kunci-nilai.	开发
Key	string	No	Kunci tag. Kunci dan nilai tag bersama-sama membentuk pasangan kunci-nilai. Catatan Maksimal 5 pasangan kunci-nilai tag dapat ditentukan sekaligus.	存储类型
NodeType	string	No	Tipe node. Nilai valid: MASTER_SLAVE: ketersediaan tinggi (dual-replica) STAND_ALONE: single replica double: dual-replica single: single replica Catatan Untuk instans cloud-native, pilih MASTER_SLAVE atau STAND_ALONE. Untuk instans klasik, pilih double atau single.	MASTER_SLAVE

Elemen respons

Element	Type	Description	Example
	object	Objek.
RequestId	string	ID permintaan.	1E83311F-0EE4-4922-A3BF-730B312B****
PageNumber	integer	Nomor halaman daftar instans.	1
PageSize	integer	Jumlah entri per halaman.	30
TotalCount	integer	Jumlah total instans.	1
Instances	object
KVStoreInstance	array<object>	Kumpulan instans.
	array<object>	Objek.
Connections	integer	Jumlah koneksi maksimum yang didukung oleh instans.	20000
EndTime	string	Waktu ketika instans langganan kedaluwarsa.	2019-06-13T16:00:00Z
ResourceGroupId	string	ID kelompok sumber daya tempat instans berada.	rg-acfmyiu4ekp****
EditionType	string	Tipe edisi. Nilai valid: Community: Edisi Komunitas. Enterprise: Edisi Perusahaan.	Enterprise
Config	string	Pengaturan parameter instans. Untuk informasi lebih lanjut, lihat Pengaturan parameter.	{\"maxmemory-policy\":\"volatile-lfu\",\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64,\"#no_loose_disabled-commands\":\"flushall,flushdb\",\"lazyfree-lazy-eviction\":\"yes\"}
Port	integer	Port layanan instans. Penting Setelah Port titik akhir dimodifikasi, bidang ini tidak dapat mencerminkan konektivitas jaringan aktual instans. Panggil operasi DescribeDBInstanceNetInfo untuk mengkueri informasi konektivitas jaringan waktu nyata instans. .	6379
DestroyTime	string	Waktu ketika instans dihancurkan.	2019-04-28T10:03:01Z
GlobalInstanceId	string	ID instans dari instans terdistribusi. Catatan Parameter ini hanya dikembalikan ketika instans merupakan instans anak dari instans terdistribusi.	gr-bp14rkqrhac****
HasRenewChangeOrder	boolean	Apakah instans memiliki pesanan pembaruan dengan perubahan spesifikasi yang tertunda. Nilai valid: true: Ya. false: Tidak.	false
ShardCount	integer	Jumlah shard data dalam kluster. Catatan Parameter ini hanya dikembalikan untuk instans kluster cloud-native atau pemisahan baca/tulis.	3
ConnectionDomain	string	Alamat koneksi jaringan internal instans. Penting Setelah alamat koneksi jaringan internal dimodifikasi atau titik akhir baru diajukan, bidang ini tidak dapat mencerminkan konektivitas jaringan aktual instans. Panggil operasi DescribeDBInstanceNetInfo untuk mengkueri informasi konektivitas jaringan waktu nyata instans. .	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
SlaveReplicaCount	integer	Jumlah node replika di zona sekunder.	1
PrivateIp	string	Alamat IP privat. Catatan Parameter ini tidak dikembalikan jika jenis jaringan instans adalah jaringan klasik.	172.16.49.***
Capacity	integer	Kapasitas penyimpanan instans. Unit: MB.	4096
QPS	integer	Kueri per detik (QPS).	100000
NetworkType	string	Jenis jaringan. Nilai valid: CLASSIC: jaringan klasik. VPC: VPC.	CLASSIC
InstanceStatus	string	Status instans. Nilai valid: Normal: Instans dalam keadaan normal. Creating: Instans sedang dibuat. Changing: Instans sedang dimodifikasi. Inactive: Instans dinonaktifkan. Flushing: Instans sedang dibersihkan. Released: Instans telah dirilis. Transforming: Instans sedang ditransformasi. Unavailable: Layanan ditangguhkan. Error: Instans gagal dibuat. Migrating: Instans sedang dimigrasi. BackupRecovering: Instans sedang dipulihkan dari cadangan. MinorVersionUpgrading: Peningkatan versi minor sedang berlangsung. NetworkModifying: Konfigurasi jaringan sedang dimodifikasi. SSLModifying: Konfigurasi SSL sedang dimodifikasi. MajorVersionUpgrading: Peningkatan versi mesin utama sedang berlangsung. Instans dapat diakses seperti biasa.	Normal
PackageType	string	Tipe paket. Nilai valid: standard: paket standar. customized: paket kustom.	standard
Bandwidth	integer	Bandwidth instans. Unit: MB/s.	96
InstanceType	string	Tipe instans. Nilai valid: Tair. Redis. Memcache.	Redis
Tags	object
Tag	array<object>	Informasi tag.
	object	Objek.
Value	string	Nilai tag.	value1
Key	string	Kunci tag.	key1
ReplacateId	string	ID logis instans redundansi geografis aktif.	grr-bp11381ebc16****
ArchitectureType	string	Tipe arsitektur. Nilai valid: cluster: Edisi Kluster. standard: Edisi Standar. rwsplit: Edisi pemisahan baca/tulis. NULL: semua tipe. Ini adalah nilai default.	cluster
EngineVersion	string	Versi mesin yang kompatibel dengan Redis pada instans.	4.0
UserName	string	Nama pengguna yang digunakan untuk koneksi. Secara default, nama pengguna yang dinamai sesuai ID instans disertakan.	r-bp1zxszhcgatnx****
ZoneId	string	ID zona.	cn-hangzhou-b
CloudType	string	Parameter ini hanya ditampilkan untuk instans CloudBox.	cloudbox
InstanceId	string	ID instans.	r-bp1zxszhcgatnx****
ShardClass	string	Spesifikasi node shard data. Untuk detailnya, lihat Pencarian spesifikasi. Catatan Kinerja keseluruhan instans kluster dihitung sebagai berikut: spesifikasi shard (ShardClass) × jumlah shard (ShardCount).	redis.shard.small.ce
CreateTime	string	Waktu ketika instans dibuat.	2018-11-07T08:49:00Z
VSwitchId	string	ID vSwitch.	vsw-bp1e7clcw529l773d****
ReplicaCount	integer	Jumlah node replika di zona primer. Catatan Parameter ReplicaCount dan SlaveReplicaCount hanya berlaku untuk instans cloud-native. Jika instans menggunakan arsitektur kluster, parameter ini menunjukkan jumlah node replika per shard di zona primer dan zona sekunder.	1
ReadOnlyCount	string	Jumlah node baca-saja di zona primer. Catatan Parameter ReadOnlyCount dan SlaveReadOnlyCount hanya berlaku untuk instans cloud-native dengan pemisahan baca/tulis yang diaktifkan. Jika instans menggunakan arsitektur kluster, parameter ini menunjukkan jumlah node baca-saja per shard di zona primer dan zona sekunder.	1
InstanceClass	string	Tipe instans.	redis.logic.sharding.2g.2db.0rodb.4proxy.default
IsRds	boolean	Apakah instans dikelola oleh ApsaraDB RDS. Nilai valid: true: Ya. false: Tidak.	true
SecondaryZoneId	string	ID zona sekunder. Catatan Jika parameter ZoneId sudah mengembalikan nilai multi-zona, seperti "cn-hangzhou-MAZ10(h,i)", parameter ini tidak mengembalikan ID zona sekunder.	cn-hangzhou-h
InstanceName	string	Nama instans.	apitest
SlaveReadOnlyCount	integer	Jumlah node baca-saja di zona sekunder.	1
VpcId	string	ID VPC.	vpc-bp1nme44gek34slfc****
ChargeType	string	Metode penagihan. Nilai valid: PrePaid: langganan. PostPaid: bayar sesuai pemakaian.	PostPaid
ComputingType	string	Tipe komputasi instans. Nilai valid: Ecs: cloud-native Machine: mesin fisik.	Ecs
NodeType	string	Tipe node. Nilai valid: double: replika ganda. single: replika tunggal (dihentikan). MASTER_SLAVE: ketersediaan tinggi (replika ganda). STAND_ALONE: replika tunggal.	double
ConnectionMode	string	Mode akses instans. Nilai valid: Standard: mode akses standar. Safe: modus Proksi database. Parameter ini tidak digunakan lagi. Gunakan operasi DescribeDBInstanceNetInfo sebagai gantinya.	Standard
RegionId	string	ID wilayah.	cn-hangzhou
WorkspaceId	string
UsedCount	integer
QuotaCount	integer

Contoh

Respons sukses

JSONformat

{
  "RequestId": "1E83311F-0EE4-4922-A3BF-730B312B****",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 1,
  "Instances": {
    "KVStoreInstance": [
      {
        "Connections": 20000,
        "EndTime": "2019-06-13T16:00:00Z",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "EditionType": "Enterprise",
        "Config": "{\\\"maxmemory-policy\\\":\\\"volatile-lfu\\\",\\\"EvictionPolicy\\\":\\\"volatile-lru\\\",\\\"hash-max-ziplist-entries\\\":512,\\\"zset-max-ziplist-entries\\\":128,\\\"zset-max-ziplist-value\\\":64,\\\"set-max-intset-entries\\\":512,\\\"hash-max-ziplist-value\\\":64,\\\"#no_loose_disabled-commands\\\":\\\"flushall,flushdb\\\",\\\"lazyfree-lazy-eviction\\\":\\\"yes\\\"}",
        "Port": 6379,
        "DestroyTime": "2019-04-28T10:03:01Z",
        "GlobalInstanceId": "gr-bp14rkqrhac****",
        "HasRenewChangeOrder": false,
        "ShardCount": 3,
        "ConnectionDomain": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
        "SlaveReplicaCount": 1,
        "PrivateIp": "172.16.49.***",
        "Capacity": 4096,
        "QPS": 100000,
        "NetworkType": "CLASSIC",
        "InstanceStatus": "Normal",
        "PackageType": "standard",
        "Bandwidth": 96,
        "InstanceType": "Redis",
        "Tags": {
          "Tag": [
            {
              "Value": "value1",
              "Key": "key1"
            }
          ]
        },
        "ReplacateId": "grr-bp11381ebc16****",
        "ArchitectureType": "cluster",
        "EngineVersion": "4.0",
        "UserName": "r-bp1zxszhcgatnx****",
        "ZoneId": "cn-hangzhou-b",
        "CloudType": "cloudbox",
        "InstanceId": "r-bp1zxszhcgatnx****",
        "ShardClass": "redis.shard.small.ce",
        "CreateTime": "2018-11-07T08:49:00Z",
        "VSwitchId": "vsw-bp1e7clcw529l773d****",
        "ReplicaCount": 1,
        "ReadOnlyCount": "1",
        "InstanceClass": "redis.logic.sharding.2g.2db.0rodb.4proxy.default",
        "IsRds": true,
        "SecondaryZoneId": "cn-hangzhou-h",
        "InstanceName": "apitest",
        "SlaveReadOnlyCount": 1,
        "VpcId": "vpc-bp1nme44gek34slfc****",
        "ChargeType": "PostPaid",
        "ComputingType": "Ecs",
        "NodeType": "double",
        "ConnectionMode": "Standard",
        "RegionId": "cn-hangzhou",
        "WorkspaceId": "",
        "UsedCount": 0,
        "QuotaCount": 0
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidInstanceIds.Malformed	The Specified parameter InstanceIds is not valid.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.