All Products
Search
Document Center

Hybrid Backup Recovery:DescribeClients

Last Updated:Nov 14, 2022

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
VaultIdstringNo

The ID of the backup vault.

v-0001vk0z******xdyr
ClientIdstringNo

The ID of the backup client.

c-000ed600******6b0
PageNumberintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Valid values: 1 to 99. Default value: 10.

10
ClientTypestringNo

The type of the backup client. Valid value:ECS_AGENT, which indicates an SAP HANA backup client.

ECS_AGENT
SourceTypestringNo

The type of the data source. Valid value:HANA, which indicates SAP HANA backup.

HANA
ClusterIdstringNo

The ID of the SAP HANA instance.

cl-0005ni1******2l87
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmw6bxl7o5qyq

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

17189276-465D-5EF3-8FFD-0FF51B5A41A0
Successboolean

Indicates whether the call is successful. Valid values:

  • true: The call is successful.
  • false: The call fails.
true
Codestring

The HTTP status code. The status code 200 indicates that the call is successful.

200
Messagestring

The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.

successful
PageNumberinteger

The page number of the returned page. Pages start from page 1. Default value: 1.

1
PageSizeinteger

The number of entries returned per page. Valid values: 1 to 99. Default value: 10.

10
TotalCountinteger

The total number of returned entries.

12
Clientsarray

The backup clients.

object

The backup clients.

Statusstring

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
VaultIdstring

The ID of the backup vault.

v-00029mx6o******n85lg
UseHttpsboolean

Indicates whether data is transmitted over HTTPS. Valid values:

  • true: Data is transmitted over HTTPS.
  • false: Data is transmitted over HTTP.
false
NetworkTypestring

The network type. Valid values:

  • CLASSIC: classic network
  • VPC: virtual private cloud (VPC)
VPC
ClientNamestring

The name of the backup client.

client-20211224-101226
ClientIdstring

The ID of the backup client.

c-00062uu******2fgj
AlertSettingstring

The alert settings. Valid value: INHERITED, which indicates that the backup client sends alert notifications in the same way as the backup vault.

INHERITED
InstanceNamestring

The name of the ECS instance.

swh-hbr
MaxVersionstring

The maximum version number of the backup client.

1.11.23
CreatedTimelong

The time when the backup client was created.

1554347313
StatusMessagestring

The status information.

HANA_NOT_SUPPORT
ClientTypestring

The type of the backup client. Valid value:ECS_AGENT, which indicates an SAP HANA backup client.

ECS_AGENT
InstanceIdstring

The ID of the instance.

i-wz9b6wya******n8yo
UpdatedTimelong

The time when the backup client was updated. This value is a UNIX timestamp. Unit: seconds.

1554347313
ClientVersionstring

The version number of the backup client.

1.11.16
ClusterIdstring

The ID of the SAP HANA instance.

cl-0008c48frr******ncpk

Example

Request example

http(s)://[Endpoint]/?Action=DescribeClients
&VaultId=v-0001vk0z******xdyr
&ClientId=c-000ed600******6b0
&PageNumber=1
&PageSize=10
&ClientType=ECS_AGENT
&SourceType=HANA
&ClusterId=cl-0005ni1******2l87
&ResourceGroupId=rg-acfmw6bxl7o5qyq
&Common request parameters

Normal return example

JSONFormat

{
  "RequestId": "17189276-465D-5EF3-8FFD-0FF51B5A41A0",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 12,
  "Clients": [
    {
      "Status": "ACTIVATED",
      "VaultId": "v-00029mx6o******n85lg",
      "UseHttps": true,
      "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 API error center.