擷取一個或者多個合格備份用戶端資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
hbr:DescribeBackupClients |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| PageNumber |
integer |
否 |
分頁頁碼，從 1 開始，預設值為 1。 |
1 |
| PageSize |
integer |
否 |
分頁大小，最小值為 1，最大值為 99，預設值為 10。 |
10 |
| ClientType |
string |
是 |
備份用戶端類型。取值：
枚舉值：
|
ECS_CLIENT |
| ClusterId |
string |
否 |
備份組群 ID。 |
cl-000ge4wa61b4d337xblq |
| ClientIds |
array |
否 |
備份用戶端識別碼 列表。 |
["c-*********************"] |
|
string |
否 |
備份用戶端識別碼。 |
c-********************* |
|
| InstanceIds |
array |
否 |
ECS 執行個體 ID 列表。 |
["i-*********************"] |
|
string |
否 |
ECS 執行個體 ID。 |
i-********************* |
|
| Tag |
array<object> |
否 |
返回的標籤資訊。 |
33738719# |
|
object |
否 |
標籤資訊。 |
||
| Key |
string |
否 |
倉庫的標籤鍵。N 的取值範圍：1~20。
|
TestKey |
| Value |
string |
否 |
倉庫的標籤值。N 的取值範圍：1~20。
|
TestValue |
| CrossAccountType |
string |
否 |
跨帳號備份類型。支援：
|
CROSS_ACCOUNT |
| CrossAccountUserId |
integer |
否 |
用於跨帳號備份功能中的原帳號 ID。 |
129374672382xxxx |
| CrossAccountRoleName |
string |
否 |
用於跨帳號備份的原帳號 RAM 中建立的角色名稱。 |
hbrcrossrole |
| Filters |
array<object> |
否 |
查詢過濾器。 |
|
|
object |
否 |
查詢過濾器。 |
||
| Key |
string |
否 |
查詢過濾器中的索引值。 |
InstanceId |
| Values |
array |
否 |
查詢過濾器中的待匹配的值。 |
|
|
string |
否 |
查詢過濾器中的待匹配的值。 |
i-********************* |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| Success |
boolean |
請求是否成功。
|
true |
| Code |
string |
返回碼。200 表示成功。 |
200 |
| Message |
string |
返回資訊描述，成功一般返回 successful，錯誤時會返回相應錯誤資訊。 |
successful |
| PageNumber |
integer |
分頁頁碼，從 1 開始，預設值為 1。 |
1 |
| PageSize |
integer |
分頁大小，最小值為 1，最大值為 99，預設值為 10。 |
10 |
| TotalCount |
integer |
查詢到的合格備份用戶端總數。 |
8 |
| Clients |
array<object> |
備份用戶端列表。 |
{'Client': []} |
|
object |
|||
| Status |
string |
備份用戶端狀態。取值範圍：
|
ACTIVATED |
| BackupStatus |
string |
備份用戶端受保護狀態。取值範圍：
|
PROTECTED |
| ArchType |
string |
僅當 ClientType 取值為ECS_CLIENT時，該參數有效。表示備份用戶端所在的系統架構。取值範圍：
|
amd64 |
| ClientId |
string |
備份用戶端識別碼。 |
c-********************* |
| MaxClientVersion |
string |
最新備份用戶端版本號碼。 |
2.4.5 |
| PrivateIpV4 |
string |
僅當 ClientType 取值為ECS_CLIENT時，該參數有效。表示 ECS 執行個體內網 IP 位址。 |
192.168.1.1 |
| InstanceName |
string |
僅當 ClientType 取值為ECS_CLIENT時，該參數有效。表示 ECS 執行個體名稱。 |
instancename |
| CreatedTime |
integer |
備份用戶端建立時間。UNIX 時間，單位為秒。 |
1554347313 |
| LastHeartBeatTime |
integer |
備份用戶端最後一次心跳時間。UNIX 時間，單位為秒。 |
1554347313 |
| ClientType |
string |
備份用戶端類型。取值為ECS_CLIENT，表示 ECS 檔案備份用戶端。 |
ECS_CLIENT |
| Hostname |
string |
備份用戶端所在的主機名稱。 |
hostname |
| InstanceId |
string |
執行個體 ID。
|
i-********************* |
| Appliance |
boolean |
是否是硬體監控一體機用戶端。
|
false |
| UpdatedTime |
integer |
備份用戶端更新時間。UNIX 時間，單位為秒。 |
1554347313 |
| OsType |
string |
僅當 ClientType 取值為ECS_CLIENT時，該參數有效。表示用戶端系統類別型。取值範圍：
|
linux |
| ZoneId |
string |
僅當 ClientType 取值為ECS_CLIENT時，該參數有效。表示地區。 |
cn-hangzhou-f |
| ClientVersion |
string |
備份用戶端版本號碼。 |
2.4.5 |
| Tags |
array<object> |
標籤資訊。 |
|
|
object |
|||
| Key |
string |
倉庫的標籤鍵。N 的取值範圍：1~20。
|
TestKey |
| Value |
string |
倉庫的標籤值。N 的取值範圍：1~20。
|
TestValue |
| Settings |
object |
備份用戶端配置資訊。 |
|
| ProxyHost |
string |
自訂資料面Proxy 伺服器主機 IP 位址。 |
192.168.11.100 |
| MaxCpuCore |
string |
單個備份任務使用的 CPU 核心數，0 表示不限制。 |
1 |
| ProxyPort |
integer |
自訂資料面Proxy 伺服器主機連接埠。 |
3128 |
| UseHttps |
string |
是否使用 HTTPS 傳輸資料面資料。
|
false |
| ProxyPassword |
string |
自訂資料面Proxy 伺服器密碼。 |
****** |
| ProxyUser |
string |
自訂資料面Proxy 伺服器使用者名稱。 |
user |
| DataProxySetting |
string |
資料面代理設定。取值範圍：
|
USE_CONTROL_PROXY |
| DataNetworkType |
string |
資料面資料存取點類型。取值範圍：
|
VPC |
| MaxWorker |
string |
單個備份任務並發工作數量，0 表示不限制。 |
1 |
| MaxMemory |
integer |
用戶端能夠使用的最大記憶體，單位是 bytes。僅支援 2.13.0 及以上版本。 |
0 |
| AlertOnPartialComplete |
boolean |
是否針對部分完成任務警示，僅針對本地檔案備份和 ECS 檔案備份生效。 |
false |
樣本
正常返回樣本
JSON格式
{
"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",
"MaxMemory": 0,
"AlertOnPartialComplete": false
}
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。