創建API端點信息。
接口說明
用于創建 API 端點信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| eventbridge:CreateApiDestination | create | *ApiDestination acs:eventbridge:{#regionId}:{#accountId}:apidestination/{#ApiDestinationName} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ApiDestinationName | string | 是 | API 名稱，最大長度 127 個字符。最小長度 2 個字符。 | api-destination-name |
| ConnectionName | string | 是 | 連接配置名稱。最大長度 127 個字符。最小長度 2 個字符。 注意 需要先調用 Connection 接口創建連接配置，ConnectionName 填寫已存在的連接名稱。 | connection-name |
| Description | string | 否 | API 描述，不超過 255 個字符。 | 連接配置描述信息 |
| HttpApiParameters | object | 是 | API 端點的配置信息。 | |
| Endpoint | string | 是 | API 端點的接入點地址。最大長度 127 個字符。 | http://127.0.0.1:8001/api |
| Method | string | 是 | HTTP 請求方法。
| POST |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "5DAF96FB-A4B6-548C-B999-0BFDCB22****",
"Message": "success",
"Code": "Success",
"Date": {
"ApiDestinationName": "ApiDestinationName"
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 |
|---|---|---|
| 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 | RequestParameterInvalid | The connection name length cannot exceed 127. |
| 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 | ApiDestinationAlreadyExist | The api-destination already existed! |
| 409 | ApiDestinationCountExceedLimit | The current count of api-destination is [{0}], which will exceed the limit quota. |
| 500 | InternalError | InternalError |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-09-13 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-04-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-04-06 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |