• Direct Connect

dc
  1. Help Center
  2. Direct Connect
  3. API Reference
  4. API
  5. Connection
  6. Description

Description

Object

Manage and operate connections, including interfaces used to create, delete, query, and update a connection, and the interface used to query the connection list.

Object Models

Table 1 Connection objects

Parameter

Type

CRUD

Default Value

Constraints

Description

id

String

R

Automatically generated

uuid

Specifies the connection ID.

tenant_id

String

CR

N/A

The value can contain 0 to 255 characters.

Specifies the tenant ID.

name

String

CRU

Left blank

The value can contain 0 to 64 characters.

Only digits, letters, underscores (_), and hyphens (-) are supported.

Specifies the connection name.

description

String

CRU

Left blank

The value can contain 0 to 128 characters.

Provides supplementary information about the connection.

port_type

String

CR

Left blank

The value can contain 0 to 255 characters.

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

bandwidth

Integer

CRU

N/A

<2,20000>

Specifies the connection bandwidth (unit: Mbit/s).

location

String

CR

Left blank

The value can contain 0 to 255 characters.

Specifies the connection access location.

peer_location

String

CR

Left blank

The value can contain 0 to 255 characters.

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

CR

Left blank

The value can contain 0 to 255 characters.

Specifies the gateway device ID of the connection.

interface_name

String

CR

Left blank

The value can contain 0 to 255 characters.

Specifies the name of the interface accessed by the connection.

redundant_id

String

CR

Left blank

uuid

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

provider

String

CR

Left blank

The value can contain 0 to 255 characters.

Specifies the connection provider.

provider_status

String

CRU

DOWN

N/A

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

type

String

CR

standard

The value can contain 0 to 255 characters.

Specifies the connection type. The value can be standard, hosting, or hosted.

hosting_id

String

CR

Left blank

uuid

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

vlan

Integer

CR

N/A

<1,4063>

Specifies the pre-allocated VLAN to the hosted connection.

charge_mode

String

CR

prepayment

The value can contain 0 to 255 characters.

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

apply_time

String

R

N/A

The value can contain 0 to 255 characters.

Specifies the time when the connection is applied for.

create_time

String

R

N/A

The value can contain 0 to 255 characters.

Specifies the time when the connection is created.

delete_time

String

R

N/A

The value can contain 0 to 255 characters.

Specifies the time when the connection is deleted.

order_id

String

CRU

Left blank

The value can contain 0 to 64 characters.

Specifies the connection order ID, which is used to support duration-based charging and identify user orders.

product_id

String

CRU

Left blank

The value can contain 0 to 64 characters.

Product ID corresponds to a connection order, which is used to order charging policies such as duration-based packages.

status

String

CR

DOWN

N/A

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

CR

true

Only true is supported.

Specifies the administrative status. The value can be true or false.