• Direct Connect

dc
  1. Help Center
  2. Direct Connect
  3. API Reference
  4. API
  5. Connection
  6. Querying the Connection List

Querying the Connection List

Function

This API is used to query the connection list.

URI

GET /v2.0/dcaas/direct-connects

Table 1 Parameter description

Parameter

Type

Mandatory

Description

direct_connects

List data structure

Yes

Indicates the direct connection list.

Request

Table 2 lists the request parameter.

Table 2 Request parameter

Parameter

Type

Mandatory

Description

fields

String

No

Indicates the parameters expected to be returned.

If you do not specify it, all parameters will be returned.

Response

Table 3 lists the response parameter.

Table 3 Response parameter

Parameter

Type

Description

direct_connects

List data structure

Indicates the direct connection list.

Table 4 lists the direct_connects parameters.

Table 4 Parameter description

Parameter

Type

Description

id

String

Indicates the connection ID.

tenant_id

String

Indicates the project ID.

name

String

Indicates the connection name.

description

String

Provides supplementary information about the connection.

port_type

String

Indicates the type of the port used by the connection. The value can be 1G or 10G.

bandwidth

Integer

Indicates the bandwidth used by the connection (unit: Mbit/s).

location

String

Indicates the connection access location.

peer_location

String

Indicates the physical location of the peer device accessed by the connection. The value can be a street, city, and province, or an IDC.

device_id

String

Indicates the gateway device ID of the connection.

interface_name

String

Indicates the name of the interface accessed by the connection.

redundant_id

String

Indicates the ID of the redundant connection using the same gateway.

provider

String

Indicates the connection provider.

provider_status

String

Indicates the status of the provider's connection. The value can be ACTIVE or DOWN.

type

String

Indicates the connection type. The value can be hosted.

hosting_id

String

Indicates the ID of the hosting connection mapped to the hosted connection.

vlan

Integer

Indicates the pre-allocated VLAN to the hosted connection.

charge_mode

String

Indicates the billing mode. The value can be prepayment, bandwidth, or traffic.

apply_time

String

Indicates the time when the connection is applied for.

create_time

String

Indicates the time when the connection is created.

delete_time

String

Indicates the time when the connection is deleted.

order_id

String

Indicates the order number of a connection.

product_id

String

Indicates the product ID corresponding to a connection order.

status

String

Indicates the connection status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_DELETE, DELETED, APPLY, DENY, PENDING_PAY, PAID, ORDERING, ACCEPT, or REJECTED.

admin_state_up

Boolean

Indicates the administrative state of the connection.

The value can be true or false.

Examples

  • Example request
    1. All parameters are returned:
    GET /v2.0/dcaas/direct-connects
    1. Filtered parameters are returned (for example, the filter is ID):
    GET /v2.0/dcaas/direct-connects?id=6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a
  • Example response
    {
        "direct_connect" : [{
            "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",        
            "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
            "name" : "direct connect1",
            "description" : "",
            "port_type" : "10G",
            "bandwidth" : 100,
            "location" : "Biere", 
            "device_id" : "172.16.40.2", 
            "provider" : "OTC"
        }]
    }

Returned Value

For details, see section Common Returned Values.