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

Consulta as informações de uma ou mais instâncias do Tair (compatível com Redis® OSS).

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. Nota Ao chamar esta operação, se o parâmetro Tag for especificado, este parâmetro será obrigatório.	cn-hangzhou
InstanceIds	string	Não	Os IDs das instâncias a serem consultadas. Nota Para especificar vários IDs de instância, separe os IDs com vírgulas (,). Você pode especificar até 30 IDs de instância em uma única solicitação.	r-bp1zxszhcgatnx****
InstanceStatus	string	Não	O status da instância. Valores válidos: Normal: normal Creating: criando Changing: alterando Inactive: desativada Flushing: limpeza em andamento Released: liberada Transforming: transformando Migrating: migrando BackupRecovering: recuperando do backup MinorVersionUpgrading: atualização de versão secundária em andamento NetworkModifying: alterando o tipo de rede SSLModifying: alterando configurações de SSL MajorVersionUpgrading: atualização de versão principal do mecanismo em andamento, durante a qual a instância permanece acessível Nota Para obter mais informações sobre os status das instâncias, consulte Status e impactos das instâncias.	Normal
ChargeType	string	Não	O método de cobrança. Valores válidos: PrePaid: assinatura PostPaid: pay-as-you-go	PostPaid
NetworkType	string	Não	O tipo de rede. Valores válidos: CLASSIC: rede clássica VPC: 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	As especificações da instância. Para obter mais informações, consulte Especificações da 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 em 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor máximo: 50. Valor padrão: 30.	30
InstanceType	string	Não	O tipo de instância. Valores válidos: Tair: Tair (Enterprise Edition) Redis: Redis de código aberto Memcache: Memcache	Redis
SearchKey	string	Não	A palavra-chave de pesquisa. Há suporte para correspondência aproximada para nomes de instâncias e IDs de instâncias.	apitest
ArchitectureType	string	Não	O tipo de arquitetura. Valores válidos: cluster: edição cluster standard: edição standard rwsplit: edição com divisão de leitura e gravação	standard
Expired	string	Não	O status de expiração da instância. Valores válidos: true: A instância expirou. false: A instância não expirou.	false
ZoneId	string	Não	O ID da zona.	cn-hongkong-b
ResourceGroupId	string	Não	O ID do grupo de recursos. Nota Você pode invocar a operação ListResourceGroups ou usar o console para obter a lista de IDs de grupos de recursos. Para operações relacionadas, consulte Visualizar as informações básicas de um grupo de recursos.	rg-acfmyiu4ekp****
GlobalInstance	boolean	Não	Especifica se deve filtrar as instâncias filhas de instâncias distribuídas na lista de instâncias retornada. Valores válidos: true: Apenas as informações da instância filha são retornadas. false: As informações da instância filha não são retornadas.	true
EditionType	string	Não	O tipo de edição da instância. Valores válidos: Community: Redis de código aberto Enterprise: Tair Enterprise Edition	Enterprise
PrivateIp	string	Não	O endereço IP privado na VPC.	172.16.49.***
Tag	array<object>	Não	As informações de tag da instância.
	object	Não	O objeto de tag.
Key	string	Não	A chave da tag. Ela forma um par chave-valor com o valor da tag. Nota Você pode especificar até 5 pares chave-valor de tag em uma única solicitação.	Storage type
Value	string	Não	O valor da tag. Ele forma um par chave-valor com a chave da tag.	Development
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 Nota 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	O objeto.
Instances	object
KVStoreInstance	array<object>	A coleção de instâncias.
	array<object>	O objeto de tag.
ArchitectureType	string	O tipo de arquitetura. Valores válidos: cluster: Cluster Edition. standard: Standard Edition. rwsplit: Read/Write Splitting Edition. NULL: Todos os tipos. Este é o valor padrão.	cluster
Bandwidth	integer	A largura de banda da instância. Unidade: MB/s.	96
Capacity	integer	A capacidade da instância. Unidade: MB.	4096
ChargeType	string	O método de cobrança. Valores válidos: PrePaid: Assinatura. PostPaid: Pay-as-you-go.	PostPaid
CloudType	string	Este parâmetro é retornado apenas para instâncias do CloudBox.	cloudbox
ComputingType	string	O tipo de computação da instância. Valores válidos: Ecs: Cloud-native. Machine: Máquina física.	Ecs
Config	string	As configurações de parâmetro da instância. Para mais informações, consulte Configurações de parâmetro.	{\"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	O endpoint interno da instância. Importante Após modificar a instância ou solicitar um novo endpoint, este campo não pode fornecer as informações reais de status de rede da instância. Use a operação de API DescribeDBInstanceNetInfo para consultar as informações de endpoint externo em tempo real da instância.	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
ConnectionMode	string	O modo de acesso da instância. Valores válidos: Standard: Modo de acesso padrão. Safe: Modo de proxy de banco de dados. [Deprecated] Use a operação de API DescribeDBInstanceNetInfo em vez disso.	Standard
Connections	integer	O número máximo de conexões com a instância.	20000
CreateTime	string	A hora em que a instância foi criada.	2018-11-07T08:49:00Z
DestroyTime	string	A hora em que a instância foi destruída.	2019-04-28T10:03:01Z
EditionType	string	A edição da instância. Valores válidos: Community: Community Edition. Enterprise: Enterprise Edition.	Enterprise
EndTime	string	A hora em que a instância de assinatura expira.	2019-06-13T16:00:00Z
EngineVersion	string	A versão do mecanismo compatível com Redis da instância.	4.0
GlobalInstanceId	string	O ID da instância distribuída. Nota Este parâmetro é retornado apenas quando a instância é uma instância filha de uma instância distribuída.	gr-bp14rkqrhac****
HasRenewChangeOrder	boolean	Indica se há uma ordem inativa de renovação e de Upgrade/Downgrade. Valores válidos: true: Sim. false: Não.	false
InstanceClass	string	O tipo de instância.	redis.logic.sharding.2g.2db.0rodb.4proxy.default
InstanceId	string	O ID da instância.	r-bp1zxszhcgatnx****
InstanceName	string	O nome da instância.	apitest
InstanceStatus	string	O status da instância. Valores válidos: Normal: Normal. Creating: Criando. Changing: Modificando. Inactive: Desativado. Flushing: Limpeza em andamento. Released: Liberado. Transforming: Transformando. Unavailable: Indisponível. Error: Falha na criação. Migrating: Migrando. BackupRecovering: Recuperando do backup. MinorVersionUpgrading: Atualizando a versão secundária. NetworkModifying: Modificando a rede. SSLModifying: Modificando o SSL. MajorVersionUpgrading: Passando por uma atualização importante da versão do mecanismo. A instância permanece acessível.	Normal
InstanceType	string	O tipo de mecanismo da instância. Valores válidos: Tair: Tair. Redis: Redis. Memcache: Memcache.	Redis
IsRds	boolean	Indica se a instância é gerenciada pelo ApsaraDB RDS. Valores válidos: true: Sim. false: Não.	true
NetworkType	string	O tipo de rede. Valores válidos: CLASSIC: Rede clássica. VPC: Virtual Private Cloud (VPC).	CLASSIC
NodeType	string	O tipo de nó. Valores válidos: double: Réplica dupla. single: Réplica única (descontinuado). MASTER_SLAVE: Alta disponibilidade (réplica dupla). STAND_ALONE: Réplica única.	double
PackageType	string	O tipo de plano. Valores válidos: standard: Plano padrão. customized: Plano personalizado.	standard
Port	integer	A porta de serviço da instância. Importante Após modificar a porta do endpoint de rede da instância, este campo não pode fornecer as informações reais de status de rede da instância. Use a operação de API DescribeDBInstanceNetInfo para consultar as informações de endpoint externo em tempo real da instância.	6379
PrivateIp	string	O endereço IP privado. Nota Este parâmetro não é retornado quando o tipo de rede da instância é a rede clássica.	172.16.49.***
QPS	integer	As consultas por segundo (QPS).	100000
QuotaCount	integer
ReadOnlyCount	string	O número de nós somente leitura na zona primária. Nota Os parâmetros ReadOnlyCount e SlaveReadOnlyCount aplicam-se apenas a instâncias cloud-native e instâncias com divisão de leitura/gravação ativada. Se a instância usar a arquitetura de cluster, esses parâmetros indicam o número de nós somente leitura nas zonas primária e secundária para um único shard.	1
RegionId	string	O ID da região.	cn-hangzhou
ReplacateId	string	O ID lógico da instância de georredundância ativa.	grr-bp11381ebc16****
ReplicaCount	integer	O número de nós secundários na zona primária. Nota Os parâmetros ReplicaCount e SlaveReplicaCount aplicam-se apenas a instâncias cloud-native. Se a instância usar a arquitetura de cluster, esses parâmetros indicam o número de nós secundários nas zonas primária e secundária para um único shard.	1
ResourceGroupId	string	O ID do grupo de recursos ao qual a instância pertence.	rg-acfmyiu4ekp****
SecondaryZoneId	string	O ID da zona secundária. Nota Se o parâmetro ZoneId já retornar várias zonas, como "cn-hangzhou-MAZ10(h,i)", este parâmetro não será retornado.	cn-hangzhou-h
ShardClass	string	As especificações do nó de shard de dados. Para mais informações, consulte Navegação de consulta de especificações. Nota O desempenho geral de uma instância de arquitetura de cluster é calculado da seguinte forma: especificações do nó de shard (ShardClass) × número de shards (ShardCount).	redis.shard.small.ce
ShardCount	integer	O número de nós de dados no cluster. Nota Este parâmetro é retornado apenas para instâncias de cluster cloud-native ou instâncias com divisão de leitura/gravação.	3
SlaveReadOnlyCount	integer	O número de nós somente leitura na zona secundária.	1
SlaveReplicaCount	integer	O número de nós secundários na zona secundária.	1
Tags	object
Tag	array<object>	As informações da tag.
	object	O objeto de tag.
Key	string	A chave da tag.	key1
Value	string	O valor da tag.	value1
UsedCount	integer
UserName	string	O nome de usuário usado para conexão. Por padrão, é incluído um nome de usuário baseado no ID da instância.	r-bp1zxszhcgatnx****
VSwitchId	string	O ID do vSwitch.	vsw-bp1e7clcw529l773d****
VpcId	string	O ID da virtual private cloud (VPC).	vpc-bp1nme44gek34slfc****
WorkspaceId	string
ZoneId	string	O ID da zona.	cn-hangzhou-b
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
RequestId	string	O ID da solicitação.	1E83311F-0EE4-4922-A3BF-730B312B****
TotalCount	integer	O número total de instâncias.	1

Exemplos

Resposta de sucesso

JSON formato

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

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.