ListConnections API の呼び出しによる接続クエリ - EventBridge - Alibaba Cloud - EventBridge

接続設定のリストを照会します。

操作説明

Queries the list of connection configurations.

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

eventbridge:ListConnections

get

*Connection

acs:eventbridge:{#regionId}:{#accountId}:connection/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ConnectionNamePrefix	string	任意	クエリする接続設定の名前プレフィックス。プレフィックス一致をサポートします。	connection-name
Type	string	任意	接続タイプでクエリ結果をフィルタリングします。有効な値: Http、MySQL、PostgreSQL、Elasticsearch。空のままにすると、すべてのタイプの接続が返されます。	Http
MaxResults	integer	任意	各ページに返すエントリの最大値。NextToken と組み合わせて使用することで、ページネーションを実装できます。デフォルト値: 10。	10
NextToken	string	任意	MaxResults が指定されている場合、フェッチする結果がさらにあると NextToken が返されます。 NextToken はデフォルトで 0 から始まります。デフォルト値: 0。	0

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	Common parameter. The ID of each request is unique and can be used for troubleshooting and issue locating.	E3619976-8714-5D88-BBA2-6983D798A8BB
Message	string	The returned message.	success
Code	string	The API status or POP error code. Valid values: Success: The request was successful.	Success
Data	object	The list of returned connection configurations.
Connections	array<object>	The list of returned connection configurations.
	array<object>	The data structure of a returned connection configuration.
ConnectionName	string	接続構成の名前です。	connection-name
Description	string	接続構成の説明です。	Description of the connection configuration
Type	string	接続タイプです。有効な値: Http、MySQL、PostgreSQL、Elasticsearch。	Http
Parameters	any	データソース接続パラメーター（JSON オブジェクト）です。データソースタイプの接続に対してのみ返され、Http タイプの場合は空になります。フィールド定義については、GetConnectionType が返す ParamsSchema を参照してください。	{"HostName":"xxx.mysql.rds.aliyuncs.com","Port":"3306","User":"root","Password":"xxx","DatabaseName":"demo_db"}
Id	integer	接続構成の ID です。	1141093
GmtCreate	integer	データソースが作成されたタイムスタンプです。	1592838994234
NetworkParameters	object	ネットワーク構成のデータ構造です。
NetworkType	string	パブリックネットワーク: PublicNetwork Virtual Private Cloud (VPC): PrivateNetwork	PublicNetwork
VpcId	string	Virtual Private Cloud (VPC) の ID です。	eb-test/vpc-bp1symadadwnwgmqud
VswitcheId	string	vSwitch の ID です。	vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeqbt2c
SecurityGroupId	string	セキュリティグループの ID です。	eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9rtyb
AuthParameters	object	認証のデータ構造です。
AuthorizationType	string	認証タイプ: BASIC: BASIC_AUTH API KEY: API_KEY_AUTH OAUTH: OAUTH_AUTH	BASIC_AUTH
ApiKeyAuthParameters	object	API KEY のデータ構造です。
ApiKeyName	string	API キーのキーです。	Token
ApiKeyValue	string	API キーの値です。	asdkjnqkwejooa
BasicAuthParameters	object	Basic 認証のデータ構造です。
Password	string	Basic 認証のパスワードです。	admin
Username	string	Basic 認証のユーザー名です。	admin
OAuthParameters	object	OAuth リクエストパラメーターのデータ構造です。
AuthorizationEndpoint	string	OAuth トークンリクエストの送信先エンドポイントです。	http://localhost:8080/oauth/token
HttpMethod	string	プローブタイプのメソッドです。有効な値: GET POST HEAD	POST
ClientParameters	object	クライアントパラメーターのデータ構造です。
ClientID	string	クライアント ID です。	ClientID
ClientSecret	string	アプリケーションのクライアントシークレットです。	ClientSecret
OAuthHttpParameters	object	OAuth 認証のリクエストパラメーターです。
BodyParameters	array<object>	リクエストパラメーターのデータ構造のリストです。
	object	ボディリクエストパラメーターのデータ構造です。
IsValueSecret	string	認証に使用されるかどうかを示します。	false
Key	string	ボディリクエストパラメーターのキーです。	name
Value	string	ボディリクエストパラメーターの値です。	demo
HeaderParameters	array<object>	リクエストヘッダーパラメーターのリストです。
	object	リクエストヘッダーパラメーターのデータ構造です。
IsValueSecret	string	認証に使用されるかどうかを示します。	false
Key	string	リクエストヘッダーパラメーターのキーです。	name
Value	string	リクエストヘッダーパラメーターの値です。	demo
QueryStringParameters	array<object>	クエリ文字列パラメーターのデータ構造です。
	object	クエリ文字列パラメーターのエンティティクラスです。
IsValueSecret	string	認証に使用されるかどうかを示します。	false
Key	string	クエリ文字列パラメーターのキーです。	name
Value	string	クエリ文字列パラメーターの値です。	demo
NextToken	string	If there are more results to fetch, NextToken is returned.	0
Total	number	The total number of entries.	1
MaxResults	number	The page size.	10

例

成功レスポンス

JSONJSON

{
  "RequestId": "E3619976-8714-5D88-BBA2-6983D798A8BB",
  "Message": "success",
  "Code": "Success",
  "Data": {
    "Connections": [
      {
        "ConnectionName": "connection-name",
        "Description": "Description of the connection configuration",
        "Type": "Http",
        "Parameters": "{\"HostName\":\"xxx.mysql.rds.aliyuncs.com\",\"Port\":\"3306\",\"User\":\"root\",\"Password\":\"xxx\",\"DatabaseName\":\"demo_db\"}",
        "Id": 1141093,
        "GmtCreate": 1592838994234,
        "NetworkParameters": {
          "NetworkType": "PublicNetwork",
          "VpcId": "eb-test/vpc-bp1symadadwnwgmqud",
          "VswitcheId": "vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeqbt2c",
          "SecurityGroupId": "eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9rtyb"
        },
        "AuthParameters": {
          "AuthorizationType": "BASIC_AUTH",
          "ApiKeyAuthParameters": {
            "ApiKeyName": "Token",
            "ApiKeyValue": "asdkjnqkwejooa"
          },
          "BasicAuthParameters": {
            "Password": "admin",
            "Username": "admin"
          },
          "OAuthParameters": {
            "AuthorizationEndpoint": "http://localhost:8080/oauth/token",
            "HttpMethod": "POST",
            "ClientParameters": {
              "ClientID": "ClientID",
              "ClientSecret": "ClientSecret"
            },
            "OAuthHttpParameters": {
              "BodyParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "name",
                  "Value": "demo"
                }
              ],
              "HeaderParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "name",
                  "Value": "demo"
                }
              ],
              "QueryStringParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "name",
                  "Value": "demo"
                }
              ]
            }
          }
        }
      }
    ],
    "NextToken": "0",
    "Total": 1,
    "MaxResults": 10
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	InternalError	InternalError
409	RequestParameterException	リクエストパラメーター例外

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

変更履歴

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