doc-exports/docs/dc/api-ref/en-dc_topic_0055025318.html

Querying a Connection

Function

This API is used to query a connection.

URI

GET /v2.0/dcaas/direct-connects/{direct_connect_id}

Table 1 Parameter description

Parameter	Type	Mandatory	Description
direct_connect_id	String	Yes	Specifies the connection ID.

Request

None

Response

Table 2 lists the response parameter.

Table 2 Response parameter

Parameter	Type	Description
direct_connect	Dictionary data structure	Specifies the direct_connect object.

Table 3 Description of field direct_connect

Parameter	Type	Description
id	String	Specifies the connection ID.
tenant_id	String	Specifies the project ID.
name	String	Specifies the connection name.
description	String	Provides supplementary information about the connection.
port_type	String	Specifies the type of the port used by the connection. The value can be 1G or 10G.
bandwidth	Integer	Specifies the bandwidth of the connection in Mbit/s.
location	String	Specifies the connection access location.
peer_location	String	Specifies 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	Specifies the gateway device ID of the connection.
interface_name	String	Specifies the name of the interface accessed by the connection.
redundant_id	String	Specifies the ID of the redundant connection using the same gateway.
provider	String	Specifies the carrier who provides the leased line.
provider_status	String	Specifies the status of the carrier's leased line. The value can be ACTIVE or DOWN.
type	String	Specifies the connection type. The value can be hosted.
hosting_id	String	Specifies the ID of the operations connection on which the hosted connection is created.
vlan	Integer	Specifies the VLAN pre-allocated to the hosted connection.
charge_mode	String	Specifies the billing mode. The value can be prepayment, bandwidth, or traffic.
apply_time	String	Specifies the time when the connection is requested.
create_time	String	Specifies the time when the connection is created.
delete_time	String	Specifies the time when the connection is deleted.
order_id	String	Specifies the order number of the connection.
product_id	String	Specifies the product ID corresponding to the connection's order.
status	String	Specifies 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	Specifies the administrative status of the connection. The value can be true or false.

Examples

• Example request

GET /v2.0/dcaas/direct-connects/{direct_connect_id}

• Example response

  {
      "direct_connect" : {
          "bandwidth" : 100,
          "create_time": "2018-10-19 09:53:26.389556", 
          "port_type" : "10G",
          "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
          "apply_time": "2018-10-19 09:53:26.389556", 
          "peer_location": "", "delete_time": null, 
          "location" : "Biere", 
          "provider" : "OTC"
          "interface_name": "Eth-Trunk2",
          "type": "standard",
          "status": "ACTIVE", 
          "description" : "",
          "provider_status": "ACTIVE",
          "order_id": "",
          "vlan": null,
          "device_id" : "172.16.40.2", 
          "name" : "direct connect1",
          "admin_state_up": true, 
          "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
          "redundant_id": null,
          "hosting_id": null,
          "product_id": "",
          "charge_mode": ""
      }
  }

Returned Value

For details, see section Common Returned Values.

Parent topic: Connection