すべてのプロダクト
Search

このプロダクト

    EventBridge:GetApiDestination

    ドキュメントセンター

    EventBridge:GetApiDestination

    最終更新日:Dec 23, 2025

    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:GetApiDestination

    get

    *ApiDestination

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ApiDestinationName

    string

    必須

    API 宛先の名前。

    api-destination-name

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    B896B484-F16D-59DE-9E23-DD0E5C361108
    Message

    string

    返されるメッセージ。リクエストが成功した場合、「success」が返されます。リクエストが失敗した場合、エラーコードが返されます。

    success
    Code

    string

    返されるレスポンスコード。値が「Success」の場合、リクエストが成功したことを示します。

    Success
    Data

    object

    返されるデータ。

    ApiDestinationName

    string

    API 宛先の名前。

    demo
    ConnectionName

    string

    接続名。

    test-basic
    Description

    string

    API 宛先の説明。

    demo
    HttpApiParameters

    object

    API 宛先に設定されているリクエストパラメーター。

    Endpoint

    string

    API 宛先のエンドポイント。

    http://127.0.0.1:8001/api

    Method

    string

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

    • POST

    • GET

    • DELETE

    • PUT

    • HEAD

    • TRACE

    • PATCH

    POST
    GmtCreate

    integer

    API 宛先が作成された時間。

    1649055710565

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "B896B484-F16D-59DE-9E23-DD0E5C361108",
  "Message": "success",
  "Code": "Success",
  "Data": {
    "ApiDestinationName": "demo",
    "ConnectionName": "test-basic",
    "Description": "demo",
    "HttpApiParameters": {
      "Endpoint": "http://127.0.0.1:8001/api\n",
      "Method": "POST"
    },
    "GmtCreate": 1649055710565
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 InternalError InternalError
    409 RequestParameterException Request parameter exception
    409 ApiDestinationNotExist The api-destination not existed!

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

    変更履歴

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