Todos os produtos
Search

Este produto

    Data Management:DescribeBackupPlanList

    Central de documentação

    Data Management:DescribeBackupPlanList

    Última atualização: Jun 28, 2026

    Consulta um plano de backup do DBS.

    Descrição da operação

    Certifique-se de que o Object Storage Service (OSS) esteja ativado antes de usar esta operação. Para obter mais informações, consulte Object Storage Service.

    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:DescribeBackupPlanList

    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. Você pode especificar vários IDs de planos de backup, separados por vírgulas.

    dbstooi01exXXXX
    Region

    string

    Não

    O ID da região onde o plano de backup está localizado. Você pode chamar a operação DescribeRegions para consultar a lista de regiões suportadas.

    cn-hangzhou
    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 a ser retornada. O valor deve ser um número inteiro maior ou igual a 0. O valor padrão é 0.

    1
    BackupPlanName

    string

    Não

    O nome do plano de backup.

    test123
    BackupPlanStatus

    string

    Não

    O status do plano de backup. Valores válidos:

    • wait: O plano de backup não está configurado.

    • init: O plano de backup não foi iniciado porque uma pré-verificação falhou.

    • running: O plano de backup está em execução.

    • stop: O plano de backup falhou.

    • pause: O plano de backup está pausado.

    • locked: O plano de backup está bloqueado.

    • check_pass: A pré-verificação foi aprovada.

    wait
    ClientToken

    string

    Não

    Um token gerado pelo cliente que garante a idempotência da solicitação.

    ASDASDASDSADASFCZXVZ
    ResourceGroupId

    string

    Não

    O ID do grupo de recursos.

    rg-aekzecovzti****
    ShowStorageStrategyInfo

    boolean

    Não

    Especifica se devem ser retornadas informações sobre a estratégia de armazenamento. Valor padrão: false.

    false
    ShowBackupStrategyInfo

    boolean

    Não

    Especifica se devem ser retornadas informações sobre a estratégia de backup. Valor padrão: false.

    false
    ShowRecoverTimeRange

    boolean

    Não

    Especifica se o intervalo de tempo de recuperação deve ser retornado. Valor padrão: false.

    false
    BackupMethod

    string

    Não

    O método de backup.

    logical

    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.

    4F1888AC-1138-4995-B9FE-D2734F61C058
    ErrCode

    string

    O código de erro.

    InvalidParameterValid
    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.

    4
    TotalElements

    integer

    O número total de planos de backup.

    100
    PageSize

    integer

    O número de entradas por página.

    30
    Items

    object

    Os itens de resposta.

    BackupPlanDetail

    array<object>

    Uma lista dos planos de backup.

    object

    Os detalhes de um plano de backup.

    CrossRoleName

    string

    The name of the RAM role for cross-account backups.

    test123
    SourceEndpointInstanceType

    string

    The type of the source endpoint. Valid values:

    • rds

    • ecs

    • express: A database connected over an Express Connect circuit, a VPN Gateway, or a Smart Access Gateway instance.

    • agent: A database connected by a backup gateway.

    • dds: An ApsaraDB for MongoDB instance.

    • other: A database connected by an IP address and a port number.

    rds
    BackupSetDownloadDir

    string

    The server directory for downloaded backup sets.

    */test/test123
    SourceEndpointIpPort

    string

    The endpoint of the source database.

    100.*.*.10:33204
    CrossAliyunId

    string

    The user ID for cross-account backups.

    2xxx7778xxxxxxxxxx
    DuplicationArchivePeriod

    integer

    The number of days after which a duplicate backup is converted to archive storage.

    365
    BackupPlanId

    string

    The ID of the backup plan.

    dbstooi01eXXXX
    EndTimestampForRestore

    integer

    The end of the restorable time period. This value is a UNIX timestamp in milliseconds.

    1554560477000
    BackupPlanStatus

    string

    The status of the backup plan. Valid values:

    • wait: The plan is not configured.

    • init: The plan has not started because a precheck failed.

    • running: The plan is running.

    • stop: The plan failed.

    • pause: The plan is paused.

    • locked: The plan is locked.

    • check_pass: The precheck passed.

    init
    BackupSetDownloadFullDataFormat

    string

    The data format for downloading full backup sets. Valid values:

    • Native

    • SQL

    • CSV

    • JSON

    SQL
    BackupRetentionPeriod

    integer

    The backup retention period, in days. Valid values: 0 to 1825.

    365
    OSSBucketRegion

    string

    The region of the OSS bucket.

    cn-hangzhou
    SourceEndpointOracleSID

    string

    The Oracle system ID (SID).

    test
    BackupStorageType

    string

    The storage type of the backup data. Valid values:

    • Empty string (default): The backup data is stored in your OSS bucket.

    • system: The backup data is stored in the built-in OSS bucket of DBS.

    system
    BackupMethod

    string

    The backup method. Valid values:

    • logical: Logical backup

    • physical: Physical backup

    • duplication: Duplicate backup

    logical
    SourceEndpointRegion

    string

    The region of the source database.

    cn-hangzhou
    BackupPeriod

    string

    The day of the week for full backups. Valid values:

    • Monday

    • Tuesday

    • Wednesday

    • Thursday

    • Friday

    • Saturday

    • Sunday

    Monday
    SourceEndpointDatabaseName

    string

    The name of the source database.

    test
    BackupSetDownloadGatewayId

    integer

    The ID of the backup gateway used to download the backup set.

    123123
    BackupPlanCreateTime

    integer

    The creation time of the backup plan. This value is a UNIX timestamp in milliseconds.

    1582527713000
    InstanceClass

    string

    The instance class. Valid values:

    • micro: Entry-level

    • small: Low-spec

    • medium: Medium-spec

    • large: High-spec

    • xlarge: High-spec (no traffic limit)

    micro
    BackupSetDownloadTargetType

    string

    The target type for backup set downloads.

    Nota

    The only valid value is agent, which indicates that a backup gateway is installed.

    agent
    DuplicationInfrequentAccessPeriod

    integer

    The number of days after which backup data is converted to Infrequent Access storage.

    180
    BackupStartTime

    string

    The start time for full backups. The time is in the HH:mm format.

    14:22
    ErrMessage

    string

    The error message returned by the precheck task.

    can not connect to oracle instance orcl with user dbs
    BackupObjects

    string

    The backup objects, specified in a JSON string.

    [ { \"DBName\":\"待备份库名\", \"SchemaName\":\"待备份 Schema 名\", \"TableIncludes\":[{ \"TableName\":\"待备份表表名\" }], \"TableExcludes\":[{ \"TableName\":\"待备份库名不需要备份表的表名\" }] } ]
    BeginTimestampForRestore

    integer

    The beginning of the restorable time period. This value is a UNIX timestamp in milliseconds.

    1554560477000
    SourceEndpointInstanceID

    string

    The ID of the source database instance.

    test
    OpenBackupSetAutoDownload

    boolean

    Indicates whether automatic download of backup sets is enabled.

    true
    BackupPlanName

    string

    The name of the backup plan.

    dbstooi01e****
    OSSBucketName

    string

    The name of the OSS bucket.

    dbs-backup-1857XXXXX489
    BackupGatewayId

    integer

    The ID of the backup gateway.

    827362187368736
    SourceEndpointUserName

    string

    The username of the source database account.

    test
    BackupSetDownloadIncrementDataFormat

    string

    The data format for downloading incremental backup sets. Valid values:

    • Native

    • SQL

    • CSV

    • JSON

    SQL
    EnableBackupLog

    boolean

    Indicates whether log backup is enabled. Valid values:

    • true: Enabled

    • false: Disabled

    true
    ResourceGroupId

    string

    The ID of the resource group.

    rg-aekzecovzti****
    DatabaseType

    string

    The type of the source database.

    MySQL
    BackupPlanRegion

    string

    The region of the backup plan.

    cn-beijing
    SourceEndpointHost

    string

    The source endpoint address.

    127.0.0.1
    InstanceChargeType

    string

    The billing method of the backup plan instance.

    PREPAY
    InstanceExpiredTimestamp

    integer

    The expiration time of the backup plan instance. This value is a UNIX timestamp in milliseconds.

    1764051253000
    SourceEndpointEnableSsl

    string

    Indicates whether SSL encryption is enabled for the source database.

    true
    StorageEncryptMethod

    string

    The encryption method for the backup storage.

    encrypted
    SourceEndpointPort

    string

    The port number of the source database.

    3306
    IncrementBackupRetentionPeriod

    string

    The retention period for incremental backups, in days.

    365
    IncrementDuplicationInfrequentAccessPeriod

    string

    The number of days after which incremental backups are converted to Infrequent Access storage.

    365
    IncrementDuplicationArchivePeriod

    string

    The number of days after which incremental backups are converted to archive storage.

    365
    LogBackupRetentionPeriod

    string

    The retention period for log backups, in days.

    365
    LogDuplicationInfrequentAccessPeriod

    string

    The number of days after which log backups are converted to Infrequent Access storage.

    365
    LogDuplicationArchivePeriod

    string

    The number of days after which log backups are converted to archive storage.

    365
    BackupGatewayIdentifier

    string

    The unique ID of the backup gateway.

    TESTGATEWAY
    EnableMysqlPhysicalBackupBinLog

    boolean

    Indicates whether log backup is enabled for MySQL physical backups.

    false

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "ErrCode": "InvalidParameterValid",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "TotalPages": 4,
  "TotalElements": 100,
  "PageSize": 30,
  "Items": {
    "BackupPlanDetail": [
      {
        "CrossRoleName": "test123",
        "SourceEndpointInstanceType": "rds",
        "BackupSetDownloadDir": "*/test/test123",
        "SourceEndpointIpPort": "100.*.*.10:33204",
        "CrossAliyunId": "2xxx7778xxxxxxxxxx",
        "DuplicationArchivePeriod": 365,
        "BackupPlanId": "dbstooi01eXXXX",
        "EndTimestampForRestore": 1554560477000,
        "BackupPlanStatus": "init",
        "BackupSetDownloadFullDataFormat": "SQL",
        "BackupRetentionPeriod": 365,
        "OSSBucketRegion": "cn-hangzhou",
        "SourceEndpointOracleSID": "test",
        "BackupStorageType": "system",
        "BackupMethod": "logical",
        "SourceEndpointRegion": "cn-hangzhou",
        "BackupPeriod": "Monday",
        "SourceEndpointDatabaseName": "test",
        "BackupSetDownloadGatewayId": 123123,
        "BackupPlanCreateTime": 1582527713000,
        "InstanceClass": "micro",
        "BackupSetDownloadTargetType": "agent",
        "DuplicationInfrequentAccessPeriod": 180,
        "BackupStartTime": "14:22",
        "ErrMessage": "  can not connect to oracle instance orcl with user dbs",
        "BackupObjects": "[     {         \\\"DBName\\\":\\\"待备份库名\\\",         \\\"SchemaName\\\":\\\"待备份 Schema 名\\\",         \\\"TableIncludes\\\":[{             \\\"TableName\\\":\\\"待备份表表名\\\"         }],         \\\"TableExcludes\\\":[{             \\\"TableName\\\":\\\"待备份库名不需要备份表的表名\\\"         }]     } ]",
        "BeginTimestampForRestore": 1554560477000,
        "SourceEndpointInstanceID": "test",
        "OpenBackupSetAutoDownload": true,
        "BackupPlanName": "dbstooi01e****",
        "OSSBucketName": "dbs-backup-1857XXXXX489",
        "BackupGatewayId": 827362187368736,
        "SourceEndpointUserName": "test",
        "BackupSetDownloadIncrementDataFormat": "SQL",
        "EnableBackupLog": true,
        "ResourceGroupId": "rg-aekzecovzti****",
        "DatabaseType": "MySQL",
        "BackupPlanRegion": "cn-beijing",
        "SourceEndpointHost": "127.0.0.1",
        "InstanceChargeType": "PREPAY",
        "InstanceExpiredTimestamp": 1764051253000,
        "SourceEndpointEnableSsl": "true",
        "StorageEncryptMethod": "encrypted",
        "SourceEndpointPort": "3306",
        "IncrementBackupRetentionPeriod": "365",
        "IncrementDuplicationInfrequentAccessPeriod": "365",
        "IncrementDuplicationArchivePeriod": "365",
        "LogBackupRetentionPeriod": "365",
        "LogDuplicationInfrequentAccessPeriod": "365",
        "LogDuplicationArchivePeriod": "365",
        "BackupGatewayIdentifier": "TESTGATEWAY",
        "EnableMysqlPhysicalBackupBinLog": false
      }
    ]
  }
}

    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.