Todos os produtos
Search

Este produto

    Data Management:DescribeRestoreTaskList

    Central de documentação

    Data Management:DescribeRestoreTaskList

    Última atualização: Jun 28, 2026

    Consulta os trabalhos de restauração no Database Backup Service (DBS).

    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

    dbs:DescribeRestoreTaskList

    get

    *BackupPlan

    acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    BackupPlanId

    string

    Não

    O ID do plano de backup.

    Nota

    Você deve especificar este parâmetro ou RestoreTaskId.

    dbs1hvb0wwwXXXXX
    RestoreTaskId

    string

    Não

    O ID do trabalho de restauração. Você pode especificar vários IDs, separados por vírgulas. Você pode chamar a operação CreateRestoreTask para obter o ID do trabalho de restauração.

    Nota

    Você deve especificar este parâmetro ou BackupPlanId. Especificar ambos os parâmetros retorna um erro.

    s102h7rf5anq
    PageSize

    integer

    Não

    O número de entradas a serem retornadas em cada página. Valores válidos: 1 a 100.

    Nota

    O valor padrão é 30.

    30
    PageNum

    integer

    Não

    O número da página. O valor deve ser um número inteiro maior ou igual a 0. Valor padrão: 0.

    1
    ClientToken

    string

    Não

    Um token gerado pelo cliente que é usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token, mas deve garantir que o token seja único entre diferentes solicitações.

    ETnLKlblzczshOTUbOCzxxxxxxx
    StartTimestamp

    integer

    Não

    O início do intervalo de tempo para consultar os trabalhos de restauração. Especifique a hora no formato de timestamp UNIX. O timestamp está no nível de milissegundos.

    1570701361528
    EndTimestamp

    integer

    Não

    O fim do intervalo de tempo para consultar os trabalhos de restauração. Especifique a hora no formato de timestamp UNIX. O timestamp está no nível de milissegundos.

    1570701361528

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Os parâmetros de resposta.

    HttpStatusCode

    integer

    O código de status HTTP.

    200
    PageNum

    integer

    O número da página.

    1
    RequestId

    string

    O ID da solicitação.

    9C397502-B4F2-4E22-AD97-C81F0049F3F3
    ErrCode

    string

    O código de erro.

    Param.NotFound
    Success

    boolean

    Indica se a solicitação foi bem-sucedida.

    true
    ErrMessage

    string

    A mensagem de erro.

    The specified parameter %s value is not valid.

    TotalPages

    integer

    O número total de páginas retornadas.

    1
    TotalElements

    integer

    O número total de trabalhos de restauração.

    1
    PageSize

    integer

    O número de entradas retornadas por página.

    30
    Items

    object

    RestoreTaskDetail

    array<object>

    Os detalhes dos trabalhos de restauração.

    object

    RestoreStatus

    string

    The status of the restore job. Valid values:

    • init: The restore job is initializing or the precheck has failed.

    • running: The restore job is running.

    • stop: The restore job has failed.

    • pause: The restore job is paused.

    • check_pass: The precheck was successful.

    running
    FullStruAfterRestoreProgress

    integer

    The progress of the post-restore full schema restoration.

    100
    CrossRoleName

    string

    The name of the RAM role used for cross-account backup.

    test123
    RestoreDir

    string

    The restore path.

    /home/test
    CrossAliyunId

    string

    The UID of the Alibaba Cloud account used for cross-account backup.

    2xxx7778xxxxxxxxxx
    RestoreObjects

    string

    The restore objects.

    [ { \"DBName\":\"test\" } ]
    BackupPlanId

    string

    The ID of the backup plan.

    dbsxxxx
    DestinationEndpointRegion

    string

    The region of the destination instance.

    cn-hangzhou
    RestoreTaskCreateTime

    integer

    The time when the restore job was created, represented as a UNIX timestamp in milliseconds.

    1554560477000
    DestinationEndpointUserName

    string

    The database account of the destination endpoint.

    testUser
    RestoreTaskFinishTime

    integer

    The time when the restore job was completed, represented as a UNIX timestamp in milliseconds.

    1554560477000
    DestinationEndpointIpPort

    string

    The connection address of the destination database instance.

    100.X.X.10:33204
    DestinationEndpointDatabaseName

    string

    The database name of the destination endpoint.

    test
    DestinationEndpointInstanceType

    string

    The type of destination instance. Valid values:

    • RDS

    • ECS

    • Express: A database connected via Express Connect, VPN Gateway, or Smart Access Gateway.

    • Agent: A database connected via a backup gateway.

    • DDS: An ApsaraDB for MongoDB instance.

    • Other: A database connected over the internet via an IP address and port.

    • dg: A self-managed database without a public IP address, connected via Database Gateway (DG).

    RDS
    DestinationEndpointOracleSID

    string

    The Oracle SID.

    Nota

    This parameter is required for Oracle databases.

    test
    FullStruforeRestoreProgress

    integer

    The progress of the pre-restore full schema restoration.

    100
    ErrMessage

    string

    The error message.

    NULL
    RestoreTaskId

    string

    The ID of the restore job.

    1iyixxxxxx
    FullDataRestoreProgress

    integer

    The progress of the full data restoration.

    100
    ContinuousRestoreProgress

    integer

    The progress of the incremental log restoration.

    100
    DestinationEndpointInstanceID

    string

    The ID of the destination instance.

    rm-bp1p8c2947XXX
    BackupSetId

    string

    The ID of the full backup set used for the restoration.

    urjlfmxxxxx
    BackupGatewayId

    integer

    The ID of the backup gateway.

    324234332
    RestoreTaskName

    string

    The name of the restore job.

    dbsr1g3xxxx_Restore_Task_1775009514575
    RestoreTime

    integer

    The point in time to which the data is restored, represented as a UNIX timestamp in milliseconds.

    1554560477000
    DestinationEndpointHost

    string

    The IP address or domain name of the destination instance.

    127.0.0.1
    DestinationEndpointPort

    string

    The port number of the destination database.

    3306
    DestinationEndpointEnableSsl

    string

    Indicates whether the connection to the destination database is SSL-encrypted.

    true
    BackupGatewayIdentifier

    string

    The unique ID of the backup gateway for the destination endpoint.

    TESTGATEWAY
    BackupSourceOssRegion

    string

    The OSS region of the backup source.

    cn-beijing
    RestoreDestinationMode

    string

    The method used to restore data to the destination endpoint.

    EXIST_INSTANCE
    PhysicalFullBackupRecoverProgress

    integer

    The progress of the full physical restore. This parameter is applicable to physical backups of MySQL and SQL Server.

    100
    PhysicalFullAndIncrementBackupRecoverProgress

    integer

    The progress of the full and incremental physical restore. This parameter is applicable to physical backups of MySQL.

    100
    PhysicalIncrementBackupRecoverProgress

    integer

    The progress of the incremental physical restore. This parameter is applicable to physical backups of SQL Server.

    100
    PhysicalDatabaseOnlineProgress

    integer

    The progress of bringing the database online after a physical restore. This parameter is applicable to physical backups of SQL Server.

    100
    PhysicalBackupRecoverProgress

    integer

    The progress of the physical restoration. This parameter is applicable to physical backups of Oracle.

    100

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "9C397502-B4F2-4E22-AD97-C81F0049F3F3",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 30,
  "Items": {
    "RestoreTaskDetail": [
      {
        "RestoreStatus": "running",
        "FullStruAfterRestoreProgress": 100,
        "CrossRoleName": "test123",
        "RestoreDir": "/home/test",
        "CrossAliyunId": "2xxx7778xxxxxxxxxx",
        "RestoreObjects": "[ { \\\"DBName\\\":\\\"test\\\" } ]",
        "BackupPlanId": "dbsxxxx",
        "DestinationEndpointRegion": "cn-hangzhou",
        "RestoreTaskCreateTime": 1554560477000,
        "DestinationEndpointUserName": "testUser",
        "RestoreTaskFinishTime": 1554560477000,
        "DestinationEndpointIpPort": "100.X.X.10:33204",
        "DestinationEndpointDatabaseName": "test",
        "DestinationEndpointInstanceType": "RDS",
        "DestinationEndpointOracleSID": "test",
        "FullStruforeRestoreProgress": 100,
        "ErrMessage": "NULL",
        "RestoreTaskId": "1iyixxxxxx",
        "FullDataRestoreProgress": 100,
        "ContinuousRestoreProgress": 100,
        "DestinationEndpointInstanceID": "rm-bp1p8c2947XXX",
        "BackupSetId": "urjlfmxxxxx",
        "BackupGatewayId": 324234332,
        "RestoreTaskName": "dbsr1g3xxxx_Restore_Task_1775009514575",
        "RestoreTime": 1554560477000,
        "DestinationEndpointHost": "127.0.0.1",
        "DestinationEndpointPort": "3306",
        "DestinationEndpointEnableSsl": "true",
        "BackupGatewayIdentifier": "TESTGATEWAY",
        "BackupSourceOssRegion": "cn-beijing",
        "RestoreDestinationMode": "EXIST_INSTANCE",
        "PhysicalFullBackupRecoverProgress": 100,
        "PhysicalFullAndIncrementBackupRecoverProgress": 100,
        "PhysicalIncrementBackupRecoverProgress": 100,
        "PhysicalDatabaseOnlineProgress": 100,
        "PhysicalBackupRecoverProgress": 100
      }
    ]
  }
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    403 Request.Forbidden Have no Permissions

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.