すべてのプロダクト
Search

このプロダクト

    :UpdateClientSettings

    ドキュメントセンター

    :UpdateClientSettings

    最終更新日:Dec 23, 2025

    HBR クライアントの構成を更新します。

    操作説明

    この操作を呼び出して、新旧両方の HBR クライアントの構成を更新できます。

    今すぐお試しください

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

    update

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    UseHttps

    boolean

    任意

    データプレーンで HTTPS を介してデータを転送するかどうかを指定します。有効な値：

    • true：データは HTTPS 経由で転送されます。

    • false：データは HTTP 経由で転送されます。

    false
    VaultId

    string

    任意

    バックアップボールトの ID。このパラメーターは、古い HBR クライアントに必要です。

    v-*********************
    ClientId

    string

    必須

    HBR クライアントの ID。

    c-*********************
    DataNetworkType

    string

    任意

    データプレーン上のエンドポイントのタイプ。有効な値：

    • PUBLIC：インターネット

    • VPC：VPC

    • CLASSIC：クラシックネットワーク

    VPC
    MaxCpuCore

    integer

    任意

    単一のバックアップジョブで使用される CPU コアの数。値 0 は、数が無制限であることを示します。

    1
    MaxWorker

    integer

    任意

    同時バックアップジョブの数。値 0 は、数が無制限であることを示します。

    1
    DataProxySetting

    string

    任意

    データプレーンのプロキシ構成。有効な値：

    • DISABLE：プロキシは使用されません。

    • USE_CONTROL_PROXY (デフォルト)：設定はコントロールプレーン上の設定と同じです。

    • CUSTOM：設定はカスタマイズされています (HTTP)。

    USE_CONTROL_PROXY
    ProxyHost

    string

    任意

    データプレーン上のプロキシサーバーのカスタムホスト IP アドレス。

    192.168.11.100
    ProxyPort

    integer

    任意

    データプレーン上のプロキシサーバーのカスタムホストポート。

    3128
    ProxyUser

    string

    任意

    データプレーン上のプロキシサーバーのカスタムユーザー名。

    user
    ProxyPassword

    string

    任意

    データプレーン上のプロキシサーバーのカスタムパスワード。

    ******
    ResourceGroupId

    string

    任意

    リソースグループの ID。

    rg-*********************
    MaxMemory

    integer

    任意

    クライアントが使用できる最大メモリ。単位：バイト。V2.13.0 以降のみがサポートされています。

    4096
    AlertOnPartialComplete

    boolean

    任意

    部分的に完了したジョブに対してアラートを生成するかどうかを指定します。このパラメーターは、オンプレミスファイルバックアップと ECS ファイルバックアップに対してのみ有効です。

    false

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Code

    string

    HTTP ステータスコード。ステータスコード 200 は、リクエストが成功したことを示します。

    200
    Message

    string

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

    successful
    RequestId

    string

    リクエスト ID。

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

    boolean

    リクエストが成功したかどうかを示します。有効な値：

    • true

    • false

    true

    例

    成功レスポンス

    JSONJSON

    {
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true
}

    エラーコード

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

    変更履歴

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