更新HTTP API。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| apig:UpdateHttpApi | update | *HttpApi acs:apig:{#regionId}:{#accountId}:httpapi/{#HttpApiId} |
| 無 |
請求語法
PUT /v1/http-apis/{httpApiId} HTTP/1.1
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| httpApiId | string | 是 | 待更新的 HTTP API ID。 | api-xxx |
| body | object | 否 | 請求體參數。 | |
| description | string | 否 | API 描述。 | 更新API描述 |
| protocols | array | 否 | API 訪問協議列表。 | |
| string | 否 | API 訪問協議。 | HTTP | |
| basePath | string | 是 | API 基礎路徑，需要以/開頭。 | /v1 |
| versionConfig | HttpApiVersionConfig | 否 | API 版本化配置。 | |
| ingressConfig | object | 否 | HTTP Ingress API 的配置信息。 | |
| environmentId | string | 否 | 環境 ID。 | env-cr6ql0tlhtgmc**** |
| sourceId | string | 否 | 來源 ID。 | src-crdddallhtgtr**** |
| ingressClass | string | 否 | 監聽的 Ingress Class。 | mse |
| watchNamespace | string | 否 | 監聽的命名空間 | default |
| overrideIngressIp | boolean | 否 | 是否更新 Ingress Status 里的地址。 | false |
| aiProtocols | array | 否 | AI 協議列表。 | |
| string | 否 | AI 協議。 枚舉值：
| OpenAI/v1 | |
| deployConfigs | array | 否 | API 部署配置列表。 | |
| HttpApiDeployConfig | 否 | API 部署配置。 |
返回參數
示例
正常返回示例
JSON格式
{
"requestId": "393E2630-DBE7-5221-AB35-9E740675491A",
"message": "success",
"code": "Ok"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-11-18 | API 內部配置變更，不影響調用 | 查看變更詳情 |
| 2024-09-06 | API 內部配置變更，不影響調用 | 查看變更詳情 |