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

Consulta as informações gerais de uma ou mais instâncias de banco de dados ApsaraDB for Tair (Redis® OSS-Compatible).

Descrição da operação

Se você não especificar nenhum parâmetro de solicitação, as informações gerais de todas as instâncias serão retornadas.

Nota

Esta operação não suporta paginação para os resultados retornados.

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:DescribeInstancesOverview

get

*Todos os recursos.

*

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. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-hangzhou
InstanceIds	string	Não	Os IDs das instâncias que você deseja consultar. Nota Por padrão, todas as instâncias da conta atual são consultadas. Para especificar vários IDs de instância, separe-os com vírgulas (,).	r-bp1zxszhcgatnx****
InstanceStatus	string	Não	O status da instância. Valores válidos: Normal: A instância está em execução. Creating: A instância está sendo criada. Changing: A instância está sendo modificada. Inactive: A instância está desativada. Flushing: A instância está sendo limpa. Released: A instância foi liberada. Transforming: A instância está sendo transformada. Migrating: A instância está sendo migrada. BackupRecovering: A instância está sendo restaurada a partir de um backup. MinorVersionUpgrading: Uma atualização de versão secundária está em andamento. NetworkModifying: A configuração de rede está sendo modificada. SSLModifying: A configuração SSL está sendo modificada. MajorVersionUpgrading: Uma atualização de versão principal do mecanismo está em andamento. A instância pode ser acessada normalmente. Nota Para obter mais informações sobre os status das instâncias, consulte Estados e impactos da instância.	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: 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. Valores válidos: 4.0 : 4.0 5.0 : 5.0 6.0 : 6.0 7.0 : 7.0 2.8 : 2.8	6.0
InstanceClass	string	Não	O tipo de instância. Para obter 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****
InstanceType	string	Não	O tipo de instância. Valores válidos: Tair Redis Memcache	Redis
SearchKey	string	Não	A palavra-chave usada para busca difusa por ID da instância ou descrição da instância.	apitest
ArchitectureType	string	Não	O tipo de arquitetura. Valores válidos: cluster: Cluster Edition. standard: Standard Edition. rwsplit: edição com divisão de leitura/gravação.	standard
ZoneId	string	Não	O ID da zona.	cn-hangzhou-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 o ID do grupo de recursos. Para operações relacionadas, consulte Visualizar informações básicas de um grupo de recursos.	rg-acfmyiu4ekp****
EditionType	string	Não	O tipo de edição. Valores válidos: Community: Community Edition. Enterprise: Enterprise Edition.	Enterprise
PrivateIp	string	Não	O endereço IP privado.	172.16.49.***

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O objeto de resposta.
RequestId	string	O ID da solicitação.	1E83311F-0EE4-4922-A3BF-730B312B****
TotalCount	integer	O número total de instâncias.	1
Instances	array<object>	A lista de instâncias.
	object	O objeto da instância.
VpcId	string	O ID da VPC.	vpc-bp1nme44gek34slfc****
PrivateIp	string	O endereço IP privado da instância em uma VPC. O endereço IP pode mudar. Use ConnectionDomain (endpoint interno) para se conectar à instância. Nota Este parâmetro não é retornado se o tipo de rede da instância for rede clássica. Este parâmetro não é retornado para instâncias nativas da nuvem.	172.16.49.***
Capacity	integer	A capacidade de armazenamento da instância. Unidade: MB.	4096
CreateTime	string	A hora em que a instância foi criada.	2018-11-07T08:49:00Z
ConnectionDomain	string	O endpoint interno da instância.	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
ChargeType	string	O método de cobrança. Valores válidos: PrePaid: assinatura. PostPaid: pay-as-you-go.	PrePaid
ArchitectureType	string	O tipo de arquitetura. Valores válidos: cluster: Cluster Edition. standard: Standard Edition. rwsplit: edição com divisão de leitura/gravação.	cluster
NetworkType	string	O tipo de rede. Valores válidos: CLASSIC: rede clássica. VPC: nuvem privada virtual (VPC).	CLASSIC
EngineVersion	string	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.	6.0
InstanceName	string	O nome da instância.	apitest
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****
InstanceClass	string	O tipo de instância.	redis.logic.sharding.2g.2db.0rodb.4proxy.default
InstanceId	string	O ID da instância.	r-bp1zxszhcgatnx****
InstanceType	string	O tipo de instância. Valores válidos: Tair: Tair (Enterprise Edition). Redis: Redis Community Edition. Memcache	Redis
NodeType	string
RegionId	string	O ID da região.	cn-hangzhou
EndTime	string	A hora em que a instância de assinatura expira.	2022-06-13T16:00:00Z
VSwitchId	string	O ID do vSwitch.	vsw-bp1e7clcw529l773d****
ResourceGroupId	string	O ID do grupo de recursos ao qual a instância pertence.	rg-acfmyiu4ekp****
ZoneId	string	O ID da zona.	cn-hangzhou-b
InstanceStatus	string	O status da instância. Valores válidos: Normal: A instância está em execução. Creating: A instância está sendo criada. Changing: A instância está sendo modificada. Inactive: A instância está desativada. Flushing: A instância está sendo limpa. Released: A instância foi liberada. Transforming: A instância está sendo transformada. Unavailable: A instância está indisponível. Error: Falha na criação da instância. Migrating: A instância está sendo migrada. BackupRecovering: A instância está sendo restaurada a partir de um backup. MinorVersionUpgrading: Uma atualização de versão secundária está em andamento. NetworkModifying: A configuração de rede está sendo modificada. SSLModifying: A configuração SSL está sendo modificada. MajorVersionUpgrading: Uma atualização de versão principal do mecanismo está em andamento. A instância pode ser acessada normalmente.	Normal
SecondaryZoneId	string	O ID da zona secundária. Nota Este parâmetro é retornado apenas quando a instância possui uma zona secundária.	cn-hangzhou-g

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "1E83311F-0EE4-4922-A3BF-730B312B****",
  "TotalCount": 1,
  "Instances": [
    {
      "VpcId": "vpc-bp1nme44gek34slfc****",
      "PrivateIp": "172.16.49.***",
      "Capacity": 4096,
      "CreateTime": "2018-11-07T08:49:00Z",
      "ConnectionDomain": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
      "ChargeType": "PrePaid",
      "ArchitectureType": "cluster",
      "NetworkType": "CLASSIC",
      "EngineVersion": "6.0",
      "InstanceName": "apitest",
      "GlobalInstanceId": "gr-bp14rkqrhac****",
      "InstanceClass": "redis.logic.sharding.2g.2db.0rodb.4proxy.default",
      "InstanceId": "r-bp1zxszhcgatnx****",
      "InstanceType": "Redis",
      "NodeType": "",
      "RegionId": "cn-hangzhou",
      "EndTime": "2022-06-13T16:00:00Z",
      "VSwitchId": "vsw-bp1e7clcw529l773d****",
      "ResourceGroupId": "rg-acfmyiu4ekp****",
      "ZoneId": "cn-hangzhou-b",
      "InstanceStatus": "Normal",
      "SecondaryZoneId": "cn-hangzhou-g"
    }
  ]
}

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.