すべてのプロダクト
Search

このプロダクト

    EventBridge:CreateConnection

    ドキュメントセンター

    EventBridge:CreateConnection

    最終更新日:Jun 29, 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:CreateConnection

    create

    *Connection

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ConnectionName

    string

    必須

    接続設定名。最大長: 127 文字。最小長: 2 文字。

    connection-name
    Description

    string

    任意

    接続設定の説明。最大長: 255 文字。

    demo
    NetworkParameters

    object

    必須

    ネットワーク構成。

    NetworkType

    string

    必須

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

    • 仮想非公開クラウド (VPC): PrivateNetwork

    重要 PrivateNetwork を選択した場合、VpcId、VswitcheId、および SecurityGroupId は必須です。

    PublicNetwork
    VpcId

    string

    任意

    VPC の ID。

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

    string

    任意

    vSwitch の ID。

    vsw-bp1iu4x7aeradadown1og8,vsw-bp193sqmadadlaszpeq****
    SecurityGroupId

    string

    任意

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

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

    string

    任意

    接続タイプ。有効な値: MySQL、PostgreSQL、Elasticsearch、および Http。このパラメーターはデータソース接続に必須です。このパラメーターが指定されていない場合、デフォルト値 Http が使用されます。Http タイプは API 宛先などの HTTP プロトコルターゲットに使用されます。データソースタイプは統合マーケットプレイスのデータ接続に使用されます。

    Http
    Parameters

    any

    任意

    データソース接続パラメーター (JSON オブジェクト)。Type がデータソースタイプに設定されている場合、このパラメーターは必須です。Http タイプの場合、このパラメーターは不要です。具体的なフィールド定義については、GetConnectionType 操作を呼び出し、応答の ParamsSchema を参照してください。

    {"HostName":"xxx.mysql.rds.aliyuncs.com","Port":"3306","User":"root","Password":"xxx","DatabaseName":"demo_db"}
    AuthParameters

    object

    任意

    認証構成。

    AuthorizationType

    string

    任意

    認証方式:

    • BASIC: BASIC_AUTH。この権限付与メソッドは、HTTP プロトコルへのコンプライアンスに基づきブラウザが実装する基本的な権限付与メソッドです。HTTP 通信において、HTTP プロトコルはクライアントを認証するための基本認証メソッドを定義しています。リクエストヘッダーに Authorization: Basic Base64Encoded(username:password) を固定フォーマットで追加します。ユーザー名と Password は必須です。

    • API KEY: API_KEY_AUTH。リクエストヘッダーに Token: TokenValue を固定フォーマットで追加します。ApiKeyName と ApiKeyValue は必須です。

    • OAUTH: OAUTH_AUTH。OAuth 2.0 は権限付与メカニズムです。OAuth 2.0 などの権限付与メカニズムを使用しないシステムでは、クライアントはリソースサーバー上のリソースに直接アクセスできます。安全なデータアクセスを確保するために、アクセストークンメカニズムが追加されています。クライアントは保護されたリソースにアクセスするためにアクセストークンを携帯する必要があります。OAuth 2.0 は悪意のあるクライアントによるリソースへのアクセスを防止し、システムのセキュリティを向上させます。AuthorizationEndpoint、OAuthHttpParameters、および HttpMethod は必須です。

    BASIC_AUTH
    ApiKeyAuthParameters

    object

    任意

    API キー認証構成。

    ApiKeyName

    string

    任意

    API キーのキー名。

    Token
    ApiKeyValue

    string

    任意

    API キーの値。

    adkjnakddh****
    BasicAuthParameters

    object

    任意

    基本認証構成。

    Password

    string

    任意

    基本認証のパスワード。

    *******
    Username

    string

    任意

    基本認証のユーザー名。

    admin
    OAuthParameters

    object

    任意

    OAuth 認証構成。

    AuthorizationEndpoint

    string

    任意

    権限付与エンドポイント URL。最大長: 127 文字。

    http://localhost:8080/oauth/token
    ClientParameters

    object

    任意

    クライアントパラメーター構成。

    ClientID

    string

    任意

    クライアント ID。

    ClientID
    ClientSecret

    string

    任意

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

    Qo57Q~F249~S74GmNPA36pZJoJK4f4LY****
    HttpMethod

    string

    任意

    HTTP メソッド。有効な値:

    • GET

    • POST

    • HEAD

    • DELETE

    • PUT

    • PATCH

    POST
    OAuthHttpParameters

    object

    任意

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

    BodyParameters

    array<object>

    任意

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

    object

    任意

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

    IsValueSecret

    string

    任意

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

    false
    Key

    string

    任意

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

    keyDemo
    Value

    string

    任意

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

    keyValue
    HeaderParameters

    array<object>

    任意

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

    object

    任意

    ヘッダーパラメーターのデータ構造。

    IsValueSecret

    string

    任意

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

    false
    Key

    string

    任意

    ヘッダーパラメーターのキー。

    keyDemo
    Value

    string

    任意

    ヘッダーパラメーターの値。

    keyValue
    QueryStringParameters

    array<object>

    任意

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

    object

    任意

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

    IsValueSecret

    string

    任意

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

    false
    Key

    string

    任意

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

    keyDemo
    Value

    string

    任意

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

    valueDemo

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    このリクエストに対して Alibaba Cloud が生成したリクエスト ID。

    7DA60DED-CD36-5837-B848-C01A23D2****
    Message

    string

    追加情報。リクエストが成功した場合、success が返されます。リクエストが失敗した場合、具体的なエラーコードが返されます。フォーマット: コード:メッセージ。

    success
    Code

    string

    API ステータスまたは POP エラーコード。有効な値: Success。

    Success
    Data

    object

    返された結果。

    ConnectionName

    string

    接続設定名。

    connection-demo

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "7DA60DED-CD36-5837-B848-C01A23D2****",
  "Message": "success",
  "Code": "Success",
  "Data": {
    "ConnectionName": "connection-demo"
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 InternalError InternalError
    409 RequestParameterException Request parameter exception
    409 ConnectionAlreadyExist The Connection already existed!
    409 ConnectionCountExceedLimit The current count of connection, which will exceed the limit quota.
    409 BasicRequiredParameterIsEmpty Basic required parameters are empty, the required parameters are username and password!
    409 BasicUserNameLengthExceed Basic username length cannot exceed 127!
    409 BasicPassWordLengthExceed Basic password length cannot exceed 127!
    409 ApiKeyRequiredParameterIsEmpty Api Key required parameters are empty, the required parameters are apiKeyName and apiKeyValue!
    409 ApiKeyNameLengthExceed Api key name length cannot exceed 127!
    409 ApiKeyValueLengthExceed Api key value length cannot exceed 127!
    409 OAuthRequiredParameterIsEmpty OAuth required parameters are empty, the required parameters are authorizationEndpoint and httpMethod!
    409 AuthorizationEndpointLengthExceed Authorization endpoint length cannot exceed 127!
    409 ClientIDLengthExceed ClientID length cannot exceed 127!
    409 ClientSecretLengthExceed ClientSecret length cannot exceed 127!
    409 OauthHttpParametersEmpty OauthHttpParameters is Empty.
    409 SecretManagerAPICreateSecretNameFailed Create secret manager api secret name failed

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

    変更履歴

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