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

Overview

Object Introduction

This section describes APIs for managing and operating connections, including the APIs used to create, query, update, and delete a connection, and the API used to query the connection list.

Object Model

Table 1 Connection objects

Attribute	Type	CRUD	Default Value	Constraint	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	None	The value can contain 0 to 64 characters. The name can contain only digits, letters, underscores (_), and hyphens (-).	Specifies the connection name.
description	String	CRU	None	The value can contain 0 to 128 characters.	Provides supplementary information about the connection.
port_type	String	CR	None	The value can contain 0 to 255 characters.	Specifies the type of the port used by the connection. The value can be 1G or 10G.
bandwidth	Integer	CRU	N/A	Bandwidth range: 2 Mbit/s to 20,000 Mbit/s	Specifies the bandwidth of the connection in Mbit/s.
location	String	CR	None	The value can contain 0 to 255 characters.	Specifies the connection access location.
peer_location	String	CR	None	The value can contain 0 to 255 characters.	Specifies the physical location of the peer device accessed by the connection, specific to the street or data center name.
device_id	String	CR	None	The value can contain 0 to 255 characters.	Specifies the gateway device ID of the connection.
interface_name	String	CR	None	The value can contain 0 to 255 characters.	Specifies the name of the interface accessed by the connection.
redundant_id	String	CR	None	uuid	Specifies the ID of the redundant connection using the same gateway.
provider	String	CR	None	The value can contain 0 to 255 characters.	Specifies the carrier who provides the leased line.
provider_status	String	CRU	DOWN	N/A	Specifies the status of the carrier's leased line. 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	None	uuid	Specifies the ID of the operations connection on which the hosted connection is created.
vlan	Integer	CR	N/A	<1, 4063>	Specifies the pre-allocated Virtual Local Area Network (VLAN) to-of 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 requested.
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	None	The value can contain 0 to 64 characters.	Specifies the connection order ID, which is used to support duration-based billing and identify user orders.
product_id	String	CRU	None	The value can contain 0 to 64 characters.	Specifies the product ID corresponding to the connection's order, which is used to custom billing 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	The value can only be true.	Specifies the administrative status of the connection. The value can be true or false.

Parent topic: Connection