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
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| hbr:DescribeClients | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| VaultId | string | Yes | 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. Pages start from page 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 parameters
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 |
|---|