查詢單個API 端點資訊。
介面說明
用於查詢單個 API 端點資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
eventbridge:GetApiDestination |
get |
*ApiDestination
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ApiDestinationName |
string |
是 |
API 端點名稱 |
api-destination-name |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
阿里雲為該請求產生的唯一識別碼。 |
B896B484-F16D-59DE-9E23-DD0E5C361108 |
| Message |
string |
附加資訊。取值說明如下:請求正常,返回 success。 請求異常,返回具體異常錯誤碼。 |
success |
| Code |
string |
介面狀態或 POP 錯誤碼。取值說明如下: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 |
| GmtCreate |
integer |
建立時間。 |
1649055710565 |
樣本
正常返回樣本
JSON格式
{
"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 status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 500 | InternalError | InternalError | |
| 409 | RequestParameterException | Request parameter exception | |
| 409 | ApiDestinationNotExist | The api-destination not existed! |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。