InstallBackupClients - - Centre de documentation Alibaba Cloud

Installe des clients de sauvegarde sur une ou plusieurs instances ECS.

Description de l'opération

Cette opération crée une tâche asynchrone en arrière-plan. La tâche utilise Cloud Assistant pour installer des clients de sauvegarde sur les instances ECS.\n\n- Appelez l'opération DescribeTask pour obtenir le résultat de la tâche.\n\n- Le délai d'expiration de la tâche est de 15 minutes. Une fois la tâche créée, attendez 60 secondes avant d'effectuer la première requête. Ensuite, interrogez le résultat toutes les 30 secondes.

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

update

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
InstanceIds	object	Oui	Les identifiants des instances ECS. Vous pouvez spécifier jusqu'à 20 identifiants d'instances.	["i-0xi5wj5*****v3j3bh2gj5"]
CrossAccountType	string	Non	Le type de sauvegarde inter-comptes. Valeurs valides :\n\n- SELF_ACCOUNT : sauvegarde les données au sein du compte actuel.\n\n- CROSS_ACCOUNT : sauvegarde les données entre plusieurs comptes.	CROSS_ACCOUNT
CrossAccountUserId	integer	Non	L'identifiant du compte source utilisé pour la sauvegarde inter-comptes.	16392782xxxxxx
CrossAccountRoleName	string	Non	Le nom du rôle RAM créé dans le compte source pour la sauvegarde inter-comptes.	BackupRole

Éléments de réponse

Élément	Type	Description	Exemple
	object
Code	string	Le code de retour. Une valeur de 200 indique que l'opération a réussi.	200
Message	string	Le message renvoyé. Si la requête aboutit, la valeur successful est renvoyée. Si la requête échoue, un message d'erreur est renvoyé.	successful
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TaskId	string	L'identifiant de la tâche asynchrone. Appelez l'opération DescribeTask pour interroger le résultat de la tâche.	t-*********************
Success	boolean	Indique si la requête a abouti.\n\n- true : la requête a abouti.\n\n- false : la requête a échoué.	true
InstanceStatuses	array<object>	L'état des instances ECS.
	object
ValidInstance	boolean	Indique si un client de sauvegarde peut être installé sur l'instance ECS.\n\n- true : le client de sauvegarde peut être installé.\n\n- false : le client de sauvegarde ne peut pas être installé.	true
InstanceId	string	L'identifiant de l'instance ECS.	i-0xi5w***v3j3bh2gj5
ErrorCode	string	Le code d'erreur. Valeurs valides :\n\n- Une valeur vide indique que l'opération a réussi.\n\n- InstanceNotExists : l'instance ECS n'existe pas.\n\n- InstanceNotRunning : l'instance ECS n'est pas dans l'état Running.\n\n- CloudAssistNotRunningOnInstance : Cloud Assistant n'est pas disponible.	InstanceNotExists

Exemples

JSON format

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TaskId": "t-*********************",
  "Success": true,
  "InstanceStatuses": [
    {
      "ValidInstance": true,
      "InstanceId": "i-0xi5w***v3j3bh2gj5",
      "ErrorCode": "InstanceNotExists"
    }
  ]
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.