DescribeClients - Cloud Backup - Alibaba Cloud Documentation Center

Queries the information about one or more backup clients that meet the specified conditions.

Operation description

This operation is applicable only to SAP HANA backup. For backup clients of other data sources, call the DescribeBackupClients operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
VaultId	string	No	The ID of the backup vault.	v-0001vk0z******xdyr
ClientId	string	No	The ID of the backup client.	c-000ed600******6b0
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 99. Default value: 10.	10
ClientType	string	No	The type of the backup client. Valid value:ECS_AGENT, which indicates an SAP HANA backup client.	ECS_AGENT
SourceType	string	No	The type of the data source. Valid value:HANA, which indicates SAP HANA backup.	HANA
ClusterId	string	No	The ID of the SAP HANA instance.	cl-0005ni1******2l87
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmw6bxl7o5qyq

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	17189276-465D-5EF3-8FFD-0FF51B5A41A0
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call fails.	true
Code	string	The HTTP status code. The status code 200 indicates that the call is successful.	200
Message	string	The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.	successful
PageNumber	integer	The page number of the returned page. Pages start from page 1. Default value: 1.	1
PageSize	integer	The number of entries returned per page. Valid values: 1 to 99. Default value: 10.	10
TotalCount	integer	The total number of returned entries.	12
Clients	object []	The backup clients.
Status	string	The status of the backup client. Valid values: REGISTERED: The backup client is registered. ACTIVATED: The backup client is enabled. DEACTIVATED: The backup client fails to be enabled. 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: classic network VPC: virtual private cloud (VPC)	VPC
ClientName	string	The name of the backup client.	client-20211224-101226
ClientId	string	The ID of the backup client.	c-00062uu******2fgj
AlertSetting	string	The alert settings. Valid value: INHERITED, which indicates that the backup client sends alert notifications in the same way as the backup vault.	INHERITED
InstanceName	string	The name of the ECS instance.	swh-hbr
MaxVersion	string	The maximum version number of the backup client.	1.11.23
CreatedTime	long	The time when the backup client was created.	1554347313
StatusMessage	string	The status information.	HANA_NOT_SUPPORT
ClientType	string	The type of the backup client. Valid value:ECS_AGENT, which indicates an SAP HANA backup client.	ECS_AGENT
InstanceId	string	The ID of the instance.	i-wz9b6wya******n8yo
UpdatedTime	long	The time when the backup client was updated. This value is a UNIX timestamp. Unit: seconds.	1554347313
ClientVersion	string	The version number of the backup client.	1.11.16
ClusterId	string	The ID of the SAP HANA instance.	cl-0008c48frr******ncpk

Examples

Sample success responses

JSONformat

{
  "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"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history