DescribeInstances - Tair (Redis® OSS-Compatible) - Centre de documentation Alibaba Cloud

Consulte les informations d'une ou plusieurs instances ApsaraDB for Redis (compatible Tair).

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

kvstore:DescribeInstances

list

DBInstance

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

DBInstance

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Non	L'identifiant de la région de l'instance. Remarque Lors de l'appel de cette API, si le paramètre Tag est spécifié, ce paramètre est obligatoire.	cn-hangzhou
InstanceIds	string	Non	Les identifiants des instances à interroger.\n> Pour spécifier plusieurs identifiants d'instance, séparez-les par des virgules (,). Vous pouvez spécifier jusqu'à 30 identifiants d'instance dans une seule requête.	r-bp1zxszhcgatnx****
InstanceStatus	string	Non	L'état de l'instance. Valeurs valides : Normal : normal. Creating : en cours de création. Changing : en cours de modification. Inactive : désactivé. Flushing : en cours de vidage. Released : libéré. Transforming : en cours de transformation. Migrating : en cours de migration. BackupRecovering : en cours de restauration à partir d'une sauvegarde. MinorVersionUpgrading : version mineure en cours de mise à niveau. NetworkModifying : type de réseau en cours de modification. SSLModifying : SSL en cours de modification. MajorVersionUpgrading : version majeure en cours de mise à niveau. L'instance est accessible normalement. Remarque Pour plus d'informations sur les états des instances, consultez États des instances et impacts.	Normal
ChargeType	string	Non	La méthode de facturation. Valeurs valides : PrePaid : abonnement. PostPaid : paiement à l'usage.	PostPaid
NetworkType	string	Non	Le type de réseau de l'instance. Valeurs valides : CLASSIC : réseau classique. VPC : réseau privé virtuel (VPC).	CLASSIC
EngineVersion	string	Non	La version du moteur compatible Redis de l'instance. Valeurs valides : 2.8, 4.0, 5.0, 6.0 et 7.0.	4.0
InstanceClass	string	Non	Le type d'instance. Pour plus d'informations, consultez Types d'instances.	redis.master.small.default
VpcId	string	Non	L'identifiant du VPC.	vpc-bp1nme44gek34slfc****
VSwitchId	string	Non	L'identifiant du vSwitch.	vsw-bp1e7clcw529l773d****
PageNumber	integer	Non	Le numéro de page de la liste des instances. Les pages commencent à 1. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre maximal d'entrées par page. Valeur maximale : 50. Valeur par défaut : 30.	30
InstanceType	string	Non	La catégorie de l'instance. Valeurs valides : Tair : Tair (Enhanced Edition) Redis : ApsaraDB for Redis Community Edition Memcache	Redis
SearchKey	string	Non	Le mot-clé utilisé pour la recherche floue par nom d'instance ou identifiant d'instance.	apitest
ArchitectureType	string	Non	Le type d'architecture. Valeurs valides :\n* cluster : cluster.\n* standard : standard.\n* rwsplit : séparation lecture/écriture.	standard
Expired	string	Non	L'état d'expiration de l'instance. Valeurs valides : true : expirée. false : non expirée.	false
ZoneId	string	Non	L'identifiant de la zone.	cn-hongkong-b
ResourceGroupId	string	Non	L'identifiant du groupe de ressources. Remarque Vous pouvez appeler l'API ListResourceGroups ou utiliser la console pour obtenir la liste des identifiants des groupes de ressources. Pour plus d'informations, consultez Afficher les informations de base d'un groupe de ressources.	rg-acfmyiu4ekp****
GlobalInstance	boolean	Non	Indique si les instances enfants des instances distribuées doivent être filtrées de la liste des instances renvoyée. Valeurs valides : true : renvoie uniquement les informations des instances enfants. false : ne renvoie pas les informations des instances enfants.	true
EditionType	string	Non	L'édition de l'instance. Valeurs valides : Community : ApsaraDB for Redis Community Edition. Enterprise : Tair Enhanced Edition.	Enterprise
PrivateIp	string	Non	L'adresse IP privée du VPC.	172.16.49.***
Tag	array<object>	Non	Les balises de l'instance.
	object	Non	Objet.
Value	string	Non	La valeur de la balise. La valeur et la clé de la balise forment ensemble une paire clé-valeur.	Développement
Key	string	Non	La clé de la balise. La clé et la valeur de la balise forment ensemble une paire clé-valeur. Remarque Vous pouvez spécifier jusqu'à 5 paires clé-valeur de balise à la fois.	Type de stockage
NodeType	string	Non	Le type de nœud. Valeurs valides : MASTER_SLAVE : haute disponibilité (double réplica) STAND_ALONE : réplica unique double : double réplica single : réplica unique Remarque Pour les instances cloud natives, sélectionnez MASTER_SLAVE ou STAND_ALONE. Pour les instances classiques, sélectionnez double ou single.	MASTER_SLAVE

Éléments de réponse

Élément	Type	Description	Exemple
	object	Objet.
RequestId	string	L'identifiant de la requête.	1E83311F-0EE4-4922-A3BF-730B312B****
PageNumber	integer	Le numéro de page de la liste des instances.	1
PageSize	integer	Le nombre d'entrées par page.	30
TotalCount	integer	Le nombre total d'instances.	1
Instances	object
KVStoreInstance	array<object>	Une collection d'instances.
	array<object>	Objet.
Connections	integer	The maximum number of connections supported by the instance.	20000
EndTime	string	The expiration time of a subscription instance.	2019-06-13T16:00:00Z
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-acfmyiu4ekp****
EditionType	string	The edition of the instance. Valid values: Community: Community Edition. Enterprise: Enhanced Edition.	Enterprise
Config	string	The parameter settings of the instance. For more information, see Parameter settings.	{\"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	The service port of the instance. Important After the port of the network connection address is changed, this field cannot provide actual network status information of the instance. Use the DescribeDBInstanceNetInfo API to query the real-time network connection information of the instance.	6379
DestroyTime	string	The time when the instance was destroyed.	2019-04-28T10:03:01Z
GlobalInstanceId	string	The ID of the distributed instance. Remarque This parameter is returned only when the instance is a child instance of a distributed instance.	gr-bp14rkqrhac****
HasRenewChangeOrder	boolean	Indicates whether the instance has an unexecuted order for renewal and configuration change. Valid values: true: yes. false: no.	false
ShardCount	integer	The number of data shards in the cluster. Remarque This parameter is returned only for cloud-native cluster or read/write splitting instances.	3
ConnectionDomain	string	The internal connection address of the instance. Important After the network connection address is changed or a new one is applied, this field cannot provide actual network status information of the instance. Use the DescribeDBInstanceNetInfo API to query the real-time network connection information of the instance.	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
SlaveReplicaCount	integer	The number of replica nodes in the secondary zone.	1
PrivateIp	string	The private IP address of the VPC. Remarque This parameter is not returned when the network type of the instance is classic network.	172.16.49.***
Capacity	integer	The storage capacity of the instance. Unit: MB.	4096
QPS	integer	Queries per second (QPS).	100000
NetworkType	string	The network type of the instance. Valid values: CLASSIC: classic network. VPC: VPC.	CLASSIC
InstanceStatus	string	The status of the instance. Valid values: Normal: normal. Creating: being created. Changing: being changed. Inactive: disabled. Flushing: being flushed. Released: released. Transforming: being transformed. Unavailable: the service is suspended. Error: the instance failed to be created. Migrating: being migrated. BackupRecovering: being restored from a backup. MinorVersionUpgrading: minor version being upgraded. NetworkModifying: network type being changed. SSLModifying: SSL being changed. MajorVersionUpgrading: major version being upgraded. The instance can be accessed normally.	Normal
PackageType	string	The plan type. Valid values: standard: standard plan. customized: custom plan.	standard
Bandwidth	integer	The bandwidth of the instance. Unit: MB/s.	96
InstanceType	string	The category of the instance. Valid values: Tair. Redis. Memcache.	Redis
Tags	object
Tag	array<object>	The tag information.
	object	Object.
Value	string	The value of the tag.	value1
Key	string	The key of the tag.	key1
ReplacateId	string	The logical ID of the active-active instance.	grr-bp11381ebc16****
ArchitectureType	string	The architecture type. Valid values: cluster: cluster. standard: standard. rwsplit: read/write splitting. NULL: all types. This is the default value.	cluster
EngineVersion	string	The Redis-compatible engine version of the instance.	4.0
UserName	string	The username used for the connection. By default, a username named after the instance ID is included.	r-bp1zxszhcgatnx****
ZoneId	string	The zone ID.	cn-hangzhou-b
CloudType	string	This parameter is displayed only for CloudBox instances.	cloudbox
InstanceId	string	The ID of the instance.	r-bp1zxszhcgatnx****
ShardClass	string	The specification of data shard nodes. For more information, see Specification lookup. Remarque The overall performance of a cluster instance is: shard node specification (ShardClass) × number of shards (ShardCount).	redis.shard.small.ce
CreateTime	string	The time when the instance was created.	2018-11-07T08:49:00Z
VSwitchId	string	The ID of the vSwitch.	vsw-bp1e7clcw529l773d****
ReplicaCount	integer	The number of replica nodes in the primary zone. Remarque The ReplicaCount and SlaveReplicaCount parameters apply only to cloud-native instances. For cluster instances, these parameters indicate the number of replica nodes per shard in the primary and secondary zones, respectively.	1
ReadOnlyCount	string	The number of read-only nodes in the primary zone. Remarque The ReadOnlyCount and SlaveReadOnlyCount parameters apply only to cloud-native instances with read/write splitting enabled. For cluster instances, these parameters indicate the number of read-only nodes per shard in the primary and secondary zones, respectively.	1
InstanceClass	string	The instance type.	redis.logic.sharding.2g.2db.0rodb.4proxy.default
IsRds	boolean	Indicates whether the instance is managed by ApsaraDB RDS. Valid values: true: yes. false: no.	true
SecondaryZoneId	string	The ID of the secondary zone. Remarque If the ZoneId parameter already returns a multi-zone value, for example "cn-hangzhou-MAZ10(h,i)", this parameter does not return the secondary zone ID.	cn-hangzhou-h
InstanceName	string	The name of the instance.	apitest
SlaveReadOnlyCount	integer	The number of read-only nodes in the secondary zone.	1
VpcId	string	The ID of the VPC.	vpc-bp1nme44gek34slfc****
ChargeType	string	The billing method. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go.	PostPaid
ComputingType	string	The computing type of the instance. Valid values: Ecs: cloud-native. Machine: physical machine.	Ecs
NodeType	string	The node type. Valid values: double: dual-replica. single: single replica (discontinued). MASTER_SLAVE: high availability (dual-replica). STAND_ALONE: single replica.	double
ConnectionMode	string	The access mode of the instance. Valid values: Standard: standard access mode. Safe: database proxy mode. Deprecated. Use DescribeDBInstanceNetInfo instead.	Standard
RegionId	string	The region ID.	cn-hangzhou
WorkspaceId	string
UsedCount	integer
QuotaCount	integer

Exemples

JSON format

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

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidInstanceIds.Malformed	The Specified parameter InstanceIds is not valid.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.