Overview¶
Object Introduction¶
This section describes the APIs for managing connections, including the API used to create a hosted connection, the APIs used to query, update, and delete a connection, and the API used to query the connection list.
Object Model¶
Parameter | 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. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. | Specifies the connection name. |
description | String | CRU | None | The value can contain 0 to 128 characters. Angle brackets (<>) are not allowed. | 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, 10G, 40G, or 100G. |
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. You can only create hosted connections by calling APIs. |
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 VLAN pre-allocated to the hosted connection. |
charge_mode | String | CR | prepayment | The value can contain 0 to 255 characters. | Specifies the billing mode. This parameter is not mandatory. The value can only be port for operations connections. This parameter is not possible to be used for hosted connections. |
apply_time | String | R | N/A | The value can contain 0 to 255 characters. | Specifies the time when the connection was 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 was 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 operating status of the connection. The value can be ACTIVE, DOWN, BUILD, or ERROR.
|
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. |
spec_code | String | CR | None | N/A | This is a reserved field, which is not used currently. |
applicant | String | CR | None | N/A | This is a reserved field, which is not used currently. |
mobile | String | CR | None | N/A | This is a reserved field, which is not used currently. |
String | CR | None | The value consists of 1 to 255 characters. | This is a reserved field, which is not used currently. | |
region_id | String | CR | None | N/A | This is a reserved field, which is not used currently. |
service_key | String | CR | None | N/A | This is a reserved field, which is not used currently. |
cable_label | String | CR | None | N/A | This is a reserved field, which is not used currently. |
peer_port_type | String | CR | None | N/A | This is a reserved field, which is not used currently. |
peer_provider | String | CR | None | N/A | This is a reserved field, which is not used currently. |
onestop_product_id | String | CR | None | N/A | This is a reserved field, which is not used currently. |
building_line_product_id | String | CR | None | N/A | This is a reserved field, which is not used currently. |
last_onestop_product_id | String | CR | None | N/A | This is a reserved field, which is not used currently. |
period_type | Integer | CR | None | N/A | This is a reserved field, which is not used currently. |
period_num | Integer | CR | None | N/A | This is a reserved field, which is not used currently. |
reason | String | CR | None | N/A | This is a reserved field, which is not used currently. |
vgw_type | String | CR | default | default | Specifies the type of the gateway. Currently, only the default type is supported. |
lag_id | String | CR | None | UUID | This is a reserved field, which is not used currently. |