DescribeInstances - - Alibaba Cloud Dokümantasyon Merkezi

Bir veya daha fazla Tair (Redis® OSS-Compatible) örneğinin bilgilerini sorgular.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

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

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	Örneğin bölge kimliği. Not Bu işlemi çağırırken Tag parametresi belirtilmişse, bu parametre gereklidir.	cn-hangzhou
InstanceIds	string	No	Sorgulanacak örneklerin kimlikleri. Not Birden fazla örnek kimliği belirtmek için kimlikleri virgül (,) ile ayırın. Tek bir istekte en fazla 30 örnek kimliği belirtebilirsiniz.	r-bp1zxszhcgatnx****
InstanceStatus	string	No	Örneğin durumu. Geçerli değerler: Normal: normal Creating: oluşturuluyor Changing: değiştiriliyor Inactive: devre dışı Flushing: temizleme işlemi devam ediyor Released: serbest bırakıldı Transforming: dönüştürülüyor Migrating: taşınıyor BackupRecovering: yedekten kurtarılıyor MinorVersionUpgrading: ara sürüm yükseltmesi devam ediyor NetworkModifying: ağ türü değiştiriliyor SSLModifying: SSL yapılandırmaları değiştiriliyor MajorVersionUpgrading: ana motor sürümü yükseltmesi devam ediyor, bu süre boyunca örnek erişilebilir durumda kalır Not Örnek durumları hakkında daha fazla bilgi için bkz. Örnek durumları ve etkileri.	Normal
ChargeType	string	No	Faturalandırma yöntemi. Geçerli değerler: PrePaid: abonelik PostPaid: kullandıkça öde	PostPaid
NetworkType	string	No	Ağ türü. Geçerli değerler: CLASSIC: klasik ağ VPC: VPC	CLASSIC
EngineVersion	string	No	Örneğin Redis uyumlu motor sürümü. Geçerli değerler: 2.8, 4.0, 5.0, 6.0 ve 7.0.	4.0
InstanceClass	string	No	Örnek teknik özellikleri. Daha fazla bilgi için bkz. Örnek teknik özellikleri.	redis.master.small.default
VpcId	string	No	VPC kimliği.	vpc-bp1nme44gek34slfc****
VSwitchId	string	No	vSwitch kimliği.	vsw-bp1e7clcw529l773d****
PageNumber	integer	No	Örnek listesinin sayfa numarası. Sayfalar 1'den başlar. Varsayılan değer: 1.	1
PageSize	integer	No	Sayfa başına giriş sayısı. Maksimum değer: 50. Varsayılan değer: 30.	30
InstanceType	string	No	Örnek türü. Geçerli değerler: Tair: Tair (Enterprise Edition) Redis: açık kaynaklı Redis Memcache: Memcache	Redis
SearchKey	string	No	Arama anahtar kelimesi. Örnek adları ve örnek kimlikleri için bulanık eşleştirme desteklenir.	apitest
ArchitectureType	string	No	Mimari türü. Geçerli değerler: cluster: küme sürümü standard: standart sürüm rwsplit: okuma/yazma bölme sürümü	standard
Expired	string	No	Örneğin sona erme durumu. Geçerli değerler: true: Örneğin süresi dolmuştur. false: Örneğin süresi dolmamıştır.	false
ZoneId	string	No	Kullanılabilirlik bölgesi kimliği.	cn-hongkong-b
ResourceGroupId	string	No	Kaynak grubu kimliği. Not Kaynak grubu kimliklerinin listesini almak için ListResourceGroups işlemini çağırabilir veya konsolu kullanabilirsiniz. İlgili işlemler için bkz. Kaynak grubunun temel bilgilerini görüntüleme.	rg-acfmyiu4ekp****
GlobalInstance	boolean	No	Döndürülen örnek listesinde dağıtılmış örneklerin alt örneklerinin filtrelenip filtrelenmeyeceğini belirtir. Geçerli değerler: true: Yalnızca alt örnek bilgileri döndürülür. false: Alt örnek bilgileri döndürülmez.	true
EditionType	string	No	Örneğin sürüm türü. Geçerli değerler: Community: açık kaynaklı Redis Enterprise: Tair Enterprise Edition	Enterprise
PrivateIp	string	No	VPC'deki özel IP adresi.	172.16.49.***
Tag	array<object>	No	Örneğin etiket bilgileri.
	object	No	Etiket nesnesi.
Key	string	No	Etiket anahtarı. Etiket değeri ile bir anahtar-değer çifti oluşturur. Not Tek bir istekte en fazla 5 etiket anahtar-değer çifti belirtebilirsiniz.	Storage type
Value	string	No	Etiket değeri. Etiket anahtarı ile bir anahtar-değer çifti oluşturur.	Development
NodeType	string	No	Düğüm türü. Geçerli değerler: MASTER_SLAVE: yüksek kullanılabilirlik (çift kopya) STAND_ALONE: tek kopya double: çift kopya single: tek kopya Not Bulut yerlisi örnekler için MASTER_SLAVE veya STAND_ALONE seçin. Klasik örnekler için double veya single seçin.	MASTER_SLAVE

Response elements

Element	Type	Description	Example
	object	Nesne.
Instances	object
KVStoreInstance	array<object>	Örnek koleksiyonu.
	array<object>	Etiket nesnesi.
ArchitectureType	string	Mimari türü. Geçerli değerler: cluster: Küme Sürümü. standard: Standart Sürüm. rwsplit: Okuma/Yazma Bölme Sürümü. NULL: Tüm türler. Bu, varsayılan değerdir.	cluster
Bandwidth	integer	Örneğin bant genişliği. Birim: MB/s.	96
Capacity	integer	Örneğin kapasitesi. Birim: MB.	4096
ChargeType	string	Faturalandırma yöntemi. Geçerli değerler: PrePaid: Abonelik. PostPaid: Kullandıkça öde.	PostPaid
CloudType	string	Bu parametre yalnızca CloudBox örnekleri için döndürülür.	cloudbox
ComputingType	string	Örneğin bilgi işlem türü. Geçerli değerler: Ecs: Bulut yerlisi. Machine: Fiziksel makine.	Ecs
Config	string	Örneğin parametre ayarları. Daha fazla bilgi için bkz. Parametre ayarları.	{\"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\"}
ConnectionDomain	string	Örneğin dahili uç noktası. Önemli Örneği değiştirdikten veya yeni bir uç nokta için başvurduktan sonra, bu alan örneğin gerçek ağ durumu bilgilerini sağlayamaz. Örneğin gerçek zamanlı harici uç nokta bilgilerini sorgulamak için DescribeDBInstanceNetInfo API işlemini kullanın.	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
ConnectionMode	string	Örneğin erişim modu. Geçerli değerler: Standard: Standart erişim modu. Safe: Veritabanı proxy modu. [Kullanımdan Kaldırıldı] Bunun yerine DescribeDBInstanceNetInfo API işlemini kullanın.	Standard
Connections	integer	Örneğe yapılacak maksimum bağlantı sayısı.	20000
CreateTime	string	Örneğin oluşturulduğu zaman.	2018-11-07T08:49:00Z
DestroyTime	string	Örneğin imha edildiği zaman.	2019-04-28T10:03:01Z
EditionType	string	Örneğin sürümü. Geçerli değerler: Community: Topluluk Sürümü. Enterprise: Kurumsal Sürüm.	Enterprise
EndTime	string	Abonelik örneğinin sona erdiği zaman.	2019-06-13T16:00:00Z
EngineVersion	string	Örneğin Redis uyumlu motor sürümü.	4.0
GlobalInstanceId	string	Dağıtılmış örnek kimliği. Not Bu parametre yalnızca örnek, dağıtılmış bir örneğin alt örneği olduğunda döndürülür.	gr-bp14rkqrhac****
HasRenewChangeOrder	boolean	Etkin olmayan bir yenileme ve Yükseltme/Düşürme siparişi olup olmadığını gösterir. Geçerli değerler: true: Evet. false: Hayır.	false
InstanceClass	string	Örnek türü.	redis.logic.sharding.2g.2db.0rodb.4proxy.default
InstanceId	string	Örneğin kimliği.	r-bp1zxszhcgatnx****
InstanceName	string	Örneğin adı.	apitest
InstanceStatus	string	Örnek durumu. Geçerli değerler: Normal: Normal. Creating: Oluşturuluyor. Changing: Değiştiriliyor. Inactive: Devre dışı. Flushing: Temizleme devam ediyor. Released: Serbest bırakıldı. Transforming: Dönüştürülüyor. Unavailable: Kullanılamıyor. Error: Oluşturma başarısız oldu. Migrating: Taşınıyor. BackupRecovering: Yedekten geri yükleniyor. MinorVersionUpgrading: Alt sürüm yükseltiliyor. NetworkModifying: Ağ değiştiriliyor. SSLModifying: SSL değiştiriliyor. MajorVersionUpgrading: Ana motor sürümü yükseltmesi yapılıyor. Örnek erişilebilir durumda kalır.	Normal
InstanceType	string	Örneğin motor türü. Geçerli değerler: Tair: Tair. Redis: Redis. Memcache: Memcache.	Redis
IsRds	boolean	Örneğin ApsaraDB RDS tarafından yönetilip yönetilmediğini gösterir. Geçerli değerler: true: Evet. false: Hayır.	true
NetworkType	string	Ağ türü. Geçerli değerler: CLASSIC: Klasik ağ. VPC: Sanal Özel Bulut (VPC).	CLASSIC
NodeType	string	Düğüm türü. Geçerli değerler: double: Çift kopya. single: Tek kopya (kullanımdan kaldırıldı). MASTER_SLAVE: Yüksek kullanılabilirlik (çift kopya). STAND_ALONE: Tek kopya.	double
PackageType	string	Plan türü. Geçerli değerler: standard: Standart plan. customized: Özel plan.	standard
Port	integer	Örneğin hizmet bağlantı noktası. Önemli Örneğin ağ uç noktasının bağlantı noktasını değiştirdikten sonra, bu alan örneğin gerçek ağ durumu bilgilerini sağlayamaz. Örneğin gerçek zamanlı harici uç nokta bilgilerini sorgulamak için DescribeDBInstanceNetInfo API işlemini kullanın.	6379
PrivateIp	string	Özel IP adresi. Not Örneğin ağ türü klasik ağ olduğunda bu parametre döndürülmez.	172.16.49.***
QPS	integer	Saniyedeki sorgu sayısı (QPS).	100000
QuotaCount	integer
ReadOnlyCount	string	Birincil bölgedeki salt okunur düğüm sayısı. Not ReadOnlyCount ve SlaveReadOnlyCount parametreleri yalnızca bulut yerlisi örnekler ve okuma/yazma bölme özelliği etkinleştirilmiş örnekler için geçerlidir. Örnek küme mimarisini kullanıyorsa, bu parametreler tek bir parça için birincil ve ikincil bölgelerdeki salt okunur düğüm sayısını gösterir.	1
RegionId	string	Bölge kimliği.	cn-hangzhou
ReplacateId	string	Etkin coğrafi yedeklilik örneğinin mantıksal kimliği.	grr-bp11381ebc16****
ReplicaCount	integer	Birincil bölgedeki ikincil düğüm sayısı. Not ReplicaCount ve SlaveReplicaCount parametreleri yalnızca bulut yerlisi örnekler için geçerlidir. Örnek küme mimarisini kullanıyorsa, bu parametreler tek bir parça için birincil ve ikincil bölgelerdeki ikincil düğüm sayısını gösterir.	1
ResourceGroupId	string	Örneğin ait olduğu kaynak grubunun kimliği.	rg-acfmyiu4ekp****
SecondaryZoneId	string	İkincil bölge kimliği. Not ZoneId parametresi halihazırda "cn-hangzhou-MAZ10(h,i)" gibi birden fazla bölge döndürüyorsa, bu parametre döndürülmez.	cn-hangzhou-h
ShardClass	string	Veri parçası düğümünün teknik özellikleri. Daha fazla bilgi için bkz. Teknik özellik sorgulama gezintisi. Not Küme mimarisi örneğinin genel performansı şu şekilde hesaplanır: parça düğümü teknik özellikleri (ShardClass) × parça sayısı (ShardCount).	redis.shard.small.ce
ShardCount	integer	Kümedeki veri düğümü sayısı. Not Bu parametre yalnızca bulut yerlisi küme örnekleri veya okuma/yazma bölme örnekleri için döndürülür.	3
SlaveReadOnlyCount	integer	İkincil bölgedeki salt okunur düğüm sayısı.	1
SlaveReplicaCount	integer	İkincil bölgedeki ikincil düğüm sayısı.	1
Tags	object
Tag	array<object>	Etiket bilgileri.
	object	Etiket nesnesi.
Key	string	Etiket anahtarı.	key1
Value	string	Etiket değeri.	value1
UsedCount	integer
UserName	string	Bağlantı için kullanılan kullanıcı adı. Varsayılan olarak, örnek kimliğiyle adlandırılmış bir kullanıcı adı bulunur.	r-bp1zxszhcgatnx****
VSwitchId	string	vSwitch kimliği.	vsw-bp1e7clcw529l773d****
VpcId	string	Sanal özel bulut (VPC) kimliği.	vpc-bp1nme44gek34slfc****
WorkspaceId	string
ZoneId	string	Kullanılabilirlik bölgesi kimliği.	cn-hangzhou-b
PageNumber	integer	Örnek listesinin sayfa numarası.	1
PageSize	integer	Sayfa başına giriş sayısı.	30
RequestId	string	İstek kimliği.	1E83311F-0EE4-4922-A3BF-730B312B****
TotalCount	integer	Toplam örnek sayısı.	1

Examples

Success response

JSON format

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

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.