全部產品
Search

搜尋本產品

    Cloud Backup：CreateClients - 安裝用戶端

    文件中心

    Cloud Backup：CreateClients - 安裝用戶端

    更新時間：Dec 23, 2025

    在指定執行個體上安裝一個或多個HBR備份用戶端。

    介面說明

    請確保在使用該介面前，已充分瞭解雲備份服務的收費方式和價格。更多資訊，請參見計費方式與計費項目。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    hbr:CreateClients

    create

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    VaultId

    string

    是

    備份倉庫 ID。

    v-0001ufe******kgm
    AlertSetting

    string

    否

    警示設定。取值為 INHERITED，表示使用與備份庫一致的警示方式。

    INHERITED
    ClientInfo

    string

    否

    用戶端安裝資訊。

    [ { "instanceId": "i-bp116lr******te9q2", "accessKeyId": "", "accessKeySecret": "", "clusterId": "cl-000csy09q******9rfz9", "sourceTypes": [ "HANA" ] }, { "instanceId": "i-bp116lrux******hte9q4", "accessKeyId": "", "accessKeySecret": "", "clusterId": "cl-000csy09q5094vw9rfz9", "sourceTypes": [ "HANA" ] }]
    UseHttps

    boolean

    否

    是否使用 HTTPS 傳輸資料。

    • true：使用 HTTPS 傳輸。

    • false：使用 HTTP 傳輸。

    false
    ResourceGroupId

    string

    否

    資源群組 ID。

    rg-aekzvx7d3c4kpny
    CrossAccountType

    string

    否

    跨帳號備份類型。支援：

    • SELF_ACCOUNT：本帳號備份

    • CROSS_ACCOUNT：跨帳號備份

    CROSS_ACCOUNT
    CrossAccountUserId

    integer

    否

    被當前帳號管理的跨帳號備份的原帳號 ID。

    158975xxxxx4625
    CrossAccountRoleName

    string

    否

    被當前帳號管理的跨帳號備份的原帳號 RAM 中建立的角色名稱。

    hbrcrossrole

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Code

    string

    返回碼，200 表示成功。

    200
    Message

    string

    返回資訊描述，成功一般返回 successful，錯誤時會返回相應錯誤資訊。

    successful
    RequestId

    string

    請求 ID。

    4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E
    TaskId

    string

    非同步任務 ID。可以通過調用 DescribeTask 擷取任務結果。

    t-000h9x5t02vhyksf1x7k
    Success

    boolean

    請求是否成功。

    • true：成功

    • false：失敗

    true
    InstanceStatuses

    object

    InstanceStatus

    array<object>

    ECS 執行個體狀態。 若存在 ECS 執行個體狀態不滿足安裝用戶端的需求，且請求中 InstanceIds 多於 1 個時，通過這個欄位返回錯誤資訊。

    object

    ECS 執行個體狀態。 若存在 ECS 執行個體狀態不滿足安裝用戶端的需求，且請求中 InstanceIds 多於 1 個時，通過這個欄位返回錯誤資訊。

    ValidInstance

    boolean

    ECS 執行個體是否可以安裝備份用戶端。

    • true：可以安裝。

    • false：不可以安裝。

    true
    InstanceId

    string

    ECS 執行個體 ID。

    i-2zegp3cdu******uj9i

    樣本

    正常返回樣本

    JSON格式

    {
  "Code": "200",
  "Message": "successful",
  "RequestId": "4A8A9AE4-F798-5E6D-853E-10F9F5A1BD4E",
  "TaskId": "t-000h9x5t02vhyksf1x7k",
  "Success": true,
  "InstanceStatuses": {
    "InstanceStatus": [
      {
        "ValidInstance": true,
        "InstanceId": "i-2zegp3cdu******uj9i"
      }
    ]
  }
}

    錯誤碼

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

    變更歷史

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