Domain name for API request: tse.intl.tencentcloudapi.com.
Create a cloud native API gateway instance
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: CreateCloudNativeAPIGateway. |
| 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. |
| Name | Yes | String | Cloud native API gateway name supports up to 60 characters. |
| Type | Yes | String | Cloud native API gateway type, currently only support kong. |
| GatewayVersion | Yes | String | Cloud Native API gateway version. Reference value: - 2.4.1 - 2.5.1 |
| NodeConfig | Yes | CloudNativeAPIGatewayNodeConfig | Cloud Native API gateway node configuration. |
| VpcConfig | Yes | CloudNativeAPIGatewayVpcConfig | Cloud native API gateway vpc configuration. |
| Description | No | String | Cloud native API gateway description supports up to 120 characters. |
| Tags.N | No | Array of InstanceTagInfo | Tag list |
| EnableCls | No | Boolean | Whether CLS log is enabled. Default value: false. |
| FeatureVersion | No | String | Product version. Reference value: -TRIAL: Development edition -STANDARD: Standard version (default value) -PROFESSIONAL: Pro Edition |
| InternetMaxBandwidthOut | No | Integer | Public network outbound traffic bandwidth, [1,2048]Mbps |
| EngineRegion | No | String | Actual region information of the instance. Default value: ap-guangzhou. |
| IngressClassName | No | String | ingress Class name |
| TradeType | No | Integer | Payment type. Reference value: 0: Postpaid (default value) 1: Prepayment (The API does not currently support creating prepaid instances) |
| InternetConfig | No | InternetConfig | Public network configuration |
| PromId | No | String | Associated prometheus ID |
| Parameter Name | Type | Description |
|---|---|---|
| Result | CreateCloudNativeAPIGatewayResult | Create the response result of the Cloud Native API gateway instance. |
| 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 API gateway instance
POST / HTTP/1.1
Host: tse.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCloudNativeAPIGateway
<Common request parameters>
{
"Name": "gateway-prod",
"Type": "kong",
"GatewayVersion": "2.5.1",
"NodeConfig": {
"Specification": "1c2g",
"Number": 2
},
"VpcConfig": {
"VpcId": "vpc-59cag821",
"SubnetId": "subnet-8tzp8uz1"
},
"Description": "Public network ingress gateway, live environment"
"Tags": [
{
"TagKey": "env",
"TagValue": "prod"
}
],
"EnableCls": false,
"FeatureVersion": "STANDARD",
"InternetMaxBandwidthOut": 1,
"EngineRegion": "ap-guangzhou",
"IngressClassName": "kong",
"TradeType": 0,
"InternetConfig": {
"InternetAddressVersion": "IPV4",
"InternetPayMode": "TRAFFIC",
"InternetMaxBandwidthOut": 1,
"Description": "Public network CLB"
"SlaType": "clb.c2.medium",
"MultiZoneFlag": true,
"MasterZoneId": "ap-guangzhou-3",
"SlaveZoneId": "ap-guangzhou-4"
}
}
{
"Response": {
"Result": {
"GatewayId": "gateway-dde03755",
"Status": "Creating",
"TaskId": "task-b2c41103"
},
"RequestId": "a02f30b2-6e3d-4efb-9883-1b11b8fa7df2"
}
}
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.Cls | Call CLS service failure |
| FailedOperation.FailedOperation | Operation failed. |
| FailedOperation.InternalError | Operation failed. Internal error. |
| FailedOperation.Resource | The maximum number of instance purchases is exceeded. |
| FailedOperation.Role | Failed to get temporary key |
| FailedOperation.Vpc | Failed to call the VPC service |
| InternalError | Internal error. |
| InternalError.CreateError | Create an internal error. |
| InvalidParameterValue.BadRequestFormat | Request format incorrect. |
| InvalidParameterValue.CreateError | Invalid request parameter caused creation failure. |
| InvalidParameterValue.InvalidParameterValue | Invalid parameter value. |
| InvalidParameterValue.Name | Invalid name. |
| InvalidParameterValue.Region | Invalid Region. |
| InvalidParameterValue.Specification | Gateway specification parameter content error |
| InvalidParameterValue.Type | Gateway type parameter content error |
| LimitExceeded.LimitExceeded | The parameter exceeds the limit. |
| MissingParameter.MissParameter | Missing required parameters. |
| OperationDenied.OperationDenied | Operation not allowed. |
| ResourceNotFound.InstanceNotFound | The instance does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
| UnauthorizedOperation.ClsNotActivated | CLS product is not activated. |
| UnauthorizedOperation.Uin | Unauthorized Uin |
| UnauthorizedOperation.UnauthorizedOperation | Unauthorized operation. |
文档反馈