すべてのプロダクト
Search

このプロダクト

    :DescribeHanaInstances

    ドキュメントセンター

    :DescribeHanaInstances

    最終更新日:Dec 23, 2025

    指定された条件を満たす 1 つ以上の SAP HANA インスタンスをクエリします。

    今すぐお試しください

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

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    VaultId

    string

    任意

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

    v-000b0ov******6zs
    ClusterId

    string

    任意

    SAP HANA インスタンスの ID。

    cl-0001zfc******50pr3
    PageNumber

    integer

    任意

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

    1
    PageSize

    integer

    任意

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

    10
    Tag

    array<object>

    任意

    SAP HANA インスタンスのタグ。

    object

    任意

    SAP HANA インスタンスのタグ。

    Key

    string

    任意

    タグキー。

    ace:rm:rgld
    Value

    string

    任意

    タグ値。

    rg-acfmwutpyat2kwy
    ResourceGroupId

    string

    任意

    リソースグループの ID。

    rg-aekz24ikcjyqjkq

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    4003DD68-3C3C-5071-B4FC-631A6C1BAC1C
    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

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

    21
    Hanas

    object

    Hana

    array<object>

    SAP HANA インスタンスに関する情報。

    array<object>

    SAP HANA インスタンス。

    Status

    integer

    SAP HANA インスタンスのステータス。有効な値：

    • INITIALIZING：インスタンスは初期化中です。

    • INITIALIZED：インスタンスは登録済みです。

    • INVALID_HANA_NODE：インスタンスは無効です。

    • INITIALIZE_FAILED：クライアントのインスタンスへのインストールに失敗しました。

    INITIALIZED
    Host

    string

    SAP HANA インスタンスのプライマリノードが存在するホストのプライベート IP アドレスまたは内部 IP アドレス。

    47.100.XX.XX
    VaultId

    string

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

    v-0000s974******1hl
    UseSsl

    boolean

    SAP HANA インスタンスが Secure Sockets Layer (SSL) 経由で接続されているかどうかを示します。有効な値：

    • true：SAP HANA インスタンスは SSL 経由で接続されています。

    • false：SAP HANA インスタンスは SSL 経由で接続されていません。

    true
    HanaName

    string

    SAP HANA インスタンスの名前。

    HANA-DEV
    InstanceNumber

    integer

    SAP HANA システムのインスタンス番号。

    00
    ValidateCertificate

    boolean

    SAP HANA インスタンスの SSL 証明書が検証されているかどうかを示します。

    false
    AlertSetting

    string

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

    INHERITED
    UserName

    string

    SYSTEMDB データベースのユーザー名。

    admin
    StatusMessage

    string

    ステータス情報。

    INSTALL_CLIENT_FAILED
    ClusterId

    string

    SAP HANA インスタンスの ID。

    cl-0004cf6g6******0yd7y
    Tags

    object

    Tag

    array<object>

    SAP HANA インスタンスのタグ。

    object

    SAP HANA インスタンスのタグ。

    Key

    string

    タグキー。

    ace:rm:rgld
    Value

    string

    タグ値。

    rg-acfmwutpyat2kwy
    ResourceGroupId

    string

    リソースグループ ID。

    rg-acfmvnf22m7itha
    CrossAccountType

    string

    データが同じ Alibaba Cloud アカウント内でバックアップされるか、Alibaba Cloud アカウント間でバックアップされるかを指定します。有効な値：

    • SELF_ACCOUNT：データは同じ Alibaba Cloud アカウント内でバックアップされます。

    • CROSS_ACCOUNT：データは Alibaba Cloud アカウント間でバックアップされます。

    CROSS_ACCOUNT
    CrossAccountUserId

    integer

    現在の Alibaba Cloud アカウントに Alibaba Cloud アカウント間でのデータバックアップを許可するソース Alibaba Cloud アカウントの ID。

    158975xxxxx4625

    CrossAccountRoleName

    string

    ソース Alibaba Cloud アカウント内に作成され、現在の Alibaba Cloud アカウントに割り当てられる Resource Access Management (RAM) ロールの名前。このロールは、現在の Alibaba Cloud アカウントに Alibaba Cloud アカウント間でのデータバックアップを許可します。

    hbrcrossrole

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "4003DD68-3C3C-5071-B4FC-631A6C1BAC1C",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 21,
  "Hanas": {
    "Hana": [
      {
        "Status": 0,
        "Host": "47.100.XX.XX",
        "VaultId": "v-0000s974******1hl",
        "UseSsl": true,
        "HanaName": "HANA-DEV",
        "InstanceNumber": 0,
        "ValidateCertificate": false,
        "AlertSetting": "INHERITED",
        "UserName": "admin",
        "StatusMessage": "INSTALL_CLIENT_FAILED",
        "ClusterId": "cl-0004cf6g6******0yd7y",
        "Tags": {
          "Tag": [
            {
              "Key": "ace:rm:rgld",
              "Value": "rg-acfmwutpyat2kwy"
            }
          ]
        },
        "ResourceGroupId": "rg-acfmvnf22m7itha",
        "CrossAccountType": "CROSS_ACCOUNT",
        "CrossAccountUserId": 0,
        "CrossAccountRoleName": "hbrcrossrole"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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