ListDatabases API によるインスタンスデータベースの取得 - Hologres

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

hologram:ListDatabases

list

*All Resource

*

なし

リクエスト構文

GET /api/v1/instances/{instanceId}/listDatabases HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
instanceId	string	任意	インスタンス ID。	hgpostcn-cn-jfj3zckut008

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
external	boolean	任意	外部テーブルのみをリスト表示するかどうかを指定します。このパラメーターを `true` に設定すると、外部テーブルのみがリスト表示されます。このパラメーターを `false` に設定するか、指定しない場合、すべてのテーブルがリスト表示されます。	false

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	0C4935F5-6217-569A-902F-931B2F3E28BA
DatabaseList	array<object>	データベースのリスト。
	object	データベースのリスト。
Name	string	データベース名。	my_db
PermissionModel	string	権限モデル。詳細については、「Hologres 権限モデル」をご参照ください。	SPM
Privilege	string	権限。	developer
External	boolean	テーブルが外部テーブルであるかどうかを示します。`true`: テーブルは外部テーブルです。`false`: テーブルは外部テーブルではありません。	false
Success	string	リクエストが成功したかどうかを示します。	true
ErrorCode	string	エラーコード。	null
ErrorMessage	string	エラーメッセージ。	null
HttpStatusCode	string	HTTP ステータスコード。	200

例

成功レスポンス

JSONJSON

{
  "RequestId": "0C4935F5-6217-569A-902F-931B2F3E28BA",
  "DatabaseList": [
    {
      "Name": "my_db",
      "PermissionModel": "SPM",
      "Privilege": "developer",
      "External": false
    }
  ],
  "Success": "true",
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	NoPermission	RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.

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

変更履歴

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