すべてのプロダクト
Search

このプロダクト

    :DescribeBackupClients

    ドキュメントセンター

    :DescribeBackupClients

    最終更新日:Jun 10, 2026

    指定された条件に一致する 1 つ以上のバックアップクライアントの情報を照会します。

    今すぐお試しください

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

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageNumber

    integer

    任意

    ページ番号。ページは 1 から始まります。デフォルト値: 1。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。最小値: 1。最大値: 99。デフォルト値: 10。

    10
    ClientType

    string

    必須

    バックアップクライアントのタイプ。有効な値:

    • ECS_CLIENT: ECS ファイルバックアップクライアント。

    • CONTAINER_CLIENT: コンテナバックアップクライアント。

    • LOCAL_CLIENT: オンプレミス NAS バックアップ、CPFS バックアップ、アーカイブ、またはデータ同期クライアント。

    列挙値:

    • CONTAINER_CLIENT :

      CONTAINER_CLIENT。

    • LOCAL_CLIENT :

      LOCAL_CLIENT。

    • ECS_CLIENT :

      ECS_CLIENT。

    ECS_CLIENT
    ClusterId

    string

    任意

    バックアップクラスターの ID。

    cl-000ge4wa61b4d337xblq
    ClientIds

    array

    任意

    バックアップクライアントの ID。

    ["c-*********************"]

    string

    任意

    The ID of the backup client.

    c-*********************
    InstanceIds

    array

    任意

    ECS インスタンスの ID。

    ["i-*********************"]

    string

    任意

    The ID of the ECS instance.

    i-*********************
    Tag

    array<object>

    任意

    返されるタグ情報。

    33738719#

    object

    任意

    The tag information.

    Key

    string

    任意

    The tag key of the backup vault. N ranges from 1 to 20.

    • The tag key cannot start with aliyun or acs:.

    • The tag key cannot contain http:// or https://.

    • The tag key cannot be an empty string.

    TestKey
    Value

    string

    任意

    The tag value of the backup vault. N ranges from 1 to 20.

    • The tag value cannot start with aliyun or acs:.

    • The tag value cannot contain http:// or https://.

    • The tag value cannot be an empty string.

    TestValue
    CrossAccountType

    string

    任意

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

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

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

    CROSS_ACCOUNT
    CrossAccountUserId

    integer

    任意

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

    129374672382xxxx
    CrossAccountRoleName

    string

    任意

    クロスアカウントバックアップ用に元のアカウントの RAM で作成されたロールの名前。

    hbrcrossrole
    Filters

    array<object>

    任意

    クエリフィルター。

    object

    任意

    The query filter.

    Key

    string

    任意

    The key of the query filter.

    InstanceId
    Values

    array

    任意

    The values to be matched in the query filter.

    string

    任意

    The value to be matched in the query filter.

    i-*********************

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    The ID of the request.

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

    boolean

    Indicates whether the request is successful. Valid values:

    • true: The request is successful.

    • false: The request fails.

    true
    Code

    string

    The response code. The value 200 indicates that the request is successful.

    200
    Message

    string

    The returned message. If the request is successful, successful is returned. If the request fails, an error message is returned.

    successful
    PageNumber

    integer

    The page number. Pages start from page 1. Default value: 1.

    1
    PageSize

    integer

    The number of entries per page. Minimum value: 1. Maximum value: 99. Default value: 10.

    10
    TotalCount

    integer

    The total number of backup clients that meet the specified conditions.

    8
    Clients

    array<object>

    The list of backup clients.

    {'Client': []}

    array<object>

    Status

    string

    The status of the backup client. Valid values:

    • REGISTERED: The client is registered.

    • ACTIVATED: The client is activated.

    • DEACTIVATED: The client is deactivated.

    • INSTALLING: The client is being installed.

    • INSTALL_FAILED: The client failed to be installed.

    • NOT_INSTALLED: The client is not installed.

    • UPGRADING: The client is being upgraded.

    • UPGRADE_FAILED: The client failed to be upgraded.

    • UNINSTALLING: The client is being uninstalled.

    • UNINSTALL_FAILED: The client failed to be uninstalled.

    • STOPPED: The client service is stopped.

    • UNKNOWN: The client is disconnected.

    ACTIVATED
    BackupStatus

    string

    The protection status of the backup client. Valid values:

    • UNPROTECTED: The server is not protected.

    • PROTECTED: The server is protected.

    PROTECTED
    ArchType

    string

    This parameter is valid only if ClientType is set to ECS_CLIENT. The parameter indicates the system architecture of the backup client. Valid values:

    • amd64

    • 386

    amd64
    ClientId

    string

    The ID of the backup client.

    c-*********************
    MaxClientVersion

    string

    The latest version of the backup client.

    2.4.5
    PrivateIpV4

    string

    This parameter is valid only if ClientType is set to ECS_CLIENT. The parameter indicates the internal IP address of the ECS instance.

    192.168.1.1
    InstanceName

    string

    This parameter is valid only if ClientType is set to ECS_CLIENT. The parameter indicates the name of the ECS instance.

    instancename
    CreatedTime

    integer

    The time when the backup client was created. The value is a UNIX timestamp. Unit: seconds.

    1554347313
    LastHeartBeatTime

    integer

    The time of the last heartbeat of the backup client. The value is a UNIX timestamp. Unit: seconds.

    1554347313
    ClientType

    string

    The type of the backup client. The value ECS_CLIENT indicates an ECS file backup client.

    ECS_CLIENT
    Hostname

    string

    The name of the host on which the backup client resides.

    hostname
    InstanceId

    string

    The instance ID.

    • If the client type is ECS file backup client, the value indicates the ID of the ECS instance.

    • If the client type is on-premises file backup client, the value indicates a hardware fingerprint that is generated based on system information.

    i-*********************
    Appliance

    boolean

    Indicates whether the client is a hardware monitoring appliance client.

    • true: The client is a hardware monitoring appliance client.

    • false: The client is not a hardware monitoring appliance client.

    false
    UpdatedTime

    integer

    The time when the backup client was updated. The value is a UNIX timestamp. Unit: seconds.

    1554347313
    OsType

    string

    This parameter is valid only if ClientType is set to ECS_CLIENT. The parameter indicates the operating system type of the client. Valid values:

    • windows

    • linux

    linux
    ZoneId

    string

    This parameter is valid only if ClientType is set to ECS_CLIENT. The parameter indicates the region.

    cn-hangzhou-f
    ClientVersion

    string

    The version of the backup client.

    2.4.5
    Tags

    array<object>

    The tag information.

    object

    Key

    string

    The tag key of the backup vault. Valid values of N: 1 to 20

    • The tag key cannot start with aliyun or acs:.

    • The tag key cannot contain http:// or https://.

    • The tag key cannot be an empty string.

    TestKey
    Value

    string

    The tag value of the backup vault. Valid values of N: 1 to 20

    • The tag value cannot start with aliyun or acs:.

    • The tag value cannot contain http:// or https://.

    • The tag value cannot be an empty string.

    TestValue
    Settings

    object

    The configuration information of the backup client.

    ProxyHost

    string

    The custom host IP address of the proxy server on the data plane.

    192.168.11.100
    MaxCpuCore

    string

    The number of CPU cores used by a single backup job. The value 0 indicates that the number is unlimited.

    1
    ProxyPort

    integer

    The custom host port of the proxy server on the data plane.

    3128
    UseHttps

    string

    Indicates whether data on the data plane is transmitted over HTTPS. Valid values:

    • true: Data is transmitted over HTTPS.

    • false: Data is transmitted over HTTP.

    false
    ProxyPassword

    string

    The custom password of the proxy server on the data plane.

    ******
    ProxyUser

    string

    The custom username of the proxy server on the data plane.

    user
    DataProxySetting

    string

    The proxy configuration on the data plane. Valid values:

    • DISABLE: The proxy is not used.

    • USE_CONTROL_PROXY (default): The configuration is the same as that on the control plane.

    • CUSTOM: The configuration is customized (HTTP).

    USE_CONTROL_PROXY
    DataNetworkType

    string

    The type of the endpoint on the data plane. Valid values:

    • PUBLIC: Internet

    • VPC: virtual private cloud (VPC)

    • CLASSIC: classic network

    VPC
    MaxWorker

    string

    The number of concurrent backup jobs. The value 0 indicates that the number is unlimited.

    1
    MaxMemory

    integer

    The maximum memory that can be used by the client. Unit: bytes. Only V2.13.0 and later are supported.

    0
    AlertOnPartialComplete

    boolean

    Indicates whether alerts are generated for partially completed jobs. This parameter is valid only for on-premises file backup and ECS file backup.

    false

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 8,
  "Clients": [
    {
      "Status": "ACTIVATED",
      "BackupStatus": "PROTECTED",
      "ArchType": "amd64",
      "ClientId": "c-*********************",
      "MaxClientVersion": "2.4.5",
      "PrivateIpV4": "192.168.1.1",
      "InstanceName": "instancename",
      "CreatedTime": 1554347313,
      "LastHeartBeatTime": 1554347313,
      "ClientType": "ECS_CLIENT",
      "Hostname": "hostname",
      "InstanceId": "i-*********************",
      "Appliance": false,
      "UpdatedTime": 1554347313,
      "OsType": "linux",
      "ZoneId": "cn-hangzhou-f",
      "ClientVersion": "2.4.5",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "Settings": {
        "ProxyHost": "192.168.11.100",
        "MaxCpuCore": "1",
        "ProxyPort": 3128,
        "UseHttps": "false",
        "ProxyPassword": "******",
        "ProxyUser": "user",
        "DataProxySetting": "USE_CONTROL_PROXY",
        "DataNetworkType": "VPC",
        "MaxWorker": "1",
        "MaxMemory": 0,
        "AlertOnPartialComplete": false
      }
    }
  ]
}

    エラーコード

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

    変更履歴

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