1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API is used to query the local gateway of CDC.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-09-28 11:26:17.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DescribeLocalGateway |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| Filters | No | Yes | Array of Filter | Query conditions: vpc-id: Filters by VPC ID; local-gateway-name: Filters by local gateway name, supporting fuzzy search; local-gateway-id: Filters by local gateway instance ID; cdc-id: Filters by CDC instance ID. Example:View |
| Offset | No | Yes | Int64 | The offset, with a default value of 0. For more details about Offset, see the relevant section in the API introduction.Example: 0 |
| Limit | No | Yes | Int64 | The number of returned results, with a default value of 20 and a maximum value of 100. For more details about Limit, see the relevant section in the API Overview.Example: 20 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| LocalGatewaySet | Array of LocalGateway | Collection of local gateway information. Example:View |
| TotalCount | Int64 | Total number of local gateways. Example: 1 |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameterValue | The parameter value is invalid. |
| InvalidParameter | Invalid input parameters. |
| InvalidParameterValue.Malformed | Invalid input format. |
| ResourceNotFound | The resource does not exist |
| InvalidParameterValue.TooLong | Invalid input: Excessive length of the parameter. |
| InternalError |