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

Consulta as instâncias do ApsaraDB for MongoDB cujos backups são restaurados em até sete 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 retornadas por página.	30
DBInstanceId	string	Sim	O ID da instância.	dds-bp114f14849d****
CreationTimeAfter	string	Sim	Consulta instâncias criadas após o horário especificado, formatado como yyyy-MM-ddTHH:00:00Z (horário UTC). Nota O horário deve ser na hora exata. O horário não pode ser anterior a 7 dias antes do horário atual.	2024-07-24T14:00:00Z

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	integer	O número de instâncias nos resultados da consulta.	5
RequestId	string	O ID da solicitação.	1AF0AD89-ED4F-44AD-B65F-BFC1D5Cxxxxx
PageSize	integer	O número de entradas retornadas por página.	30
PageNumber	integer	O número da página.	1
DBInstances	object
DBInstance	array<object>	Lista de instâncias de banco de dados.
	object	Lista de instâncias de banco de dados.
CreationTime	string	The time of instance creation, formatted as yyyy-MM-ddTHH:00:00Z (UTC time).	2022-01-02T07:43:59Z
LockMode	string	The locked state of the instance, value description: Unlock: Normal. ManualLock: Manually triggered lock. LockByExpiration: Automatically locked due to expiration. LockByRestoration: Automatically locked before restoration. LockByDiskQuota: Automatically locked due to disk quota exceeded.	Unlock
EngineVersion	string	The database engine version of the instance. Valid values: 7.0 6.0 5.0 4.4 4.2 4.0 3.4	4.2
DBInstanceDescription	string	The description of the instance.	Test database
DBInstanceType	string	The architecture of the instance. Valid values: sharding: sharded cluster instance replicate: replica set or standalone instance	replicate
DBInstanceStatus	string	The status of the instance. For more information, see Instance states.	Running
RegionId	string	The region ID of the instance.	cn-hangzhou
ZoneId	string	The zone ID of the instance.	cn-hangzhou-g
DBInstanceId	string	The instance ID.	dds-bp12c5b040dc****
IsDeleted	integer	Specifies whether the instance is deleted. Valid values: 0: not deleted 1: deleted	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.	The specified parameter %s is not valid.
400	InvalidDBInstanceId.NotFound	Specified instance does not exist.	Instance not found. Refresh the page to check whether the instance has been released.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.