Queries the information about one or more HBR clients that meet the specified conditions.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
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 | Yes | The type of the HBR client. Valid values:
| ECS_CLIENT |
ClusterId | string | No | The ID of the cluster for the backup. | cl-000ge4wa61b4d337xblq |
ClientIds | array | No | The IDs of HBR clients. | |
string | No | The ID of the HBR client. | c-********************* | |
InstanceIds | array | No | The IDs of ECS instances. | |
string | No | The ID of the ECS instance. | i-********************* | |
Tag | object [] | No | The tags. | 33738719# |
Key | string | No | The tag key of the backup vault. Valid values of N: 1 to 20.
| TestKey |
Value | string | No | The tag value of the backup vault. Valid values of N: 1 to 20.
| TestValue |
CrossAccountType | string | No | Specifies whether data is backed up within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values:
| CROSS_ACCOUNT |
CrossAccountUserId | long | No | The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up data across Alibaba Cloud accounts. | 129374672382xxxx |
CrossAccountRoleName | string | No | The name of the RAM role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up data across Alibaba Cloud accounts. | hbrcrossrole |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Success": true,
"Code": "200",
"Message": "successful",
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 8,
"Clients": [
{
"Status": "ACTIVATED",
"BackupStatus": "PROTECTED",
"ArchType": "amd64",
"ClientId": "c-*********************",
"MaxClientVersion": "2.4.5",
"PrivateIpV4": "192.168.1.1",
"InstanceName": "instancename",
"CreatedTime": 1554347313,
"LastHeartBeatTime": 1554347313,
"ClientType": "ECS_CLIENT",
"Hostname": "hostname",
"InstanceId": "i-*********************",
"Appliance": false,
"UpdatedTime": 1554347313,
"OsType": "linux",
"ZoneId": "cn-hangzhou-f",
"ClientVersion": "2.4.5",
"Tags": [
{
"Key": "TestKey",
"Value": "TestValue"
}
],
"Settings": {
"ProxyHost": "192.168.11.100",
"MaxCpuCore": "1",
"ProxyPort": 3128,
"UseHttps": "false",
"ProxyPassword": "******",
"ProxyUser": "user",
"DataProxySetting": "USE_CONTROL_PROXY",
"DataNetworkType": "VPC",
"MaxWorker": "1"
}
}
]
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||
---|---|---|---|---|
2023-08-08 | The response structure of the API has changed | see changesets | ||
| ||||
2023-07-31 | The response structure of the API has changed | see changesets | ||
|