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

Mengambil informasi satu atau beberapa instans ApsaraDB for Tair (kompatibel Redis).

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 tempat instans berada. Catatan Parameter ini wajib ditentukan jika parameter Tag ditentukan.	cn-hangzhou
InstanceIds	string	No	ID instans yang akan dikueri. Catatan Untuk mengkueri beberapa instans, tentukan ID instans yang dipisahkan dengan koma (,). Anda dapat menentukan hingga 30 ID instans dalam satu permintaan.	r-bp1zxszhcgatnx****
InstanceStatus	string	No	Status instans. Nilai yang valid: Normal: Instans berjalan sebagaimana mestinya. Creating: Instans sedang dibuat. Changing: Konfigurasi instans sedang diubah. Inactive: Instans dinonaktifkan. Flushing: Instans sedang diflush. Released: Instans telah dilepas. Transforming: Metode penagihan instans sedang diubah. Migrating: Instans sedang dimigrasikan. BackupRecovering: Instans sedang dipulihkan dari backup. MinorVersionUpgrading: Versi minor instans sedang ditingkatkan. NetworkModifying: Jenis jaringan instans sedang diubah. SSLModifying: Sertifikat SSL instans sedang diubah. MajorVersionUpgrading: Versi utama instans sedang ditingkatkan. Instans tetap dapat diakses selama proses upgrade. Catatan Untuk informasi lebih lanjut tentang status instans dan dampaknya, lihat Status instans dan dampaknya.	Normal
ChargeType	string	No	Metode penagihan instans. Nilai yang valid: PrePaid: subscription PostPaid: pay-as-you-go	PostPaid
NetworkType	string	No	Jenis jaringan instans. Nilai yang valid: CLASSIC: classic network VPC: VPC	CLASSIC
EngineVersion	string	No	Versi engine kompatibel Redis dari instans. Nilai yang valid: 2.8, 4.0, 5.0, 6.0, dan 7.0.	4.0
InstanceClass	string	No	Tipe instans. Untuk informasi lebih lanjut, 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 yang akan dikembalikan. Nilainya harus berupa bilangan bulat lebih besar dari 0. Default: 1.	1
PageSize	integer	No	Jumlah entri yang dikembalikan per halaman. Maksimum: 50. Default: 30.	30
InstanceType	string	No	Jenis instans. Nilai yang valid: Tair: Tair (edisi enterprise) Redis: Redis Community Edition Memcache	Redis
SearchKey	string	No	Kata kunci untuk pencarian fuzzy pada nama dan ID instans.	apitest
ArchitectureType	string	No	Arsitektur instans. Nilai yang valid: cluster: edisi kluster standard: edisi standar rwsplit: edisi pemisahan baca/tulis	standard
Expired	string	No	Menentukan apakah instans telah kedaluwarsa. Nilai yang valid: true: Instans telah kedaluwarsa. false: Instans belum kedaluwarsa.	false
ZoneId	string	No	ID zona ketersediaan.	cn-hongkong-b
ResourceGroupId	string	No	ID kelompok sumber daya. Catatan Anda dapat memanggil operasi ListResourceGroups atau melihat informasi dasar tentang kelompok sumber daya di Konsol untuk mendapatkan ID kelompok sumber daya.	rg-acfmyiu4ekp****
GlobalInstance	boolean	No	Menentukan apakah hanya mengembalikan instans anak dari instans terdistribusi. Nilai yang valid: true: Hanya instans anak yang dikembalikan. false: Respons tidak dibatasi hanya untuk instans anak.	true
EditionType	string	No	Edisi instans. Nilai yang valid: Community: Redis Community Edition Enterprise: Edisi enterprise Tair	Enterprise
PrivateIp	string	No	Alamat IP pribadi instans.	172.16.49.***
Tag	array<object>	No	Tag instans.
	object	No	Objek tag yang terdiri dari kunci dan nilai.
Value	string	No	Nilai tag.	开发
Key	string	No	Kunci tag. Catatan Anda dapat menentukan hingga lima tag dalam satu permintaan.	存储类型
NodeType	string	No	Jenis node. Nilai yang valid: MASTER_SLAVE: ketersediaan tinggi (dual-replika) STAND_ALONE: single-replika double: dual-replika single: single-replika Catatan Untuk instans edisi cloud-native, atur parameter ini ke MASTER_SLAVE atau STAND_ALONE. Untuk instans edisi klasik, atur parameter ini ke double atau single.	MASTER_SLAVE

Elemen respons

Element	Type	Description	Example
	object	Objek respons.
RequestId	string	ID permintaan.	1E83311F-0EE4-4922-A3BF-730B312B****
PageNumber	integer	Nomor halaman daftar instans.	1
PageSize	integer	Jumlah entri per halaman yang Anda tentukan dalam permintaan.	30
TotalCount	integer	Jumlah total instans.	1
Instances	object	Detail instans.
KVStoreInstance	array<object>	Array detail instans.
	array<object>	Detail instans.
Connections	integer	Jumlah maksimum koneksi ke instans.	20000
EndTime	string	Waktu kedaluwarsa instans langganan.	2019-06-13T16:00:00Z
ResourceGroupId	string	ID kelompok sumber daya tempat instans berada.	rg-acfmyiu4ekp****
EditionType	string	Edisi instans. Nilai yang valid: Community: Edisi Community. Enterprise: Edisi Perusahaan (Tair).	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 Anda mengubah port instans, nilai parameter ini mungkin tertunda. Untuk mengkueri port real-time, panggil operasi DescribeDBInstanceNetInfo.	6379
DestroyTime	string	Waktu saat instans dilepas.	2019-04-28T10:03:01Z
GlobalInstanceId	string	ID instans terdistribusi. Catatan Parameter ini hanya dikembalikan jika instans merupakan instans anak dari instans terdistribusi.	gr-bp14rkqrhac****
HasRenewChangeOrder	boolean	Menunjukkan apakah terdapat pesanan tertunda untuk perpanjangan atau perubahan konfigurasi instans. Nilai yang valid: true: Terdapat pesanan tertunda. false: Tidak ada pesanan tertunda.	false
ShardCount	integer	Jumlah shard data dalam instans kluster. Catatan Parameter ini hanya dikembalikan untuk instans kluster cloud-native atau instans yang menggunakan arsitektur pemisahan baca/tulis.	3
ConnectionDomain	string	Titik akhir internal instans. Penting Setelah Anda mengubah titik akhir instans, nilai parameter ini mungkin tertunda. Untuk mengkueri titik akhir real-time, panggil operasi DescribeDBInstanceNetInfo.	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
SlaveReplicaCount	integer	Jumlah node replika di zona ketersediaan sekunder.	1
PrivateIp	string	Alamat IP pribadi instans. Catatan Parameter ini tidak dikembalikan jika jenis jaringan instans adalah classic network.	172.16.49.***
Capacity	integer	Kapasitas memori instans dalam MB.	4096
QPS	integer	Jumlah kueri per detik (QPS).	100000
NetworkType	string	Jenis jaringan instans. Nilai yang valid: CLASSIC: classic network. VPC: Virtual Private Cloud (VPC).	CLASSIC
InstanceStatus	string	Status instans. Nilai yang valid: Normal: Instans sedang berjalan. Creating: Instans sedang dibuat. Changing: Konfigurasi instans sedang diubah. Inactive: Instans dinonaktifkan. Flushing: Instans sedang diflush. Released: Instans telah dilepas. Transforming: Metode penagihan instans sedang diubah. Unavailable: Instans tidak tersedia. Error: Pembuatan instans gagal. BackupRecovering: Instans sedang dipulihkan dari backup. MinorVersionUpgrading: Versi minor instans sedang di-upgrade. NetworkModifying: Pengaturan jaringan instans sedang dimodifikasi. SSLModifying: Sertifikat SSL sedang diubah. MajorVersionUpgrading: Versi utama instans sedang di-upgrade. Instans tetap dapat diakses. MajorVersionUpgrading: Peningkatan versi utama sedang berlangsung. Layanan tetap dapat diakses.	Normal
PackageType	string	Jenis paket instans. Nilai yang valid: standard: paket standar. customized: paket khusus.	standard
Bandwidth	integer	Bandwidth instans dalam MB/s.	96
InstanceType	string	Engine database instans. Nilai yang valid: Tair Redis Memcache	Redis
Tags	object	Tag instans.
Tag	array<object>	Detail tag.
	object	Tag, yang terdiri dari kunci dan nilai.
Value	string	Nilai tag.	value1
Key	string	Kunci tag.	key1
ReplacateId	string	ID logis instans multi-aktif.	grr-bp11381ebc16****
ArchitectureType	string	Arsitektur instans. Nilai yang valid: cluster: arsitektur kluster. standard: arsitektur standar. rwsplit: arsitektur pemisahan baca/tulis. NULL: Nilai ini tidak dikembalikan untuk arsitektur instans. Hanya digunakan untuk penyaringan permintaan.	cluster
EngineVersion	string	Versi engine database instans.	4.0
UserName	string	Username koneksi. Secara default, sama dengan ID instans.	r-bp1zxszhcgatnx****
ZoneId	string	ID zona ketersediaan.	cn-hangzhou-b
CloudType	string	Parameter ini hanya dikembalikan untuk instans di Alibaba Cloud Box.	cloudbox
InstanceId	string	ID instans.	r-bp1zxszhcgatnx****
ShardClass	string	Tipe instans untuk setiap shard data. Untuk informasi lebih lanjut, lihat Tipe instans. Catatan Kinerja keseluruhan instans kluster dihitung dengan rumus berikut: Kinerja satu shard data (ShardClass) × Jumlah shard data (ShardCount).	redis.shard.small.ce
CreateTime	string	Waktu saat instans dibuat.	2018-11-07T08:49:00Z
VSwitchId	string	ID vSwitch.	vsw-bp1e7clcw529l773d****
ReplicaCount	integer	Jumlah node replika di zona ketersediaan primer. Catatan Parameter ReplicaCount dan SlaveReplicaCount hanya berlaku untuk instans cloud-native. Jika instans merupakan instans kluster, parameter ini menunjukkan jumlah node replika per shard di zona ketersediaan primer dan sekunder, masing-masing.	1
ReadOnlyCount	string	Jumlah node read-only di zona ketersediaan primer. Catatan Parameter ReadOnlyCount dan SlaveReadOnlyCount hanya berlaku untuk instans cloud-native dengan pemisahan baca/tulis yang diaktifkan. Jika instans merupakan instans kluster, parameter ini menunjukkan jumlah node read-only per shard di zona ketersediaan primer dan sekunder, masing-masing.	1
InstanceClass	string	Tipe instans.	redis.logic.sharding.2g.2db.0rodb.4proxy.default
IsRds	boolean	Menunjukkan apakah instans dikelola oleh ApsaraDB. Nilai yang valid: true: Instans dikelola oleh ApsaraDB. false: Instans tidak dikelola oleh ApsaraDB.	true
SecondaryZoneId	string	ID zona ketersediaan sekunder. Catatan Jika parameter ZoneId mengembalikan nilai yang menunjukkan penerapan multi-zona, seperti `cn-hangzhou-MAZ10(h,i)`, parameter ini tidak dikembalikan.	cn-hangzhou-h
InstanceName	string	Nama instans.	apitest
SlaveReadOnlyCount	integer	Jumlah node read-only di zona ketersediaan sekunder.	1
VpcId	string	ID VPC.	vpc-bp1nme44gek34slfc****
ChargeType	string	Metode penagihan instans. Nilai yang valid: PrePaid: subscription. PostPaid: pay-as-you-go.	PostPaid
ComputingType	string	Jenis sumber daya komputasi. Nilai yang valid: Ecs: Instans diterapkan pada mesin virtual ECS. Machine: Instans diterapkan pada mesin fisik.	Ecs
NodeType	string	Jenis node. Nilai yang valid: double: dual-replika. single: single-replika. MASTER_SLAVE: ketersediaan tinggi (dual-replika). STAND_ALONE: single-replika.	double
ConnectionMode	string	Mode koneksi instans. Nilai yang valid: Standard: mode koneksi standar. Safe: mode proksi database. Parameter ini sudah tidak digunakan lagi. Gunakan operasi DescribeDBInstanceNetInfo sebagai gantinya.	Standard
RegionId	string	ID wilayah.	cn-hangzhou
WorkspaceId	string

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": ""
      }
    ]
  }
}

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.