すべてのプロダクト
Search

このプロダクト

    EventBridge:CreateApiDestination

    ドキュメントセンター

    EventBridge:CreateApiDestination

    最終更新日:Apr 23, 2026

    API 宛先を作成します。

    操作説明

    この API オペレーションを呼び出して、API 宛先を作成できます。

    今すぐお試しください

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

    create

    *ApiDestination

    acs:eventbridge:{#regionId}:{#accountId}:apidestination/{#ApiDestinationName}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ApiDestinationName

    string

    必須

    API 宛先の名前。名前の長さは 2～127 文字である必要があります。

    api-destination-name
    ConnectionName

    string

    必須

    接続の名前。名前の長さは 2～127 文字である必要があります。

    説明

    このパラメーターを設定する前に、CreateConnection オペレーションを呼び出して接続を作成する必要があります。その後、このパラメーターを、作成した接続の名前に設定します。

    connection-name
    Description

    string

    任意

    API 宛先の説明。説明の長さは 255 文字までです。

    This is the description.
    HttpApiParameters

    object

    必須

    API 宛先用に設定されるパラメーター。

    Endpoint

    string

    必須

    API 宛先のエンドポイント。エンドポイントの長さは 127 文字までです。

    http://127.0.0.1:8001/api

    Method

    string

    必須

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

    • GET

    • POST

    • HEAD

    • DELETE

    • PUT

    • PATCH

    POST

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    5DAF96FB-A4B6-548C-B999-0BFDCB22****
    Message

    string

    返されたメッセージ。

    success
    Code

    string

    返された応答コード。値が `Success` の場合、リクエストは成功です。

    Success
    Date

    object

    API 宛先が作成された場合に返されるデータ。

    ApiDestinationName

    string

    API 宛先の名前。

    ApiDestinationName

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "5DAF96FB-A4B6-548C-B999-0BFDCB22****",
  "Message": "success",
  "Code": "Success",
  "Date": {
    "ApiDestinationName": "ApiDestinationName"
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 InternalError InternalError
    409 RequestParameterException Request parameter exception
    409 RequestParameterInvalid The ApiDestination name is invalid! Only letters a~z or A~Z, numbers 0~9, underscore (_) and dash (-) are supported.
    409 ApiDestinationAlreadyExist The api-destination already existed!
    409 ConnectionNotExist The Connection not existed!
    409 HttpApiParametersIsNull HttpApiParameters is null!
    409 EndpointIsBlank Endpoint is blank!
    409 Method Method is blank!
    409 EndpointLengthExceed Endpoint length cannot exceed 127!
    409 ApiDestinationCountExceedLimit The current count of api-destination is [{0}], which will exceed the limit quota.

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

    変更履歴

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