DescribeClients查詢SAP HANA備份用戶端-雲備份-阿里雲

擷取一個或多個合格備份用戶端。

介面說明

該介面目前僅適用於 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	否	備份用戶端識別碼。	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

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	17189276-465D-5EF3-8FFD-0FF51B5A41A0
Success	boolean	請求是否成功。 true：成功 false：失敗	true
Code	string	返回碼，200 表示成功。	200
Message	string	返回資訊描述，成功一般返回 successful，錯誤時會返回相應錯誤資訊。	successful
PageNumber	integer	分頁頁碼，從 1 開始，預設值為 1。	1
PageSize	integer	分頁大小，最小值為 1，最大值為 99，預設值為 10。	10
TotalCount	integer	總記錄數。	12
Clients	object
Client	array<object>	備份用戶端列表。
	object	用戶端資訊。
Status	string	備份用戶端狀態。取值包括： REGISTERED：註冊成功 ACTIVATED：啟用成功 DEACTIVATED：啟用失效 INSTALLING：安裝中 INSTALL_FAILED：安裝失敗 NOT_INSTALLED：未安裝 UPGRADING：升級中 UPGRADE_FAILED：升級失敗 UNINSTALLING：卸載用戶端中 UNINSTALL_FAILED：卸載用戶端失敗 STOPPED：用戶端服務已停止 UNKNOWN：用戶端失聯	ACTIVATED
VaultId	string	備份倉庫 ID。	v-00029mx6o******n85lg
UseHttps	boolean	是否使用 HTTPS 傳輸資料。 true 表示使用 HTTPS 傳輸。 false 表示使用 HTTP 傳輸。	false
NetworkType	string	網路類型，傳回值包括： CLASSIC：傳統網路。 VPC：專用網路。	VPC
ClientName	string	用戶端名稱。	client-20211224-101226
ClientId	string	備份用戶端識別碼。	c-00062uu******2fgj
AlertSetting	string	警示設定。取值為 INHERITED，表示使用與備份庫一致的警示方式。	INHERITED
InstanceName	string	ECS 執行個體名稱。	swh-hbr
MaxVersion	string	用戶端最大版本號碼。	1.11.23
CreatedTime	integer	用戶端建立時間。	1554347313
StatusMessage	string	狀態資訊。	HANA_NOT_SUPPORT
ClientType	string	備份用戶端類型。取值為ECS_AGENT，表示 SAP HANA 備份用戶端。	ECS_AGENT
InstanceId	string	執行個體 ID。	i-wz9b6wya******n8yo
UpdatedTime	integer	備份用戶端更新時間。UNIX 時間，單位為秒。	1554347313
ClientVersion	string	備份用戶端版本號碼。	1.11.16
ClusterId	string	SAP HANA 執行個體 ID。	cl-0008c48frr******ncpk
HeartBeatTime	integer	用戶端心跳時間。UNIX 時間，單位為秒。	1554347313

樣本

正常返回樣本

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",
        "HeartBeatTime": 1554347313
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。