更新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 | |
| agentProtocols | array | 否 | Agent 协议列表 | |
| string | 否 | 参数 | DashScope | |
| deployConfigs | array | 否 | API 部署配置列表。 | |
| HttpApiDeployConfig | 否 | API 部署配置。 | ||
| enableAuth | boolean | 否 | 是否开启权限认证 | true |
| authConfig | AuthConfig | 否 | 权限认证配置 | |
| onlyChangeConfig | boolean | 否 | 仅修改配置，true 表示只修改配置不触发重新部署 | true |
| removeBasePathOnForward | boolean | 否 | 转发时是否移除基础路径 | true |
| firstByteTimeout | integer | 否 | 首字节超时时间 | 30s |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "393E2630-DBE7-5221-AB35-9E740675491A",
"message": "success",
"code": "Ok"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-07-17 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2025-06-26 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2025-05-21 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2025-01-02 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2024-11-18 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2024-09-06 | API 内部配置变更，不影响调用 | 查看变更详情 |