Help Center/ Cloud Connect/ API Reference/ API/ Cloud Connection Routes/ Querying a Cloud Connection Route
Updated on 2024-11-25 GMT+08:00

Querying a Cloud Connection Route

Function

This API is used to query the details of a cloud connection route.

Parameters marker and limit are used for pagination query. The two parameters take effect only when they are used together.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v3/{domain_id}/ccaas/cloud-connection-routes/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID.

id

Yes

String

Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

request_id

String

Request ID.

cloud_connection_route

CloudConnectionRoute object

Cloud connection route.

Table 4 CloudConnectionRoute

Parameter

Type

Description

id

String

Instance ID.

cloud_connection_id

String

Cloud connection ID.

domain_id

String

ID of the account that the instance belongs to.

instance_id

String

ID of the network instance (VPC or virtual gateway).

project_id

String

Project ID.

region_id

String

Region ID.

type

String

Type of the network instance that the next hop of a route points to.

  • VPC: a VPC

  • VGW: a virtual gateway

destination

String

Destination address.

Example Requests

Querying the details of a cloud connection route

GET https://{cc_endpoint}/v3/{domain_id}/ccaas/cloud-connection-routes/{id}

Example Responses

Status code: 200

The details of a cloud connection route have been queried.

{
  "request_id" : "844d75196c487081d2a32187ea9d3757",
  "cloud_connection_route" : {
    "id" : "XXX",
    "cloud_connection_id" : "XXX",
    "domain_id" : "XXX",
    "project_id" : "XXX",
    "instance_id" : "XXX",
    "type" : "vpc",
    "region_id" : "region-abc",
    "destination" : "192.168.1.0/24"
  }
}

Status Codes

Status Code

Description

200

The details of a cloud connection route have been queried.

Error Codes

See Error Codes.