tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeLocalGateway

Last updated: 2023-08-23 14:11:11

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API is used to query local gateways of a CDC instance.

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: DescribeLocalGateway.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
Filters.N No Array of Filter Query criteria:
vpc-id: filter by VPC ID; local-gateway-name: filter by local gateway name (fuzzy search is supported); local-gateway-id: filter by local gateway instance ID; cdc-id: filter by CDC instance ID.
Offset No Integer The offset. Default value: 0. For more information on Offset, see the relevant sections in API Introduction.
Limit No Integer The number of returned results. Default value: 20. Maximum value: 100. For more information on Limit, see the relevant sections in API Introduction.

3. Output Parameters

Parameter Name Type Description
LocalGatewaySet Array of LocalGateway Information set of local gateways
TotalCount Integer Total number of local gateways
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying local gateways

Input Example

https://vpc.tencentcloudapi.com/?Action=DescribeLocalGateway
&<Common request parameters>

Output Example

{
    "Response": {
        "LocalGatewaySet": [
            {
                "CdcId": "cluster-1234dert",
                "VpcId": "vpc-m0c2kcun",
                "UniqLocalGwId": "lgw-1234edfr",
                "LocalGatewayName": "TEST",
                "LocalGwIp": "10.0.0.0",
                "CreateTime": "2021-03-24 15:31:56"
            }
        ],
        "TotalCount": 1,
        "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"
    }
}

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

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 An internal error occurred.
InvalidParameter A parameter error occurred.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.Malformed Invalid input parameter format.
InvalidParameterValue.TooLong Invalid parameter value. The parameter value is too long.
ResourceNotFound The resource does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy