Updates an HTTP API.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| apig:UpdateHttpApi | update | *HttpApi acs:apig:{#regionId}:{#accountId}:httpapi/{#HttpApiId} |
| none |
Request syntax
PUT /v1/http-apis/{httpApiId} HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| httpApiId | string | Yes | The HTTP API ID. | api-xxx |
| body | object | No | The request body. | |
| description | string | No | The API description. | API for testing |
| protocols | array | No | The protocols that are used to access the API. | |
| string | No | The protocol. | HTTP | |
| basePath | string | Yes | The API base path, which must start with a forward slash (/). | /v1 |
| versionConfig | HttpApiVersionConfig | No | The versioning configurations. | |
| ingressConfig | object | No | The HTTP Ingress API configurations. | |
| environmentId | string | No | The environment ID. | env-cr6ql0tlhtgmc**** |
| sourceId | string | No | The source ID. | src-crdddallhtgtr**** |
| ingressClass | string | No | The Ingress class for listening. | mse |
| watchNamespace | string | No | The namespace for listening. | default |
| overrideIngressIp | boolean | No | Specifies whether to update the address in Ingress Status. | false |
| aiProtocols | array | No | The AI protocols. | |
| string | No | The AI protocol. Valid values:
| OpenAI/v1 | |
| deployConfigs | array | No | The deployment configurations. | |
| HttpApiDeployConfig | No | The deployment configuration. | ||
| enableAuth | boolean | No | Specifies whether to enable authentication. | |
| authConfig | AuthConfig | No | The authentication configuration. |
Response parameters
Examples
Sample success responses
JSONformat
{
"requestId": "393E2630-DBE7-5221-AB35-9E740675491A",
"message": "success",
"code": "Ok"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-07-17 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2025-06-26 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2025-05-21 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2025-01-02 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-11-18 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-09-06 | The internal configuration of the API is changed, but the call is not affected | View Change Details |