DescribeClients API Overview for SAP HANA Backup - Cloud Backup - Alibaba Cloud - Cloud Backup

Queries Cloud Backup clients that meet specified conditions.

Operation description

This operation applies only to SAP HANA backup. For other data sources, call the DescribeBackupClients operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hbr:DescribeClients

get

*All Resource

*

None

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 Cloud Backup client.	c-000ed600******6b0
PageNumber	integer	No	The page number, starting from 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 99. Default value: 10.	10
ClientType	string	No	The type of the Cloud 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 elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	17189276-465D-5EF3-8FFD-0FF51B5A41A0
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Code	string	The response code. Status code 200 indicates that the request was successful.	200
Message	string	The returned message. Returns "successful" on success, or an error message on failure.	successful
PageNumber	integer	The page number, starting from 1. Default value: 1.	1
PageSize	integer	The number of entries per page. Valid values: 1 to 99. Default value: 10.	10
TotalCount	integer	The total number of entries returned.	12
Clients	object
Client	array<object>	The Cloud Backup clients.
	object	The client information.
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 setting. Valid value: INHERITED, which indicates that the backup client inherits alert notification settings from 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 last heartbeat time of the Cloud Backup client. This value is a UNIX timestamp. Unit: seconds.	1554347313

Examples

Success response

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.