すべてのプロダクト
Search

このプロダクト

    :InstallBackupClients

    ドキュメントセンター

    :InstallBackupClients

    最終更新日:Jun 10, 2026

    1台または複数のECSインスタンスにバックアップクライアントをインストールします。

    操作説明

    • この操作は、Cloud Assistant を呼び出して ECS インスタンスにバックアップクライアントをインストールするバックグラウンドの非同期タスクを作成します。

    • DescribeTask 操作を呼び出すことでタスク結果を取得できます。

    • タスクのタイムアウト時間は15 分です。タスク作成後 60 秒経過してから初回のクエリを行い、その後 30 秒ごとに結果をクエリすることを推奨します。

    今すぐお試しください

    この 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:InstallBackupClients

    update

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceIds

    object

    必須

    ECSインスタンスのID。最大 20 個まで指定できます。

    ["i-0xi5wj5*****v3j3bh2gj5"]
    CrossAccountType

    string

    任意

    クロスアカウントバックアップタイプ。有効な値:

    • SELF_ACCOUNT: 現在のAlibaba Cloudアカウント内でのバックアップ

    • CROSS_ACCOUNT: クロスアカウントバックアップ

    CROSS_ACCOUNT
    CrossAccountUserId

    integer

    任意

    クロスアカウントバックアップ機能で使用される元のアカウントのID。

    16392782xxxxxx
    CrossAccountRoleName

    string

    任意

    元のアカウントで作成され、クロスアカウントバックアップを承認するために使用されるRAMロールの名前。

    BackupRole

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Code

    string

    レスポンスコード。値が200の場合、リクエストが成功したことを示します。

    200
    Message

    string

    返されたメッセージ。リクエストが成功した場合は successful が返されます。リクエストが失敗した場合はエラーメッセージが返されます。

    successful
    RequestId

    string

    リクエストID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    TaskId

    string

    非同期タスクのID。DescribeTask 操作を呼び出してタスク結果を取得できます。

    t-*********************
    Success

    boolean

    リクエストが成功したかどうかを示します。

    • true: リクエストが成功しました。

    • false: リクエストが失敗しました。

    true
    InstanceStatuses

    array<object>

    ECSインスタンスのステータス。

    object

    ValidInstance

    boolean

    ECSインスタンスにバックアップクライアントをインストールできるかどうかを示します。

    • true: バックアップクライアントをインストールできます。

    • false: バックアップクライアントをインストールできません。

    true
    InstanceId

    string

    ECSインスタンスのID。

    i-0xi5w***v3j3bh2gj5
    ErrorCode

    string

    返されたエラーコード。有効な値:

    • 空: 操作が成功したことを示します。

    • InstanceNotExists: ECSインスタンスが存在しないことを示します。

    • InstanceNotRunning: ECSインスタンスが Running 状態ではないことを示します。

    • CloudAssistNotRunningOnInstance: Cloud Assistant が利用できないことを示します。

    InstanceNotExists

    例

    成功レスポンス

    JSONJSON

    {
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TaskId": "t-*********************",
  "Success": true,
  "InstanceStatuses": [
    {
      "ValidInstance": true,
      "InstanceId": "i-0xi5w***v3j3bh2gj5",
      "ErrorCode": "InstanceNotExists"
    }
  ]
}

    エラーコード

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

    変更履歴

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