ListDatabases API を使用したデータベースクエリ - Bastionhost - Alibaba Cloud - Bastionhost

踏み台ホストで管理されているデータベース群を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-bastionhost:ListDatabases

list

* すべてのリソース

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	文字列	必須	照会対象の踏み台ホストの ID。説明 DescribeInstances API を呼び出して、踏み台ホストの ID を照会できます。	bastionhost-cn-7mz28f5tk0o
RegionId	文字列	任意	照会対象の踏み台ホストのリージョン ID。説明リージョン ID とリージョン名のマッピングの詳細については、「リージョンとゾーン」をご参照ください。	cn-hangzhou
PageNumber	文字列	任意	取得するページの番号。デフォルト値： 1。	1
PageSize	文字列	任意	ページあたりのエントリ数。有効な値： 1～100。デフォルト値： 20。このパラメーターを省略した場合、1ページあたり 20 件のエントリが返されます。説明このパラメーターは省略しないことを推奨します。	20
DatabaseType	文字列	任意	照会対象のデータベースエンジン。有効な値： MySQL Oracle PostgreSQL SQLServer	MySQL
NetworkDomainId	文字列	任意	照会対象のデータベースが属するネットワークドメインの ID。	2
Source	文字列	任意	照会対象のデータベースのタイプ。有効な値： Local：オンプレミスデータベース。 Rds： ApsaraDB for RDS インスタンス。 PolarDB： PolarDB クラスター。	Local
HostGroupId	文字列	任意	照会対象の資産グループの ID。このパラメーターを指定すると、その資産グループ内のデータベースが返されます。説明 ListHostGroups API を呼び出して、資産グループの ID を照会できます。	20

レスポンスフィールド

フィールド	型	説明	例
	object
Databases	array<object>	返されたデータベース。
	object
ActiveAddressType	string	データベースのアドレスタイプ。有効な値： Public Private	Public
Comment	string	データベースの備考。	comment
DatabaseId	string	データベース ID。	9
DatabaseName	string	データベース名。	MySQL0
DatabasePort	integer	データベースのポート。	3306
DatabasePrivateAddress	string	データベースの内部アドレス。値はドメイン名または IP アドレスです。	rm-wz973w7******
DatabasePublicAddress	string	データベースのパブリックアドレス。値はドメイン名または IP アドレスです。	rm-uf65n2******
DatabaseType	string	データベースエンジン。有効な値： MySQL Oracle PostgreSQL SQLServer	MySQL
NetworkDomainId	string	データベースが存在するネットワークドメインの ID。	8
Source	string	データベースのソースタイプ。有効な値： Local：オンプレミスデータベース。 Rds：ApsaraDB for RDS インスタンス。 PolarDB：PolarDB クラスター。	Local
SourceInstanceId	string	ApsaraDB for RDS インスタンスまたは PolarDB クラスターの ID。説明 Source が Local の場合、このパラメーターは返されません。	i-wz9ejupczf41******
SourceInstanceRegionId	string	ApsaraDB for RDS インスタンスまたは PolarDB クラスターのリージョン ID。	cn-hangzhou
SourceInstanceState	string	データベースのステータス。有効な値： Normal Release	Normal
RequestId	string	リクエスト ID。	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
TotalCount	integer	返されたデータベースの総数。	4

例

成功レスポンス

JSONJSON

{
  "Databases": [
    {
      "ActiveAddressType": "Public",
      "Comment": "comment",
      "DatabaseId": "9",
      "DatabaseName": "MySQL0",
      "DatabasePort": 3306,
      "DatabasePrivateAddress": "rm-wz973w7******",
      "DatabasePublicAddress": "rm-uf65n2******",
      "DatabaseType": "MySQL",
      "NetworkDomainId": "8",
      "Source": "Local",
      "SourceInstanceId": "i-wz9ejupczf41******",
      "SourceInstanceRegionId": "cn-hangzhou",
      "SourceInstanceState": "Normal"
    }
  ],
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "TotalCount": 4
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter	The argument is invalid.	引数が無効です。
500	InternalError	An unknown error occurred.	不明なエラーが発生しました。

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

変更履歴

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