Consultar arquivos de backup de dados - : Central de Documentação do Alibaba Cloud

Nota

Um arquivo de backup de dados só permite restauração quando o valor de

BackupStatus

for

Success

.

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 códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeBackups	A operação a ser executada. Defina o valor como DescribeBackups.
DBInstanceId	String	Yes	rm-uf6wjk5xxxxxxx	O ID da instância.
BackupId	String	No	327329803	O ID do arquivo de backup de dados.
BackupStatus	String	No	Success	O status do arquivo de backup de dados. Valores válidos: Success Failed
BackupMode	String	No	Automated	O modo de backup do arquivo de backup de dados. Valores válidos: Automated Manual
StartTime	String	No	2011-06-01T16:00Z	Início do intervalo de tempo da consulta. Especifique a hora no padrão ISO 8601, no formato aaaa-MM-ddTHH:mmZ. A hora deve estar em UTC.
EndTime	String	No	2011-06-15T16:00Z	Fim do intervalo de tempo da consulta. A hora final deve ser posterior à inicial. Especifique a hora no padrão ISO 8601, no formato aaaa-MM-ddTHH:mmZ. A hora deve estar em UTC.
PageSize	Integer	No	30	Número de entradas por página. Valores válidos: 30 50 100 Valor padrão: 30.
PageNumber	Integer	No	1	Número da página a retornar. Valores válidos: qualquer número inteiro positivo diferente de zero. Valor padrão: 1.
BackupType	String	No	FullBackup	Tipo de backup do arquivo de backup de dados. Valores válidos: FullBackup IncrementalBackup
ResourceGroupId	String	No	rg-acfmy*****	O ID do grupo de recursos.

Parâmetros de resposta

Parameter	Type	Example	Description
RequestId	String	1A6D328C-84B8-40DC-BF49-6C73984D7494	O ID da solicitação.
TotalEcsSnapshotSize	Long	0	Tamanho da cadeia de snapshots da instância. Unidade: bytes.
PageRecordCount	String	30	Número de arquivos de backup de dados na página.
TotalRecordCount	String	100	Número total de entradas retornadas.
PageNumber	String	1	Número da página retornada.
Items	Array of Backup		Matriz com os detalhes dos arquivos de backup de dados retornados.
Backup
StorageClass	String	0	Classe de armazenamento do arquivo de backup de dados. Valores válidos: 0: armazenamento padrão 1: armazenamento de arquivamento
Encryption	String	{}	Informações de criptografia do arquivo de backup de dados.
BackupStatus	String	Success	Status do arquivo de backup de dados.
StoreStatus	String	Disabled	Indica se é possível excluir o arquivo de backup de dados. Valores válidos: Enabled: exclusão permitida. Disabled: exclusão não permitida.
ConsistentTime	Long	1576506856	Momento de consistência dos dados no arquivo de backup. O valor retornado é um timestamp. Nota Se a instância executar MySQL 5.6, retorna-se um timestamp. Caso contrário, retorna-se o valor 0.
BackupType	String	FullBackup	Tipo de backup do arquivo de backup de dados. Valores válidos: FullBackup IncrementalBackup
CopyOnlyBackup	String	0	Modo de backup do arquivo de backup de dados. Valores válidos: 0: modo padrão. Compatível com backups completos e incrementais. 1: modo somente cópia. Compatível apenas com backups completos. Nota Este parâmetro é retornado apenas quando a instância executa SQL Server.
BackupEndTime	String	2019-02-13T12:20:00Z	Hora de término da tarefa de backup. Segue o padrão ISO 8601, no formato aaaa-MM-ddTHH:mmZ. Exibida em UTC.
MetaStatus	String	OK	Status do arquivo de backup usado para restaurar bancos de dados ou tabelas individuais. Valores válidos: OK: arquivo normal. LARGE: contém quantidade anormalmente grande de tabelas. Inviável para restauração individual de bancos ou tabelas. EMPTY: gerado por tarefa de backup com falha. Nota Se retornar string vazia, o arquivo não serve para restaurar bancos de dados ou tabelas individuais.
BackupInitiator	String	System	Iniciador da tarefa de backup. Valores válidos: System User
BackupIntranetDownloadURL	String	http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx	URL para baixe do arquivo de backup via rede interna. Retorna null se o baixe não estiver disponível. Nota Por exemplo, retorna null se a instância executar SQL Server e o parâmetro BackupMethod for Snapshot.
BackupMethod	String	Physical	Método de geração do arquivo de backup de dados. Valores válidos: Logical: backup lógico Physical: backup físico Snapshot: backup de snapshot
BackupStartTime	String	2019-02-03T12:20:00Z	Hora de início da tarefa de backup. Segue o padrão ISO 8601, no formato aaaa-MM-ddTHH:mmZ. Exibida em UTC.
BackupDownloadURL	String	http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx	URL para baixe do arquivo de backup via Internet. Retorna null se o baixe não estiver disponível. Nota Por exemplo, retorna null se a instância executar SQL Server e o parâmetro BackupMethod for Snapshot.
IsAvail	Integer	1	Disponibilidade do arquivo de backup de dados. Valores válidos: 0: indisponível. 1: disponível.
BackupId	String	321020562	O ID do arquivo de backup de dados.
HostInstanceID	String	5882781	Número da instância que gerou o arquivo de backup. Indica se a origem foi uma instância primária ou secundária.
BackupSize	Long	2167808	Tamanho do arquivo de backup de dados. Unidade: bytes.
BackupMode	String	Automated	Modo de backup do arquivo de backup de dados. Valores válidos: Automated Manual
DBInstanceId	String	rm-uf6wjk5xxxxxxx	O ID da instância.
Checksum	String	1835830439**********	Soma de verificação calculada pelo algoritmo CRC64.
BackupDownloadLinkByDB	Array of BackupDownloadLinkByDB		URL para baixe do arquivo de backup de um banco de dados específico.
BackupDownloadLinkByDB
IntranetDownloadLink	String	https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&dbList=tb1	URL interna para baixe do arquivo de backup de dados.
DataBase	String	dbs	Nome do banco de dados.
DownloadLink	String	https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&dbList=tb1	URL pública para baixe do arquivo de backup de dados.
ResourceGroupId	String	rg-acfmy*****	O ID do grupo de recursos.

Exemplos

Exemplo de solicitação

http(s)://rds.aliyuncs.com/?Action=DescribeBackups
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<Common request parameters>

Exemplo de resposta de sucesso

Formato XML

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

<DescribeBackupsResponse>
    <TotalRecordCount>100</TotalRecordCount>
    <TotalEcsSnapshotSize>0</TotalEcsSnapshotSize>
    <PageRecordCount>30</PageRecordCount>
    <RequestId>1A6D328C-84B8-40DC-BF49-6C73984D7494</RequestId>
    <PageNumber>1</PageNumber>
    <Items>
        <Backup>
            <BackupMethod>Physical</BackupMethod>
            <BackupInitiator>System</BackupInitiator>
            <StorageClass>0</StorageClass>
            <BackupIntranetDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx</BackupIntranetDownloadURL>
            <BackupSize>2167808</BackupSize>
            <BackupMode>Automated</BackupMode>
            <BackupId>321020562</BackupId>
            <IsAvail>1</IsAvail>
            <Encryption>{}</Encryption>
            <HostInstanceID>5882781</HostInstanceID>
            <StoreStatus>Disabled</StoreStatus>
            <BackupDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx</BackupDownloadURL>
            <DBInstanceId>rm-uf6wjk5xxxxxxx</DBInstanceId>
            <CopyOnlyBackup>0</CopyOnlyBackup>
            <BackupEndTime>2019-02-13T12:20:00Z</BackupEndTime>
            <ConsistentTime>1576506856</ConsistentTime>
            <BackupStartTime>2019-02-03T12:20:00Z</BackupStartTime>
            <MetaStatus>OK</MetaStatus>
            <BackupType>FullBackup</BackupType>
            <BackupStatus>Success</BackupStatus>
            <BackupDownloadLinkByDB>
                <BackupDownloadLinkByDB>
                    <DownloadLink>https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&amp;dbList=tb1</DownloadLink>
                    <IntranetDownloadLink>https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&amp;dbList=tb1</IntranetDownloadLink>
                    <DataBase>dbs</DataBase>
                </BackupDownloadLinkByDB>
            </BackupDownloadLinkByDB>
        </Backup>
    </Items>
</DescribeBackupsResponse>

Formato JSON

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

{
  "DescribeBackupsResponse" : {
    "TotalRecordCount" : 100,
    "TotalEcsSnapshotSize" : 0,
    "PageRecordCount" : 30,
    "RequestId" : "1A6D328C-84B8-40DC-BF49-6C73984D7494",
    "PageNumber" : 1,
    "Items" : {
      "Backup" : {
        "BackupMethod" : "Physical",
        "BackupInitiator" : "System",
        "StorageClass" : 0,
        "BackupIntranetDownloadURL" : "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx",
        "BackupSize" : 2167808,
        "BackupMode" : "Automated",
        "BackupId" : 321020562,
        "IsAvail" : 1,
        "Encryption" : "{}",
        "HostInstanceID" : 5882781,
        "StoreStatus" : "Disabled",
        "BackupDownloadURL" : "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx",
        "DBInstanceId" : "rm-uf6wjk5xxxxxxx",
        "CopyOnlyBackup" : 0,
        "BackupEndTime" : "2019-02-13T12:20:00Z",
        "ConsistentTime" : 1576506856,
        "BackupStartTime" : "2019-02-03T12:20:00Z",
        "MetaStatus" : "OK",
        "BackupType" : "FullBackup",
        "BackupStatus" : "Success",
        "BackupDownloadLinkByDB" : {
          "BackupDownloadLinkByDB" : {
            "DownloadLink" : "https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&amp;dbList=tb1",
            "IntranetDownloadLink" : "https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&amp;dbList=tb1",
            "DataBase" : "dbs"
          }
        }
      }
    }
  }
}

Códigos de erro

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