Creating a Connection

Function

This API is used to create a connection.

  1. When you create a hosted connection that does not need to be confirmed, set Status to ACCEPT.
  2. The bandwidth of a hosted connection cannot exceed that of the associated operations connection.

URI

POST /v2.0/dcaas/direct-connects

Table 1 Parameter description

Parameter

Type

Mandatory

Description

direct_connect

Dictionary data structure

Yes

Specifies the direct_connect object.

Request

Table 2 lists the direct_connect request parameters.

Table 2 Request parameters

Parameter

Type

Mandatory

Description

tenant_id

String

No

Specifies the project ID.

name

String

No

Specifies the connection name.

description

String

No

Provides supplementary information about the connection.

port_type

String

Yes

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

bandwidth

Integer

Yes

Specifies the connection bandwidth in Mbit/s.

location

String

Yes

Specifies the connection access location.

peer_location

String

No

Specifies the physical location of the peer device accessed by the connection, specific to the street or data center name.

device_id

String

No

Specifies the gateway device ID of the connection.

interface_name

String

No

Specifies the name of the interface accessed by the connection.

redundant_id

String

No

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

provider

String

Yes

Specifies the carrier who provides the leased line.

provider_status

String

No

Specifies the status of the carrier's leased line.

The value can be ACTIVE or DOWN.

type

String

No

Specifies the connection type. The value can be hosted.

hosting_id

String

No

Specifies the ID of the operations connection on which the hosted connection is created.

vlan

Integer

No

Specifies the VLAN pre-allocated to the hosted connection.

charge_mode

String

No

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

order_id

String

No

Specifies the order number of the connection.

product_id

String

No

Specifies the product ID corresponding to the connection's order.

status

String

No

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

No

Specifies the administrative status of the connection.

The value can be true or false.

Response

Table 3 lists the response parameter.

Table 3 Response parameter

Parameter

Type

Description

direct_connect

Dictionary data structure

Specifies the direct_connect object.

Table 4 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, specific to the street or data center name.

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 pre-allocated VLAN to the hosted connection.

charge_mode

String

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

Its value is left blank by default.

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

Returned Value

For details, see section Common Returned Values.