すべてのプロダクト
Search

このプロダクト

    EventBridge:GetConnection

    ドキュメントセンター

    EventBridge:GetConnection

    最終更新日:Jun 09, 2026

    単一の接続の設定情報をクエリします。

    操作説明

    単一の接続の設定情報をクエリします。

    今すぐお試しください

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

    get

    *Connection

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ConnectionName

    string

    必須

    接続の名前。

    connection-name

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    返されたリクエストID。

    34AD682D-5B91-5773-8132-AA38C130****
    Message

    string

    APIリクエストによって返される情報。

    success
    Code

    string

    APIステータスまたはPOPエラーコード。有効な値: Success: リクエストが成功しました。

    Success
    HttpCode

    integer

    HTTPステータスコード。

    200
    Data

    object

    返される結果。

    Connections

    array<object>

    接続設定情報のリスト。

    array<object>

    接続設定情報のデータ構造。

    ConnectionName

    string

    接続設定の名前。

    demo
    Id

    integer

    データソース ID。

    5668
    Description

    string

    接続設定の説明。

    demo
    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"}
    GmtCreate

    integer

    作成時刻。

    1669648905
    NetworkParameters

    object

    ネットワーク設定のデータ構造。

    NetworkType

    string

    • パブリックネットワーク：PublicNetwork

    • 仮想プライベートクラウド (VPC)：PrivateNetwork

    PublicNetwork
    VpcId

    string

    仮想プライベートクラウド (VPC) の ID。

    eb-test/vpc-bp1symadadwnwg****
    VswitcheId

    string

    vSwitch の ID。

    vsw-bp1iu4x7aeradadown****,vsw-bp193sqmadadlaszpeq****
    SecurityGroupId

    string

    セキュリティグループの ID。

    eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9****
    AuthParameters

    object

    認可のデータ構造。

    AuthorizationType

    string

    認可タイプ。有効な値：

    • BASIC：BASIC_AUTH

    • API KEY：API_KEY_AUTH

    • OAUTH：OAUTH_AUTH

    BASIC_AUTH
    ApiKeyAuthParameters

    object

    API キーのデータ構造。

    ApiKeyName

    string

    API キーのキー。

    key
    ApiKeyValue

    string

    API キーの値。

    value
    BasicAuthParameters

    object

    基本認証のデータ構造。

    Password

    string

    基本認証のパスワード。

    ********
    Username

    string

    基本認証のユーザー名。

    admin
    OAuthParameters

    object

    OAuth リクエストパラメーターのデータ構造。

    AuthorizationEndpoint

    string

    OAuth がトークンを取得するためのエンドポイント。

    http://localhost:8080/oauth/token
    HttpMethod

    string

    HTTP リクエストメソッド。有効な値：

    • GET

    • POST

    • HEAD

    POST
    ClientParameters

    object

    クライアントパラメーターのデータ構造。

    ClientID

    string

    クライアント ID。

    ClientID
    ClientSecret

    string

    アプリケーションのクライアントシークレット。

    Qo57Q~F249~S74GmNPA36pZJoJK4f4****
    OAuthHttpParameters

    object

    OAuth 認証のリクエストパラメーター。

    BodyParameters

    array<object>

    リクエストパラメーターデータ構造のリスト。

    object

    リクエストパラメーターデータ構造のリスト。

    IsValueSecret

    string

    認証に使用するかどうかを指定します。

    false
    Key

    string

    ボディリクエストパラメーターのキー。

    keyDemo
    Value

    string

    ボディリクエストパラメーターの値。

    valueDemo
    HeaderParameters

    array<object>

    リクエストヘッダーパラメーターのリスト。

    object

    リクエストヘッダーパラメーターのリスト。

    IsValueSecret

    string

    認証に使用するかどうかを指定します。

    false
    Key

    string

    リクエストヘッダーパラメーターのキー。

    keyDemo
    Value

    string

    リクエストヘッダーパラメーターの値。

    keyDemo
    QueryStringParameters

    array<object>

    リクエストパスパラメーターのデータ構造。

    object

    リクエストパスパラメーターのデータ構造。

    IsValueSecret

    string

    認証に使用するかどうかを指定します。

    false
    Key

    string

    リクエストパスパラメーターのキー。

    keyDemo
    Value

    string

    リクエストパスパラメーターの値。

    valueDemo

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
  "Message": "success",
  "Code": "Success",
  "HttpCode": 200,
  "Data": {
    "Connections": [
      {
        "ConnectionName": "demo",
        "Id": 5668,
        "Description": "demo",
        "Type": "Http",
        "Parameters": "{\"HostName\":\"xxx.mysql.rds.aliyuncs.com\",\"Port\":\"3306\",\"User\":\"root\",\"Password\":\"xxx\",\"DatabaseName\":\"demo_db\"}",
        "GmtCreate": 1669648905,
        "NetworkParameters": {
          "NetworkType": "PublicNetwork",
          "VpcId": "eb-test/vpc-bp1symadadwnwg****",
          "VswitcheId": "vsw-bp1iu4x7aeradadown****,vsw-bp193sqmadadlaszpeq****",
          "SecurityGroupId": "eb-167adad548759-security_grop/sg-bp1addad26peuh9qh9****"
        },
        "AuthParameters": {
          "AuthorizationType": "BASIC_AUTH",
          "ApiKeyAuthParameters": {
            "ApiKeyName": "key",
            "ApiKeyValue": "value"
          },
          "BasicAuthParameters": {
            "Password": "********",
            "Username": "admin"
          },
          "OAuthParameters": {
            "AuthorizationEndpoint": "http://localhost:8080/oauth/token",
            "HttpMethod": "POST",
            "ClientParameters": {
              "ClientID": "ClientID",
              "ClientSecret": "Qo57Q~F249~S74GmNPA36pZJoJK4f4****"
            },
            "OAuthHttpParameters": {
              "BodyParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "keyDemo",
                  "Value": "valueDemo"
                }
              ],
              "HeaderParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "keyDemo",
                  "Value": "keyDemo"
                }
              ],
              "QueryStringParameters": [
                {
                  "IsValueSecret": "false",
                  "Key": "keyDemo",
                  "Value": "valueDemo"
                }
              ]
            }
          }
        }
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 InternalError 内部エラー
    409 RequestParameterException リクエストパラメーター例外
    409 ConnectionNotExist 接続名が存在しません。

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

    変更履歴

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