すべてのプロダクト
Search

このプロダクト

    :DescribeClients

    ドキュメントセンター

    :DescribeClients

    最終更新日:Dec 23, 2025

    指定された条件を満たす Cloud Backup クライアントを 1 つ以上照会します。

    操作説明

    この操作は SAP HANA バックアップにのみ適用されます。他のデータソースの Cloud Backup クライアントについては、DescribeBackupClients 操作を呼び出してください。

    今すぐお試しください

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

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    VaultId

    string

    任意

    バックアップボールトの ID。

    v-0001vk0z******xdyr
    ClientId

    string

    任意

    Cloud Backup クライアントの ID。

    c-000ed600******6b0
    PageNumber

    integer

    任意

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

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。有効値：1～99。デフォルト値：10。

    10
    ClientType

    string

    任意

    Cloud Backup クライアントのタイプ。有効値：ECS_AGENT。これは SAP HANA バックアップクライアントを示します。

    ECS_AGENT
    SourceType

    string

    任意

    データソースのタイプ。有効値：HANA。これは SAP HANA バックアップを示します。

    HANA
    ClusterId

    string

    任意

    SAP HANA インスタンスの ID。

    cl-0005ni1******2l87
    ResourceGroupId

    string

    任意

    リソースグループの ID。

    rg-acfmw6bxl7o5qyq

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    17189276-465D-5EF3-8FFD-0FF51B5A41A0
    Success

    boolean

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

    • true

    • false

    true
    Code

    string

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

    200
    Message

    string

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

    successful
    PageNumber

    integer

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

    1
    PageSize

    integer

    1 ページあたりのエントリ数。有効値：1～99。デフォルト値：10。

    10
    TotalCount

    integer

    返されたエントリの総数。

    12
    Clients

    object

    Client

    array<object>

    Cloud Backup クライアント。

    object

    クライアント情報。

    Status

    string

    Cloud Backup クライアントのステータス。有効値：

    • REGISTERED：バックアップクライアントは登録済みです。

    • ACTIVATED：バックアップクライアントはアクティブ化済みです。

    • DEACTIVATED：バックアップクライアントのアクティブ化に失敗しました。

    • INSTALLING：バックアップクライアントはインストール中です。

    • INSTALL_FAILED：バックアップクライアントのインストールに失敗しました。

    • NOT_INSTALLED：バックアップクライアントはインストールされていません。

    • UPGRADING：バックアップクライアントはアップグレード中です。

    • UPGRADE_FAILED：バックアップクライアントのアップグレードに失敗しました。

    • UNINSTALLING：バックアップクライアントはアンインストール中です。

    • UNINSTALL_FAILED：バックアップクライアントのアンインストールに失敗しました。

    • STOPPED：バックアップクライアントはサービスを停止しています。

    • UNKNOWN：バックアップクライアントは切断されています。

    ACTIVATED
    VaultId

    string

    バックアップボールトの ID。

    v-00029mx6o******n85lg
    UseHttps

    boolean

    データが HTTPS 経由で送信されるかどうかを示します。有効値：

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

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

    false
    NetworkType

    string

    ネットワークタイプ。有効値：

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

    • VPC：Virtual Private Cloud (VPC)

    VPC
    ClientName

    string

    クライアント名。

    client-20211224-101226
    ClientId

    string

    Cloud Backup クライアントの ID。

    c-00062uu******2fgj
    AlertSetting

    string

    アラート設定。有効値：INHERITED。これは、Cloud Backup クライアントがバックアップボールトに設定されたのと同じメソッドを使用してアラート通知を送信することを示します。

    INHERITED
    InstanceName

    string

    ECS インスタンスの名前。

    swh-hbr
    MaxVersion

    string

    Cloud Backup クライアントの最大バージョン番号。

    1.11.23
    CreatedTime

    integer

    Cloud Backup クライアントが作成された時間。

    1554347313
    StatusMessage

    string

    ステータス情報。

    HANA_NOT_SUPPORT
    ClientType

    string

    Cloud Backup クライアントのタイプ。有効値：ECS_AGENT。これは SAP HANA バックアップクライアントを示します。

    ECS_AGENT
    InstanceId

    string

    インスタンス ID。

    i-wz9b6wya******n8yo
    UpdatedTime

    integer

    Cloud Backup クライアントが更新された時間。この値は UNIX タイムスタンプです。単位：秒。

    1554347313
    ClientVersion

    string

    Cloud Backup クライアントのバージョン番号。

    1.11.16
    ClusterId

    string

    SAP HANA インスタンスの ID。

    cl-0008c48frr******ncpk
    HeartBeatTime

    integer

    Cloud Backup クライアントの最新のハートビート時間。この値は UNIX タイムスタンプです。単位：秒。

    1554347313

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "17189276-465D-5EF3-8FFD-0FF51B5A41A0",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 12,
  "Clients": {
    "Client": [
      {
        "Status": "ACTIVATED",
        "VaultId": "v-00029mx6o******n85lg",
        "UseHttps": false,
        "NetworkType": "VPC",
        "ClientName": "client-20211224-101226",
        "ClientId": "c-00062uu******2fgj",
        "AlertSetting": "INHERITED",
        "InstanceName": "swh-hbr",
        "MaxVersion": "1.11.23",
        "CreatedTime": 1554347313,
        "StatusMessage": "HANA_NOT_SUPPORT",
        "ClientType": "ECS_AGENT",
        "InstanceId": "i-wz9b6wya******n8yo",
        "UpdatedTime": 1554347313,
        "ClientVersion": "1.11.16",
        "ClusterId": "cl-0008c48frr******ncpk",
        "HeartBeatTime": 1554347313
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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