Updating a Connection
Function
This API is used to update a connection, such as its name and description.
Debugging
For details, see Calling APIs.
URI
PUT /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
direct_connect_id |
Yes |
String |
Specifies the connection ID. Minimum: 36 Maximum: 36 |
project_id |
Yes |
String |
Specifies the project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header. Minimum: 0 Maximum: 10240 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
direct_connect |
No |
UpdateDirectConnect object |
Specifies the connection to be updated. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Specifies the connection name. Minimum: 0 Maximum: 64 |
description |
No |
String |
Provides supplementary information about the connection. Minimum: 0 Maximum: 128 |
bandwidth |
No |
Integer |
Specifies the bandwidth of the hosted connection, in Mbit/s. Minimum: 2 Maximum: 100000 |
peer_location |
No |
String |
Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name. Minimum: 0 Maximum: 255 |
status |
No |
String |
Specifies the resource status. The value can be PENDING_PAY or APPLY. Enumeration values:
|
provider_status |
No |
String |
Specifies the carrier status. The value can be ACTIVE or DOWN. Enumeration values:
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID. |
direct_connect |
DirectConnect object |
Specifies the connection. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the connection ID. |
tenant_id |
String |
Specifies the project ID. |
name |
String |
Specifies the connection name. Minimum: 0 Maximum: 64 |
description |
String |
Provides supplementary information about the connection. Minimum: 0 Maximum: 128 |
port_type |
String |
Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G. Enumeration values:
|
bandwidth |
Integer |
Specifies the connection bandwidth, in Mbit/s. Minimum: 2 Maximum: 100000 |
location |
String |
Specifies information about the Direct Connect location. Minimum: 0 Maximum: 255 |
peer_location |
String |
Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name. Minimum: 0 Maximum: 255 |
device_id |
String |
Specifies the ID of the device connected to the connection. Minimum: 0 Maximum: 36 |
type |
String |
Specifies the type of a connection. The value can be standard (a standard connection), hosting (an operations connection) or hosted (a hosted connection). Default: standard Enumeration values:
|
hosting_id |
String |
Specifies the ID of the operations connection on which the hosted connection is created. |
charge_mode |
String |
Specifies the billing mode. The value can be prepayment, bandwidth, or traffic. Enumeration values:
|
provider |
String |
Specifies the line carrier of a connection. |
admin_state_up |
Boolean |
Specifies the administrative status. The value can be true (default) or false. |
vlan |
Integer |
Specifies the VLAN allocated to the hosted connection. Minimum: 0 Maximum: 3999 |
status |
String |
Specifies the connection status.
Enumeration values:
|
apply_time |
String |
Specifies when the connection was requested. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ. |
create_time |
String |
Specifies when the connection was created. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ. |
provider_status |
String |
Specifies the carrier status. The status can be ACTIVE or DOWN. Enumeration values:
|
peer_port_type |
String |
Specifies the peer port type. |
peer_provider |
String |
Specifies the carrier of the leased line. |
order_id |
String |
Specifies the connection order ID, which is used to support duration-based billing and identify user orders. |
product_id |
String |
Specifies the product ID corresponding to the connection's order. The product ID is used to specify billing policies such as duration-based packages. |
spec_code |
String |
Specifies the product specifications corresponding to the connection's order. The specifications are used to specify billing policies such as duration-based packages. |
period_type |
Integer |
Specifies whether a connection in a specified order is billed by year or month. |
period_num |
Integer |
Specifies the required service duration of a yearly/monthly connection. |
vgw_type |
String |
Specifies the gateway type required by a connection. Default: default Enumeration values:
|
lag_id |
String |
Specifies the ID of the LAG that the connection belongs to. |
signed_agreement_status |
String |
Specifies the signing status of the Direct Connect Disclaimers. Enumeration values:
|
signed_agreement_time |
String |
Specifies when the Direct Connect Disclaimers were signed. |
enterprise_project_id |
String |
Specifies the ID of the enterprise project that the connection belongs to. Minimum: 36 Maximum: 36 |
tags |
Array of Tag objects |
Specifies the tags. Array length: 0–10 |
locales |
LocalesBody object |
Specifies the region of the connection. |
support_feature |
Array of strings |
Lists the features supported by the connection. |
ies_id |
String |
Specifies the edge site ID. |
reason |
String |
Displays error information if the status of a line is Error. |
|
String |
Specifies the customer email information. |
onestop_product_id |
String |
Specifies the product ID if the connection is a full-service connection. This parameter is used in line sales scenarios. |
building_line_product_id |
String |
Specifies the product ID of the line resource used in the equipment room. This parameter is used in line sales scenarios. |
last_onestop_product_id |
String |
Specifies the product ID of a full-service connection before the change. This parameter is used in line sales scenarios and used to save the last record when the line bandwidth is changed. |
last_building_line_product_id |
String |
Specifies the product ID of the line resource used in the equipment room before the change. This parameter is used in line sales scenarios and used to save the last record when the line bandwidth is changed. |
modified_bandwidth |
Integer |
Specifies the new bandwidth after the line bandwidth is changed. |
change_mode |
Integer |
Specifies the status of a renewal change. |
onestopdc_status |
String |
Specifies the status of a full-service connection. |
public_border_group |
String |
Specifies the public border group of the AZ, indicating whether the site is a HomeZones site. |
auto_renew |
Integer |
Specifies whether to automatically renew a yearly/monthly subscription. |
ratio_95peak |
Integer |
Specifies the percentage of the minimum bandwidth for 95th percentile billing. Minimum: 0 Maximum: 100 |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Specifies the tag key. The key:
|
value |
String |
Specifies the tag value. The value:
|
Example Requests
Updating the name and description of a connection
PUT https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/direct-connects/6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a { "direct_connect" : { "description" : "", "name" : "direct connect1" } }
Example Responses
Status code: 200
OK
- The connection is updated.
{ "request_id" : "9a4f4dfc4fb2fc101e65bba07d908535", "direct_connect" : { "bandwidth" : 100, "create_time" : "2018-10-19T09:53:26.000Z", "port_type" : "10G", "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a", "apply_time" : "2018-10-19T09:53:26.000Z", "peer_location" : "", "peer_port_type" : null, "peer_provider" : null, "location" : "ExampleLocation", "provider" : "ExampleProvider", "type" : "standard", "status" : "BUILD", "description" : "", "provider_status" : "ACTIVE", "order_id" : "", "vlan" : null, "device_id" : "172.16.40.2", "name" : "direct connect1", "admin_state_up" : true, "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f", "hosting_id" : null, "product_id" : "", "vgw_type" : "default", "spec_code" : "100ge", "charge_mode" : null, "support_feature" : [ ], "ies_id" : null, "reason" : null, "email" : "cloud@example.com", "onestop_product_id" : null, "building_line_product_id" : null, "last_building_line_product_id" : null, "last_onestop_product_id" : null, "modified_bandwidth" : null, "change_mode" : null, "onestopdc_status" : null, "public_border_group" : "center", "auto_renew" : 0, "ratio_95peak" : null } }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.