獲取一個或多個符合條件的備份客戶端。
接口說明
該接口目前僅適用于 SAP HANA 備份，其他數據源的備份客戶端請調用 DescribeBackupClients 接口。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| hbr:DescribeClients | get | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| VaultId | string | 是 | 備份倉庫 ID。 | v-0001vk0z******xdyr |
| ClientId | string | 否 | 備份客戶端 ID。 | c-000ed600******6b0 |
| PageNumber | integer | 否 | 分頁頁碼，從 1 開始，默認值為 1。 | 1 |
| PageSize | integer | 否 | 分頁大小，最小值為 1，最大值為 99，默認值為 10。 | 10 |
| ClientType | string | 否 | 備份客戶端類型。取值為ECS_AGENT，表示 SAP HANA 備份客戶端。 | ECS_AGENT |
| SourceType | string | 否 | 數據源類型，取值為 HANA，表示 SAP HANA 備份。 | HANA |
| ClusterId | string | 否 | SAP HANA 實例 ID。 | cl-0005ni1******2l87 |
| ResourceGroupId | string | 否 | 資源組 ID。 | rg-acfmw6bxl7o5qyq |
返回參數
示例
正常返回示例
JSON格式
{
"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"
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史