All Products
Search

This Product

    Cloud Backup:DescribeClients

    Document Center

    Cloud Backup:DescribeClients

    Last Updated:Aug 26, 2024

    Queries one or more Cloud Backup clients that meet the specified conditions.

    Operation description

    This operation is applicable only to SAP HANA backup. For Cloud 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.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    hbr:DescribeClientsget
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    VaultIdstringNo

    The ID of the backup vault.

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

    The ID of the Cloud Backup client.

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

    The page number. Pages start from page 1. Default value: 1.

    		1
    PageSizeintegerNo

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

    		10
    ClientTypestringNo

    The type of the Cloud 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 request ID.

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

    Indicates whether the request was successful. Valid values:

    • true
    • false
    		true
    Codestring

    The response code. The status code 200 indicates that the request was successful.

    		200
    Messagestring

    The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.

    		successful
    PageNumberinteger

    The page number. Pages start from page 1. Default value: 1.

    		1
    PageSizeinteger

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

    		10
    TotalCountinteger

    The total number of entries returned.

    		12
    Clientsarray<object>

    The Cloud Backup clients.

    object

    The backup clients.

    Statusstring

    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
    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: the classic network
    • VPC: the virtual private cloud (VPC)
    		VPC
    ClientNamestring

    The client name.

    		client-20211224-101226
    ClientIdstring

    The ID of the Cloud Backup client.

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

    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
    InstanceNamestring

    The name of the ECS instance.

    		swh-hbr
    MaxVersionstring

    The maximum version number of the Cloud Backup client.

    		1.11.23
    CreatedTimelong

    The time when the Cloud Backup client was created.

    		1554347313
    StatusMessagestring

    The status information.

    		HANA_NOT_SUPPORT
    ClientTypestring

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

    		ECS_AGENT
    InstanceIdstring

    The instance ID.

    		i-wz9b6wya******n8yo
    UpdatedTimelong

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

    		1554347313
    ClientVersionstring

    The version number of the Cloud Backup client.

    		1.11.16
    ClusterIdstring

    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 timeSummary of changesOperation
    No change history