Deploy HttpApi
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:DeployHttpApi | none | *HttpApi acs:apig:{#regionId}:{#accountId}:httpapi/{#HttpApiId} |
| none |
Request syntax
POST /v1/http-apis/{httpApiId}/deploy HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| httpApiId | string | No | HTTP API ID. | api-cr68g1dlhtgm31fb*** |
| body | object | No | The request body. | |
| routeId | string | No | The route ID. You must specify this parameter when you publish an HTTP API. | hr-cr82undlhtgrl*** |
| restApiConfig | object | No | The REST API deployment configuration. This parameter is required when you publish a REST API. | |
| revisionId | string | No | The historical version of the API. If you specify this parameter, the corresponding version of the API is published. | apr-xxx |
| description | string | No | The publish description. | The user service API |
| environment | object | No | The environment configurations. | |
environmentIddeprecated | string | No | The environment ID. | env-cpqnr6tlhtgubc*** |
| customDomainIds | array | No | The custom domain names. | |
| string | No | The domain ID. | d-cr62ts5lhtgln*** | |
backendScenedeprecated | string | No | The publishing scenario. Valid values:
| SingleService |
serviceConfigsdeprecated | array<object> | No | The configurations of existing services. For single-service publishing, only one entry is allowed. For other scenarios, multiple entries are allowed. | |
| object | No | The configurations of an existing service. | ||
| serviceId | string | No | The service ID. | svc-cr6pk4tlhtgm58e*** |
| protocol | string | No | The service protocol. Valid values:
| HTTP |
| port | integer | No | The service port. If you want to use a dynamic port, do not pass this parameter. | 8080 |
| weight | integer | No | The weight. Valid values: [1,100]. This parameter is valid only in proportional routing. | 49 |
| version | string | No | The version of the microservice. | v1 |
| match | HttpApiBackendMatchConditions | No | The matching condition configurations related to API publishing. | |
operationIdsdeprecated | array | No | operationIds | |
| string | No | string | ["operation-002", "operation-003"] | |
| gatewayId | string | No | The gateway ID. | gw-cvn2u46m1hkun04oll8g |
| operationDeployments | array<object> | No | Operation-level deployment control list | |
| object | No | object | ||
| operationId | string | No | Unique identifier of the operation | op-xxx |
| action | string | No | Operation type | Publish |
httpApiConfigdeprecated | object | No | httpApiConfig | |
| gatewayId | string | No | The gateway ID. | gw-csrhgfmm1hknf0hu6o3g |
| routeIds | array | No | routeIds | |
| string | No | string | ["xxx-002", "xxx-003"] |
Response parameters
Examples
Sample success responses
JSONformat
{
"requestId": "0C2D1C68-0D93-5561-8EE6-FDB7BF067A30",
"code": "Ok",
"message": "success"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2026-02-09 | The internal configuration of the API is changed, but the call is not affected | View Change Details |