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

Consulta os detalhes de uma instância Tair distribuída (compatível com Redis OSS).

Descrição da operação

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

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

get

*DBInstance

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
GlobalInstanceId	string	Não	O ID da instância distribuída.	gr-bp14rkqrhac****
PageNumber	string	Não	O número da página a ser retornada. O valor deve ser um número inteiro maior que 0. Valor padrão: 1.	1
PageSize	string	Não	O número de entradas a serem retornadas em cada página.	20
SubInstanceId	string	Não	O ID da instância filha que está anexada à instância distribuída.	gr-bp1zcjlobkyrq****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageSize	integer	O número de entradas retornadas por página.	20
RequestId	string	O ID da solicitação.	F3F44BE3-5419-4B61-9BAC-E66E295A****
PageNumber	integer	O número da página retornada.	1
TotalRecordCount	integer	O número total de entradas retornadas.	1
GlobalDistributeCaches	array<object>	Detalhes da instância distribuída.
	array<object>
Status	string	O status da instância distribuída. Valores válidos: Normal: A instância está normal. Changing: As configurações da instância estão sendo alteradas. Creating: A instância está sendo criada.	Normal
GlobalInstanceId	string	O ID da instância distribuída.	gr-bp14rkqrhac****
SubInstances	array<object>	Detalhes das instâncias filhas.
	object
InstanceStatus	string	The state of the child instance. Valid values: Normal: The instance is normal. Creating: The instance is being created. Changing: The configurations of the instance are being changed. Inactive: The instance is disabled. Flushing: The instance is being released. Released: The instance is released. Transforming: The billing method of the instance is changing. Unavailable: The instance is suspended. Error: The instance failed to be created. Migrating: The instance is being migrated. BackupRecovering: The instance is being restored from a backup. MinorVersionUpgrading: The minor version of the instance is being updated. NetworkModifying: The network type of the instance is being changed. SSLModifying: The SSL certificate of the instance is being changed. MajorVersionUpgrading: The major version of the instance is being upgraded. The instance remains available during the upgrade. Nota For more information about instance states, see Instance states and impacts.	Normal
InstanceID	string	The ID of the child instance.	r-bp1zxszhcgatnx****
InstanceClass	string	The instance type of the child instance. For more information, see the following topics: Standard DRAM-based instances Cluster DRAM-based instances Read/write splitting DRAM-based instances	redis.amber.logic.sharding.2g.2db.0rodb.6proxy.multithread
GlobalInstanceId	string	The ID of the distributed instance.	gr-bp14rkqrhac****
RegionId	string	The ID of the region.	cn-hangzhou

Exemplos

Resposta de sucesso

JSON formato

{
  "PageSize": 20,
  "RequestId": "F3F44BE3-5419-4B61-9BAC-E66E295A****",
  "PageNumber": 1,
  "TotalRecordCount": 1,
  "GlobalDistributeCaches": [
    {
      "Status": "Normal",
      "GlobalInstanceId": "gr-bp14rkqrhac****",
      "SubInstances": [
        {
          "InstanceStatus": "Normal",
          "InstanceID": "r-bp1zxszhcgatnx****",
          "InstanceClass": "redis.amber.logic.sharding.2g.2db.0rodb.6proxy.multithread",
          "GlobalInstanceId": "gr-bp14rkqrhac****",
          "RegionId": "cn-hangzhou"
        }
      ]
    }
  ]
}

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.