UpdateHttpApi - 更新HTTP API
更新HTTP API。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
apig:UpdateHttpApi |
update |
*HttpApi
|
无 | 无 |
请求语法
PUT /v1/http-apis/{httpApiId} HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| httpApiId |
string |
是 |
待更新的 HTTP API ID。 |
api-xxx |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求体参数。 |
{'key': 'value'} |
| 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 |
否 |
首字节超时时间，单位：秒(s) |
30 |
| dryRun |
boolean |
否 |
是否只做预检校验（dry run）。true 时执行与真实更新一致的全部同步校验但不更新任何配置、不产生副作用；缺省或 false 时行为与现有版本一致。 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
响应。 |
||
| requestId |
string |
请求 ID。 |
393E2630-DBE7-5221-AB35-9E740675491A |
| message |
string |
响应消息。 |
success |
| code |
string |
响应状态码。 |
Ok |
示例
正常返回示例
JSON格式
{
"requestId": "393E2630-DBE7-5221-AB35-9E740675491A",
"message": "success",
"code": "Ok"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。