すべてのプロダクト
Search

このプロダクト

    :CreateClients

    ドキュメントセンター

    :CreateClients

    最終更新日:Dec 23, 2025

    指定されたインスタンスに 1 つ以上の Cloud Backup クライアントをインストールします。

    操作説明

    この操作を呼び出す前に、Cloud Backup の課金方法と価格設定を十分に理解していることを確認してください。 詳細については、「課金方法と課金項目」をご参照ください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    hbr:CreateClients

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    VaultId

    string

    必須

    バックアップボールトの ID。

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

    string

    任意

    アラート設定。 有効な値：INHERITED。これは、HBR クライアントがバックアップボールトに設定されているのと同じ方法を使用してアラート通知を送信することを示します。

    INHERITED
    ClientInfo

    string

    任意

    HBR クライアントのインストール情報。

    [ { "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：同じ Alibaba Cloud アカウント内でデータがバックアップされます。

    • CROSS_ACCOUNT：Alibaba Cloud アカウント間でデータがバックアップされます。

    CROSS_ACCOUNT
    CrossAccountUserId

    integer

    任意

    現在の Alibaba Cloud アカウントが Alibaba Cloud アカウント間でデータをバックアップすることを承認する、ソース Alibaba Cloud アカウントの ID。

    158975xxxxx4625
    CrossAccountRoleName

    string

    任意

    ソース Alibaba Cloud アカウント内に作成され、現在の Alibaba Cloud アカウントに割り当てられる Resource Access Management (RAM) ロールの名前。現在の Alibaba Cloud アカウントが Alibaba Cloud アカウント間でデータをバックアップすることを承認します。

    hbrcrossrole

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Code

    string

    HTTP ステータスコード。 ステータスコード 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 インスタンスのステータス。 リクエストで複数のインスタンス ID を指定し、ECS インスタンスのステータスが HBR クライアントをインストールするための要件を満たしていない場合、このパラメーターの値に基づいてエラーメッセージが返されます。

    object

    ECS インスタンスのステータス。 リクエストで複数のインスタンス ID を指定し、ECS インスタンスのステータスが HBR クライアントをインストールするための要件を満たしていない場合、このパラメーターの値に基づいてエラーメッセージが返されます。

    ValidInstance

    boolean

    HBR クライアントを ECS インスタンスにインストールできるかどうかを示します。 有効な値：

    • true：HBR クライアントは ECS インスタンスにインストールできます。

    • false：HBR クライアントは ECS インスタンスにインストールできません。

    true
    InstanceId

    string

    ECS インスタンスの ID。

    i-2zegp3cdu******uj9i

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。