CreateBackupJob - - Centre de documentation Alibaba Cloud

Crée une tâche de sauvegarde.

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

Aucune autorisation n'est requise pour cette opération. En cas de problème, contactez le support technique.

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
JobName	string	Non	Le nom de la tâche de sauvegarde.	k8s-backup-infra-20220131150046-hbr
SourceType	string	Oui	Le type de source de données. Valeurs valides : UDM_ECS : instance Elastic Compute Service (ECS) Valeurs valides : UDM_ECS :	CONTAINER
Retention	integer	Non	La période de rétention des données de sauvegarde. Unité : jours.	15
InstanceId	string	Non	Ce paramètre est requis uniquement si vous définissez le paramètre SourceType sur UDM_ECS. Ce paramètre spécifie l'identifiant de l'instance ECS.	i-bp1xxxxxxxxxxxxxxysm
Detail	object	Non	Ce paramètre est requis uniquement si vous définissez le paramètre SourceType sur UDM_ECS. La valeur est une chaîne JSON. Valeurs valides : doCopy : indique si la réplication à distance doit être activée. destinationRegionId : la région de destination pour la réplication à distance. destinationRetention : la période de rétention du point de sauvegarde pour la réplication à distance. diskIdList : les identifiants des disques à sauvegarder. Si ce paramètre est laissé vide, tous les disques sont sauvegardés. snapshotGroup : indique si un groupe cohérent au niveau des instantanés doit être utilisé. Ce paramètre n'est valide que si tous les disques de l'instance ECS sont des disques SSD d'entreprise (ESSD). appConsistent : indique si la fonction de sauvegarde cohérente au niveau de l'application doit être utilisée. Ce paramètre doit être utilisé avec les paramètres preScriptPath et postScriptPath. preScriptPath : le chemin d'accès aux scripts de pré-gel. postScriptPath : le chemin d'accès aux scripts de post-dégel. enableWriters : ce paramètre est requis uniquement si vous définissez le paramètre AppConsistent sur true. Ce paramètre indique si des instantanés cohérents au niveau de l'application doivent être créés. true : crée des instantanés cohérents au niveau de l'application. false : crée des instantanés cohérents au niveau du système de fichiers. enableFsFreeze : ce paramètre est requis uniquement si vous définissez le paramètre AppConsistent sur true. Ce paramètre indique si Linux fsfreeze doit être activé pour mettre les systèmes de fichiers en état de lecture seule avant la création d'instantanés cohérents au niveau de l'application. Valeur par défaut : true. timeoutSeconds : ce paramètre est requis uniquement si vous définissez le paramètre AppConsistent sur true. Ce paramètre spécifie le délai d'expiration du gel des E/S. Valeur par défaut : 30. Unité : secondes.	{ "doCopy": false, "destinationRegionId": "", "destinationRetention": null, "diskIdList": [], "snapshotGroup": false, "appConsistent": false, "enableWriters": true, "preScriptPath": "", "postScriptPath": "", "enableFsFreeze": true, "timeoutInSeconds": 60 }
BackupType	string	Non	Le type de sauvegarde. Ce paramètre est requis uniquement si vous définissez le paramètre SourceType sur UDM_ECS. COMPLETE : sauvegarde complète Valeurs valides : COMPLETE :	INCREMENTAL
VaultId	string	Non	L'identifiant du coffre de sauvegarde. Ce paramètre n'est pas requis si vous définissez le paramètre SourceType sur UDM_ECS.	v-000xxxxxxxxxxxxxxy1v
SpeedLimit	string	Non	Ce paramètre ne prend pas effet si vous définissez le paramètre SourceType sur UDM_ECS. Ce paramètre spécifie les règles de limitation. Format : `{start}\|{end}\|{bandwidth}`. Séparez plusieurs règles de limitation par des barres verticales (\|). Une plage horaire spécifiée ne peut pas chevaucher une autre plage horaire. start : l'heure de début. end : l'heure de fin. bandwidth : la bande passante. Unité : Ko/s.	0:24:NaN
Options	string	Non	Vous n'avez pas besoin de spécifier ce paramètre.	{"UseVSS":false}
Include	string	Non	Ce paramètre ne prend pas effet si vous définissez le paramètre SourceType sur UDM_ECS. Ce paramètre spécifie les chemins d'accès aux fichiers sauvegardés. La valeur peut comporter jusqu'à 255 caractères.	["/home/alice/.pdf", "/home/bob/.txt"]
Exclude	string	Non	Ce paramètre ne prend pas effet si vous définissez le paramètre SourceType sur UDM_ECS. Ce paramètre spécifie les chemins d'accès aux fichiers exclus de la tâche de sauvegarde. La valeur peut comporter jusqu'à 255 caractères.	["/var", "/proc"]
ClusterId	string	Non	Vous n'avez pas besoin de spécifier ce paramètre.	cl-00068btz******oku
ContainerResources	string	Non	Vous n'avez pas besoin de spécifier ce paramètre.	[{\"resourceType\":\"PV\",\"backupMethod\":\"FILE\",\"resourceId\":\"674dac6d-74cd-47e9-a675-09e2f10d2c45\",\"resourceInfo\":\"{\\\"pv_name\\\":\\\"nas-650dac6d-74cd-47e9-a675-09e2f10d2c45\\\",\\\"pv_size\\\":\\\"8Gi\\\",\\\"storage_class\\\":\\\"alibabacloud-cnfs-nas\\\",\\\"pvc_name\\\":\\\"data-postgresql-default-0\\\",\\\"namespace\\\":\\\"database\\\"}\",\"host\":\"cn-huhehaote.192.168.13.133\",\"hostPrefix\":\"6f5e758e-8d35-4584-b9ce-8333adfc7547/volumes/kubernetes.io~csi/nas-670dac6d-74cd-47e9-a675-09e2f10d2c45/mount\",\"pvPath\":\"/\"}]
InitiatedByAck	boolean	Non	false ou laissé vide.	false
ContainerClusterId	string	Non	Vous n'avez pas besoin de spécifier ce paramètre.	cc-000xxxxxxxxxxxxxxi00
CrossAccountType	string	Non	Indique si les données sont sauvegardées au sein du même compte Alibaba Cloud ou entre plusieurs comptes Alibaba Cloud. Valeurs valides : SELF_ACCOUNT : les données sont sauvegardées au sein du même compte Alibaba Cloud. CROSS_ACCOUNT : les données sont sauvegardées entre plusieurs comptes Alibaba Cloud.	SELF_ACCOUNT
CrossAccountUserId	integer	Non	L'identifiant du compte Alibaba Cloud source qui autorise le compte Alibaba Cloud actuel à sauvegarder des données entre plusieurs comptes Alibaba Cloud.	158975xxxxxx4625
CrossAccountRoleName	string	Non	Le nom du rôle RAM créé au sein du compte Alibaba Cloud source et attribué au compte Alibaba Cloud actuel pour autoriser ce dernier à sauvegarder des données entre plusieurs comptes Alibaba Cloud.	BackupRole

Éléments de réponse

Élément	Type	Description	Exemple
	object
Code	string	Le code d'état HTTP. Le code d'état 200 indique que la requête a réussi.	200
Message	string	Le message renvoyé. Si la requête a réussi, « successful » est renvoyé. Si la requête a échoué, un message d'erreur est renvoyé.	successful
RequestId	string	L'identifiant de la requête.	25F49E7B-7E39-542E-83AD-62E6E7F73786
Success	boolean	Indique si la requête a réussi. Valeurs valides : true false	true
JobId	string	L'identifiant de la tâche de sauvegarde.	job-000csy09q50a2jdcbwbo

Exemples

JSON format

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "25F49E7B-7E39-542E-83AD-62E6E7F73786",
  "Success": true,
  "JobId": "job-000csy09q50a2jdcbwbo"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.