All Products
Search
Document Center

API Gateway:UpdateHttpApi

Last Updated:Feb 05, 2026
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Updates an HTTP API.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
apig:UpdateHttpApiupdate
*HttpApi
acs:apig:{#regionId}:{#accountId}:httpapi/{#HttpApiId}
    none
none

Request syntax

PUT /v1/http-apis/{httpApiId} HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
httpApiIdstringYes

The API base path, which must start with a forward slash (/).

api-xxx
bodyobjectNo

json

descriptionstringNo

The environment ID.

The source ID.
protocolsarrayNo

The listened namespace.

stringNo

List of AI protocols.

HTTP
basePathstringYes

The list of API deployment configurations.

/v1
versionConfigHttpApiVersionConfigNo

A deployment configuration.

ingressConfigobjectNo

Specifies whether to enable authentication.

environmentIdstringNo

The authentication configuration.

env-cr6ql0tlhtgmc****
sourceIdstringNo

json

src-crdddallhtgtr****
ingressClassstringNo

The response parameters.

mse
watchNamespacestringNo

The request ID.

default
overrideIngressIpbooleanNo

The returned message.

false
aiProtocolsarrayNo

The status code.

stringNo

Update HTTP API

Enumeration Value:
  • OpenAI/v1: OpenAI/v1.
OpenAI/v1
agentProtocolsarrayNo

The list of agent protocols

stringNo

string

DashScope
deployConfigsarrayNo

The deployment configurations

HttpApiDeployConfigNo

HttpApiDeployConfig

enableAuthbooleanNo

Whether authentication is enabled

true
authConfigAuthConfigNo

The authentication configuration

onlyChangeConfigbooleanNo

Whether to only change configuration without redeployment

true
removeBasePathOnForwardbooleanNo

Whether to remove base path when forwarding

true
firstByteTimeoutintegerNo

The first byte timeout in nanoseconds

30s

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

Request ID.

393E2630-DBE7-5221-AB35-9E740675491A
messagestring

Response message.

success
codestring

Response status code.

200

Examples

Sample success responses

JSONformat

{
  "requestId": "393E2630-DBE7-5221-AB35-9E740675491A",
  "message": "success",
  "code": 200
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2025-07-17The internal configuration of the API is changed, but the call is not affectedView Change Details
2025-06-26The internal configuration of the API is changed, but the call is not affectedView Change Details
2025-05-21The internal configuration of the API is changed, but the call is not affectedView Change Details
2025-01-02The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-11-18The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-09-06The internal configuration of the API is changed, but the call is not affectedView Change Details