DescribeClients - - Centre de documentation Alibaba Cloud

Consulte un ou plusieurs clients Cloud Backup qui remplissent les conditions spécifiées.

Description de l'opération

Cette opération s'applique uniquement à la sauvegarde SAP HANA. Pour les clients Cloud Backup d'autres sources de données, appelez l'opération DescribeBackupClients.

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

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
VaultId	string	Non	L'identifiant du coffre de sauvegarde.	v-0001vk0z******xdyr
ClientId	string	Non	L'identifiant du client Cloud Backup.	c-000ed600******6b0
PageNumber	integer	Non	Le numéro de page. Les pages commencent à la page 1. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. Valeurs valides : 1 à 99. Valeur par défaut : 10.	10
ClientType	string	Non	Le type de client Cloud Backup. Valeur valide : ECS_AGENT, qui indique un client de sauvegarde SAP HANA.	ECS_AGENT
SourceType	string	Non	Le type de source de données. Valeur valide : HANA, qui indique la sauvegarde SAP HANA.	HANA
ClusterId	string	Non	L'identifiant de l'instance SAP HANA.	cl-0005ni1******2l87
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-acfmw6bxl7o5qyq

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	17189276-465D-5EF3-8FFD-0FF51B5A41A0
Success	boolean	Indique si la requête a réussi. Valeurs valides : true false	true
Code	string	Le code de réponse. 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
PageNumber	integer	Le numéro de page. Les pages commencent à la page 1. Valeur par défaut : 1.	1
PageSize	integer	Le nombre d'entrées par page. Valeurs valides : 1 à 99. Valeur par défaut : 10.	10
TotalCount	integer	Le nombre total d'entrées renvoyées.	12
Clients	object
Client	array<object>	Les clients Cloud Backup.
	object	Les informations du client.
Status	string	The status of the Cloud Backup client. Valid values: REGISTERED: The backup client is registered. ACTIVATED: The backup client is activated. DEACTIVATED: The backup client fails to be activated. INSTALLING: The backup client is being installed. INSTALL_FAILED: The backup client fails to be installed. NOT_INSTALLED: The backup client is not installed. UPGRADING: The backup client is being upgraded. UPGRADE_FAILED: The backup client fails to be upgraded. UNINSTALLING: The backup client is being uninstalled. UNINSTALL_FAILED: The backup client fails to be uninstalled. STOPPED: The backup client is out of service. UNKNOWN: The backup client is disconnected.	ACTIVATED
VaultId	string	The ID of the backup vault.	v-00029mx6o******n85lg
UseHttps	boolean	Indicates whether data is transmitted over HTTPS. Valid values: true: Data is transmitted over HTTPS. false: Data is transmitted over HTTP.	false
NetworkType	string	The network type. Valid values: CLASSIC: the classic network VPC: the virtual private cloud (VPC)	VPC
ClientName	string	The client name.	client-20211224-101226
ClientId	string	The ID of the Cloud Backup client.	c-00062uu******2fgj
AlertSetting	string	The alert settings. Valid value: INHERITED, which indicates that the Cloud Backup client sends alert notifications by using the same method configured for the backup vault.	INHERITED
InstanceName	string	The name of the ECS instance.	swh-hbr
MaxVersion	string	The maximum version number of the Cloud Backup client.	1.11.23
CreatedTime	integer	The time when the Cloud Backup client was created.	1554347313
StatusMessage	string	The status information.	HANA_NOT_SUPPORT
ClientType	string	The type of the Cloud Backup client. Valid value: ECS_AGENT, which indicates an SAP HANA backup client.	ECS_AGENT
InstanceId	string	The instance ID.	i-wz9b6wya******n8yo
UpdatedTime	integer	The time when the Cloud Backup client was updated. This value is a UNIX timestamp. Unit: seconds.	1554347313
ClientVersion	string	The version number of the Cloud Backup client.	1.11.16
ClusterId	string	The ID of the SAP HANA instance.	cl-0008c48frr******ncpk
HeartBeatTime	integer	The latest heartbeat time of the Cloud Backup client. This value is a UNIX timestamp. Unit: seconds.	1554347313

Exemples

JSON format

{
  "RequestId": "17189276-465D-5EF3-8FFD-0FF51B5A41A0",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 12,
  "Clients": {
    "Client": [
      {
        "Status": "ACTIVATED",
        "VaultId": "v-00029mx6o******n85lg",
        "UseHttps": false,
        "NetworkType": "VPC",
        "ClientName": "client-20211224-101226",
        "ClientId": "c-00062uu******2fgj",
        "AlertSetting": "INHERITED",
        "InstanceName": "swh-hbr",
        "MaxVersion": "1.11.23",
        "CreatedTime": 1554347313,
        "StatusMessage": "HANA_NOT_SUPPORT",
        "ClientType": "ECS_AGENT",
        "InstanceId": "i-wz9b6wya******n8yo",
        "UpdatedTime": 1554347313,
        "ClientVersion": "1.11.16",
        "ClusterId": "cl-0008c48frr******ncpk",
        "HeartBeatTime": 1554347313
      }
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.