全部產品
Search

搜尋本產品

    EventBridge：ListApiDestinations - 擷取API 端點列表

    文件中心

    EventBridge：ListApiDestinations - 擷取API 端點列表

    更新時間：Dec 23, 2025

    擷取API 端點列表資訊。

    介面說明

    用於擷取 API 端點列表資訊。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    eventbridge:ListApiDestinations

    list

    *ApiDestination

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ApiDestinationNamePrefix

    string

    否

    API 端點名稱首碼。

    api-demo
    ConnectionName

    string

    否

    串連配置名稱。

    connection-name
    MaxResults

    integer

    否

    限定每次返回的最大條數，可以和 nextToken 搭配使用實現翻頁能力。

    預設值是 10。

    10
    NextToken

    string

    否

    當指定 MaxResults 時，如果還有多餘的傳回值則會返回 NextToken。

    NextToken 值預設是從 0 開始計算的，預設值是 0。

    0

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID，阿里雲為該請求產生的唯一識別碼。

    96D7C0AB-DCE5-5E82-96B8-4725E170****
    Message

    string

    附加資訊。取值說明如下：請求正常，返回 success。 請求異常，返回具體異常錯誤碼。

    success
    Code

    string

    介面狀態或 POP 錯誤碼。取值說明如下：Success：成功。

    Success
    Data

    object

    返回的結果。

    ApiDestinations

    array<object>

    API 端點結果集。

    array<object>

    API 端點資料結構。

    ApiDestinationName

    string

    API 端點名稱。

    api-destination-2
    ConnectionName

    string

    串連配置名稱。

    connection-name
    Description

    string

    串連配置描述資訊。

    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

    建立時間。

    1665223213000
    NextToken

    string

    如果還有多餘的傳回值則會返回 NextToken。

    1
    Total

    number

    總條數。

    2
    MaxResults

    number

    限定每次返回的最大條數。

    10

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "96D7C0AB-DCE5-5E82-96B8-4725E170****",
  "Message": "success",
  "Code": "Success",
  "Data": {
    "ApiDestinations": [
      {
        "ApiDestinationName": "api-destination-2",
        "ConnectionName": "connection-name",
        "Description": "demo",
        "HttpApiParameters": {
          "Endpoint": "http://127.0.0.1:8001/api",
          "Method": "POST"
        },
        "GmtCreate": 1665223213000
      }
    ],
    "NextToken": "1",
    "Total": 2,
    "MaxResults": 10
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    500 InternalError InternalError
    409 RequestParameterException Request parameter exception

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。