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 | Request Body. | |
| routeId | string | No | Route ID. This must be provided when publishing the route of an HTTP API. | hr-cr82undlhtgrl*** |
| restApiConfig | object | No | Rest API deployment configuration. Required when deploying an HTTP API as a Rest API. | |
| revisionId | string | No | Historical version number. If this field is specified, the publication information will be based on the historical version information. | apr-xxx |
| description | string | No | Publication description. | 用户服务API发布。 |
| environment | object | No | Publication environment configuration. | |
| environmentId | string | No | Environment ID. | env-cpqnr6tlhtgubc*** |
| customDomainIds | array | No | List of user domains. | |
| string | No | Domain ID. | d-cr62ts5lhtgln*** | |
| backendScene | string | No | API publication scenario. Enumeration Value:
| SingleService |
| serviceConfigs | array<object> | No | Existing service configurations. Only one entry is allowed in a single-service scenario, while multiple entries are allowed in scenarios such as by ratio or by content. | |
| object | No | Existing service configuration. | ||
| serviceId | string | No | Service ID. | svc-cr6pk4tlhtgm58e*** |
| protocol | string | No | Service protocol:
| HTTP |
| port | integer | No | Service port, do not provide for dynamic ports. | 8080 |
| weight | integer | No | Weight, range [1,100], valid only in the by-ratio scenario. | 49 |
| version | string | No | Service version. | v1 |
| match | HttpApiBackendMatchConditions | No | Configuration of matching conditions related to API deployment. |
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.