vpc — Virtual Private Cloud
vpc · 2017-03-12

DescribeRouteTables

POST

Query route tables.

Wire call

Converge Cloud is RPC over HTTP. There is one path — / — and the action travels in the X-TC-Action header. The /vpc/DescribeRouteTables path used in the OpenAPI document is a documentation convenience so each action is addressable; it is not a route on the server.

curl
curl -sS https://vpc.api3.convergecloud.com/ \
  -H 'Authorization: TC3-HMAC-SHA256 Credential=<SecretId>/<YYYY-MM-DD>/vpc/tc3_request, SignedHeaders=content-type;host;x-tc-action, Signature=<sig>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'Host: vpc.api3.convergecloud.com' \
  -H 'X-TC-Action: DescribeRouteTables' \
  -H 'X-TC-Version: 2017-03-12' \
  -H 'X-TC-Timestamp: <unix-seconds>' \
  -H 'X-TC-Region: luzon' \
  -d '{"Offset":0,"Limit":20}'

Request parameters

FieldTypeRequiredDescription
FiltersFilter[]—Filter condition. `RouteTableIds` and `Filters` cannot be specified at the same time.
RouteTableIdsstring[]—The route table instance ID, such as `rtb-azd4dt1c`.
Offsetstring—Offset.
Limitstring—The number of request objects.
NeedRouterInfoboolean—Whether to obtain routing policy information. Enabled by default. Set to False when the console does not need to pull routing policy information.

Response

Fields are returned inside the Response envelope. Converge Cloud answers HTTP 200 for errors as well as successes, so read Response.Error rather than the status code — and test for the presence of that object, because Code is occasionally the empty string.

FieldTypeDescription
TotalCountintegerNumber of eligible instances.
RouteTableSetRouteTable[]Route table object.
RequestIdstringThe 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.
Success
{
  "Response": {
    "TotalCount": …,
    "RouteTableSet": …,
    "RequestId": "…"
  }
}
Error
{
  "Response": {
    "Error": { "Code": "…", "Message": "…" },
    "RequestId": "…"
  }
}

Try it

CredentialThe key never leaves this tab — it signs the request here. The signed request goes to /api-relay/vpc.
Request bodyvalid JSONPOST vpc.api3.convergecloud.com · DescribeRouteTables
Read-only. Creates nothing.
Recorded example response — captured 2026-09-17
{
  "Response": {
    "RouteTableSet": [
      {
        "VpcId": "vpc-k0jq74eh",
        "RouteTableId": "rtb-h0wwp39q",
        "RouteTableName": "foundation-0a1b2c3d-rt-public",
        "AssociationSet": [
          {
            "SubnetId": "subnet-5119lh74",
            "RouteTableId": "rtb-h0wwp39q"
          }
        ],
        "Main": false,
        "CreatedTime": "2026-09-11 20:45:57",
        "TagSet": [],
        "LocalCidrBlocks": [
          "10.0.0.0/16"
        ],
        "LocalCidrForCcn": [],
        "SubnetNum": 1,
        "RouteSet": [],
        "RoutePolicyAssociationSet": [],
        "Region": "luzon"
      },
      {
        "VpcId": "vpc-k0jq74eh",
        "RouteTableId": "rtb-o9dnanu2",
        "RouteTableName": "default",
        "AssociationSet": [
          {
            "SubnetId": "subnet-j1h5agm4",
            "RouteTableId": "rtb-o9dnanu2"
          }
        ],
        "Main": true,
        "CreatedTime": "2026-09-11 20:44:13",
        "TagSet": [],
        "LocalCidrBlocks": [
          "10.0.0.0/16"
        ],
        "LocalCidrForCcn": [],
        "SubnetNum": 1,
        "RouteSet": [],
        "RoutePolicyAssociationSet": [],
        "Region": "luzon"
      }
    ],
    "TotalCount": 2,
    "RegionStatistics": [
      {
        "TotalCount": 2,
        "Region": "luzon"
      }
    ],
    "RequestId": "94fe0e44-2a3c-f9aa-81e9-23e44f9b899e"
  }
}

What failure looks like

Example error responses for this action. Match on Code.

Recorded error 1
{
  "Response": {
    "Error": {
      "Code": "ResourceNotFound",
      "Message": "指定资源 `rtb-90dtbn2g` 未找到。"
    },
    "RequestId": "76ac18b8-fc0d-d7f9-2e30-b8216fb40ae9"
  }
}
Recorded error 2
{
  "Response": {
    "Error": {
      "Code": "ResourceNotFound",
      "Message": "指定资源 `rtb-qnf99vjg` 未找到。"
    },
    "RequestId": "c9b81dcf-38fc-3cf3-6df6-18c20a748d3d"
  }
}