DescribeHanaDatabases を使用した SAP HANA データベースの取得 - Cloud Backup

SAP HANA データベースの情報を照会します。

操作説明

SAP HANA インスタンスを登録し、そのインスタンスに Cloud Backup クライアントをインストールした後、この操作を呼び出して SAP HANA データベースの情報を照会できます。StartHanaDatabaseAsync 操作を呼び出してデータベースを起動し、StopHanaDatabaseAsync 操作を呼び出してデータベースを停止できます。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
VaultId	string	任意	バックアップボールトの ID です。	v-00063fq******8xjr
ClusterId	string	必須	SAP HANA インスタンスの ID です。	cl-000hpc******uv14x
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。デフォルト値：1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。有効値：1～99。デフォルト値：10。	10
ResourceGroupId	string	任意	リソースグループの ID です。	rg-acfmw2azsegupmi

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID です。	DAAB6A29-34EB-5F56-962F-D5BDBFE8A5C2
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	返されたエントリの総数です。	10
HanaDatabases	object
HanaDatabase	array<object>	SAP HANA データベースの情報です。
	object	SAP HANA データベースの情報です。
Host	string	ホスト名です。	izbp1jbf3zy******antqmz
SqlPort	integer	ポート番号です。	30013
DatabaseName	string	データベース名です。	SYSTEMDB
ServiceName	string	サービス名です。	indexserver
ActiveStatus	string	データベースが起動しているかどうかを示します。有効な値： YES：データベースは起動しています。 NO：データベースは起動していません。	YES
Detail	string	詳細情報です。	master

例

成功レスポンス

JSONJSON

{
  "RequestId": "DAAB6A29-34EB-5F56-962F-D5BDBFE8A5C2",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 10,
  "HanaDatabases": {
    "HanaDatabase": [
      {
        "Host": "izbp1jbf3zy******antqmz",
        "SqlPort": 30013,
        "DatabaseName": "SYSTEMDB",
        "ServiceName": "indexserver",
        "ActiveStatus": "YES",
        "Detail": "master"
      }
    ]
  }
}

エラーコード

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

変更履歴

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