すべてのプロダクト
Search

このプロダクト

    :UpdateClientSettings

    ドキュメントセンター

    :UpdateClientSettings

    最終更新日:Aug 06, 2026

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

    操作説明

    レガシクライアントと新規クライアントの両方の更新に適用されます。

    今すぐお試しください

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

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    UseHttps

    boolean

    任意

    データプレーンデータの送信に HTTPS を使用するかどうかを指定します。

    • true: 送信に HTTPS を使用します。

    • false: 送信に HTTP を使用します。

    false
    VaultId

    string

    任意

    バックアップボールトの ID。このパラメーターはレガシクライアントで必須です。

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

    string

    必須

    バックアップクライアントの 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

    任意

    クライアントが使用できるメモリの最大値 (バイト単位)。バージョン 2.13.0 以降のみサポートされています。

    4096
    AlertOnPartialComplete

    boolean

    任意

    部分的に完了したタスクに対してアラートをトリガーするかどうかを指定します。このパラメーターは、ローカルファイルバックアップおよび ECS ファイルバックアップ Basic エディションでのみ効果が適用されます。

    false

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Code

    string

    応答コード。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
}

    エラーコード

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

    変更履歴

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