Domain name for API request: tse.intl.tencentcloudapi.com.
This API is used to create a cloud-native gateway route.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateCloudNativeAPIGatewayRoute. |
| Version | Yes | String | Common Params. The value used for this API: 2020-12-07. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| GatewayId | Yes | String | Gateway ID |
| ServiceID | Yes | String | Service ID |
| RouteName | No | String | The name of the route, unique at the instance level, does not need to be provided. |
| Methods.N | No | Array of String | Method of route. Available values: - GET - POST - DELETE - PUT - OPTIONS - PATCH - HEAD - ANY - TRACE - COPY - MOVE - PROPFIND - PROPPATCH - MKCOL - LOCK - UNLOCK |
| Hosts.N | No | Array of String | Domain of the route |
| Paths.N | No | Array of String | Path of the route |
| Protocols.N | No | Array of String | Route protocol, optional - https - http |
| PreserveHost | No | Boolean | Preserve Host when forwarding to backend |
| HttpsRedirectStatusCode | No | Integer | HTTP redirection status code |
| StripPath | No | Boolean | StripPath when forwarding to backend |
| DestinationPorts.N | No | Array of Integer | Destination port for Layer 4 match |
| Headers.N | No | Array of KVMapping | Headers of the route |
| RequestBuffering | No | Boolean | Whether to cache the request body, default true |
| ResponseBuffering | No | Boolean | Whether to cache the response body. Default true |
| RegexPriority | No | Integer | Regular priority |
| QueryStringParameters.N | No | Array of KVMapping | queryString parameter |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Create a cloud-native gateway route
POST / HTTP/1.1
Host: tse.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCloudNativeAPIGatewayRoute
<Common request parameters>
{
"GatewayId": "gateway-9abf3b79",
"ServiceID": "service-demo",
"RouteName": "route-demo",
"Methods": [
"GET",
"POST"
],
"Hosts": [
"www.baidu.com"
],
"Paths": [
"/v1/users"
],
"PreserveHost": true,
"StripPath": false,
"HttpsRedirectStatusCode": 308
}
{
"Response": {
"RequestId": "741e4e82-371d-48de-a843-867c69ff114d"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.FailedOperation | Operation failed. |
| FailedOperation.InternalError | Operation failed. Internal error. |
| FailedOperation.Role | Failed to get temporary key |
| FailedOperation.Vpc | Failed to call the VPC service |
| InternalError | Internal error. |
| InternalError.QueryError | Query internal error. |
| InternalError.UnknownError | Unknown error. |
| InvalidParameterValue.BadRequestFormat | Request format incorrect. |
| InvalidParameterValue.InvalidParameterValue | Invalid parameter value. |
| InvalidParameterValue.OperationFailed | Invalid request parameter caused operation failure. |
| InvalidParameterValue.Region | Invalid Region. |
| InvalidParameterValue.ResourceAlreadyExist | The resource already exists. |
| InvalidParameterValue.Specification | Gateway specification parameter content error |
| InvalidParameterValue.Type | Gateway type parameter content error |
| MissingParameter | Parameters are missing. |
| ResourceNotFound.InstanceNotFound | The instance does not exist. |
| ResourceNotFound.ResourceNotFound | The resource does not exist. |
| UnauthorizedOperation.CamNoAuth | Authentication fail. |
| UnauthorizedOperation.CamPassRoleNotExist | The sub-account lacks passRole permission. |
| UnauthorizedOperation.Uin | Unauthorized Uin |
| UnauthorizedOperation.UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback