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

Consulta as informações sobre instâncias de banco de dados ApsaraDB for Tair (compatível com Redis) em um cluster dedicado.

Descrição da operação

Nota

Para consultar as informações sobre instâncias que não estão em um cluster dedicado, chame DescribeInstanceAttribute.

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

get

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região. Você pode chamar DescribeRegions para consultar os IDs das regiões.	cn-hangzhou
ZoneId	string	Não	O ID da zona. Você pode chamar DescribeZones para consultar os IDs das zonas.	cn-hangzhou-e
InstanceId	string	Não	O ID da instância. Nota A instância deve ser criada em um cluster dedicado. Para mais informações, consulte ApsaraDB for MyBase.	r-bp1zxszhcgatnx****
InstanceStatus	integer	Não	O status da instância. Valores válidos: 0: Criando. 1: Em execução. 3: Excluindo. 5: Alterando especificações. 6: Migrando. 7: Restaurando do backup. 8: Alternando. 9: Excluindo dados expirados.	1
InstanceNetType	string	Não	O tipo de rede do endpoint da instância. Valores válidos: 0: Internet. 1: Rede clássica. 2: Virtual Private Cloud (VPC).	2
Engine	string	Não	O mecanismo de banco de dados. Defina o valor como Redis. Valores válidos: Redis : Mecanismo Redis.	Redis
EngineVersion	string	Não	A versão do mecanismo de banco de dados. Defina o valor como 5.0. Valores válidos: 5.0 : Versão 5.0	5.0
ClusterId	string	Não	O ID do cluster dedicado. Você pode obter o ID na página de informações do cluster dedicado no console do ApsaraDB for MyBase. Nota Para especificar vários IDs, separe-os por vírgulas (,).	dhg-5f2v98840ioq****
DedicatedHostName	string	Não	O ID do host no cluster dedicado. Você pode chamar DescribeDedicatedHosts para consultar o ID do host. Nota Para especificar vários IDs, separe-os por vírgulas (,).	ch-t4n664a9mal4c****
PageNumber	integer	Não	O número da página. O valor deve ser maior que 0 e menor ou igual ao valor máximo do tipo de dados Integer. Valor padrão: 1.	1
PageSize	integer	Não	O número máximo de entradas a serem retornadas em cada página. Valores válidos: 30, 50 e 100. Valor padrão: 30. Valores válidos: 30 : 30 entradas por página. 50 : 50 entradas por página. 100 : 100 entradas por página.	30

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas retornadas por página.	25
RequestId	string	O ID da solicitação.	712CCF2A-16BD-411B-93F7-E978BEF2****
TotalCount	integer	O número total de entradas.	0
Instances	array<object>	A lista de informações das instâncias.
	array<object>	A lista de informações das instâncias.
VpcId	string	O ID da VPC.	vpc-t4n2clc70t3hqwsrr****
CharacterType	string	O tipo de arquitetura. Valores válidos: logic: Arquitetura de cluster. normal: Arquitetura padrão.	logic
VswitchId	string	O ID do vSwitch.	vsw-t4nvrca24dczppq44****
InstanceClass	string	O tipo de instância.	redis.cluster.sharding.common.ce
MaintainStartTime	string	A hora de início da janela de manutenção. A hora está no formato HH:mmZ. A hora é exibida em UTC.	16:00Z
CreateTime	string	A hora em que a instância foi criada. A hora está no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2021-05-06T07:09:40Z
ConnectionDomain	string	O endpoint de conexão direta.	r-t4ncdi1dgi0ja8****.redis.hangzhou.rds.aliyuncs.com
MaintainEndTime	string	A hora de término da janela de manutenção. A hora está no formato HH:mmZ. A hora é exibida em UTC.	17:00Z
StorageType	string	O tipo de armazenamento. O valor é fixo como LOCAL_SSD (disco em nuvem ESSD (SSD padrão)).	LOCAL_SSD
InstanceId	string	O ID da instância.	r-bp1e7vl6ygf1yq****
BandWidth	integer	A largura de banda padrão da instância. Unidade: MB/s.	24
CurrentBandWidth	integer	A largura de banda atual da instância. Unidade: MB/s. O valor é a soma da largura de banda padrão e da largura de banda aumentada.	50
EngineVersion	string	A versão do mecanismo de banco de dados. O valor é fixo como 5.0.	5.0
RegionId	string	O ID da região.	cn-hangzhou
InstanceName	string	O nome da instância.	testdb
ZoneId	string	O ID da zona.	cn-hangzhou-e
ClusterName	string	O nome do cluster dedicado.	testname
InstanceStatus	string	O status da instância. Valores válidos: Normal: Normal. Creating: Criando. Changing: Alterando. Inactive: Desativado. Flushing: Limpeza em andamento. Released: Liberado. Transforming: Transformando. Unavailable: Indisponível. Error: Falha na criação. Migrating: Migrando. BackupRecovering: Restaurando do backup. MinorVersionUpgrading: Atualização de versão secundária em andamento. NetworkModifying: Alterando a rede. SSLModifying: Alterando configurações de SSL. MajorVersionUpgrading: Atualização de versão principal do mecanismo em andamento. A instância permanece acessível.	Normal
Engine	string	O mecanismo de banco de dados. O valor é fixo como redis.	redis
ShardCount	integer	O número de shards de dados. Nota Este parâmetro é retornado apenas quando a instância usa a arquitetura de cluster.	3
CustomId	string	Um parâmetro interno usado para manutenção da instância.	4652****
ProxyCount	integer	O número de nós de proxy. Nota Um valor de 0 indica que o modo de proxy está desativado para a instância. Um valor maior que 0 (como 1) indica que o modo de proxy está ativado para a instância. Este parâmetro é retornado apenas quando a instância usa a arquitetura de cluster.	1
ClusterId	string	O ID do cluster dedicado.	dhg-rx71fc5ndh9o****
InstanceNodeList	array<object>	A lista de informações dos nós.
	object	A lista de nós da instância.
NodeIp	string	O endereço IP do nó.	10.0.33.***
DedicatedHostName	string	O ID do host no cluster dedicado.	ch-bp13vf0y9gx3c****
NodeType	string	O tipo de nó. Valores válidos: db: Nó de dados. proxy: Nó de proxy. normal: Nó regular. Este valor é retornado para instâncias que usam a arquitetura padrão.	normal
ZoneId	string	A zona à qual o nó pertence.	cn-hangzhou-h
InstanceId	string	O ID da instância.	r-bp1e7vl6ygf1yq****
Port	integer	A porta do nó.	3001
Role	string	A função do nó. Valores válidos: master: Nó primário. slave: Nó secundário.	master
NodeId	integer	O ID do nó.	17921111

Exemplos

Resposta de sucesso

JSON formato

{
  "PageNumber": 1,
  "PageSize": 25,
  "RequestId": "712CCF2A-16BD-411B-93F7-E978BEF2****",
  "TotalCount": 0,
  "Instances": [
    {
      "VpcId": "vpc-t4n2clc70t3hqwsrr****",
      "CharacterType": "logic",
      "VswitchId": "vsw-t4nvrca24dczppq44****",
      "InstanceClass": "redis.cluster.sharding.common.ce",
      "MaintainStartTime": "16:00Z",
      "CreateTime": "2021-05-06T07:09:40Z",
      "ConnectionDomain": "r-t4ncdi1dgi0ja8****.redis.hangzhou.rds.aliyuncs.com",
      "MaintainEndTime": "17:00Z",
      "StorageType": "LOCAL_SSD",
      "InstanceId": "r-bp1e7vl6ygf1yq****",
      "BandWidth": 24,
      "CurrentBandWidth": 50,
      "EngineVersion": "5.0",
      "RegionId": "cn-hangzhou",
      "InstanceName": "testdb",
      "ZoneId": "cn-hangzhou-e",
      "ClusterName": "testname",
      "InstanceStatus": "Normal",
      "Engine": "redis",
      "ShardCount": 3,
      "CustomId": "4652****",
      "ProxyCount": 1,
      "ClusterId": "dhg-rx71fc5ndh9o****",
      "InstanceNodeList": [
        {
          "NodeIp": "10.0.33.***",
          "DedicatedHostName": "ch-bp13vf0y9gx3c****",
          "NodeType": "normal",
          "ZoneId": "cn-hangzhou-h",
          "InstanceId": "r-bp1e7vl6ygf1yq****",
          "Port": 3001,
          "Role": "master",
          "NodeId": 17921111
        }
      ]
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.