CreateRoute

下载PDF

最后更新时间：2025-11-21 20:32:31

CreateRoute

最后更新时间： 2025-11-21 20:32:31

下载PDF

1. API Description

Domain name for API request: ckafka.intl.tencentcloudapi.com.

This API is used to add instance routes.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: CreateRoute.
Version	Yes	String	Common Params. The value used for this API: 2019-08-19.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Specifies the ckafka cluster instance id. obtain through the API DescribeInstances. .
VipType	Yes	Integer	Specifies the network type of the route (3: vpc routing; 7: internal support route; 1: public network route). .
VpcId	No	String	vpc network Id. required when vipType is 3. .
SubnetId	No	String	Specifies the vpc subnet id. required when vipType is 3. .
AccessType	No	Integer	Access type: 0-plaintext; 1-sasl_plaintext; 3-sasl_ssl; 4-sasl_scram_sha_256; 5-sasl_scram_sha_512. defaults to 0. when vipType=3, supports 0,1,3,4,5. when vipType=7, supports 0,1,3. when vipType=1, supports 1,3. .
AuthFlag	No	Integer	Specifies whether access management is required. this field has been deprecated. .
CallerAppid	No	Integer	Specifies the caller appId. .
PublicNetwork	No	Integer	Public network bandwidth. required for public network route. must be a multiple of 3. no default value. .
Ip	No	String	vip address. .
Note	No	String	Specifies the remark information. .
SecurityGroupIds.N	No	Array of String	Specifies the ordered list of security group associations. .

3. Output Parameters

Parameter Name	Type	Description
Result	JgwOperateResponse	Returned result. .
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.

4. Example

Example1 Successfully Request

Input Example

https://ckafka.intl.tencentcloudapi.com/?Action=CreateRoute
&InstanceId=ckafka-test
&VipType=1
&<Common request parameters>

Output Example

{
    "Response": {
        "Result": {
            "ReturnCode": "0",
            "ReturnMessage": "success",
            "Data": {
                "FlowId": 111,
                "RouteDTO": {
                    "RouteId": 132321
                }
            }
        },
        "RequestId": "36713f94-d07d-4b96-babf-42d139276f23"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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.
InternalError	Internal error.
InvalidParameter	Invalid parameter.
InvalidParameterValue.InstanceNotExist	The instance does not exist.
InvalidParameterValue.RepetitionValue	The parameter already exists.
InvalidParameterValue.SubnetIdInvalid	Invalid subnet ID.
InvalidParameterValue.SubnetNotBelongToZone	The subnet is not in the zone.
InvalidParameterValue.VpcIdInvalid	Invalid VPC ID.
InvalidParameterValue.WrongAction	The value of the `Action` parameter is incorrect.
InvalidParameterValue.ZoneNotSupport	The zone is not supported.
LimitExceeded.RouteOverLimit	The number of routes exceeds the limit.
LimitExceeded.RouteSASLOverLimit	SASL route exceeds the limit.
ResourceNotFound	The resource does not exist.
ResourceUnavailable	The resource is unavailable.
UnauthorizedOperation	Unauthorized operation.
UnsupportedOperation	Unsupported operation.
UnsupportedOperation.BatchDelInstanceLimit	The batch instance deletion limit is reached.
UnsupportedOperation.OssReject	Oss rejected the operation.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud