Function

This API is used to update a connection.

You can only increase the connection bandwidth.
Bandwidths of the operations connections cannot be modified.

URI

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

**Table 1** Parameter description
Parameter	Type	Mandatory	Description
direct_connect_id	String	No	Specifies the connection ID.

Request

Table 2 lists the request parameter.

**Table 2** Request parameter
Parameter	Type	Mandatory	Description
direct_connect	Dictionary data structure	No	Specifies the direct_connect object.

**Table 3** Description of field **direct_connect**
Parameter	Type	Mandatory	Description
description	String	No	Provides supplementary information about the connection.
name	String	No	Specifies the connection name.
bandwidth	Integer	No	Specifies the bandwidth of the connection in Mbit/s.
provider_status	String	No	Specifies the status of the carrier's leased line. The value can be ACTIVE or DOWN.
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.

Response

Table 4 lists the response parameter.

**Table 4** Response parameter
Parameter	Type	Description
direct_connect	Dictionary data structure	Specifies the direct_connect object.

**Table 5** 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 pre-allocated VLAN 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

PUT /v2.0/dcaas/direct-connects/{direct_connect_id}
{
    "direct_connect" : {
        "name" : "direct connect1",
        "description" : "New description"
    }
}

Example response

{
    "direct_connect" : {
        "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",        
        "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
        "name" : "direct connect1",
        "description" : "",
        "port_type" : "10G",
        "bandwidth" : 100,
        "location" : "Biere", 
        "device_id" : "172.16.40.2", 
        "provider" : "OTC"
    }
}

Returned Value

For details, see section Common Returned Values.

Updating a Connection

Function

URI

Request

Response

Examples

Returned Value