DescribeBackups - : Central de Documentação do Alibaba Cloud

Consulta os conjuntos de backup de uma instância do ApsaraDB for MongoDB.

Depuração

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

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeBackups	A operação a ser executada. Defina o valor como DescribeBackups.
RegionId	String	Não	cn-hangzhou	ID da região da instância. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
DBInstanceId	String	Sim	dds-bp1a7009eb24****	ID da instância. Nota Se você definir este parâmetro como o ID de uma instância de cluster fragmentado, também deverá especificar o parâmetro NodeId.
NodeId	String	Não	d-bp128a003436****	ID do nó shard na instância de cluster fragmentado. Nota Este parâmetro é válido apenas quando DBInstanceId está definido como o ID de uma instância de cluster fragmentado.
BackupId	String	Não	2072**,2072,2072**	ID do conjunto de backup. Chame a operação CreateBackup para obter o valor deste parâmetro. Se você definir o parâmetro DBInstanceId como o ID de uma instância de cluster fragmentado, o número de IDs de backup será igual ao número de shards. Separe vários IDs com vírgulas (,).
PageNumber	Integer	Não	1	Número da página a ser retornada. O valor deve ser um número inteiro maior que 0. Valor padrão: 1.
PageSize	Integer	Não	30	Número de entradas a serem retornadas em cada página. Valores válidos: 30, 50 e 100. Valor padrão: 30.
StartTime	String	Não	2022-01-13T13:00Z	Início do intervalo de tempo a ser consultado. Especifique a hora no formato aaaa-MM-ddTHH:mmZ. A hora deve estar em UTC.
EndTime	String	Não	2022-01-14T13:00Z	Fim do intervalo de tempo a ser consultado. Especifique a hora no formato aaaa-MM-ddTHH:mmZ. A hora deve estar em UTC.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
TotalCount	Integer	1	Número total de conjuntos de backup retornados.
RequestId	String	275D43C3-F12F-5224-B375-0C6BF453BD56	ID da solicitação.
PageSize	Integer	30	Número de entradas retornadas em cada página.
PageNumber	Integer	1	Número da página retornada.
Backups	Array of Backup		Detalhes sobre os conjuntos de backup.
Backup
BackupStatus	String	Success	Status do backup. Valores válidos: Success: A tarefa de backup foi concluída com êxito. Failed: A tarefa de backup falhou.
BackupType	String	FullBackup	Método de backup. FullBackup: backup completo IncrementalBackup: backup incremental
BackupStartTime	String	2022-01-14T03:56:17Z	Início do intervalo de tempo do backup. A hora está no formato aaaa-MM-ddTHH:mm:ssZ e é exibida em UTC.
BackupIntranetDownloadURL	String	http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559***/hins1936_data_2022052504_qp.xb?Expires=165361&OSSAccessKeyId=LTAI4G2wxd32KLGARfi&Signature=lkFPjOY%2F8adB18vnOCbtmT7ii**&Region=cn-hangzhou	URL de download interno do conjunto de backup. Nota Use esta URL para baixar o conjunto de backup a partir de uma instância ECS que esteja na mesma rede da instância do ApsaraDB for MongoDB.
BackupSize	Long	6168576	Tamanho do conjunto de backup. Unidade: bytes.
BackupDownloadURL	String	http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559**/hins1936_data_2022052504_qp.xb?Expires=165361&OSSAccessKeyId=LTAI4G2wxd32KLGARf&Signature=lkFPjOY%2F8adB18vnOCbtmT7**&Region=cn-hangzhou	URL de download pela Internet do conjunto de backup. Se a URL de download não estiver disponível, este parâmetro será uma string vazia.
BackupMode	String	Automated	Modo de backup. Automated: backup automático Manual: backup manual
BackupEndTime	String	2022-01-14T03:57:34Z	Fim do intervalo de tempo do backup. A hora está no formato aaaa-MM-ddTHH:mm:ssZ e é exibida em UTC.
BackupId	Integer	32102****	ID do conjunto de backup.
BackupDBNames	String	config,myNewDB	Nome do banco de dados incluído no backup.
BackupMethod	String	Physical	Método de backup. Valores válidos: Snapshot Physical Logical

Exemplos

Solicitações de exemplo

http(s)://mongodb.aliyuncs.com/?Action=DescribeBackups
&DBInstanceId=dds-bp1a7009eb24****
&<Common request parameters>

Respostas de sucesso de exemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeBackupsResponse>
    <TotalCount>1</TotalCount>
    <RequestId>275D43C3-F12F-5224-B375-0C6BF453BD56</RequestId>
    <PageSize>30</PageSize>
    <PageNumber>1</PageNumber>
    <Backups>
        <BackupStatus>Success</BackupStatus>
        <BackupType>FullBackup</BackupType>
        <BackupStartTime>2022-01-14T03:56:17Z</BackupStartTime>
        <BackupIntranetDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559*****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&amp;OSSAccessKeyId=LTAI4G2wxd32KLGARfi****&amp;Signature=lkFPjOY%2F8adB18vnOCbtmT7ii****&amp;Region=cn-hangzhou</BackupIntranetDownloadURL>
        <BackupSize>6168576</BackupSize>
        <BackupDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&amp;OSSAccessKeyId=LTAI4G2wxd32KLGARf****&amp;Signature=lkFPjOY%2F8adB18vnOCbtmT7****&amp;Region=cn-hangzhou</BackupDownloadURL>
        <BackupMode>Automated</BackupMode>
        <BackupEndTime>2022-01-14T03:57:34Z</BackupEndTime>
        <BackupDBNames>database</BackupDBNames>
        <BackupMethod>Physical</BackupMethod>
    </Backups>
</DescribeBackupsResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "275D43C3-F12F-5224-B375-0C6BF453BD56",
  "PageSize" : 30,
  "PageNumber" : 1,
  "Backups" : {
    "BackupStatus" : "Success",
    "BackupType" : "FullBackup",
    "BackupStartTime" : "2022-01-14T03:56:17Z",
    "BackupIntranetDownloadURL" : "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559*****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&amp;OSSAccessKeyId=LTAI4G2wxd32KLGARfi****&amp;Signature=lkFPjOY%2F8adB18vnOCbtmT7ii****&amp;Region=cn-hangzhou",
    "BackupSize" : 6168576,
    "BackupDownloadURL" : "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&amp;OSSAccessKeyId=LTAI4G2wxd32KLGARf****&amp;Signature=lkFPjOY%2F8adB18vnOCbtmT7****&amp;Region=cn-hangzhou",
    "BackupMode" : "Automated",
    "BackupEndTime" : "2022-01-14T03:57:34Z",
    "BackupDBNames" : "database",
    "BackupMethod" : "Physical"
  }
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o API Error Center.