すべてのプロダクト
Search

このプロダクト

    :DescribeBackupClients

    ドキュメントセンター

    :DescribeBackupClients

    最終更新日:Aug 06, 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

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageNumber

    integer

    任意

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

    1
    PageSize

    integer

    任意

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

    10
    ClientType

    string

    必須

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

    列挙値:

    • CONTAINER_CLIENT :

      CONTAINER_CLIENT。

    • LOCAL_CLIENT :

      LOCAL_CLIENT。

    • ECS_CLIENT :

      ECS_CLIENT。

    ECS_CLIENT
    ClusterId

    string

    任意

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

    cl-000ge4wa61b4d337xblq
    ClientIds

    array

    任意

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

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

    string

    任意

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

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

    array

    任意

    ECS インスタンス ID のリスト。

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

    string

    任意

    ECS インスタンスのインスタンス ID。

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

    array<object>

    任意

    返されるタグ情報。

    33738719#

    object

    任意

    タグ情報。

    Key

    string

    任意

    バックアップボールトのタグキー。N の有効な値: 1～20。

    TestKey
    Value

    string

    任意

    バックアップボールトのタグ値。N の有効な値: 1～20。

    TestValue
    CrossAccountType

    string

    任意

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

    CROSS_ACCOUNT
    CrossAccountUserId

    integer

    任意

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

    129374672382xxxx
    CrossAccountRoleName

    string

    任意

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

    ロール
    Filters

    array<object>

    任意

    クエリフィルター。

    object

    任意

    クエリフィルター。

    Key

    string

    任意

    クエリフィルターのキー。

    InstanceId
    Values

    array

    任意

    クエリフィルターで一致させる値。

    string

    任意

    クエリフィルターで一致させる値。

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

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

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

    boolean

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

    true
    Code

    string

    応答コード。200 は成功を示します。

    200
    Message

    string

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

    successful
    PageNumber

    integer

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

    1
    PageSize

    integer

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

    10
    TotalCount

    integer

    指定された条件を満たすバックアップクライアントの総数。

    8
    Clients

    array<object>

    バックアップクライアントのリスト。

    {'Client': []}

    array<object>

    Status

    string

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

    ACTIVATED
    BackupStatus

    string

    バックアップクライアントの保護ステータス。有効な値:

    PROTECTED
    ArchType

    string

    このパラメーターは、ClientType が ECS_CLIENT に設定されている場合にのみ有効です。バックアップクライアントのシステムアーキテクチャー。有効な値:

    amd64
    ClientId

    string

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

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

    string

    バックアップクライアントの最新バージョン番号。

    2.4.5
    PrivateIpV4

    string

    このパラメーターは、ClientType が ECS_CLIENT に設定されている場合にのみ有効です。ECS インスタンスの内部 IP アドレス。

    192.168.1.1
    InstanceName

    string

    このパラメーターは、ClientType が ECS_CLIENT に設定されている場合にのみ有効です。ECS インスタンスの名前。

    インスタンス
    CreatedTime

    integer

    バックアップクライアントが作成された時間。この値は UNIX タイムスタンプです。単位: 秒。

    1554347313
    LastHeartBeatTime

    integer

    バックアップクライアントの最後のハートビートの時間。この値は UNIX タイムスタンプです。単位: 秒。

    1554347313
    ClientType

    string

    バックアップクライアントのタイプ。ECS_CLIENT という値は ECS ファイルバックアップクライアントを示します。

    ECS_CLIENT
    Hostname

    string

    バックアップクライアントのホスト名。

    ホスト名
    InstanceId

    string

    インスタンス ID。

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

    boolean

    クライアントがハードウェアモニタリングアプライアンスクライアントであるかどうかを示します。

    false
    UpdatedTime

    integer

    バックアップクライアントが最後に更新された時間。この値は UNIX タイムスタンプです。単位: 秒。

    1554347313
    OsType

    string

    このパラメーターは、ClientType が ECS_CLIENT に設定されている場合にのみ有効です。クライアントのオペレーティングシステムタイプ。有効な値:

    linux
    ZoneId

    string

    このパラメーターは、ClientType が ECS_CLIENT に設定されている場合にのみ有効です。ゾーンの ID。

    cn-hangzhou-f
    ClientVersion

    string

    バックアップクライアントのバージョン番号。

    2.4.5
    Tags

    array<object>

    タグ情報。

    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

    バックアップクライアントの構成情報。

    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
      }
    }
  ]
}

    エラーコード

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

    変更履歴

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