DescribeInstanceAutoRenewalAttribute - ApsaraDB for MongoDB: Central de Documentação do Alibaba Cloud

Consulta o status de renovação automática de instâncias MongoDB.

Descrição da operação

Esta operação é aplicável a instâncias de assinatura.

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

dds:DescribeInstanceAutoRenewalAttribute

get

Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da instância. Você pode chamar a operação DescribeDBInstanceAttribute para consultar o ID da região da instância.	cn-hangzhou
DBInstanceId	string	Não	O ID da instância.	dds-bp567b****
DBInstanceType	string	Não	A categoria da instância. Valores válidos: replicate: instância standalone ou de conjunto de réplicas sharding: instância de cluster fragmentado Valor padrão: replicate.	replicate
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 30, 50 e 100. Nota Valor padrão: 30.	30
PageNumber	integer	Não	O número da página a ser retornada. O valor deve ser um inteiro positivo que não exceda o valor máximo do parâmetro Integer. Valor padrão: 1.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
ItemsNumbers	integer	O número total de entradas retornadas.	2
PageRecordCount	integer	O número de entradas retornadas na página atual.	2
RequestId	string	O ID da solicitação.	FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949
PageNumber	integer	O número da página retornada.	1
Items	object
Item	array<object>	Detalhes sobre as entradas retornadas.
	object
DBInstanceType	string	The category of the instance. Valid values: replicate: the standalone or replica set instance sharding: the sharded cluster instance	replicate
AutoRenew	string	Indicates whether auto-renewal is enabled for the instance. Valid values: true: Auto-renewal is enabled for the instance. false: Auto-renewal is disabled for the instance.	true
Duration	string	The auto-renewal period. Unit: months. Nota This parameter is ruturned only when the returned value of the AutoRenew parameter is true. You can call the ModifyInstanceAutoRenewalAttribute operation to modify the auto-renewal period.	1
DbInstanceId	string	The ID of the instance.	dds-bp2568*****
RegionId	string	The region ID of the instance.	cn-hangzhou

Exemplos

Resposta de sucesso

JSON formato

{
  "ItemsNumbers": 2,
  "PageRecordCount": 2,
  "RequestId": "FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949",
  "PageNumber": 1,
  "Items": {
    "Item": [
      {
        "DBInstanceType": "replicate",
        "AutoRenew": "true",
        "Duration": "1",
        "DbInstanceId": "dds-bp2568*****",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error occurred. Please try again later.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.