Tous les produits
Search

Ce produit

    :CreateBackupPlan

    Centre de documentation

    :CreateBackupPlan

    Dernière mise à jour :Aug 06, 2026

    Crée un plan de sauvegarde.

    Description de l'opération

    Important

    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.

    hbr:CreateBackupPlan

    create

    *All Resource

    *

    		 Aucune Aucune

    Paramètres de requête

    Paramètre

    Type

    Requis

    Description

    Exemple
    SourceType

    string

    Oui

    Le type de la source de données. Valeurs valides :

    ECS_FILE
    PlanName

    string

    Non

    Le nom du plan de sauvegarde. Le nom doit comporter de 1 à 64 caractères. Le nom du plan de sauvegarde doit être unique pour chaque type de source de données au sein d'un même coffre.

    planname
    BackupType

    string

    Non

    Le type de sauvegarde. Définissez la valeur sur COMPLETE, ce qui indique une sauvegarde complète.

    COMPLETE
    VaultId

    string

    Non

    L'identifiant du coffre.

    v-0006******q
    Schedule

    string

    Non

    La stratégie de sauvegarde. Format : I|{startTime}|{interval}. Cela indique qu'une tâche de sauvegarde est exécutée à chaque {interval} à partir de {startTime}. Les tâches de sauvegarde pour les périodes passées ne sont pas compensées. Si la tâche de sauvegarde précédente n'est pas terminée, la tâche de sauvegarde suivante n'est pas déclenchée. Exemple : I|1631685600|P1D indique qu'une sauvegarde est effectuée une fois par jour à partir du 2021-09-15 14:00:00.

    I|1602673264|P1D
    Retention

    integer

    Non

    La période de rétention des données de sauvegarde. Valeur minimale : 1. Unité : jours.

    7
    ClusterId

    string

    Non

    L'identifiant du groupe de clients qui exécute le plan de synchronisation de données. Ce paramètre est requis uniquement pour la synchronisation de données.

    cl-***************
    FileSystemId

    string

    Non

    Ce paramètre est requis uniquement lorsque SourceType est défini sur NAS. L'identifiant du système de fichiers.

    005494
    CreateTime

    integer

    Non

    Ce paramètre est requis uniquement lorsque SourceType est défini sur NAS. L'heure de création du système de fichiers. La valeur est un horodatage UNIX. Unité : secondes.

    1607436917
    Bucket

    string

    Non

    Ce paramètre est requis uniquement lorsque SourceType est défini sur OSS. Le nom du compartiment OSS.

    hbr-backup-oss
    Prefix

    string

    Non

    Ce paramètre est requis uniquement lorsque SourceType est défini sur OSS. Le préfixe de sauvegarde. S'il est spécifié, seuls les objets correspondant au préfixe sont sauvegardés.

    oss-prefix
    InstanceId

    string

    Non

    Ce paramètre est requis uniquement lorsque SourceType est défini sur ECS_FILE. L'identifiant de l'instance ECS.

    i-m5e*****6q
    Detail

    object

    Non

    Les détails de la sauvegarde par copie complète. La valeur est une chaîne JSON.

    {\"EnableFsFreeze\":true,\"appConsistent\":false,\"postScriptPath\":\"\",\"preScriptPath\":\"\",\"snapshotGroup\":true,\"timeoutInSeconds\":60}
    UdmRegionId

    string

    Non

    La région où réside l'instance ECS pour la sauvegarde par copie complète.

    cn-shanghai
    SpeedLimit

    string

    Non

    Ce paramètre est requis uniquement lorsque SourceType est défini sur ECS_FILE. Le contrôle du trafic de sauvegarde. Format : {start}:{end}:{bandwidth}. Séparez plusieurs configurations de contrôle de trafic par des barres verticales (|). Les plages horaires des configurations ne peuvent pas se chevaucher.

    0:24:5120
    Include

    string

    Non

    Ce paramètre est requis uniquement lorsque SourceType est défini sur ECS_FILE. Le chemin à inclure dans la sauvegarde. Tous les fichiers de ce chemin sont sauvegardés. La valeur peut comporter jusqu'à 255 caractères.

    ["/home/alice/*.pdf", "/home/bob/*.txt"]
    Exclude

    string

    Non

    Ce paramètre est requis uniquement lorsque SourceType est défini sur ECS_FILE. Le chemin à exclure de la sauvegarde. Aucun fichier de ce chemin n'est sauvegardé. La valeur peut comporter jusqu'à 255 caractères.

    ["/var", "/proc"]
    Options

    string

    Non

    Ce paramètre est requis uniquement lorsque SourceType est défini sur ECS_FILE. Indique s'il faut utiliser le service Volume Shadow Copy (VSS) de Windows pour définir le chemin source.

    {"UseVSS":false}
    DataSourceId

    string

    Non

    L'identifiant de la source de données source. Ce paramètre est requis uniquement pour la synchronisation de données.

    ds-****************
    Path

    array

    Non

    Les chemins sources.

    string

    Non

    Le chemin source. La valeur peut comporter jusqu'à 65536 caractères.

    ["/home"]
    Rule

    array<object>

    Non

    Les règles du plan de sauvegarde.

    object

    Non

    Les règles du plan de sauvegarde.

    DestinationRetention

    integer

    Non

    La période de rétention de la sauvegarde par géo-redondance. Unité : jours.

    7
    Schedule

    string

    Non

    La stratégie de sauvegarde. Format : I|{startTime}|{interval}. Cela indique qu'une tâche de sauvegarde est exécutée à chaque {interval} à partir de {startTime}. Les tâches de sauvegarde pour les périodes passées ne sont pas exécutées. Si la tâche de sauvegarde précédente n'est pas terminée, la tâche de sauvegarde suivante n'est pas déclenchée. Exemple : I|1631685600|P1D indique qu'une sauvegarde est effectuée une fois par jour à partir du 2021-09-15 14:00:00.

    I|1602673264|P1D
    Retention

    integer

    Non

    La période de rétention de la sauvegarde.

    7
    Disabled

    boolean

    Non

    Indique si la règle est désactivée.

    false
    DoCopy

    boolean

    Non

    Indique s'il faut activer la réplication interrégionale.

    false
    DestinationRegionId

    string

    Non

    L'identifiant de la région de destination pour la réplication interrégionale.

    cn-hangzhou
    RuleName

    string

    Non

    Le nom de la règle.

    rule-test-name
    BackupType

    string

    Non

    Le type de sauvegarde.

    COMPLETE
    InstanceName

    string

    Non

    Le nom de l'instance Tablestore.

    instancename
    OtsDetail OtsDetail

    Non

    Les détails de l'instance Tablestore.

    CrossAccountType

    string

    Non

    Le type de sauvegarde intercomptes. Valeurs valides :

    Valeurs valides :

    • SELF_ACCOUNT :

      SELF_ACCOUNT.

    • CROSS_ACCOUNT :

      CROSS_ACCOUNT.

    CROSS_ACCOUNT
    CrossAccountUserId

    integer

    Non

    L'identifiant du compte source pour la sauvegarde intercomptes.

    15897534xxxx4625
    CrossAccountRoleName

    string

    Non

    Le nom du rôle RAM créé dans le compte source pour la sauvegarde intercomptes.

    BackupRole
    KeepLatestSnapshots

    integer

    Non

    Indique s'il faut conserver au moins une version de sauvegarde. Valeurs valides :

    Valeurs valides :

    • 0 :

      Ne conserve pas.

    • 1 :

      Conserve.

    1
    DestSourceType

    string

    Non

    Le type de la source de données de destination. Ce paramètre est requis uniquement pour la synchronisation de données.

    OSS
    DestDataSourceId

    string

    Non

    L'identifiant de la source de données de destination. Ce paramètre est requis uniquement pour la synchronisation de données.

    ds-*********************

    DestDataSourceDetail

    object

    Non

    Les détails de la source de données de destination. Ce paramètre est requis uniquement pour la synchronisation de données.

    {\"prefix\":\"/\"}
    ChangeListPath

    string

    Non

    La configuration de la liste de synchronisation incrémentielle des fichiers. Ce paramètre est requis uniquement pour la synchronisation de données.

    {"dataSourceId": "ds-123456789", "path": "/changelist"}
    Disabled

    boolean

    Non

    Indique si le plan est désactivé par défaut.

    true
    Edition

    string

    Non

    Le type d'édition. Valeurs valides : BASIC et STANDARD. Valeur par défaut : STANDARD.

    STANDARD

    Éléments de réponse

    Élément

    Type

    Description

    Exemple

    object

    Les paramètres de réponse.

    Code

    string

    Le code de réponse. La valeur 200 indique un succès.

    200
    Message

    string

    Le message renvoyé. La valeur "successful" est renvoyée pour une réponse de succès. Un message d'erreur est renvoyé pour une réponse d'échec.

    successful
    RequestId

    string

    L'identifiant de la requête.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    PlanId

    string

    L'identifiant du plan de sauvegarde.

    plan-*********************
    Success

    boolean

    Indique si la requête a réussi.

    true

    Exemples

    JSON format

    {
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PlanId": "plan-*********************",
  "Success": true
}

    Codes d'erreur

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

    Notes de version

    Consultez Notes de version pour la liste complète.