DescribeSecurityGroupRoutes

Last updated:2025-12-29 11:41:42

DescribeSecurityGroupRoutes

Last updated: 2025-12-29 11:41:42

1. API Description

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

This API is used to retrieve the security group route information list.

A maximum of 20 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: DescribeSecurityGroupRoutes.
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.
InstanceRoute	No	InstanceRoute	Specifies the routing information.
Filters.N	No	Array of RouteFilter	Filter.
Offset	No	Integer	Specifies the pagination Offset. default is 0.
Limit	No	Integer	Pagination Limit. default: 20.
SearchWord	No	String	Keyword. specifies fuzzy search by instance id, instance name, or vip.

3. Output Parameters

Parameter Name	Type	Description
Result	SecurityGroupRouteResp	Returns the security group routing information result object.
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 Retrieving the Security Group Route Information List

Input Example

POST / HTTP/1.1
Host: ckafka.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSecurityGroupRoutes
<Common request parameters>

{
    "Offset": 0,
    "Limit": 10
}

Output Example

{
    "Response": {
        "Result": {
            "SecurityGroupRoutes": [
                {
                    "InstanceRoute": {
                        "InstanceId": "ckafka-test",
                        "RouteId": 1234
                    },
                    "SecurityGroupIds": [],
"InstanceName": "ckafka-test"
                    "VpcId": "vpc-test",
                    "Vip": "10.0.0.5"
                }
            ],
            "TotalCount": 1
        },
        "RequestId": "test-reqId-1134"
    }
}

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
InternalError	Internal error.
InvalidFilter	Invalid Filter
InvalidParameter	Invalid parameter.
InvalidParameterValue	Invalid parameter value.
LimitExceeded	The quota limit has been reached.
UnsupportedOperation	Unsupported operation.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud