Tous les produits
Search

Ce produit

    :DescribeBackupPlanList

    Centre de documentation

    :DescribeBackupPlanList

    Dernière mise à jour :Aug 06, 2026

    Consulte un plan de sauvegarde DBS.

    Description de l'opération

    Assurez-vous qu'Object Storage Service (OSS) est activé avant d'utiliser cette opération. Pour plus d'informations, consultez Object Storage Service.

    Testez maintenant

    Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

    Test

    Autorisation RAM

    Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

    • Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.

    • API : l'API que vous pouvez appeler pour exécuter l'action.

    • Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.

    • Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.

      • Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.

      • Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.

    • Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.

    • Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

    dbs:DescribeBackupPlanList

    get

    *BackupPlan

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

    		 Aucune Aucune

    Paramètres de requête

    Paramètre

    Type

    Requis

    Description

    Exemple
    BackupPlanId

    string

    Non

    L'identifiant du plan de sauvegarde. Vous pouvez spécifier plusieurs identifiants de plan de sauvegarde, séparés par des virgules.

    dbstooi01exXXXX
    Region

    string

    Non

    L'identifiant de la région où se trouve le plan de sauvegarde. Vous pouvez appeler l'opération DescribeRegions pour interroger la liste des régions prises en charge.

    cn-hangzhou
    PageSize

    integer

    Non

    Le nombre d'entrées à renvoyer sur chaque page. Valeurs valides : 1 à 100.

    30
    PageNum

    integer

    Non

    Le numéro de page à renvoyer. La valeur doit être un entier supérieur ou égal à 0. La valeur par défaut est 0.

    1
    BackupPlanName

    string

    Non

    Le nom du plan de sauvegarde.

    test123
    BackupPlanStatus

    string

    Non

    L'état du plan de sauvegarde. Valeurs valides :

    wait
    ClientToken

    string

    Non

    Un jeton généré par le client qui garantit l'idempotence de la requête.

    ASDASDASDSADASFCZXVZ
    ResourceGroupId

    string

    Non

    L'identifiant du groupe de ressources.

    rg-aekzecovzti****
    ShowStorageStrategyInfo

    boolean

    Non

    Indique si les informations sur la stratégie de stockage doivent être renvoyées. Valeur par défaut : false.

    false
    ShowBackupStrategyInfo

    boolean

    Non

    Indique si les informations sur la stratégie de sauvegarde doivent être renvoyées. Valeur par défaut : false.

    false
    ShowRecoverTimeRange

    boolean

    Non

    Indique si la plage de temps de récupération doit être renvoyée. Valeur par défaut : false.

    false
    BackupMethod

    string

    Non

    La méthode de sauvegarde.

    logical

    Éléments de réponse

    Élément

    Type

    Description

    Exemple

    object

    Les paramètres de réponse.

    HttpStatusCode

    integer

    Le code d'état HTTP.

    200
    PageNum

    integer

    Le numéro de page.

    1
    RequestId

    string

    L'identifiant de la requête.

    4F1888AC-1138-4995-B9FE-D2734F61C058
    ErrCode

    string

    Le code d'erreur.

    InvalidParameterValid
    Success

    boolean

    Indique si la requête a réussi.

    true
    ErrMessage

    string

    Le message d'erreur.

    La valeur spécifiée du paramètre %s n'est pas valide
    TotalPages

    integer

    Le nombre total de pages.

    4
    TotalElements

    integer

    Le nombre total de plans de sauvegarde.

    100
    PageSize

    integer

    Le nombre d'entrées par page.

    30
    Items

    object

    Les éléments de réponse.

    BackupPlanDetail

    array<object>

    Une liste des plans de sauvegarde.

    object

    Les détails d'un plan de sauvegarde.

    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.

    Remarque

    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

    Exemples

    JSON format

    {
  "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
      }
    ]
  }
}

    Codes d'erreur

    Code de statut HTTP

    Code d'erreur

    Message d'erreur

    Description
    403 Request.Forbidden Have no Permissions

    Consultez Codes d'erreur pour la liste complète.

    Notes de version

    Consultez Notes de version pour la liste complète.