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

Nota

Um arquivo de backup completo contém os dados de um banco de dados MySQL autogerenciado. Você pode restaurar esses dados em uma instância do ApsaraDB RDS for MySQL a partir desse arquivo. Para mais informações, consulte Migrar os dados de uma instância MySQL 5.7 autogerenciada para a nuvem.
Antes de chamar a operação CreateDBInstance para criar uma instância do ApsaraDB RDS for MySQL destinada à importação de arquivos de backup completo, chame a operação ListUserBackupFiles para obter os IDs desses arquivos.
Chame a operação ImportUserBackupFile para importar um arquivo de backup completo em uma instância do ApsaraDB RDS for MySQL.

Depuração

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

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListUserBackupFiles	A operação a ser executada. Defina o valor como ListUserBackupFiles.
Status	String	Não	CheckSuccess	O status dos arquivos de backup completo. Valores válidos: Importing: os arquivos de backup completo estão sendo importados. Failed: falha na importação dos arquivos de backup completo. CheckSucccess: os arquivos de backup completo passaram na verificação. BackupSuccess: os arquivos de backup completo foram importados. Deleted: os arquivos de backup completo foram excluídos.
RegionId	String	Sim	cn-hangzhou	O ID da região da instância. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
Comment	String	Não	BackupTest	Parte da descrição incluída nas descrições dos arquivos de backup completo. Nota O sistema realiza uma correspondência aproximada com base no valor deste parâmetro.
BackupId	String	Não	b-kwwvr7v8t7of********	O ID do arquivo de backup completo.
OssUrl	String	Não	https://****.oss-ap-******.aliyuncs.com/backup_qp.xb	A URL para baixar o arquivo de backup completo armazenado como objeto em um bucket do Object Storage Service (OSS). Para mais informações sobre como obter a URL, consulte Obter a URL de acesso após o upload de objetos.
Tags	String	Não	key1:value1	A tag adicionada aos arquivos de backup completo.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	AD67C22F-64F3-4448-A9A8-D1606D242879	O ID da solicitação.
Records	Array of Records		Uma matriz composta pelas informações retornadas sobre os arquivos de backup completo.
Status	String	BackupSuccess	O status do arquivo de backup completo. Valores válidos: Importing: o arquivo de backup completo está sendo importado. Failed: falha na importação do arquivo de backup completo. CheckSucccess: o arquivo de backup completo passou na verificação. BackupSuccess: o arquivo de backup completo foi importado. Deleted: o arquivo de backup completo foi excluído.
CreationTime	String	1623231084000	O momento em que o sistema iniciou a importação do arquivo de backup completo. O valor é um timestamp UNIX. Unidade: milissegundos.
FinishTime	String	1623231750000	O momento em que o sistema concluiu a importação do arquivo de backup completo. O valor é um timestamp UNIX. Unidade: milissegundos.
Comment	String	BackupTest	A descrição do arquivo de backup completo.
OssFilePath	String	test/backup_qp.xb	O caminho do arquivo de backup completo armazenado como objeto em um bucket do OSS.
OssBucket	String	BackupTest	O nome do bucket do OSS onde o arquivo de backup completo está armazenado como objeto.
ModificationTime	String	1623231750000	O momento em que o sistema concluiu a importação do arquivo de backup completo. O valor é um timestamp UNIX. Unidade: milissegundos.
OssFileSize	Long	79115	O tamanho do arquivo de backup completo armazenado como objeto em um bucket do OSS. Unidade: KB.
OssFileName	String	backup_qp.xb	O nome do arquivo de backup completo armazenado como objeto em um bucket do OSS.
EngineVersion	String	5.7	A versão do mecanismo de banco de dados da instância.
BackupId	String	b-kwwvr7v8t7of********	O ID do arquivo de backup completo.
RestoreSize	String	20	O armazenamento necessário para restaurar os dados do arquivo de backup completo. Unidade: GB.
ZoneId	String	cn-hangzhou-b	O ID da zona do arquivo de backup completo.
Retention	Integer	3	O período de retenção do arquivo de backup completo. Unidade: dias.
Engine	String	mysql	O mecanismo de banco de dados da instância.
OssUrl	String	https://****.oss-ap-******.aliyuncs.com/backup_qp.xb	A URL de download do OSS para o arquivo de backup completo.
OssFileMetaData	String	{\"Accept-Ranges\":\"bytes\",\"Connection\":\"keep-alive\",\"Content-Length\":81014337,\"Content-Type\":\"application/octet-stream\",\"Date\":1623309548000,\"ETag\":\"889FE9E5FCEBFE4781829488A352863B-1\",\"Last-Modified\":1622186844000,\"Server\":\"AliyunOSS\",\"x-oss-hash-crc64ecma\":\"5793608435727323129\",\"x-oss-object-type\":\"Multipart\",\"x-oss-request-id\":\"60C1BCEC92572F37318BD499\",\"x-oss-server-time\":\"166\",\"x-oss-storage-class\":\"Standard\"}	Os metadados do arquivo de backup completo. Para mais informações, consulte Gerenciar metadados de objetos.
BinlogInfo	String	{\"binlogPosition\":\"154\",\"binlogFile\":\"0.000002\"}	As informações sobre o arquivo de log binário com dados incrementais. Este parâmetro é retornado se houver geração de dados incrementais durante o backup completo.
Reason	String	success	O motivo da falha na importação do arquivo de backup completo.

Exemplos

Exemplos de solicitações

http(s)://rds.aliyuncs.com/?Action=ListUserBackupFiles
&RegionId=cn-hangzhou
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<ListUserBackupFilesResponse>
<RequestId>9FB29A6E-C63A-4810-B71D-AFC65FD66309</RequestId>
<Records>
    <Status>BackupSuccess</Status>
    <Comment>b-c8677aw89jo7********</Comment>
    <EngineVersion>5.7</EngineVersion>
    <OssBucket>ghjtest</OssBucket>
    <BackupId>b-c8677aw89jo7********</BackupId>
    <ModificationTime>1623310685000</ModificationTime>
    <Retention>3</Retention>
    <OssFileMetaData>{"Accept-Ranges":"bytes","Connection":"keep-alive","Content-Length":81014337,"Content-MD5":"WBKyX0RbaSVjiwINUgEuTA==","Content-Type":"application/octet-stream","Date":1623310682000,"ETag":"5812B25F445B6925638B020D52012E4C","Last-Modified":1623310648000,"Server":"AliyunOSS","x-oss-hash-crc64ecma":"5793608435727323129","x-oss-object-type":"Normal","x-oss-request-id":"60C1C15AA846BB3737811ED8","x-oss-server-time":"17","x-oss-storage-class":"Standard"}</OssFileMetaData>
    <CreationTime>1623310685000</CreationTime>
    <OssUrl>https://******.oss-ap-********.aliyuncs.com/backup_qp.xb</OssUrl>
    <OssFileName>backup_qp.xb</OssFileName>
    <RestoreSize>20</RestoreSize>
    <OssFileSize>79115</OssFileSize>
    <Engine>mysql</Engine>
    <OssFilePath>test/backup_qp.xb</OssFilePath>
</Records>
</ListUserBackupFilesResponse>

Formato JSON

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

{
  "RequestId" : "9FB29A6E-C63A-4810-B71D-AFC65FD66309",
  "Records" : [ {
    "Status" : "BackupSuccess",
    "Comment" : "b-c8677aw89jo7********",
    "EngineVersion" : "5.7",
    "OssBucket" : "ghjtest",
    "BackupId" : "b-c8677aw89jo7********",
    "ModificationTime" : 1623310685000,
    "Retention" : 3,
    "OssFileMetaData" : "{\"Accept-Ranges\":\"bytes\",\"Connection\":\"keep-alive\",\"Content-Length\":81014337,\"Content-MD5\":\"WBKyX0RbaSVjiwINUgEuTA==\",\"Content-Type\":\"application/octet-stream\",\"Date\":1623310682000,\"ETag\":\"5812B25F445B6925638B020D52012E4C\",\"Last-Modified\":1623310648000,\"Server\":\"AliyunOSS\",\"x-oss-hash-crc64ecma\":\"5793608435727323129\",\"x-oss-object-type\":\"Normal\",\"x-oss-request-id\":\"60C1C15AA846BB3737811ED8\",\"x-oss-server-time\":\"17\",\"x-oss-storage-class\":\"Standard\"}",
    "CreationTime" : 1623310685000,
    "OssUrl" : "https://******.oss-ap-********.aliyuncs.com/backup_qp.xb",
    "OssFileName" : "backup_qp.xb",
    "RestoreSize" : 20,
    "OssFileSize" : 79115,
    "Engine" : "mysql",
    "OssFilePath" : "test/backup_qp.xb"
  } ]
}

Códigos de erro

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