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

Consulta se a renovação automática está ativada para uma instância 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:DescribeInstanceAutoRenewalAttribute

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClientToken	string	Não	O token do cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o valor, mas deve garantir que ele seja exclusivo entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não pode exceder 64 caracteres de comprimento.	ETnLKlblzczshOTUbOCz****
RegionId	string	Sim	O ID da região da instância.	cn-hangzhou
DBInstanceId	string	Não	O ID da instância. Nota Por padrão, o sistema verifica se a renovação automática está ativada para todas as instâncias.	r-bp1zxszhcgatnx****
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 30, 50 e 100. Nota O valor padrão é 30.	30
PageNumber	integer	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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	2B17D708-1D6D-49F3-B6D7-478371DD****
PageNumber	integer	O número da página retornada.	1
PageRecordCount	integer	O número de entradas retornadas na página atual.	30
TotalRecordCount	integer	O número total de entradas retornadas.	1
Items	object
Item	array<object>	Detalhes das informações de renovação automática da instância.
	object
Duration	integer	The auto-renewal period. Unit: months.	1
DBInstanceId	string	The ID of the instance.	r-bp1zxszhcgatnx****
AutoRenew	string	Indicates whether auto-renewal is enabled. Valid values: true: Auto-renewal is enabled. false: Auto-renewal is disabled.	true
RegionId	string	The region ID of the instance.	cn-shanghai

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "2B17D708-1D6D-49F3-B6D7-478371DD****",
  "PageNumber": 1,
  "PageRecordCount": 30,
  "TotalRecordCount": 1,
  "Items": {
    "Item": [
      {
        "Duration": 1,
        "DBInstanceId": "r-bp1zxszhcgatnx****",
        "AutoRenew": "true",
        "RegionId": "cn-shanghai"
      }
    ]
  }
}

Resposta de erro

JSON formato

{
 "Items": {
   "Item": [
     {
       "Duration": 1,
       "RegionId": "cn-shanghai",
       "DBInstanceId": "r-xxxxxxxxxxxxxxx",
       "AutoRenew": "true"
     }
   ]
 },
 "TotalRecordCount": 1,
 "PageNumber": 1,
 "RequestId": "2B17D708-1D6D-49F3-B6D7-478371DDDBE8",
 "PageRecordCount": 1
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	IllegalParameter	Specified parameter exceeds range.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.