新功能发布记录
Broker 版本升级记录
公告
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.
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. . |
| 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. |
https://ckafka.intl.tencentcloudapi.com/?Action=CreateRoute
&InstanceId=ckafka-test
&VipType=1
&<Common request parameters>{
"Response": {
"Result": {
"ReturnCode": "0",
"ReturnMessage": "success",
"Data": {
"FlowId": 111,
"RouteDTO": {
"RouteId": 132321
}
}
},
"RequestId": "36713f94-d07d-4b96-babf-42d139276f23"
}
}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. |
| 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. |
文档反馈