DescribeInstances - Tair (Redis® OSS-Compatible): Central de Documentação do Alibaba Cloud

Consulta informações sobre uma ou mais instâncias do ApsaraDB for Redis (compatível com Tair).

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

kvstore:DescribeInstances

list

DBInstance

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

DBInstance

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região da instância. null Ao chamar esta API, se o parâmetro Tag for especificado, este parâmetro é obrigatório.	cn-hangzhou
InstanceIds	string	Não	Os IDs das instâncias a serem consultadas. null Para especificar vários IDs de instância, separe-os com vírgulas (,). No máximo 30 IDs de instância podem ser especificados em uma única solicitação.	r-bp1zxszhcgatnx****
InstanceStatus	string	Não	O status da instância. Valores válidos: Normal: normal. Creating: sendo criada. Changing: sendo alterada. Inactive: desativada. Flushing: sendo limpa. Released: liberada. Transforming: sendo transformada. Migrating: sendo migrada. BackupRecovering: sendo restaurada a partir de um backup. MinorVersionUpgrading: versão secundária sendo atualizada. NetworkModifying: tipo de rede sendo alterado. SSLModifying: SSL sendo alterado. MajorVersionUpgrading: versão principal sendo atualizada. A instância pode ser acessada normalmente. null Para mais informações sobre os status das instâncias, consulte Status das instâncias e impactos.	Normal
ChargeType	string	Não	O método de cobrança. Valores válidos: PrePaid: assinatura. PostPaid: pagamento conforme o uso.	PostPaid
NetworkType	string	Não	O tipo de rede da instância. Valores válidos: CLASSIC: rede clássica. VPC: nuvem privada virtual (VPC).	CLASSIC
EngineVersion	string	Não	A versão do mecanismo compatível com Redis da instância. Valores válidos: 2.8, 4.0, 5.0, 6.0 e 7.0.	4.0
InstanceClass	string	Não	O tipo de instância. Para mais informações, consulte Tipos de instância.	redis.master.small.default
VpcId	string	Não	O ID da VPC.	vpc-bp1nme44gek34slfc****
VSwitchId	string	Não	O ID do vSwitch.	vsw-bp1e7clcw529l773d****
PageNumber	integer	Não	O número da página da lista de instâncias. As páginas começam a partir de 1. Valor padrão: 1.	1
PageSize	integer	Não	O número máximo de entradas por página. Valor máximo: 50. Valor padrão: 30.	30
InstanceType	string	Não	A categoria da instância. Valores válidos: Tair: Tair (Edição Aprimorada) Redis: ApsaraDB for Redis Community Edition Memcache	Redis
SearchKey	string	Não	A palavra-chave usada para pesquisa aproximada por nome ou ID da instância.	apitest
ArchitectureType	string	Não	O tipo de arquitetura. Valores válidos: cluster: cluster. standard: padrão. rwsplit: divisão de leitura/gravação.	standard
Expired	string	Não	O status de expiração da instância. Valores válidos: true: expirada. false: não expirada.	false
ZoneId	string	Não	O ID da zona.	cn-hongkong-b
ResourceGroupId	string	Não	O ID do grupo de recursos. null Você pode chamar a API ListResourceGroups ou usar o console para obter a lista de IDs de grupos de recursos. Para mais informações, consulte Visualizar informações básicas de um grupo de recursos.	rg-acfmyiu4ekp****
GlobalInstance	boolean	Não	Especifica se as instâncias filhas de instâncias distribuídas devem ser filtradas da lista de instâncias retornada. Valores válidos: true: retorna apenas informações de instâncias filhas. false: não retorna informações de instâncias filhas.	true
EditionType	string	Não	A edição da instância. Valores válidos: Community: ApsaraDB for Redis Community Edition. Enterprise: Tair Edição Aprimorada.	Enterprise
PrivateIp	string	Não	O endereço IP privado da VPC.	172.16.49.***
Tag	array<object>	Não	As tags da instância.
	object	Não	Objeto.
Value	string	Não	O valor da tag. O valor e a chave da tag juntos formam um par chave-valor.	开发
Key	string	Não	A chave da tag. A chave e o valor da tag juntos formam um par chave-valor. null No máximo 5 pares chave-valor de tag podem ser especificados por vez.	存储类型
NodeType	string	Não	O tipo de nó. Valores válidos: MASTER_SLAVE: alta disponibilidade (réplica dupla) STAND_ALONE: réplica única double: réplica dupla single: réplica única null Para instâncias nativas da nuvem, selecione MASTER_SLAVE ou STAND_ALONE. Para instâncias clássicas, selecione double ou single.	MASTER_SLAVE

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Objeto.
RequestId	string	O ID da solicitação.	1E83311F-0EE4-4922-A3BF-730B312B****
PageNumber	integer	O número da página da lista de instâncias.	1
PageSize	integer	O número de entradas por página.	30
TotalCount	integer	O número total de instâncias.	1
Instances	object
KVStoreInstance	array<object>	Uma coleção de instâncias.
	array<object>	Objeto.
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. null 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. null 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. null This parameter is returned only for cloud-native cluster or read/write splitting instances.	3
ConnectionDomain	string	The internal connection address of the instance. null 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. null 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. null 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. null 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. null 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. null 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

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidInstanceIds.Malformed	The Specified parameter InstanceIds is not valid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.