CreateClients - - Centre de documentation Alibaba Cloud

Installe un ou plusieurs clients Cloud Backup sur les instances spécifiées.

Description de l'opération

Avant d'appeler cette opération, assurez-vous de bien comprendre les méthodes de facturation et la tarification de Cloud Backup. Pour plus d'informations, consultez Méthodes de facturation et éléments facturables.

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

create

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
VaultId	string	Oui	L'identifiant du coffre de sauvegarde.	v-0001ufe******kgm
AlertSetting	string	Non	Les paramètres d'alerte. Valeur valide : INHERITED, ce qui indique que le client HBR envoie des notifications d'alerte en utilisant la même méthode que celle configurée pour le coffre de sauvegarde.	INHERITED
ClientInfo	string	Non	Les informations d'installation des clients HBR.	[ { "instanceId": "i-bp116lr****te9q2", "accessKeyId": "", "accessKeySecret": "", "clusterId": "cl-000csy09q**9rfz9", "sourceTypes": [ "HANA" ] }, { "instanceId": "i-bp116lrux****hte9q4", "accessKeyId": "", "accessKeySecret": "", "clusterId": "cl-000csy09q5094vw9rfz9", "sourceTypes": [ "HANA" ] }]
UseHttps	boolean	Non	Indique si les données doivent être transmises via HTTPS. Valeurs valides : true : transmet les données via HTTPS. false : transmet les données via HTTP.	false
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-aekzvx7d3c4kpny
CrossAccountType	string	Non	Le type de sauvegarde. 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.	CROSS_ACCOUNT
CrossAccountUserId	integer	Non	L'identifiant du compte Alibaba Cloud source qui autorise le compte Alibaba Cloud actuel à sauvegarder des données entre comptes Alibaba Cloud.	158975xxxxx4625
CrossAccountRoleName	string	Non	Le nom du rôle Resource Access Management (RAM) créé dans le compte Alibaba Cloud source et attribué au compte Alibaba Cloud actuel pour autoriser ce dernier à sauvegarder des données entre comptes Alibaba Cloud.	hbrcrossrole

É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 l'appel a réussi.	200
Message	string	Le message renvoyé. Si l'appel réussit, « successful » est renvoyé. Si l'appel échoue, un message d'erreur est renvoyé.	successful
RequestId	string	L'identifiant de la requête.	4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E
TaskId	string	L'identifiant de la tâche asynchrone. Vous pouvez appeler l'opération DescribeTask pour interroger le résultat d'exécution d'une tâche asynchrone.	t-000h9x5t02vhyksf1x7k
Success	boolean	Indique si l'appel a réussi. Valeurs valides : true : l'appel a réussi. false : l'appel a échoué.	true
InstanceStatuses	object
InstanceStatus	array<object>	L'état de l'instance ECS. Si vous spécifiez plusieurs identifiants d'instance dans la requête et que l'état d'une instance ECS ne répond pas aux exigences pour l'installation d'un client HBR, un message d'erreur est renvoyé en fonction de la valeur de ce paramètre.
	object	L'état de l'instance ECS. Si vous spécifiez plusieurs identifiants d'instance dans la requête et que l'état d'une instance ECS ne répond pas aux exigences pour l'installation d'un client HBR, un message d'erreur est renvoyé en fonction de la valeur de ce paramètre.
ValidInstance	boolean	Indicates whether an HBR client can be installed on the ECS instance. Valid values: true: An HBR client can be installed on the ECS instance. false: An HBR client cannot be installed on the ECS instance.	true
InstanceId	string	The ID of the ECS instance.	i-2zegp3cdu******uj9i

Exemples

JSON format

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E",
  "TaskId": "t-000h9x5t02vhyksf1x7k",
  "Success": true,
  "InstanceStatuses": {
    "InstanceStatus": [
      {
        "ValidInstance": true,
        "InstanceId": "i-2zegp3cdu******uj9i"
      }
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.