更新API 端點。
接口說明
用于更新 API 端點相關(guān)配置信息。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| eventbridge:UpdateApiDestination | update | *ApiDestination acs:eventbridge:{#regionId}:{#accountId}:apidestination/{#ApiDestinationName} |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Description | string | 否 | API 端點描述信息，最大長度 255 個字符。 | demo |
| ApiDestinationName | string | 是 | 需要更新的 API 端點名稱，最大長度 127 個字符。最小長度 2 個字符。 | api-destination-name |
| ConnectionName | string | 否 | 連接配置名稱。最大長度 127 個字符。最小長度 2 個字符。 提示 ： 需要先調(diào)用 Connection 接口創(chuàng)建連接配置，ConnectionName 填寫已存在的連接名稱 | connection-name |
| HttpApiParameters | object | 否 | API 端點的配置信息 | |
| Endpoint | string | 否 | API 端點的接入點地址。最大長度 127 個字符。 | http://127.0.0.1:8001/api |
| Method | string | 否 | HTTP 請求方法。
| POST |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "382E6272-8E9C-5681-AC96-A8AF0BFAC1A5",
"Message": "success",
"Code": "Success",
"ApiDestinationName": "api-destination-name"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 |
|---|---|---|
| 409 | RequestParameterException | Request parameter exception |
| 409 | ApiDestinationNotExist | The api-destination 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 | ConnectionNotExist | The Connection not existed! |
| 500 | InternalError | InternalError |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2023-09-13 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-04-12 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-04-06 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |