CreateAndStartBackupPlan - - Centre de documentation Alibaba Cloud

Crée, configure et démarre un plan de sauvegarde.

Description de l'opération

Avant d'appeler cette opération, assurez-vous de comprendre les méthodes de facturation et tarifs de Database Backup (DBS).

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

create

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
BackupPlanId	string	Non	L'identifiant du plan de sauvegarde.	dbstooi0*******
Region	string	Non	La région où DBS est disponible. Pour consulter les régions disponibles, appelez l'opération DescribeRegions.	cn-hangzhou
InstanceClass	string	Oui	La spécification du plan de sauvegarde. Valeurs valides :	micro
DatabaseType	string	Oui	Le type de base de données. Valeurs valides :	MySQL
BackupMethod	string	Oui	La méthode de sauvegarde. Valeurs valides :	logical
Period	string	Non	Le cycle de facturation de l'instance par abonnement. Valeurs valides :	Year
UsedTime	integer	Non	La durée de l'abonnement. Valeurs valides :	1
PayType	string	Non	La méthode de paiement. Valeur valide :	prepay
DatabaseRegion	string	Non	La région où se trouve la base de données.	cn-hangzhou
StorageRegion	string	Non	La région de stockage.	cn-hangzhou
InstanceType	string	Non	Le type d'instance de base de données. Valeurs valides :	RDS
StorageType	string	Non	Ce paramètre n'est pas encore disponible.	Aucun
FromApp	string	Non	La source de la requête. La valeur par défaut est OpenApi. Vous n'avez pas besoin de définir ce paramètre.	OpenApi
SourceEndpointInstanceType	string	Oui	L'emplacement de la base de données. Valeurs valides :	RDS
SourceEndpointRegion	string	Non	La région où se trouve la base de données.	cn-hangzhou
SourceEndpointInstanceID	string	Non	L'identifiant de l'instance de base de données.	rm-uf6wjk5xxxxxxxxxx
SourceEndpointIP	string	Non	Le point de terminaison de la base de données.	rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com
SourceEndpointPort	integer	Non	Le port de la base de données.	3306
SourceEndpointDatabaseName	string	Non	Le nom de la base de données.	testRDS
SourceEndpointUserName	string	Non	Le compte de la base de données.	testRDS
SourceEndpointPassword	string	Non	Le mot de passe du compte de la base de données.	testPassword
BackupGatewayId	integer	Non	L'identifiant de la passerelle de sauvegarde.	23313123312
OSSBucketName	string	Non	Le nom du compartiment Object Storage Service (OSS).	TestOssBucket
BackupObjects	string	Non	Les objets de sauvegarde.	[ { "DBName":"Nom de la base de données à sauvegarder", "SchemaName":"Nom du schéma à sauvegarder", "TableIncludes":[{ "TableName":"Nom de la table à sauvegarder" }], "TableExcludes":[{ "TableName":"Nom de la table à exclure de la sauvegarde" }] } ]
BackupPeriod	string	Non	Le cycle de sauvegarde complète. Valeurs valides :	Monday
BackupStartTime	string	Non	L'heure de début de la sauvegarde complète. L'heure est au format HH:mm et en UTC.	14:22
EnableBackupLog	boolean	Non	Indique si la sauvegarde incrémentielle des journaux doit être activée. Valeurs valides :	true
BackupLogIntervalSeconds	integer	Non	L'intervalle pour les sauvegardes incrémentielles, en secondes.	1000
BackupRetentionPeriod	integer	Non	La période de rétention des données de sauvegarde, en jours. Valeurs valides : 0 à 1825. Valeur par défaut : 730.	730
DuplicationInfrequentAccessPeriod	integer	Non	Le délai après lequel les données de sauvegarde sont converties en stockage à accès peu fréquent (IA), en jours. Valeur par défaut : 180.	180
DuplicationArchivePeriod	integer	Non	Le délai après lequel les données de sauvegarde sont converties en stockage d'archive, en jours. Valeur par défaut : 365.	365
BackupPlanName	string	Oui	Le nom personnalisé du plan de sauvegarde.	dbstooi0*******
SourceEndpointOracleSID	string	Non	L'identifiant système Oracle (SID). Ce paramètre est requis si le type de base de données est Oracle.	test
BackupStorageType	string	Non	Le type de stockage intégré :	Aucun
BackupSpeedLimit	integer	Non	La limite d'E/S du disque, en Ko/s.	262144
BackupRateLimit	integer	Non	La limite de la bande passante réseau, en Ko/s. La valeur maximale autorisée est de 10 Go.	262144
BackupStrategyType	string	Non	La stratégie de sauvegarde complète. Valeurs valides :	simple
CrossAliyunId	string	Non	L'UID du compte Alibaba Cloud pour la sauvegarde intercomptes.	1648821913******
CrossRoleName	string	Non	Le nom du rôle RAM pour la sauvegarde intercomptes.	test123
ClientToken	string	Non	Un jeton client utilisé pour garantir l'idempotence de la requête. Cela permet d'éviter les requêtes en double.	ASDASDASDSADASFCZXVZ
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-aekzecovzti****

É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
RequestId	string	L'identifiant de la requête.	4F1888AC-1138-4995-B9FE-D2734F61C058
CreateBackupSet	boolean	Indique si le jeu de sauvegarde est activé. La valeur de retour est l'une des suivantes :	true
ErrCode	string	Le code d'erreur.	Param.NotFound
Success	boolean	Indique si la requête a réussi.	true
ErrMessage	string	Le message d'erreur.	La valeur spécifiée pour le paramètre %s n'est pas valide
BackupPlanId	string	L'identifiant du plan de sauvegarde.	dbs1hvb0wwwe****
OrderId	string	L'identifiant de la commande.	2056157***

Exemples

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "CreateBackupSet": true,
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.",
  "BackupPlanId": "dbs1hvb0wwwe****",
  "OrderId": "2056157***"
}

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.