獲取一個或者多個符合條件的備份客戶端信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| 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 | 否 | 備份客戶端 ID 列表。 | |
| string | 否 | 備份客戶端 ID。 | c-********************* | |
| InstanceIds | array | 否 | ECS 實例 ID 列表。 | |
| 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 | long | 否 | 用于跨賬號備份功能中的原賬號 ID。 | 129374672382xxxx |
| CrossAccountRoleName | string | 否 | 用于跨賬號備份的原賬號 RAM 中創建的角色名。 | hbrcrossrole |
返回參數
示例
正常返回示例
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
}
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-08-08 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-07-31 | OpenAPI 返回結構發生變更 | 查看變更詳情 |