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

Consulta as instâncias de backup e restauração de uma instância do MongoDB nos últimos 7 dias.

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

get

*Instance

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Não	O número da página.	1
PageSize	integer	Não	O número de entradas por página.	30
DBInstanceId	string	Sim	O ID da instância.	dds-bp114f14849d****
CreationTimeAfter	string	Sim	A hora de início usada para consultar instâncias. Apenas as instâncias criadas após essa hora são retornadas. Especifique a hora no formato yyyy-MM-ddTHH:00:00Z. A hora deve estar em UTC. Nota A hora deve ser um intervalo de tempo. A hora não pode ser anterior a 7 dias antes da hora atual.	2024-07-24T14:00:00Z

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	integer	O número total de instâncias retornadas no resultado da consulta.	5
RequestId	string	O ID da solicitação.	1AF0AD89-ED4F-44AD-B65F-BFC1D5Cxxxxx
PageSize	integer	O número de entradas por página.	30
PageNumber	integer	O número da página.	1
DBInstances	object
DBInstance	array<object>	A lista de informações das instâncias.
	object	A lista de informações das instâncias.
CreationTime	string	A hora em que a instância foi criada. A hora está no formato yyyy-MM-ddTHH:mm:ssZ. A hora está em UTC.	2022-01-02T07:43:59Z
LockMode	string	O estado de bloqueio da instância. Valores válidos: Unlock: Normal. ManualLock: Bloqueado manualmente. LockByExpiration: Bloqueado automaticamente devido ao vencimento. LockByRestoration: Bloqueado automaticamente antes de uma reversão. LockByDiskQuota: Bloqueado automaticamente devido ao espaço de armazenamento cheio.	Unlock
EngineVersion	string	A versão do mecanismo de banco de dados. Valores válidos: 7.0 6.0 5.0 4.4 4.2 4.0	4.2
DBInstanceDescription	string	A descrição ou observação da instância.	Test database
DBInstanceType	string	O tipo de instância. Valores válidos: sharding: Instância de cluster fragmentado. replicate: Instância de conjunto de réplicas.	replicate
DBInstanceStatus	string	O status da instância. Para mais informações, consulte Status das instâncias.	Running
RegionId	string	O ID da região da instância.	cn-hangzhou
ZoneId	string	O ID da zona da instância.	cn-hangzhou-g
DBInstanceId	string	O ID da instância.	dds-bp12c5b040dc****
IsDeleted	integer	Indica se a instância foi excluída. Valores válidos: 1: Excluída. 0: Não excluída.	0

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 5,
  "RequestId": "1AF0AD89-ED4F-44AD-B65F-BFC1D5Cxxxxx",
  "PageSize": 30,
  "PageNumber": 1,
  "DBInstances": {
    "DBInstance": [
      {
        "CreationTime": "2022-01-02T07:43:59Z",
        "LockMode": "Unlock",
        "EngineVersion": "4.2",
        "DBInstanceDescription": "Test database",
        "DBInstanceType": "replicate",
        "DBInstanceStatus": "Running",
        "RegionId": "cn-hangzhou",
        "ZoneId": "cn-hangzhou-g",
        "DBInstanceId": "dds-bp12c5b040dc****",
        "IsDeleted": 0
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter	The specified parameter %s is not valid.	O parâmetro %s é inválido.
400	InvalidDBInstanceId.NotFound	Specified instance does not exist.	O ID da instância não existe.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.