Virtual gateway
diff --git a/docs/dc/api-ref/en-dc_topic_0055025309.html b/docs/dc/api-ref/en-dc_topic_0055025309.html
index 45a9f681..9dddc837 100644
--- a/docs/dc/api-ref/en-dc_topic_0055025309.html
+++ b/docs/dc/api-ref/en-dc_topic_0055025309.html
@@ -1,6 +1,6 @@
-API
+APIs
diff --git a/docs/dc/api-ref/en-dc_topic_0055025310.html b/docs/dc/api-ref/en-dc_topic_0055025310.html
index bcefcf0b..395c69f9 100644
--- a/docs/dc/api-ref/en-dc_topic_0055025310.html
+++ b/docs/dc/api-ref/en-dc_topic_0055025310.html
@@ -11,7 +11,7 @@
diff --git a/docs/dc/api-ref/en-dc_topic_0055025311.html b/docs/dc/api-ref/en-dc_topic_0055025311.html
index 668e115f..6314dfe3 100644
--- a/docs/dc/api-ref/en-dc_topic_0055025311.html
+++ b/docs/dc/api-ref/en-dc_topic_0055025311.html
@@ -7,7 +7,7 @@
-ResponseTable 1 lists the response parameters.
+ ResponseTable 1 lists the response parameters.
Table 1 Response parametersParameter
|
@@ -28,7 +28,7 @@
String
|
-Specifies the version number, for example, v2.0
+ | Specifies the version number, for example, v2.0.
|
|---|
links
@@ -52,6 +52,13 @@
| Specifies the relationship between the current API version and the referenced address.
|
+version
+ |
+String
+ |
+Specifies the version. If APIs of this version support minor versions, set this parameter to the supported maximum minor version. If minor versions are not supported, leave this parameter blank.
+ |
+
status
|
String
@@ -60,23 +67,41 @@
- CURRENT: indicates a primary version.
- SUPPORTED: indicates an old version that is still supported.
- DEPRECATED: indicates a deprecated version that may be deleted later.
|
+updated
+ |
+String
+ |
+Specifies the version release time in UTC. For example, the release time format of v2.0 APIs is YYYY-MM-DDTHH:MM:SSZ.
+ |
+
+min_version
+ |
+String
+ |
+Specifies the version. If APIs of this version support minor versions, set this parameter to the supported minimum minor version. If minor versions are not supported, leave this parameter blank.
+ |
+
Examples- Example request
GET /
- - Example response
{
- "versions": [
- {
- "status": "CURRENT",
- "id": "v2.0",
- "links":[
+ - Example response
{
+ "versions": [
{
- "href": "https://network.az0.dc0.domainname.com/v2.0","rel": "self"
- }
- ]
- }
- ]
+ "id": "v2.0",
+ "links": [
+ {
+ "href": "https://dcaas.eu-de.otc.t-systems.com/v2.0",
+ "rel": "self"
+ }
+ ],
+ "min_version": "",
+ "updated": "YYYY-MM-DDTHH:MM:SSZ",
+ "status": "CURRENT",
+ "version": ""
+ }
+ ]
}
diff --git a/docs/dc/api-ref/en-dc_topic_0055025312.html b/docs/dc/api-ref/en-dc_topic_0055025312.html
index fe67fa04..e03538f5 100644
--- a/docs/dc/api-ref/en-dc_topic_0055025312.html
+++ b/docs/dc/api-ref/en-dc_topic_0055025312.html
@@ -7,7 +7,7 @@
ResponseTable 1 lists the response parameters.
+ ResponseTable 1 lists the response parameters.
Table 1 Response parametersParameter
|
@@ -64,14 +64,14 @@
String
|
-Specifies the version release time in UTC. Specifies the time when v1 APIs are released, for example, 2014-06-28T12:20:21Z.
+ | Specifies the version release time in UTC. For example, the release time format of v2.0 APIs is YYYY-MM-DDTHH:MM:SSZ.
|
|---|
min_version
|
String
|
-Specifies the version. If APIs of this version supports minor versions, set this parameter to the supported minimum minor version. If minor versions are not supported, leave this parameter blank.
+ | Specifies the version. If APIs of this version support minor versions, set this parameter to the supported minimum minor version. If minor versions are not supported, leave this parameter blank.
|
@@ -79,16 +79,16 @@
Examples- Example request
GET /v2.0
- - Example response
{
+ - Example response
{
"version": {
"id": "v2.0",
"links": [
{
- "href": "https://dcaas.***region.myhwclouds.com/v2.0",
+ "href": "https://dcaas.eu-de.otc.t-systems.com/v2.0",
"rel": "self"
}
],
- "updated": "2017-11-30T00:00:00Z",
+ "updated": "YYYY-MM-DDTHH:MM:SSZ",
"status": "CURRENT",
"version": "",
"min_version": ""
diff --git a/docs/dc/api-ref/en-dc_topic_0055025313.html b/docs/dc/api-ref/en-dc_topic_0055025313.html
index cfd28dd2..d1782aab 100644
--- a/docs/dc/api-ref/en-dc_topic_0055025313.html
+++ b/docs/dc/api-ref/en-dc_topic_0055025313.html
@@ -19,7 +19,7 @@
Overview
-Object IntroductionThis 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 IntroductionThis 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
- Table 1 Connection objectsAttribute
+Object Model
+ Table 1 Connection objectsParameter
|
-Type
+ | Type
|
-CRUD
+ | CRUD
|
-Default Value
+ | Default Value
|
-Constraint
+ | Constraint
|
-Description
+ | Description
|
|---|
-id
+ | id
|
-String
+ | String
|
-R
+ | R
|
-Automatically generated
+ | Automatically generated
|
-uuid
+ | UUID
|
-Specifies the connection ID.
+ | Specifies the connection ID.
|
-tenant_id
+ | tenant_id
|
-String
+ | String
|
-CR
+ | CR
|
-N/A
+ | N/A
|
-The value can contain 0 to 255 characters.
+ | The value can contain 0 to 255 characters.
|
-Specifies the tenant ID.
+ | Specifies the tenant ID.
|
-name
+ | name
|
-String
+ | String
|
-CRU
+ | CRU
|
-None
+ | None
|
-The value can contain 0 to 64 characters.
-The name can contain only digits, letters, underscores (_), and hyphens (-).
+ | The value can contain 0 to 64 characters.
+Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
|
-Specifies the connection name.
+ | Specifies the connection name.
|
-description
+ | description
|
-String
+ | String
|
-CRU
+ | CRU
|
-None
+ | None
|
-The value can contain 0 to 128 characters.
+ | The value can contain 0 to 128 characters.
+Angle brackets (<>) are not allowed.
|
-Provides supplementary information about the connection.
+ | Provides supplementary information about the connection.
|
-port_type
+ | port_type
|
-String
+ | String
|
-CR
+ | CR
|
-None
+ | None
|
-The value can contain 0 to 255 characters.
+ | 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.
+ | Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G.
|
-bandwidth
+ | bandwidth
|
-Integer
+ | Integer
|
-CRU
+ | CRU
|
-N/A
+ | N/A
|
-Bandwidth range: 2 Mbit/s to 20,000 Mbit/s
+ | Bandwidth range: 2 Mbit/s to 20,000 Mbit/s
|
-Specifies the bandwidth of the connection in Mbit/s.
+ | Specifies the bandwidth of the connection in Mbit/s.
|
-location
+ | location
|
-String
+ | String
|
-CR
+ | CR
|
-None
+ | None
|
-The value can contain 0 to 255 characters.
+ | The value can contain 0 to 255 characters.
|
-Specifies the connection access location.
+ | Specifies the connection access location.
|
-peer_location
+ | peer_location
|
-String
+ | String
|
-CR
+ | CR
|
-None
+ | None
|
-The value can contain 0 to 255 characters.
+ | 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.
+ | Specifies the physical location of the peer device accessed by the connection, specific to the street or data center name.
|
-device_id
+ | device_id
|
-String
+ | String
|
-CR
+ | CR
|
-None
+ | None
|
-The value can contain 0 to 255 characters.
+ | The value can contain 0 to 255 characters.
|
-Specifies the gateway device ID of the connection.
+ | Specifies the gateway device ID of the connection.
|
-interface_name
+ | interface_name
|
-String
+ | String
|
-CR
+ | CR
|
-None
+ | None
|
-The value can contain 0 to 255 characters.
+ | The value can contain 0 to 255 characters.
|
-Specifies the name of the interface accessed by the connection.
+ | Specifies the name of the interface accessed by the connection.
|
-redundant_id
+ | redundant_id
|
-String
+ | String
|
-CR
+ | CR
|
-None
+ | None
|
-uuid
+ | UUID
|
-Specifies the ID of the redundant connection using the same gateway.
+ | Specifies the ID of the redundant connection using the same gateway.
|
-provider
+ | provider
|
-String
+ | String
|
-CR
+ | CR
|
-None
+ | None
|
-The value can contain 0 to 255 characters.
+ | The value can contain 0 to 255 characters.
|
-Specifies the carrier who provides the leased line.
+ | Specifies the carrier who provides the leased line.
|
-provider_status
+ | provider_status
|
-String
+ | String
|
-CRU
+ | CRU
|
-DOWN
+ | DOWN
|
-N/A
+ | N/A
|
-Specifies the status of the carrier's leased line. The value can be ACTIVE or DOWN.
+ | Specifies the status of the carrier's leased line. The value can be ACTIVE or DOWN.
|
-type
+ | type
|
-String
+ | String
|
-CR
+ | CR
|
-standard
+ | standard
|
-The value can contain 0 to 255 characters.
+ | The value can contain 0 to 255 characters.
|
-Specifies the connection type. The value can be standard, hosting, or hosted.
+ | Specifies the connection type. The value can be standard, hosting, or hosted.
+You can only create hosted connections by calling APIs.
|
-hosting_id
+ | hosting_id
|
-String
+ | String
|
-CR
+ | CR
|
-None
+ | None
|
-uuid
+ | UUID
|
-Specifies the ID of the operations connection on which the hosted connection is created.
+ | Specifies the ID of the operations connection on which the hosted connection is created.
|
-vlan
+ | vlan
|
-Integer
+ | Integer
|
-CR
+ | CR
|
-N/A
+ | N/A
|
-<1, 4063>
+ | <1, 4063>
|
-Specifies the pre-allocated Virtual Local Area Network (VLAN) to-of the hosted connection.
+ | Specifies the VLAN pre-allocated to the hosted connection.
|
-charge_mode
+ | charge_mode
|
-String
+ | String
|
-CR
+ | CR
|
-prepayment
+ | prepayment
|
-The value can contain 0 to 255 characters.
+ | The value can contain 0 to 255 characters.
|
-Specifies the billing mode. The value can be prepayment, bandwidth, or traffic.
+ | 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
+ | apply_time
|
-String
+ | String
|
-R
+ | R
|
-N/A
+ | N/A
|
-The value can contain 0 to 255 characters.
+ | The value can contain 0 to 255 characters.
|
-Specifies the time when the connection is requested.
+ | Specifies the time when the connection was requested.
|
-create_time
+ | create_time
|
-String
+ | String
|
-R
+ | R
|
-N/A
+ | N/A
|
-The value can contain 0 to 255 characters.
+ | The value can contain 0 to 255 characters.
|
-Specifies the time when the connection is created.
+ | Specifies the time when the connection is created.
|
-delete_time
+ | delete_time
|
-String
+ | String
|
-R
+ | R
|
-N/A
+ | N/A
|
-The value can contain 0 to 255 characters.
+ | The value can contain 0 to 255 characters.
|
-Specifies the time when the connection is deleted.
+ | Specifies the time when the connection was deleted.
|
-order_id
+ | order_id
|
-String
+ | String
|
-CRU
+ | CRU
|
-None
+ | None
|
-The value can contain 0 to 64 characters.
+ | 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.
+ | Specifies the connection order ID, which is used to support duration-based billing and identify user orders.
|
-product_id
+ | product_id
|
-String
+ | String
|
-CRU
+ | CRU
|
-None
+ | None
|
-The value can contain 0 to 64 characters.
+ | 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.
+ | Specifies the product ID corresponding to the connection's order, which is used to custom billing policies such as duration-based packages.
|
-status
+ | status
|
-String
+ | String
|
-CR
+ | CR
|
-DOWN
+ | DOWN
|
-N/A
+ | 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.
+ | Specifies the operating status of the connection. The value can be ACTIVE, DOWN, BUILD, or ERROR.
+- ACTIVE: The connection has been created and is normal.
- DOWN: The port is down.
- BUILD: The connection is being created.
- ERROR: The connection is abnormal.
|
-admin_state_up
+ | admin_state_up
|
-Boolean
+ | Boolean
|
-CR
+ | CR
|
-true
+ | true
|
-The value can only be true.
+ | The value can only be true.
|
-Specifies the administrative status of the connection.
+ | 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.
+ |
+
+email
+ |
+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.
+ |
+
diff --git a/docs/dc/api-ref/en-dc_topic_0055025315.html b/docs/dc/api-ref/en-dc_topic_0055025315.html
index 497d98c2..4e917190 100644
--- a/docs/dc/api-ref/en-dc_topic_0055025315.html
+++ b/docs/dc/api-ref/en-dc_topic_0055025315.html
@@ -1,227 +1,221 @@
- Creating a Connection
- FunctionThis API is used to create a connection.
-  - When you create a hosted connection that does not need to be confirmed, set Status to ACCEPT.
- The bandwidth of a hosted connection cannot exceed that of the associated operations connection.
+ Creating a Connection
+ FunctionThis API is used to create a hosted connection.
+ This API can only be used to create hosted connections.
URIPOST /v2.0/dcaas/direct-connects
- Table 1 Parameter descriptionParameter
+Table 1 Parameter descriptionParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-direct_connect
+ | direct_connect
|
-Dictionary data structure
+ | Dictionary
|
-Yes
+ | Yes
|
-Specifies the direct_connect object.
+ | Specifies the direct_connect object.
|
RequestTable 2 lists the direct_connect request parameters.
+ RequestFor details about the direct_connect field, see Table 2.
- Table 2 Request parametersParameter
+Table 2 Request parametersParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-tenant_id
+ | tenant_id
|
-String
+ | String
|
-No
+ | No
|
-Specifies the project ID.
+ | Specifies the project ID.
|
-name
+ | name
|
-String
+ | String
|
-No
+ | No
|
-Specifies the connection name.
+ | Specifies the connection name.
+Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
|
-description
+ | description
|
-String
+ | String
|
-No
+ | No
|
-Provides supplementary information about the connection.
+ | Provides supplementary information about the connection.
+Angle brackets (<>) are not allowed.
|
-port_type
+ | port_type
|
-String
+ | String
|
-Yes
+ | Yes
|
-Specifies the type of the port used by the connection. The value can be 1G or 10G.
+ | Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G.
|
-bandwidth
+ | bandwidth
|
-Integer
+ | Integer
|
-Yes
+ | Yes
|
-Specifies the connection bandwidth in Mbit/s.
+ | Specifies the bandwidth of the connection in Mbit/s.
|
-location
+ | location
|
-String
+ | String
|
-Yes
+ | Yes
|
-Specifies the connection access location.
+ | Specifies the connection access location.
|
-peer_location
+ | peer_location
|
-String
+ | String
|
-No
+ | No
|
-Specifies the physical location of the peer device accessed by the connection, specific to the street or data center name.
+ | Specifies the physical location of the peer device accessed by the connection, specific to the street or data center name.
|
-device_id
+ | device_id
|
-String
+ | String
|
-No
+ | No
|
-Specifies the gateway device ID of the connection.
+ | Specifies the gateway device ID of the connection.
|
-interface_name
+ | interface_name
|
-String
+ | String
|
-No
+ | No
|
-Specifies the name of the interface accessed by the connection.
+ | Specifies the name of the interface accessed by the connection.
|
-redundant_id
+ | redundant_id
|
-String
+ | String
|
-No
+ | No
|
-Specifies the ID of the redundant connection using the same gateway.
+ | Specifies the ID of the redundant connection using the same gateway.
|
-provider
+ | provider
|
-String
+ | String
|
-Yes
+ | Yes
|
-Specifies the carrier who provides the leased line.
+ | Specifies the carrier who provides the leased line.
|
-provider_status
+ | provider_status
|
-String
+ | String
|
-No
+ | No
|
-Specifies the status of the carrier's leased line.
+ | Specifies the status of the carrier's leased line.
The value can be ACTIVE or DOWN.
|
-type
+ | type
|
-String
+ | String
|
-No
+ | No
|
-Specifies the connection type. The value can be hosted.
+ | Specifies the connection type. The value can only be hosted.
|
-hosting_id
+ | hosting_id
|
-String
+ | String
|
-No
+ | No
|
-Specifies the ID of the operations connection on which the hosted connection is created.
+ | Specifies the ID of the operations connection on which the hosted connection is created.
|
-vlan
+ | charge_mode
|
-Integer
+ | String
|
-No
+ | No
|
-Specifies the VLAN pre-allocated to the hosted connection.
+ | 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.
|
-charge_mode
+ | order_id
|
-String
+ | String
|
-No
+ | No
|
-Specifies the billing mode. The value can be prepayment, bandwidth, or traffic.
+ | Specifies the order number of the connection.
|
-order_id
+ | product_id
|
-String
+ | String
|
-No
+ | No
|
-Specifies the order number of the connection.
+ | Specifies the product ID corresponding to the connection's order.
|
-product_id
+ | status
|
-String
+ | String
|
-No
+ | No
|
-Specifies the product ID corresponding to the connection's order.
- |
-
-status
- |
-String
- |
-No
- |
-Specifies the connection status.
+ | 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
+ | admin_state_up
|
-Boolean
+ | Boolean
|
-No
+ | No
|
-Specifies the administrative status of the connection.
+ | Specifies the administrative status of the connection.
The value can be true or false.
|
@@ -233,7 +227,7 @@
Table 3 Response parameterParameter
|
-Type
+ | Type
|
Description
|
@@ -241,7 +235,7 @@
|---|
direct_connect
|
-Dictionary data structure
+ | Dictionary
|
Specifies the direct_connect object.
|
@@ -249,230 +243,64 @@
Table 4 Description of field direct_connectParameter
- |
-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, specific to the street or data center name.
- |
-
-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.
-Its value is left blank by default.
- |
-
-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.
- |
-
-
-
- For details about the direct_connect field, see Table 1.
Examples- Example request
POST /v2.0/dcaas/direct-connects
{
"direct_connect" : {
- "name" : "direct connect1",
- "port_type" : "10G",
- "bandwidth" : 100,
- "location" : "Biere",
- "device_id" : "172.16.40.2",
- "provider" : "OTC"
+ "name": "client-dc-55df",
+ "bandwidth": 2,
+ "description": "",
+ "type": "hosted",
+ "vlan": "1234",
+ "port_type": "1G",
+ "location": "Biere",
+ "provider": "OTC",
+ "hosting_id": "07fa7f82-826f-4bf1-9a90-8364e53b91f4",
+ "tenant_id": "06057682ed80d5762f25c00b5deb794a"
}
}
- Example response
{
- "direct_connect" : {
- "bandwidth" : 100,
- "create_time": "2018-10-19 09:53:26.389556",
- "port_type" : "10G",
- "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
- "apply_time": "2018-10-19 09:53:26.389556",
- "peer_location": "",
- "delete_time": null,
- "location" : "Biere",
- "provider" : "OTC"
- "interface_name": "Eth-Trunk2",
- "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",
- "redundant_id": null,
- "hosting_id": null,
- "product_id": "",
- "charge_mode": ""
- }
+ "direct_connect" : {
+ "id" : "10a91e67-90e9-4b06-87c8-e762296fada1",
+ "name" : "client-dc-65de",
+ "description" : "",
+ "tenant_id" : "06057682ed80d5762f25c00b5deb794a",
+ "type" : "hosted",
+ "hosting_id" : "07fa7f82-826f-4bf1-9a90-8364e53b91f4",
+ "vlan" : 1234,
+ "charge_mode" : null,
+ "port_type" : "1G",
+ "bandwidth" : 2,
+ "location" : "Biere",
+ "peer_location" : "",
+ "device_id" : "18.8.215.131",
+ "provider" : "OTC",
+ "provider_status" : "ACTIVE",
+ "status" : "BUILD",
+ "apply_time" : "2023-02-12T23:46:26.000Z",
+ "reason" : null,
+ "admin_state_up" : true,
+ "order_id" : null,
+ "product_id" : null,
+ "spec_code" : null,
+ "create_time" : "2023-02-12T23:46:26.000Z",
+ "peer_port_type" : null,
+ "peer_provider" : null,
+ "onestop_product_id" : null,
+ "building_line_product_id" : null,
+ "last_building_line_product_id" : null,
+ "last_onestop_product_id" : null,
+ "period_type" : null,
+ "period_num" : null,
+ "vgw_type" : "default",
+ "lag_id" : null
+ }
}
-
diff --git a/docs/dc/api-ref/en-dc_topic_0055025316.html b/docs/dc/api-ref/en-dc_topic_0055025316.html
index 283534f5..38b9882c 100644
--- a/docs/dc/api-ref/en-dc_topic_0055025316.html
+++ b/docs/dc/api-ref/en-dc_topic_0055025316.html
@@ -3,25 +3,25 @@
Querying the Connection List
FunctionThis API is used to query the connection list.
- URIGET /v2.0/dcaas/direct-connects
+ URIGET /v2.0/dcaas/direct-connects
- Table 1 Parameter descriptionParameter
+Table 1 Parameter descriptionParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-direct_connects
+ | direct_connects
|
-List data structure
+ | List
|
-Yes
+ | Yes
|
-Specifies the connection list.
+ | Specifies the connection list.
|
@@ -30,23 +30,23 @@
RequestTable 2 lists the request parameter.
- Table 2 Request parameterParameter
+Table 2 Request parameterParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-fields
+ | fields
|
-String
+ | String
|
-No
+ | No
|
-Specifies the parameters expected to be returned.
+ | Specifies the parameters expected to be returned.
If you do not specify it, all parameters will be returned.
|
@@ -54,230 +54,80 @@
ResponseTable 3 lists the response parameter.
+ ResponseTable 3 lists the response parameter.
- Table 3 Response parameterParameter
+Table 3 Response parameterParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-direct_connects
+ | direct_connects
|
-List data structure
+ | List
|
-Specifies the connection list.
+ | Specifies the connection list.
|
Table 4 lists the direct_connects parameters.
-
-Table 4 Parameter descriptionParameter
- |
-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 location of the on-premises facility at the other end of the connection, specific to the street or data center name.
- |
-
-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 VLAN pre-allocated 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.
- |
-
-
-
+ For details about the direct_connects field, see Table 1.
Examples- Example request
- All parameters are returned:
+
-- 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"
- }]
+- Example response
{
+ "direct_connects" : [{
+ "name": "direct connect",
+ "id": "294ebeeb-62dd-4ece-99f5-73055df6d835",
+ "description": "",
+ "tenant_id": "0605768ad980d5762f8ac010b919754c",
+ "type": "hosted",
+ "hosting_id": "0e85c677-6eb5-4ef6-87a7-74d4586be895",
+ "vlan": 228,
+ "charge_mode": null,
+ "port_type": "1G",
+ "bandwidth": 2,
+ "location": "Biere",
+ "peer_location": "",
+ "device_id": "18.8.215.131",
+ "interface_name": "Eth-Trunk2",
+ "redundant_id": null,
+ "provider": "OTC",
+ "provider_status": "ACTIVE",
+ "status": "ACTIVE",
+ "apply_time": "2022-12-08T01:59:36.000Z",
+ "reason": null,
+ "admin_state_up": true,
+ "order_id": null,
+ "product_id": null,
+ "spec_code": null,
+ "applicant": null,
+ "mobile": null,
+ "email": null,
+ "create_time": "2022-12-08T01:59:36.000Z",
+ "region_id": null,
+ "service_key": null,
+ "cable_label": null,
+ "peer_port_type": null,
+ "peer_provider": null,
+ "onestop_product_id": null,
+ "building_line_product_id": null,
+ "last_onestop_product_id": null,
+ "period_type": null,
+ "period_num": null,
+ "vgw_type": "default",
+ "lag_id": null
+ }]
}
-
diff --git a/docs/dc/api-ref/en-dc_topic_0055025317.html b/docs/dc/api-ref/en-dc_topic_0055025317.html
index afeeed8f..b009cdc8 100644
--- a/docs/dc/api-ref/en-dc_topic_0055025317.html
+++ b/docs/dc/api-ref/en-dc_topic_0055025317.html
@@ -1,9 +1,9 @@
- Deleting a Connection
- FunctionThis API is used to delete a connection.
+ Deleting a Connection
+ FunctionThis API is used to delete a connection.
- URIDELETE /v2.0/dcaas/direct-connects/{direct_connect_id}
+ URIDELETE /v2.0/dcaas/direct-connects/{direct_connect_id}
Table 1 Parameter descriptionParameter
|
@@ -21,7 +21,7 @@
Yes
|
-Indicates the connection ID.
+ | Specifies the connection ID.
|
|---|
@@ -35,7 +35,7 @@
Examples
DELETE /v2.0/dcaas/direct-connects/{direct_connect_id}
diff --git a/docs/dc/api-ref/en-dc_topic_0055025318.html b/docs/dc/api-ref/en-dc_topic_0055025318.html
index 42791494..d7f9429e 100644
--- a/docs/dc/api-ref/en-dc_topic_0055025318.html
+++ b/docs/dc/api-ref/en-dc_topic_0055025318.html
@@ -30,11 +30,11 @@
-ResponseTable 2 lists the response parameter.
+ ResponseTable 2 lists the response parameter.
Table 2 Response parameterParameter
|
-Type
+ | Type
|
Description
|
@@ -42,7 +42,7 @@
|---|
direct_connect
|
-Dictionary data structure
+ | Dictionary
|
Specifies the direct_connect object.
|
@@ -50,220 +50,57 @@
-
- Table 3 Description of field direct_connectParameter
- |
-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 VLAN pre-allocated 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.
- |
-
-
-
-
+ For details about the direct_connect field, see Table 1.
Examples
GET /v2.0/dcaas/direct-connects/{direct_connect_id}
- - Example response
{
- "direct_connect" : {
- "bandwidth" : 100,
- "create_time": "2018-10-19 09:53:26.389556",
- "port_type" : "10G",
- "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
- "apply_time": "2018-10-19 09:53:26.389556",
- "peer_location": "", "delete_time": null,
- "location" : "Biere",
- "provider" : "OTC"
+- Example response
{
+ "direct_connects" : {
+ "name": "direct connect",
+ "id": "294ebeeb-62dd-4ece-99f5-73055df6d835",
+ "description": "",
+ "tenant_id": "0605768ad980d5762f8ac010b919754c",
+ "type": "hosted",
+ "hosting_id": "0e85c677-6eb5-4ef6-87a7-74d4586be895",
+ "vlan": 228,
+ "charge_mode": null,
+ "port_type": "1G",
+ "bandwidth": 2,
+ "location": "Biere",
+ "peer_location": "",
+ "device_id": "18.8.215.131",
"interface_name": "Eth-Trunk2",
- "type": "standard",
- "status": "ACTIVE",
- "description" : "",
- "provider_status": "ACTIVE",
- "order_id": "",
- "vlan": null,
- "device_id" : "172.16.40.2",
- "name" : "direct connect1",
- "admin_state_up": true,
- "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
"redundant_id": null,
- "hosting_id": null,
- "product_id": "",
- "charge_mode": ""
- }
+ "provider": "OTC",
+ "provider_status": "ACTIVE",
+ "status": "ACTIVE",
+ "apply_time": "2022-12-08T01:59:36.000Z",
+ "reason": null,
+ "admin_state_up": true,
+ "order_id": null,
+ "product_id": null,
+ "spec_code": null,
+ "applicant": null,
+ "mobile": null,
+ "email": null,
+ "create_time": "2022-12-08T01:59:36.000Z",
+ "region_id": null,
+ "service_key": null,
+ "cable_label": null,
+ "peer_port_type": null,
+ "peer_provider": null,
+ "onestop_product_id": null,
+ "building_line_product_id": null,
+ "last_onestop_product_id": null,
+ "period_type": null,
+ "period_num": null,
+ "vgw_type": "default",
+ "lag_id": null
+ }
}
-
diff --git a/docs/dc/api-ref/en-dc_topic_0055025319.html b/docs/dc/api-ref/en-dc_topic_0055025319.html
index a04ad2b3..06593ac7 100644
--- a/docs/dc/api-ref/en-dc_topic_0055025319.html
+++ b/docs/dc/api-ref/en-dc_topic_0055025319.html
@@ -1,29 +1,27 @@
- Updating a Connection
- FunctionThis API is used to update a connection.
- - You can only increase the connection bandwidth.
- Bandwidths of the operations connections cannot be modified.
-
+ Updating a Connection
+ FunctionThis API is used to update a connection.
URIPUT /v2.0/dcaas/direct-connects/{direct_connect_id}
- Table 1 Parameter descriptionParameter
+Table 1 Parameter descriptionParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-direct_connect_id
+ | direct_connect_id
|
-String
+ | String
|
-No
+ | No
|
-Specifies the connection ID.
+ | Specifies the connection ID.
|
@@ -32,299 +30,103 @@
RequestTable 2 lists the request parameter.
- Table 2 Request parameterParameter
+Table 2 Request parameterParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-direct_connect
+ | direct_connect
|
-Dictionary data structure
+ | Dictionary
|
-No
+ | No
|
-Specifies the direct_connect object.
+ | Specifies the direct_connect object.
|
Table 3 Description of field direct_connectParameter
+Table 3 Description of field direct_connectParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-description
+ | description
|
-String
+ | String
|
-No
+ | No
|
-Provides supplementary information about the connection.
+ | Provides supplementary information about the connection.
+Angle brackets (<>) are not allowed.
|
-name
+ | name
|
-String
+ | String
|
-No
+ | No
|
-Specifies the connection name.
+ | Specifies the connection name.
+Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
|
-bandwidth
+ | bandwidth
|
-Integer
+ | Integer
|
-No
+ | No
|
-Specifies the bandwidth of the connection in Mbit/s.
+ | Specifies the bandwidth of the connection in Mbit/s.
|
-provider_status
+ | provider_status
|
-String
+ | String
|
-No
+ | No
|
-Specifies the status of the carrier's leased line.
+ | 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.
- |
-
ResponseTable 4 lists the response parameter.
+ ResponseTable 4 lists the response parameter.
- Table 4 Response parameterParameter
+Table 4 Response parameterParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-direct_connect
+ | direct_connect
|
-Dictionary data structure
+ | Dictionary
|
-Specifies the direct_connect object.
- |
-
-
-
- Table 5 Description of field direct_connectParameter
- |
-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.
+ | Specifies the direct_connect object.
|
For details about the direct_connect field, see Table 1.
-- 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"
- }
+- Example response
{
+ "direct_connects" : {
+ "name": "direct connect",
+ "id": "294ebeeb-62dd-4ece-99f5-73055df6d835",
+ "description": "",
+ "tenant_id": "0605768ad980d5762f8ac010b919754c",
+ "type": "hosted",
+ "hosting_id": "0e85c677-6eb5-4ef6-87a7-74d4586be895",
+ "vlan": 228,
+ "charge_mode": null,
+ "port_type": "1G",
+ "bandwidth": 2,
+ "location": "Biere",
+ "peer_location": "",
+ "device_id": "18.8.215.131",
+ "interface_name": "Eth-Trunk2",
+ "redundant_id": null,
+ "provider": "OTC",
+ "provider_status": "ACTIVE",
+ "status": "ACTIVE",
+ "apply_time": "2022-12-08T01:59:36.000Z",
+ "reason": null,
+ "admin_state_up": true,
+ "order_id": null,
+ "product_id": null,
+ "spec_code": null,
+ "applicant": null,
+ "mobile": null,
+ "email": null,
+ "create_time": "2022-12-08T01:59:36.000Z",
+ "region_id": null,
+ "service_key": null,
+ "cable_label": null,
+ "peer_port_type": null,
+ "peer_provider": null,
+ "onestop_product_id": null,
+ "building_line_product_id": null,
+ "last_onestop_product_id": null,
+ "period_type": null,
+ "period_num": null,
+ "vgw_type": "default",
+ "lag_id": null
+ }
}
-
diff --git a/docs/dc/api-ref/en-dc_topic_0055025320.html b/docs/dc/api-ref/en-dc_topic_0055025320.html
index 83533925..4e539485 100644
--- a/docs/dc/api-ref/en-dc_topic_0055025320.html
+++ b/docs/dc/api-ref/en-dc_topic_0055025320.html
@@ -1,8 +1,11 @@
- Virtual Gateway
-
+
+ Virtual Gateway
+
+
+
diff --git a/docs/dc/api-ref/en-dc_topic_0055025321.html b/docs/dc/api-ref/en-dc_topic_0055025321.html
index e641602f..68a13a0a 100644
--- a/docs/dc/api-ref/en-dc_topic_0055025321.html
+++ b/docs/dc/api-ref/en-dc_topic_0055025321.html
@@ -1,182 +1,226 @@
Overview
- Object IntroductionThis section describes the APIs for managing and operating the virtual gateway, including the APIs used to create, query, update, and delete a virtual gateway, and the API used to query the virtual gateway list.
+ Object IntroductionThis section describes the APIs for managing and operating the virtual gateway, including the APIs used to create, query, update, and delete a virtual gateway, and the API used to query the virtual gateway list.
+ Virtual gateway APIs do not support IPv6 addresses.
+
- Object Model
- Table 1 Virtual gateway objectsAttribute
+Object Model
+ Table 1 Virtual gateway objectsParameter
|
-Type
+ | Type
|
-CRUD
+ | CRUD
|
-Default Value
+ | Default Value
|
-Constraint
+ | Constraint
|
-Description
+ | Description
|
|---|
-id
+ | id
|
-String
+ | String
|
-R
+ | R
|
-Automatically generated
+ | Automatically generated
|
-uuid
+ | UUID
|
-Specifies the virtual gateway ID.
+ | Specifies the virtual gateway ID.
|
-tenant_id
+ | tenant_id
|
-String
+ | String
|
-CR
+ | CR
|
-N/A
+ | N/A
|
-The value can contain 0 to 255 characters.
+ | The value can contain 0 to 255 characters.
|
-Specifies the tenant ID.
+ | Specifies the tenant ID.
|
-name
+ | name
|
-String
+ | String
|
-CRU
+ | CRU
|
-None
+ | None
|
-The value can contain 0 to 64 characters.
-The name can contain only digits, letters, underscores (_), and hyphens (-).
+ | The value can contain 0 to 64 characters.
+Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
|
-Specifies the virtual gateway name.
+ | Specifies the virtual gateway name.
|
-description
+ | description
|
-String
+ | String
|
-CRU
+ | CRU
|
-None
+ | None
|
-The value can contain 0 to 128 characters.
+ | The value can contain 0 to 128 characters.
+Angle brackets (<>) are not allowed.
|
-Provides supplementary information about the virtual gateway.
+ | Provides supplementary information about the virtual gateway.
|
-vpc_id
+ | vpc_id
|
-String
+ | String
|
-CR
+ | CR
|
-N/A
+ | N/A
|
-uuid
+ | UUID
|
-Specifies the ID of the VPC to be accessed.
+ | Specifies the ID of the VPC to be accessed.
|
-local_ep_group_id
+ | local_ep_group_id
|
-String
+ | String
|
-CRU
+ | CRU
|
-N/A
+ | N/A
|
-uuid
+ | UUID
|
-Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.
+ | Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.
|
-device_id
+ | device_id
|
-String
+ | String
|
-CR
+ | CR
|
-None
+ | None
|
-The value can contain 0 to 255 characters.
+ | The value can contain 0 to 255 characters.
|
-Specifies the ID of the physical device.
+ | Specifies the ID of the physical device used by the virtual gateway.
|
-redundant_device_id
+ | redundant_device_id
|
-String
+ | String
|
-CR
+ | CR
|
-None
+ | None
|
-The value can contain 0 to 255 characters.
+ | The value can contain 0 to 255 characters.
|
-Specifies the ID of the redundant device.
+ | Specifies the ID of the redundant physical device used by the virtual gateway.
|
-type
+ | type
|
-String
+ | String
|
-CR
+ | CR
|
-default
+ | default
|
-The value can contain 0 to 255 characters.
+ | The value can contain 0 to 255 characters.
|
-Specifies the virtual gateway type. The value can be default or double ipsec.
+ | Specifies the virtual gateway type. The value can only be default.
|
-ipsec_bandwidth
+ | ipsec_bandwidth
|
-Integer
+ | Integer
|
-CR
+ | CR
|
-N/A
+ | 1
|
-Bandwidth range: 1 Mbit/s to 300 Mbit/s
+ | Bandwidth range: 1 Mbit/s to 300 Mbit/s
|
-Specifies the bandwidth provided for Internet Protocol security virtual private network (IPsec VPN) in Mbit/s.
+ | This field is discarded.
|
-status
+ | status
|
-String
+ | String
|
-R
+ | R
|
-NA
+ | NA
|
-N/A
+ | N/A
|
-Specifies the virtual gateway status.
-Valid values are: ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, and PENDING_DELETE.
+ | Specifies the operating status of the virtual gateway. The value can be ACTIVE, ERROR, PENDING_CREATE, or PENDING_UPDATE.
+- ACTIVE: The virtual gateway is normal.
- ERROR: The virtual gateway is abnormal.
- PENDING_CREATE: The virtual gateway is being created.
- PENDING_UPDATE: The virtual gateway is being updated.
|
-admin_state_up
+ | admin_state_up
|
-Boolean
+ | Boolean
|
-CR
+ | CR
|
-true
+ | true
|
-The value can only be true.
+ | The value can only be true.
|
-Specifies the administrative status of the virtual gateway.
+ | Specifies the administrative status of the virtual gateway.
The value can be true or false.
|
+bgp_asn
+ |
+Integer
+ |
+CR
+ |
+64512
+ |
+N/A
+ |
+Specifies the BGP ASN of the virtual gateway. This is a reserved field, which is not used currently.
+ |
+
+region_id
+ |
+String
+ |
+CRU
+ |
+None
+ |
+N/A
+ |
+This is a reserved field, which is not used currently.
+ |
+
+local_ep_group_ipv6_id
+ |
+String
+ |
+CR
+ |
+None
+ |
+UUID
+ |
+Specifies the ID of the local endpoint group that records CIDR blocks of the IPv6 VPC subnets.
+ NOTE: This is a reserved field. It can only be viewed in APIs and cannot be configured or used.
+
+ |
+
diff --git a/docs/dc/api-ref/en-dc_topic_0055025322.html b/docs/dc/api-ref/en-dc_topic_0055025322.html
index 762764c7..4a86d17e 100644
--- a/docs/dc/api-ref/en-dc_topic_0055025322.html
+++ b/docs/dc/api-ref/en-dc_topic_0055025322.html
@@ -5,139 +5,132 @@
URIPOST /v2.0/dcaas/virtual-gateways
- Table 1 Parameter descriptionParameter
+Table 1 Parameter descriptionParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-virtual_gateway
+ | virtual_gateway
|
-Dictionary data structure
+ | Dictionary
|
-Yes
+ | Yes
|
-Specifies the virtual_gateway object.
+ | Specifies the virtual_gateway object.
|
RequestTable 2 lists the virtual_gateway parameters.
+ RequestFor details about the virtual_gateway field, see Table 2.
- Table 2 Request parametersParameter
+Table 2 Request parametersParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-tenant_id
+ | tenant_id
|
-String
+ | String
|
-No
+ | No
|
-Specifies the project ID.
+ | Specifies the project ID.
|
-name
+ | name
|
-String
+ | String
|
-No
+ | No
|
-Specifies the virtual gateway name.
+ | Specifies the virtual gateway name.
+Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
|
-description
+ | description
|
-String
+ | String
|
-No
+ | No
|
-Provides supplementary information about the virtual gateway.
+ | Provides supplementary information about the virtual gateway.
+Angle brackets (<>) are not allowed.
|
-vpc_id
+ | vpc_id
|
-String
+ | String
|
-Yes
+ | Yes
|
-Specifies the ID of the VPC to be accessed.
+ | Specifies the ID of the VPC to be accessed.
|
-local_ep_group_id
+ | local_ep_group_id
|
-String
+ | String
|
-Yes
+ | Yes
|
-Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.
+ | Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.
For details about how to obtain the ID, see section Creating an Endpoint Group.
|
-device_id
+ | bgp_asn
|
-String
+ | Integer
|
-No
+ | No
|
-Specifies the ID of the physical device used by the virtual gateway.
+ | Specifies the BGP ASN of the virtual gateway.
|
-redundant_device_id
+ | device_id
|
-String
+ | String
|
-No
+ | No
|
-Specifies the ID of the redundant physical device used by the virtual gateway.
+ | Specifies the ID of the physical device used by the virtual gateway.
|
-type
+ | redundant_device_id
|
-String
+ | String
|
-No
+ | No
|
-Specifies the virtual gateway type. The value can be default or double ipsec.
+ | Specifies the ID of the redundant physical device used by the virtual gateway.
|
-ipsec_bandwidth
+ | type
|
-Integer
+ | String
|
-No
+ | No
|
-Specifies the bandwidth provided for IPsec VPN in Mbit/s.
+ | Specifies the virtual gateway type. The value can only be default.
|
-bgp_asn
+ | admin_state_up
|
-Integer
+ | Boolean
|
-No
+ | No
|
-Specifies the BGP ASN of the virtual gateway.
- |
-
-admin_state_up
- |
-Boolean
- |
-No
- |
-Specifies the administrative status of the virtual gateway.
+ | Specifies the administrative status of the virtual gateway.
The value can be true or false.
|
@@ -145,160 +138,60 @@
ResponseTable 3 lists the response parameter.
+ ResponseTable 3 lists the response parameter.
- Table 3 Response parameterParameter
+Table 3 Response parameterParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-virtual_gateway
+ | virtual_gateway
|
-Dictionary data structure
+ | Dictionary
|
-Specifies the virtual_gateway object.
+ | Specifies the virtual_gateway object.
|
Table 4 Description of field virtual_gatewayParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-id
- |
-String
- |
-Specifies the virtual gateway ID.
- |
-
-tenant_id
- |
-String
- |
-Specifies the project ID.
- |
-
-name
- |
-String
- |
-Specifies the virtual gateway name.
- |
-
-description
- |
-String
- |
-Provides supplementary information about the virtual gateway.
- |
-
-vpc_id
- |
-String
- |
-Specifies the ID of the VPC to be accessed.
- |
-
-local_ep_group_id
- |
-String
- |
-Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.
- |
-
-device_id
- |
-String
- |
-Specifies the ID of the physical device used by the virtual gateway.
- |
-
-redundant_device_id
- |
-String
- |
-Specifies the ID of the redundant physical device used by the virtual gateway.
- |
-
-type
- |
-String
- |
-Specifies the virtual gateway type. The value can be default or double ipsec.
- |
-
-ipsec_bandwidth
- |
-Integer
- |
-Specifies the bandwidth provided for IPsec VPN in Mbit/s.
- |
-
-bgp_asn
- |
-Integer
- |
-Specifies the BGP ASN of the virtual gateway.
- |
-
-admin_state_up
- |
-Boolean
- |
-Specifies the administrative status of the virtual gateway.
-The value can be true or false.
- |
-
-status
- |
-String
- |
-Specifies the virtual gateway status. The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
- |
-
-
-
+ For details about the virtual_gateway field, see Table 1.
Examples- Example request
POST /v2.0/dcaas/virtual-gateways
-{
- "virtual_gateway" : {
- "name" : "virtual gateway1",
- "vpc_id" : "908d9cf3-da64-4acb-393f-e5eb6b9e838a",
- "local_ep_group_id" : "f8834cf1-5468-87c7-223d-56e78b9699ab",
- "device_id" : "aaa_01"
- }
+Examples- Example request
POST /v2.0/dcaas/virtual-gateways
+ {
+ "virtual_gateway" : {
+ "name" : "virtual gateway1",
+ "vpc_id" : "5352423b-b4ff-4a9e-839d-02698c2b36af ",
+ "local_ep_group_id" : "f8834cf1-5468-87c7-223d-56e78b9699ab",
+ "device_id" : "aaa_01"
+ }
}
- Example response
{
- "virtual_gateway":{
- "status": "PENDING_CREATE",
- "redundant_device_id": "",
- "description":"",
- "admin_state_up": true,
- "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f",
- "name": "virtual gateway1",
- "local_ep_group_id":"011856d0-e1b0-4d78-b83a-edd67801764b",
- "vpc_id":"908d9cf3-da64-4acb-393f-e5eb6b9e838a",
- "device_id":"70.202.5.206",
- "type": "default",
- "id":"97b87776-49e3-44a4-ac4c-8f9156a360cd",
- "ipsec_bandwidth":1
- }
+- Example response
{
+ "virtual_gateway":{
+ "id": "0a0888a6-4096-43a6-81c6-923912933451",
+ "name": "virtual gateway",
+ "description": null,
+ "tenant_id": "0605768a3300d5762f82c01180692873",
+ "vpc_id": "5352423b-b4ff-4a9e-839d-02698c2b36af",
+ "local_ep_group_id": "f8834cf1-5468-87c7-223d-56e78b9699ab",
+ "local_ep_group_ipv6_id": null,
+ "device_id": "aaa_01",
+ "redundant_device_id": null,
+ "type": "default",
+ "ipsec_bandwidth": 1,
+ "status": "PENDING_CREATE",
+ "admin_state_up": true,
+ "bgp_asn": null,
+ "region_id": null
+ }
}
-
diff --git a/docs/dc/api-ref/en-dc_topic_0055025323.html b/docs/dc/api-ref/en-dc_topic_0055025323.html
index 19f06505..46ae90fc 100644
--- a/docs/dc/api-ref/en-dc_topic_0055025323.html
+++ b/docs/dc/api-ref/en-dc_topic_0055025323.html
@@ -31,7 +31,7 @@
|
|---|
- ResponseTable 2 lists the response parameter.
+ ResponseTable 2 lists the response parameter.
Table 2 Response parameterParameter
|
@@ -43,7 +43,7 @@
|---|
virtual_gateways
|
-List data structure
+ | List
|
Specifies the virtual gateway list.
|
@@ -51,131 +51,35 @@
-
- Table 3 Description of field virtual_gatewaysParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-id
- |
-String
- |
-Specifies the virtual gateway ID.
- |
-
-tenant_id
- |
-String
- |
-Specifies the project ID.
- |
-
-name
- |
-String
- |
-Specifies the virtual gateway name.
- |
-
-description
- |
-String
- |
-Provides supplementary information about the virtual gateway.
- |
-
-vpc_id
- |
-String
- |
-Specifies the ID of the VPC to be accessed.
- |
-
-local_ep_group_id
- |
-String
- |
-Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.
- |
-
-device_id
- |
-String
- |
-Specifies the ID of the physical device used by the virtual gateway.
- |
-
-redundant_device_id
- |
-String
- |
-Specifies the ID of the redundant physical device used by the virtual gateway.
- |
-
-type
- |
-String
- |
-Specifies the virtual gateway type. The value can be default or double ipsec.
- |
-
-bgp_asn
- |
-Integer
- |
-Specifies the BGP ASN of the virtual gateway.
- |
-
-ipsec_bandwidth
- |
-Integer
- |
-Specifies the bandwidth provided for IPsec VPN in Mbit/s.
- |
-
-status
- |
-String
- |
-Specifies the virtual gateway status.
-The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
- |
-
-admin_state_up
- |
-Boolean
- |
-Specifies the administrative status of the virtual gateway.
-The value can be true or false.
- |
-
-
-
+ For details about the virtual_gateway field, see Table 1.
-
- Examples- Example request
- All parameters are returned:
+
-- Example response
{
- "virtual_gateways" : [{
- "id" : "7ec892f3-ca64-46c7-863f-a2eb1b9e8389",
- "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
- "name" : "virtual gateway1",
- "description" : "",
- "vpc_id" : "908d9cf3-da64-4acb-393f-e5eb6b9e838a",
- "local_ep_group_id" : "f8834cf1-5468-87c7-223d-56e78b9699ab",
- "device_id" : "aaa_01"
- }]
+- Example response
{
+ "virtual_gateways" : [{
+ "id": "0a0888a6-4096-43a6-81c6-923912933451",
+ "name": "virtual gateway",
+ "description": null,
+ "tenant_id": "0605768a3300d5762f82c01180692873",
+ "vpc_id": "5352423b-b4ff-4a9e-839d-02698c2b36af",
+ "local_ep_group_id": "f8834cf1-5468-87c7-223d-56e78b9699ab",
+ "local_ep_group_ipv6_id": null,
+ "device_id": "aaa_01",
+ "redundant_device_id": null,
+ "type": "default",
+ "ipsec_bandwidth": 1,
+ "status": "PENDING_CREATE",
+ "admin_state_up": true,
+ "bgp_asn": 64512,
+ "region_id": null
+ }]
}
-
diff --git a/docs/dc/api-ref/en-dc_topic_0055025324.html b/docs/dc/api-ref/en-dc_topic_0055025324.html
index fadb6e94..b87c7e9b 100644
--- a/docs/dc/api-ref/en-dc_topic_0055025324.html
+++ b/docs/dc/api-ref/en-dc_topic_0055025324.html
@@ -3,50 +3,50 @@
Deleting a Virtual Gateway
FunctionThis API is used to delete a virtual gateway.
- URIDELETE /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}
+ URIDELETE /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}
- Table 1 Parameter descriptionParameter
+Table 1 Parameter descriptionParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-virtual_gateway_id
+ | virtual_gateway_id
|
-String
+ | String
|
-Yes
+ | Yes
|
-Indicates the virtual gateway ID.
+ | Specifies the virtual gateway ID.
|
RequestTable 2 lists the request parameter.
+ RequestTable 2 lists the request parameter.
- Table 2 Request parameterParameter
+Table 2 Request parameterParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-virtual_gateway_id
+ | virtual_gateway_id
|
-String
+ | String
|
-Yes
+ | Yes
|
-Indicates the virtual gateway ID.
+ | Specifies the virtual gateway ID.
|
@@ -60,7 +60,7 @@
-
diff --git a/docs/dc/api-ref/en-dc_topic_0055025325.html b/docs/dc/api-ref/en-dc_topic_0055025325.html
index bd88332d..b284905c 100644
--- a/docs/dc/api-ref/en-dc_topic_0055025325.html
+++ b/docs/dc/api-ref/en-dc_topic_0055025325.html
@@ -5,23 +5,23 @@
URIGET /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}
- Table 1 Parameter descriptionParameter
+Table 1 Parameter descriptionParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-virtual_gateway_id
+ | virtual_gateway_id
|
-String
+ | String
|
-Yes
+ | Yes
|
-Specifies the virtual gateway ID.
+ | Specifies the virtual gateway ID.
|
@@ -30,203 +30,79 @@
RequestTable 2 lists the request parameter.
- Table 2 Request parameterParameter
+Table 2 Request parameterParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-virtual_gateway_id
+ | virtual_gateway_id
|
-String
+ | String
|
-Yes
+ | Yes
|
-Specifies the virtual gateway ID.
+ | Specifies the virtual gateway ID.
|
ResponseTable 3 lists the response parameter.
+ ResponseTable 3 lists the response parameter.
- Table 3 Response parameterParameter
+Table 3 Response parameterParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-virtual_gateway
+ | virtual_gateway
|
-Dictionary data structure
+ | Dictionary
|
-Yes
+ | Yes
|
-Specifies the virtual_gateway object.
+ | Specifies the virtual_gateway object.
|
Table 4 Description of field virtual_gatewayParameter
- |
-Type
- |
-Mandatory
- |
-Description
- |
-
|---|
-
-id
- |
-String
- |
-Yes
- |
-Specifies the virtual gateway ID.
- |
-
-tenant_id
- |
-String
- |
-Yes
- |
-Specifies the project ID.
- |
-
-name
- |
-String
- |
-No
- |
-Specifies the virtual gateway name.
- |
-
-description
- |
-String
- |
-No
- |
-Provides supplementary information about the virtual gateway.
- |
-
-vpc_id
- |
-String
- |
-Yes
- |
-Specifies the ID of the VPC to be accessed.
- |
-
-local_ep_group_id
- |
-String
- |
-Yes
- |
-Specifies the ID of the local endpoint group that records CIDR blocks of the VPC subnets.
- |
-
-device_id
- |
-String
- |
-No
- |
-Specifies the ID of the physical device used by the virtual gateway.
- |
-
-redundant_device_id
- |
-String
- |
-No
- |
-Specifies the ID of the redundant physical device used by the virtual gateway.
- |
-
-type
- |
-String
- |
-No
- |
-Specifies the virtual gateway type. The value can be default or double ipsec.
- |
-
-ipsec_bandwidth
- |
-Integer
- |
-No
- |
-Specifies the bandwidth provided for IPsec VPN in Mbit/s.
- |
-
-bgp_asn
- |
-Integer
- |
-No
- |
-Specifies the BGP ASN of the virtual gateway.
- |
-
-status
- |
-String
- |
-No
- |
-Specifies the virtual gateway status.
-The value can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
- |
-
-admin_state_up
- |
-Boolean
- |
-No
- |
-Specifies the administrative status of the virtual gateway.
-The value can be true or false.
- |
-
-
-
+ For details about the virtual_gateway field, see Table 1.
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|