-
diff --git a/docs/dc/api-ref/dc_08_0001.html b/docs/dc/api-ref/dc_08_0001.html
index 5aca5d91..9bfb04e2 100644
--- a/docs/dc/api-ref/dc_08_0001.html
+++ b/docs/dc/api-ref/dc_08_0001.html
@@ -1,7 +1,7 @@
- Introduction
+
+ - Connections
+
+ - Virtual Gateways
+
+ - Virtual Interfaces
+
+ - Permissions: Statements in a policy that allow or deny certain operations.
- APIs: REST APIs that can be called by a user who has been granted specific permissions.
- Actions: Specific operations that are allowed or denied.
- IAM or enterprise projects: Type of projects for which an action will take effect. Policies that contain actions for both IAM and enterprise projects can be used and take effect for both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM. For details about the differences between IAM projects and enterprise projects, see "What Are the Differences Between IAM and Enterprise Management?" in the Identity and Access Management User Guide.+
The check mark (√) and cross symbol (x) indicate that an action takes effect or does not take effect for the corresponding type of projects.
+ - Connections: contains actions supported by the APIs of Direct Connect connections, for example, creating a connection.
- Virtual Gateways: contains actions supported by the APIs of Direct Connect virtual gateway, such as creating a virtual gateway.
- Virtual Interfaces: contains actions supported by the APIs of Direct Connect virtual interfaces, for example, creating a virtual interface.
- Example request
- Overview
-
- - Creating a Virtual Gateway
-
- - Querying the Virtual Gateway List
-
- - Deleting a Virtual Gateway
-
- - Querying a Virtual Gateway
-
- - Updating a Virtual Gateway
-
- - Example request
- Overview
-
- - Creating a Virtual Interface
-
- - Querying the Virtual Interface List
-
- - Deleting a Virtual Interface
-
- - Querying a Virtual Interface
-
- - Updating a Virtual Interface
-
- - Example request
- Overview
-
- - Creating an Endpoint Group
-
- - Querying the Direct Connect Endpoint Group List
-
- - Deleting an Endpoint Group
-
- - Querying a Direct Connect Endpoint Group
-
- - Updating a Direct Connect Endpoint Group
-
- - Example request
PUT /v2.0/dcaas/dc-endpoint-groups/{endpoint_group_id} -{ - "dc_endpoint_group" : { - "name" : "endpoint group1", - "description" : "New description" - } -}- - Example response
{ - "dc_endpoint_groups" : { - "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a", - "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f", - "name" : "endpoint group1", - "description" : "New description", - "endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ], - "type" : "cidr" - } -}- - Common Status Codes
-
- - Error Codes
-
- - Updated Table 1 in Overview.
- Updated • Example response in Querying the Connection List.
- Updated • Example response in Querying a Connection.
- Updated • Example response in Updating a Connection.
- Updated Table 1 in Overview.
- Updated Table 2 in Creating a Virtual Interface.
- Updated Function in Updating a Virtual Interface.
- Updated Table 1 in API Overview.
- Updated Table 1 and Response in Querying All API Versions.
- Updated Table 1 and Response in Querying a Specified API Version.
- Updated Object Introduction in Overview.
- Updated the descriptions of the type parameter in Direct Connect Endpoint Group.
- Updated Error Codes.
- Updated Table 1 in API Overview.
- Added a note to state that only hosted connections can be created in Creating a Connection.
- Updated Error Codes.
- Updated Table 1 in API Overview.
- Deleted the API for creating a connection.
- Updated Function in Deleting a Connection.
- Updated Function in Updating a Connection.
- Updated the description of parameter type in Overview, Creating an Endpoint Group, Querying the Direct Connect Endpoint Group List, Querying a Direct Connect Endpoint Group, and Updating a Direct Connect Endpoint Group.
- Updated Table 2 in Updating a Connection.
- Updated Table 2 in Creating a Virtual Gateway.
- Updated Table 1 in API Overview.
- Updated Table 1 and • Example response in Querying All API Versions.
- Updated Table 1 and • Example response in Querying a Specified API Version.
- Updated Object Introduction and Object Model in Overview.
- Updated the function description, URI, request message, and response message in the API for creating a connection.
- Updated URI, Response, and Examples in Querying the Connection List.
- Updated Function and URI in Deleting a Connection.
- Updated Response in Querying a Connection.
- Updated Function and Response in Updating a Connection.
- Updated Object Introduction and Object Model in Overview.
- Updated Request, Response, and Examples in Creating a Virtual Gateway.
- Updated Response and Examples in Querying the Virtual Gateway List.
- Updated URI and Request in Deleting a Virtual Gateway.
- Updated Response and Examples in Querying a Virtual Gateway.
- Updated Request, Response, and Examples in Updating a Virtual Gateway.
- Updated Object Introduction and Object Model in Overview.
- Updated Request, Response, and Examples in Creating a Virtual Interface.
- Updated Request, Response, and Examples in Querying the Virtual Interface List.
- Updated URI in Deleting a Virtual Interface.
- Updated Response and Examples in Querying a Virtual Interface.
- Updated Request, Response, and Examples in Updating a Virtual Interface.
- Updated Object Introduction and Object Model in Overview.
- Updated Error Codes.
- Optimized the document structure.
- Deleted the introduction section.
- Added section Obtaining the API Version Information.
- Added the description about how to use the Direct Connect APIs.
- Added API constraints for creating a connection.
- Modified the request example and response example in the API for creating a connection.
- Added an example request for which filtered parameters are returned in section Querying the Connection List.
- Changed the value of Port Type to 1G and 10G in table "Connection object".
- Changed the value of Port Type to 1G or 10G in table "Description of field direct_connects" in section Querying the Connection List.
- Changed the value of Port Type to 1G or 10G in table "Description of field direct_connects" in section Querying a Connection.
- Changed the value of Port Type to 1G or 10G in table "Description of field direct_connects" in section Updating a Connection.
- Modified the description about parameter local_ep_group_id in table "Description of field virtual_gateway" in section Creating a Virtual Gateway.
- Added an example request for which filtered parameters are returned in section Querying the Virtual Gateway List.
- Added an example request for which filtered parameters are returned in section Querying the Virtual Interface List.
- Added an example request for which filtered parameters are returned in section Querying the Direct Connect Endpoint Group List.
- Deleted request parameter endpoint_group_id in section Updating a Direct Connect Endpoint Group.
- Updated the parameters in the "Connection object" table.
- Added parameters type and ipsec_bandwidth to the "Virtual gateway object" table.
- API Version
+
+ - Connection
+
+ - Virtual Gateway
+
+ - Virtual Interface
+
+ - Direct Connect Endpoint Group
+
+ - CURRENT: indicates a primary version.
- SUPPORTED: indicates an old version that is still supported.
- DEPRECATED: indicates a deprecated version that may be deleted later.
- CURRENT: indicates a primary version.
- SUPPORTED: indicates an old version that is still supported.
- DEPRECATED: indicates a deprecated version that may be deleted later.
- Example request
GET /
- - Example response
{ +diff --git a/docs/dc/api-ref/en-dc_topic_0055025312.html b/docs/dc/api-ref/en-us_topic_0055025312.html similarity index 52% rename from docs/dc/api-ref/en-dc_topic_0055025312.html rename to docs/dc/api-ref/en-us_topic_0055025312.html index e03538f5..957256b9 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025312.html +++ b/docs/dc/api-ref/en-us_topic_0055025312.html @@ -1,85 +1,85 @@ - +-Parent topic: Obtaining the API Version Information+Parent topic: API VersionQuerying a Specified API Version
-Function
This API is used to query a specified API version supported by Direct Connect.
+-Function
This API is used to query a specified API version supported by Direct Connect.
URI
GET /{api_version}
+-URI
GET /{api_version}
Request
None
+-Request
None
Response
Table 1 lists the response parameters.
+Response
Table 1 lists the response parameters.
-Table 1 Response parameters Parameter
+-Table 1 Response parameters Parameter
Type
+Type
Description
+Description
id
+id
String
+String
Specifies the version number, for example, v2.0.
+Specifies the version number, for example, v2.0.
links
+links
Array
+Array
Specifies the API URL.
+Specifies the API URL.
href
+href
String
+String
Specifies the reference address of the current API version.
+Specifies the reference address of the current API version.
rel
+rel
String
+String
Specifies the relationship between the current API version and the referenced address.
+Specifies the relationship between the current API version and the referenced address.
version
+version
String
+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.
+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
+status
String
+String
Specifies the version status. Value options are as follows:
-- CURRENT: indicates a primary version.
- SUPPORTED: indicates an old version that is still supported.
- DEPRECATED: indicates a deprecated version that may be deleted later.
Specifies the version status. Value options are as follows:
+- 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
+updated
String
+String
Specifies the version release time in UTC. For example, the release time format of v2.0 APIs is YYYY-MM-DDTHH:MM:SSZ.
+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
+min_version
String
+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.
+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 /v2.0
- - Example response
{ +Examples
diff --git a/docs/dc/api-ref/en-dc_topic_0055025313.html b/docs/dc/api-ref/en-us_topic_0055025313.html similarity index 51% rename from docs/dc/api-ref/en-dc_topic_0055025313.html rename to docs/dc/api-ref/en-us_topic_0055025313.html index d1782aab..cbf5ec20 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025313.html +++ b/docs/dc/api-ref/en-us_topic_0055025313.html @@ -1,25 +1,25 @@ - +-Parent topic: Obtaining the API Version Information+Parent topic: API VersionConnection
diff --git a/docs/dc/api-ref/en-dc_topic_0055025314.html b/docs/dc/api-ref/en-us_topic_0055025314.html similarity index 56% rename from docs/dc/api-ref/en-dc_topic_0055025314.html rename to docs/dc/api-ref/en-us_topic_0055025314.html index 9ec17eaa..0ab7d869 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025314.html +++ b/docs/dc/api-ref/en-us_topic_0055025314.html @@ -1,560 +1,562 @@ - +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 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
-Table 1 Connection objects Parameter
+Object Model
+Table 1 Connection objects Parameter
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.
-Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
+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.
-Angle brackets (<>) are not allowed.
+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, 10G, 40G, or 100G.
+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.
-You can only create hosted connections by calling APIs.
+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 VLAN pre-allocated to 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. 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.
+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 was 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.
+The UTC time format YYYY-MM-DDTHH:MM:SSZ is used.
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 was deleted.
+Specifies the time when the connection was deleted.
+The UTC time format YYYY-MM-DDTHH:MM:SSZ is used.
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 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.
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.
-The value can be true or false.
+Specifies the administrative status of the connection.
+The value can be true or false.
spec_code
+spec_code
String
+String
CR
+CR
None
+None
N/A
+N/A
This is a reserved field, which is not used currently.
+This is a reserved field, which is not used currently.
applicant
+applicant
String
+String
CR
+CR
None
+None
N/A
+N/A
This is a reserved field, which is not used currently.
+This is a reserved field, which is not used currently.
mobile
+mobile
String
+String
CR
+CR
None
+None
N/A
+N/A
This is a reserved field, which is not used currently.
+This is a reserved field, which is not used currently.
email
+email
String
+String
CR
+CR
None
+None
The value consists of 1 to 255 characters.
+The value consists of 1 to 255 characters.
This is a reserved field, which is not used currently.
+This is a reserved field, which is not used currently.
region_id
+region_id
String
+String
CR
+CR
None
+None
N/A
+N/A
This is a reserved field, which is not used currently.
+This is a reserved field, which is not used currently.
service_key
+service_key
String
+String
CR
+CR
None
+None
N/A
+N/A
This is a reserved field, which is not used currently.
+This is a reserved field, which is not used currently.
cable_label
+cable_label
String
+String
CR
+CR
None
+None
N/A
+N/A
This is a reserved field, which is not used currently.
+This is a reserved field, which is not used currently.
peer_port_type
+peer_port_type
String
+String
CR
+CR
None
+None
N/A
+N/A
This is a reserved field, which is not used currently.
+This is a reserved field, which is not used currently.
peer_provider
+peer_provider
String
+String
CR
+CR
None
+None
N/A
+N/A
This is a reserved field, which is not used currently.
+This is a reserved field, which is not used currently.
onestop_product_id
+onestop_product_id
String
+String
CR
+CR
None
+None
N/A
+N/A
This is a reserved field, which is not used currently.
+This is a reserved field, which is not used currently.
building_line_product_id
+building_line_product_id
String
+String
CR
+CR
None
+None
N/A
+N/A
This is a reserved field, which is not used currently.
+This is a reserved field, which is not used currently.
last_onestop_product_id
+last_onestop_product_id
String
+String
CR
+CR
None
+None
N/A
+N/A
This is a reserved field, which is not used currently.
+This is a reserved field, which is not used currently.
period_type
+period_type
Integer
+Integer
CR
+CR
None
+None
N/A
+N/A
This is a reserved field, which is not used currently.
+This is a reserved field, which is not used currently.
period_num
+period_num
Integer
+Integer
CR
+CR
None
+None
N/A
+N/A
This is a reserved field, which is not used currently.
+This is a reserved field, which is not used currently.
reason
+reason
String
+String
CR
+CR
None
+None
N/A
+N/A
This is a reserved field, which is not used currently.
+This is a reserved field, which is not used currently.
vgw_type
+vgw_type
String
+String
CR
+CR
default
+default
default
+default
Specifies the type of the gateway. Currently, only the default type is supported.
+Specifies the type of the gateway. Currently, only the default type is supported.
lag_id
+lag_id
String
+String
CR
+CR
None
+None
UUID
+UUID
This is a reserved field, which is not used currently.
+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-us_topic_0055025315.html similarity index 52% rename from docs/dc/api-ref/en-dc_topic_0055025315.html rename to docs/dc/api-ref/en-us_topic_0055025315.html index 4e917190..5b35a6d8 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025315.html +++ b/docs/dc/api-ref/en-us_topic_0055025315.html @@ -1,251 +1,251 @@ - + --Parent topic: Connection+Parent topic: ConnectionCreating a Connection
-Function
This API is used to create a hosted connection.
- This API can only be used to create hosted connections.
+Creating a Connection
+-Function
This API is used to create a hosted connection.
+ This API can only be used to create hosted connections.
URI
POST /v2.0/dcaas/direct-connects
+URI
POST /v2.0/dcaas/direct-connects
-Table 1 Parameter description Parameter
+-Table 1 Parameter description Parameter
Type
+Type
Mandatory
+Mandatory
Description
+Description
direct_connect
+direct_connect
Dictionary
+Dictionary
Yes
+Yes
Specifies the direct_connect object.
+Specifies the direct_connect object.
Request
For details about the direct_connect field, see Table 2.
+Request
For details about the direct_connect field, see Table 2.
-Table 2 Request parameters Parameter
+-Table 2 Request parameters Parameter
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.
-Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
+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.
-Angle brackets (<>) are not allowed.
+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, 10G, 40G, or 100G.
+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 bandwidth of the connection 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.
-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
No
+No
Specifies the connection type. The value can only 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.
charge_mode
+charge_mode
String
+String
No
+No
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.
+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.
order_id
+order_id
String
+String
No
+No
Specifies the order number of the connection.
+Specifies the order number of the connection.
product_id
+product_id
String
+String
No
+No
Specifies the product ID corresponding to the connection's order.
+Specifies the product ID corresponding to the connection's order.
status
+status
String
+String
No
+No
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 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.
-The value can be true or false.
+Specifies the administrative status of the connection.
+The value can be true or false.
Response
Table 3 lists the response parameter.
+Response
Table 3 lists the response parameter.
-Table 3 Response parameter Parameter
+-Table 3 Response parameter Parameter
Type
+Type
Description
+Description
direct_connect
+direct_connect
Dictionary
+Dictionary
Specifies the direct_connect object.
+Specifies the direct_connect object.
For details about the direct_connect field, see Table 1.
+For details about the direct_connect field, see Table 1.
-Examples
- Example request
POST /v2.0/dcaas/direct-connects +
-Examples
- Example request
POST /v2.0/dcaas/direct-connects { "direct_connect" : { "name": "client-dc-55df", @@ -262,7 +262,7 @@ }
- Example response
{ +- Example response
{ "direct_connect" : { "id" : "10a91e67-90e9-4b06-87c8-e762296fada1", "name" : "client-dc-65de", @@ -300,12 +300,12 @@ } }
Status Codes
For details, see Common Status Codes.
+Status Codes
For details, see Common Status Codes.
diff --git a/docs/dc/api-ref/en-dc_topic_0055025316.html b/docs/dc/api-ref/en-us_topic_0055025316.html similarity index 53% rename from docs/dc/api-ref/en-dc_topic_0055025316.html rename to docs/dc/api-ref/en-us_topic_0055025316.html index 38b9882c..dfebcaea 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025316.html +++ b/docs/dc/api-ref/en-us_topic_0055025316.html @@ -1,88 +1,88 @@ - +-Parent topic: Connection+Parent topic: ConnectionQuerying the Connection List
-Function
This API is used to query the connection list.
+-Function
This API is used to query the connection list.
URI
GET /v2.0/dcaas/direct-connects
+URI
GET /v2.0/dcaas/direct-connects
-Table 1 Parameter description Parameter
+-Table 1 Parameter description Parameter
Type
+Type
Mandatory
+Mandatory
Description
+Description
direct_connects
+direct_connects
List
+List
Yes
+Yes
Specifies the connection list.
+Specifies the connection list.
Request
Table 2 lists the request parameter.
+Request
Table 2 lists the request parameter.
-Table 2 Request parameter Parameter
+-Table 2 Request parameter Parameter
Type
+Type
Mandatory
+Mandatory
Description
+Description
fields
+fields
String
+String
No
+No
Specifies the parameters expected to be returned.
-If you do not specify it, all parameters will be returned.
+Specifies the parameters expected to be returned.
+If you do not specify it, all parameters will be returned.
Response
Table 3 lists the response parameter.
+Response
Table 3 lists the response parameter.
-Table 3 Response parameter Parameter
+-Table 3 Response parameter Parameter
Type
+Type
Description
+Description
direct_connects
+direct_connects
List
+List
Specifies the connection list.
+Specifies the connection list.
For details about the direct_connects field, see Table 1.
+For details about the direct_connects field, see Table 1.
-Examples
- Example request
- Querying all connections
GET /v2.0/dcaas/direct-connects
-- Querying a connection using its ID
GET /v2.0/dcaas/direct-connects?id=6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a
+-Examples
- Example request
- Querying all connections
GET /v2.0/dcaas/direct-connects
+- Querying a connection using its ID
GET /v2.0/dcaas/direct-connects?id=6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a
- Example response
{ +- Example response
{ "direct_connects" : [{ "name": "direct connect", "id": "294ebeeb-62dd-4ece-99f5-73055df6d835", @@ -127,12 +127,12 @@ }] }
Status Codes
For details, see Common Status Codes.
+Status Codes
For details, see Common Status Codes.
diff --git a/docs/dc/api-ref/en-us_topic_0055025317.html b/docs/dc/api-ref/en-us_topic_0055025317.html new file mode 100644 index 00000000..2ec46856 --- /dev/null +++ b/docs/dc/api-ref/en-us_topic_0055025317.html @@ -0,0 +1,46 @@ + + +-Parent topic: Connection+Parent topic: ConnectionDeleting a Connection
++++URI
DELETE /v2.0/dcaas/direct-connects/{direct_connect_id}
+ ++
+Table 1 Parameter description Parameter
+Type
+Mandatory
+Description
+direct_connect_id
+String
+Yes
+Specifies the connection ID.
++Request
None
++Response
None
++Examples
- Example request
DELETE /v2.0/dcaas/direct-connects/{direct_connect_id}++Status Codes
For details, see Common Status Codes.
+++ diff --git a/docs/dc/api-ref/en-dc_topic_0055025318.html b/docs/dc/api-ref/en-us_topic_0055025318.html similarity index 54% rename from docs/dc/api-ref/en-dc_topic_0055025318.html rename to docs/dc/api-ref/en-us_topic_0055025318.html index d7f9429e..9c2a644a 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025318.html +++ b/docs/dc/api-ref/en-us_topic_0055025318.html @@ -1,61 +1,61 @@ - +++Parent topic: Connection+Querying a Connection
-Function
This API is used to query a connection.
+-Function
This API is used to query a connection.
URI
GET /v2.0/dcaas/direct-connects/{direct_connect_id}
+URI
GET /v2.0/dcaas/direct-connects/{direct_connect_id}
-Table 1 Parameter description Parameter
+-Table 1 Parameter description Parameter
Type
+Type
Mandatory
+Mandatory
Description
+Description
direct_connect_id
+direct_connect_id
String
+String
Yes
+Yes
Specifies the connection ID.
+Specifies the connection ID.
Request
None
+-Request
None
Response
Table 2 lists the response parameter.
+Response
Table 2 lists the response parameter.
-Table 2 Response parameter Parameter
+-Table 2 Response parameter Parameter
Type
+Type
Description
+Description
direct_connect
+direct_connect
Dictionary
+Dictionary
Specifies the direct_connect object.
+Specifies the direct_connect object.
For details about the direct_connect field, see Table 1.
+For details about the direct_connect field, see Table 1.
-Examples
- Example request
GET /v2.0/dcaas/direct-connects/{direct_connect_id}+-Examples
- Example request
GET /v2.0/dcaas/direct-connects/{direct_connect_id}- Example response
{ +- Example response
{ "direct_connects" : { "name": "direct connect", "id": "294ebeeb-62dd-4ece-99f5-73055df6d835", @@ -100,12 +100,12 @@ } }
Status Codes
For details, see Common Status Codes.
+Status Codes
For details, see Common Status Codes.
diff --git a/docs/dc/api-ref/en-dc_topic_0055025319.html b/docs/dc/api-ref/en-us_topic_0055025319.html similarity index 52% rename from docs/dc/api-ref/en-dc_topic_0055025319.html rename to docs/dc/api-ref/en-us_topic_0055025319.html index 06593ac7..e051357a 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025319.html +++ b/docs/dc/api-ref/en-us_topic_0055025319.html @@ -1,134 +1,134 @@ - + --Parent topic: Connection+Parent topic: ConnectionUpdating a Connection
-Function
This API is used to update a connection.
+Updating a Connection
+-URI
PUT /v2.0/dcaas/direct-connects/{direct_connect_id}
+URI
PUT /v2.0/dcaas/direct-connects/{direct_connect_id}
-Table 1 Parameter description Parameter
+-Table 1 Parameter description Parameter
Type
+Type
Mandatory
+Mandatory
Description
+Description
direct_connect_id
+direct_connect_id
String
+String
No
+No
Specifies the connection ID.
+Specifies the connection ID.
Request
Table 2 lists the request parameter.
+Request
Table 2 lists the request parameter.
-Table 2 Request parameter Parameter
+-Table 2 Request parameter Parameter
Type
+Type
Mandatory
+Mandatory
Description
+Description
direct_connect
+direct_connect
Dictionary
+Dictionary
No
+No
Specifies the direct_connect object.
+Specifies the direct_connect object.
Table 3 Description of field direct_connect Parameter
+-Table 3 Description of field direct_connect Parameter
Type
+Type
Mandatory
+Mandatory
Description
+Description
description
+description
String
+String
No
+No
Provides supplementary information about the connection.
-Angle brackets (<>) are not allowed.
+Provides supplementary information about the connection.
+Angle brackets (<>) are not allowed.
name
+name
String
+String
No
+No
Specifies the connection name.
-Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
+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.
-The value can be ACTIVE or DOWN.
+Specifies the status of the carrier's leased line.
+The value can be ACTIVE or DOWN.
Response
Table 4 lists the response parameter.
+Response
Table 4 lists the response parameter.
-Table 4 Response parameter Parameter
+-Table 4 Response parameter Parameter
Type
+Type
Description
+Description
direct_connect
+direct_connect
Dictionary
+Dictionary
Specifies the direct_connect object.
+Specifies the direct_connect object.
For details about the direct_connect field, see Table 1.
+For details about the direct_connect field, see Table 1.
-Examples
- Example request
PUT /v2.0/dcaas/direct-connects/{direct_connect_id} +-Examples
- Example request
PUT /v2.0/dcaas/direct-connects/{direct_connect_id} { "direct_connect" : { "name" : "direct connect1", @@ -137,7 +137,7 @@ }
- Example response
{ +- Example response
{ "direct_connects" : { "name": "direct connect", "id": "294ebeeb-62dd-4ece-99f5-73055df6d835", @@ -182,12 +182,12 @@ } }
Status Codes
For details, see Common Status Codes.
+Status Codes
For details, see Common Status Codes.
diff --git a/docs/dc/api-ref/en-us_topic_0055025320.html b/docs/dc/api-ref/en-us_topic_0055025320.html new file mode 100644 index 00000000..69166ca2 --- /dev/null +++ b/docs/dc/api-ref/en-us_topic_0055025320.html @@ -0,0 +1,29 @@ + + + +-Parent topic: Connection+Parent topic: ConnectionVirtual Gateway
+ +++ +++ diff --git a/docs/dc/api-ref/en-dc_topic_0055025321.html b/docs/dc/api-ref/en-us_topic_0055025321.html similarity index 59% rename from docs/dc/api-ref/en-dc_topic_0055025321.html rename to docs/dc/api-ref/en-us_topic_0055025321.html index 68a13a0a..b5262084 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025321.html +++ b/docs/dc/api-ref/en-us_topic_0055025321.html @@ -1,223 +1,223 @@ - +-
+
- Overview
+
+ - Creating a Virtual Gateway
+
+ - Querying the Virtual Gateway List
+
+ - Deleting a Virtual Gateway
+
+ - Querying a Virtual Gateway
+
+ - Updating a Virtual Gateway
+
+
++Parent topic: APIs v2.0+Overview
-Object Introduction
This 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 Introduction
This 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 objects Parameter
+Object Model
+Table 1 Virtual gateway objects Parameter
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.
-Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
+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.
-Angle brackets (<>) are not allowed.
+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 used by the virtual gateway.
+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 physical device used by the virtual gateway.
+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 only be default.
+Specifies the virtual gateway type. The value can only be default.
ipsec_bandwidth
+ipsec_bandwidth
Integer
+Integer
CR
+CR
1
+1
Bandwidth range: 1 Mbit/s to 300 Mbit/s
+Bandwidth range: 1 Mbit/s to 300 Mbit/s
This field is discarded.
+This field is discarded.
status
+status
String
+String
R
+R
NA
+NA
N/A
+N/A
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.
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.
-The value can be true or false.
+Specifies the administrative status of the virtual gateway.
+The value can be true or false.
bgp_asn
+bgp_asn
Integer
+Integer
CR
+CR
64512
+64512
N/A
+N/A
Specifies the BGP ASN of the virtual gateway. This is a reserved field, which is not used currently.
+Specifies the BGP ASN of the virtual gateway. This is a reserved field, which is not used currently.
region_id
+region_id
String
+String
CRU
+CRU
None
+None
N/A
+N/A
This is a reserved field, which is not used currently.
+This is a reserved field, which is not used currently.
local_ep_group_ipv6_id
+local_ep_group_ipv6_id
String
+String
CR
+CR
None
+None
UUID
+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.
+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-us_topic_0055025322.html similarity index 53% rename from docs/dc/api-ref/en-dc_topic_0055025322.html rename to docs/dc/api-ref/en-us_topic_0055025322.html index 4a86d17e..00c3efa3 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025322.html +++ b/docs/dc/api-ref/en-us_topic_0055025322.html @@ -1,166 +1,166 @@ - +-Parent topic: Virtual Gateway+Parent topic: Virtual GatewayCreating a Virtual Gateway
-Function
This API is used to create a virtual gateway.
+-Function
This API is used to create a virtual gateway.
URI
POST /v2.0/dcaas/virtual-gateways
+URI
POST /v2.0/dcaas/virtual-gateways
-Table 1 Parameter description Parameter
+-Table 1 Parameter description Parameter
Type
+Type
Mandatory
+Mandatory
Description
+Description
virtual_gateway
+virtual_gateway
Dictionary
+Dictionary
Yes
+Yes
Specifies the virtual_gateway object.
+Specifies the virtual_gateway object.
Request
For details about the virtual_gateway field, see Table 2.
+Request
For details about the virtual_gateway field, see Table 2.
-Table 2 Request parameters Parameter
+-Table 2 Request parameters Parameter
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.
-Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.
+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.
-Angle brackets (<>) are not allowed.
+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.
-For details about how to obtain the ID, see section Creating an Endpoint Group.
+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.
bgp_asn
+bgp_asn
Integer
+Integer
No
+No
Specifies the BGP ASN of the virtual gateway.
+Specifies the BGP ASN of the virtual gateway.
device_id
+device_id
String
+String
No
+No
Specifies the ID of the physical device used by the virtual gateway.
+Specifies the ID of the physical device used by the virtual gateway.
redundant_device_id
+redundant_device_id
String
+String
No
+No
Specifies the ID of the redundant physical device used by the virtual gateway.
+Specifies the ID of the redundant physical device used by the virtual gateway.
type
+type
String
+String
No
+No
Specifies the virtual gateway type. The value can only be default.
+Specifies the virtual gateway type. The value can only be default.
admin_state_up
+admin_state_up
Boolean
+Boolean
No
+No
Specifies the administrative status of the virtual gateway.
-The value can be true or false.
+Specifies the administrative status of the virtual gateway.
+The value can be true or false.
Response
Table 3 lists the response parameter.
+Response
Table 3 lists the response parameter.
-Table 3 Response parameter Parameter
+-Table 3 Response parameter Parameter
Type
+Type
Description
+Description
virtual_gateway
+virtual_gateway
Dictionary
+Dictionary
Specifies the virtual_gateway object.
+Specifies the virtual_gateway object.
For details about the virtual_gateway field, see Table 1.
+For details about the virtual_gateway field, see Table 1.
-Examples
- Example request
POST /v2.0/dcaas/virtual-gateways + -
- Example response
{ +- Example response
{ "virtual_gateway":{ "id": "0a0888a6-4096-43a6-81c6-923912933451", "name": "virtual gateway", @@ -191,12 +191,12 @@ } }
Status Codes
For details, see Common Status Codes.
+Status Codes
For details, see Common Status Codes.
diff --git a/docs/dc/api-ref/en-dc_topic_0055025323.html b/docs/dc/api-ref/en-us_topic_0055025323.html similarity index 50% rename from docs/dc/api-ref/en-dc_topic_0055025323.html rename to docs/dc/api-ref/en-us_topic_0055025323.html index 46ae90fc..c64a7580 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025323.html +++ b/docs/dc/api-ref/en-us_topic_0055025323.html @@ -1,65 +1,65 @@ - +-Parent topic: Virtual Gateway+Parent topic: Virtual GatewayQuerying the Virtual Gateway List
-Function
This API is used to query the virtual gateway list.
+-Function
This API is used to query the virtual gateway list.
URI
GET /v2.0/dcaas/virtual-gateways
+-URI
GET /v2.0/dcaas/virtual-gateways
Request
Table 1 lists the request parameter.
+Request
Table 1 lists the request parameter.
-Table 1 Request parameter Parameter
+-Table 1 Request parameter Parameter
Type
+Type
Mandatory
+Mandatory
Description
+Description
fields
+fields
String
+String
No
+No
Specifies the parameters expected to be returned.
-If you do not specify it, all parameters will be returned.
+Specifies the parameters expected to be returned.
+If you do not specify it, all parameters will be returned.
Response
Table 2 lists the response parameter.
+Response
Table 2 lists the response parameter.
-Table 2 Response parameter Parameter
+-Table 2 Response parameter Parameter
Type
+Type
Description
+Description
virtual_gateways
+virtual_gateways
List
+List
Specifies the virtual gateway list.
+Specifies the virtual gateway list.
For details about the virtual_gateway field, see Table 1.
+For details about the virtual_gateway field, see Table 1.
-Examples
- Example request
- Querying all virtual gateways
GET /v2.0/dcaas/virtual-gateways
-- Querying a virtual gateway by ID
GET /v2.0/dcaas/virtual-gateways?id=7ec892f3-ca64-46c7-863f-a2eb1b9e8389
+-Examples
- Example request
- Querying all virtual gateways
GET /v2.0/dcaas/virtual-gateways
+- Querying a virtual gateway by ID
GET /v2.0/dcaas/virtual-gateways?id=7ec892f3-ca64-46c7-863f-a2eb1b9e8389
- Example response
{ +- Example response
{ "virtual_gateways" : [{ "id": "0a0888a6-4096-43a6-81c6-923912933451", "name": "virtual gateway", @@ -79,12 +79,12 @@ }] }
Status Codes
For details, see Common Status Codes.
+Status Codes
For details, see Common Status Codes.
diff --git a/docs/dc/api-ref/en-us_topic_0055025324.html b/docs/dc/api-ref/en-us_topic_0055025324.html new file mode 100644 index 00000000..aff36cd6 --- /dev/null +++ b/docs/dc/api-ref/en-us_topic_0055025324.html @@ -0,0 +1,71 @@ + + +-Parent topic: Virtual Gateway+Parent topic: Virtual GatewayDeleting a Virtual Gateway
+++Function
This API is used to delete a virtual gateway.
++ +URI
DELETE /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}
+ ++
+Table 1 Parameter description Parameter
+Type
+Mandatory
+Description
+virtual_gateway_id
+String
+Yes
+Specifies the virtual gateway ID.
++Response
None
++ +Examples
- Example request
DELETE /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}++Status Codes
For details, see Common Status Codes.
+++ diff --git a/docs/dc/api-ref/en-dc_topic_0055025325.html b/docs/dc/api-ref/en-us_topic_0055025325.html similarity index 51% rename from docs/dc/api-ref/en-dc_topic_0055025325.html rename to docs/dc/api-ref/en-us_topic_0055025325.html index b284905c..3a7d7f92 100644 --- a/docs/dc/api-ref/en-dc_topic_0055025325.html +++ b/docs/dc/api-ref/en-us_topic_0055025325.html @@ -1,88 +1,88 @@ - +++Parent topic: Virtual Gateway+Querying a Virtual Gateway
-Function
This API is used to query a virtual gateway.
+-Function
This API is used to query a virtual gateway.
URI
GET /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}
+URI
GET /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}
-Table 1 Parameter description Parameter
+-Table 1 Parameter description Parameter
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.
Request
Table 2 lists the request parameter.
+Request
Table 2 lists the request parameter.
- - Example response
- Example response
- Example response
- Example response
- Example request
- Example response
- Example response
- Example response
- Example request
Introduction
-This chapter describes fine-grained permissions management for your Direct Connect. If your cloud account does not need individual Identity and Access Management (IAM) users, then you may skip over this chapter.
+This chapter describes fine-grained permissions management for Direct Connect. If your cloud account does not need individual Identity and Access Management (IAM) users, you can skip over this chapter.
By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.
You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.
Policy-based authorization is useful if you want to allow or deny the access to an API.
@@ -17,7 +17,7 @@Permissions Policies and Supported Actions (APIs v3)
+ +-
+
Introduction
+This topic describes fine-grained permissions management for Direct Connect. If your cloud account does not need individual Identity and Access Management (IAM) users, you can skip over this chapter.
+By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.
+You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.
+ Policy-based authorization is useful if you want to allow or deny the access to an API.
+An account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query the connections using an API, the user must have been granted permissions that allow the dcaas:directConnect:list action.
+Supported Actions
IAM provides system-defined policies that can be directly used. You can also create custom policies to work with system-defined policies for more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:
+Direct Connect supports the following actions that can be defined in custom policies:
+Connections
+Permission + |
+API + |
+Action + |
+Related Action + |
+IAM Project + |
+Enterprise Project + |
+
|---|---|---|---|---|---|
Creating a hosted connection + |
+POST /v3/{project_id}/dcaas/hosted-connects + |
+dcaas:directConnect:create + |
+vpc:vpcs:get +vpc:vpcs:list + |
+√ + |
+× + |
+
Querying the connection list + |
+GET /v3/{project_id}/dcaas/direct-connects + |
+dcaas:directConnect:list + |
+- + |
+√ + |
+× + |
+
Querying details of a connection + |
+GET /v3/{project_id}/dcaas/direct-connects/{direct_connect_id} + |
+dcaas:directConnect:get + |
+- + |
+√ + |
+× + |
+
Querying the hosted connection list + |
+GET /v3/{project_id}/dcaas/hosted-connects + |
+dcaas:directConnect:list + |
+- + |
+√ + |
+× + |
+
Querying details of a hosted connection + |
+GET /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id} + |
+dcaas:directConnect:get + |
+- + |
+√ + |
+× + |
+
Updating a Connection + |
+PUT /v3/{project_id}/dcaas/direct-connects/{direct_connect_id} + |
+dcaas:directConnect:update + |
+- + |
+√ + |
+× + |
+
Updating a hosted connection + |
+PUT /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id} + |
+dcaas:directConnect:update + |
+- + |
+√ + |
+× + |
+
Deleting a connection + |
+DELETE /v3/{project_id}/dcaas/direct-connects/{direct_connect_id} + |
+dcaas:directConnect:delete + |
+- + |
+√ + |
+× + |
+
Deleting a hosted connection + |
+DELETE /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id} + |
+dcaas:directConnect:delete + |
+- + |
+√ + |
+× + |
+
Virtual Gateways
+Permission + |
+API + |
+Action + |
+Related Action + |
+IAM Project + |
+Enterprise Project + |
+
|---|---|---|---|---|---|
Creating a virtual gateway + |
+POST /v3/{project_id}/dcaas/virtual-gateways + |
+dcaas:vgw:create + |
+vpc:vpcs:get +vpc:vpcs:list +vpc:subnets:get + |
+√ + |
+× + |
+
Querying the virtual gateway list + |
+GET /v3/{project_id}/dcaas/virtual-gateways + |
+dcaas:vgw:list + |
+- + |
+√ + |
+× + |
+
Querying a virtual gateway + |
+GET /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id} + |
+dcaas:vgw:get + |
+- + |
+√ + |
+× + |
+
Updating a virtual gateway + |
+PUT /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id} + |
+dcaas:vgw:update + |
+- + |
+√ + |
+× + |
+
Deleting a virtual gateway + |
+DELETE /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id} + |
+dcaas:vgw:delete + |
+- + |
+√ + |
+× + |
+
Virtual Interfaces
+Permission + |
+API + |
+Action + |
+Related Action + |
+IAM Project + |
+Enterprise Project + |
+
|---|---|---|---|---|---|
Creating a virtual interface + |
+POST /v3/{project_id}/dcaas/virtual-interfaces + |
+dcaas:vif:create + |
+vpc:vpcs:get +vpc:vpcs:list +vpc:subnets:get + |
+√ + |
+× + |
+
Querying the virtual interface list + |
+GET /v3/{project_id}/dcaas/virtual-interfaces + |
+dcaas:vif:list + |
+- + |
+√ + |
+× + |
+
Querying a virtual interface + |
+GET /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id} + |
+dcaas:vif:get + |
+- + |
+√ + |
+× + |
+
Updating a virtual interface + |
+PUT /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id} + |
+dcaas:vif:update + |
+- + |
+√ + |
+× + |
+
Deleting a virtual interface + |
+DELETE /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id} + |
+dcaas:vif:delete + |
+- + |
+√ + |
+× + |
+
API Overview
-Direct Connect APIs allow you to use all Direct Connect functions.
- -Category - |
-Subcategory - |
-Description - |
-
|---|---|---|
Direct Connect API - |
-Connection - |
-Used to manage connections, including the API used to create a hosted connection, the APIs used to query, delete, and update a connection, and the API to query the connection list. - |
-
Virtual gateway - |
-Used to manage virtual gateways, including the APIs used to create, delete, query, and update a virtual gateway, and the API to query the virtual gateway list. - |
-|
Virtual interface - |
-Used to manage virtual interfaces, including the APIs used to create, delete, query, and update a virtual interface, and the API to query the virtual interface list. - |
-|
Direct Connect endpoint group - |
-Used to manage Direct Connect endpoint groups, including the APIs used to create, delete, query, and update a Direct Connect endpoint group, and the API to query the Direct Connect endpoint group list. - |
-
APIs
- -Deleting a Connection
-URI
DELETE /v2.0/dcaas/direct-connects/{direct_connect_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
|---|---|---|---|
direct_connect_id - |
-String - |
-Yes - |
-Specifies the connection ID. - |
-
Request
None
-Response
None
-Examples
DELETE /v2.0/dcaas/direct-connects/{direct_connect_id}
-Status Codes
For details, see Common Status Codes.
-Virtual Gateway
- --
-
Deleting a Virtual Gateway
-Function
This API is used to delete a virtual gateway.
-URI
DELETE /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
|---|---|---|---|
virtual_gateway_id - |
-String - |
-Yes - |
-Specifies the virtual gateway ID. - |
-
Response
None
-Examples
DELETE /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}
-Status Codes
For details, see Common Status Codes.
-Virtual Interface
- --
-
Deleting a Virtual Interface
-Function
This API is used to delete a virtual interface.
-URI
DELETE /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
|---|---|---|---|
virtual_interface_id - |
-String - |
-Yes - |
-Specifies the virtual interface ID. - |
-
Request
Table 2 lists the request parameter.
- - -Response
None
-Examples
DELETE /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}
-Status Codes
For details, see Common Status Codes.
-Direct Connect Endpoint Group
- --
-
Updating a Direct Connect Endpoint Group
-Function
This API is used to update a Direct Connect endpoint group.
-URI
PUT /v2.0/dcaas/dc-endpoint-groups/{endpoint_group_id}
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
|---|---|---|---|
endpoint_group_id - |
-String - |
-Yes - |
-Specifies the ID of the Direct Connect endpoint group. - |
-
Request
Table 2 lists the request parameter.
- -Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
|---|---|---|---|
dc_endpoint_group - |
-Dictionary - |
-Yes - |
-Specifies the dc_endpoint_group object. - |
-
Parameter - |
-Type - |
-Mandatory - |
-Description - |
-
|---|---|---|---|
description - |
-String - |
-No - |
-Provides supplementary information about the Direct Connect endpoint group. -Angle brackets (<>) are not allowed. - |
-
name - |
-String - |
-No - |
-Specifies the name of the Direct Connect endpoint group. -Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. - |
-
Response
Table 4 lists the response parameter.
- -Parameter - |
-Type - |
-Description - |
-
|---|---|---|
dc_endpoint_group - |
-Dictionary - |
-Specifies the dc_endpoint_group object. - |
-
Parameter - |
-Type - |
-Description - |
-
|---|---|---|
id - |
-String - |
-Specifies the ID of the Direct Connect endpoint group. - |
-
tenant_id - |
-String - |
-Specifies the project ID. - |
-
name - |
-String - |
-Specifies the name of the Direct Connect endpoint group. - |
-
description - |
-String - |
-Provides supplementary information about the Direct Connect endpoint group. - |
-
endpoints - |
-List<String> - |
-Specifies the list of the endpoints in a Direct Connect endpoint group. - |
-
type - |
-String - |
-Specifies the type of the Direct Connect endpoints. The value can only be cidr. -Only IPv4 CIDR blocks are supported. - |
-
Examples
Status Codes
For details, see Common Status Codes.
-Public Parameters
- --
-
Change History
-Released On - |
-What's New - |
-
|---|---|
2023-04-17 - |
-This release incorporates the following changes: -Added Introduction, Connections, Virtual Gateways, and Virtual Interfaces in Permissions Policies and Supported Actions. - |
-
2023-04-12 - |
-This release incorporates the following changes: - - |
-
2023-04-04 - |
-This release incorporates the following changes: - - |
-
2023-03-23 - |
-This release incorporates the following changes: - |
-
2023-02-24 - |
-This release incorporates the following changes: - |
-
2023-02-14 - |
-This release incorporates the following changes: - |
-
2023-01-03 - |
-This release incorporates the following changes: - |
-
2022-12-07 - |
-This release incorporates the following changes: - |
-
2022-10-13 - |
-This release incorporates the following changes: - |
-
2018-10-30 - |
-This release incorporates the following changes: - |
-
2018-04-30 - |
-This release incorporates the following changes: - |
-
2018-03-30 - |
-This release incorporates the following changes: -Modified the API usage. - |
-
2018-02-18 - |
-This release incorporates the following changes: - |
-
2017-11-30 - |
-This release incorporates the following changes: - |
-
2017-9-30 - |
-This issue is the first official release. - |
-
API Usage Guidelines
-Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
-Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.
-For details about how to use APIs, see API Usage Guidelines.
+Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
+Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by application/json.
+For details about how to use APIs, see API Usage Guidelines.
API Overview
+Direct Connect APIs allow you to use all Direct Connect functions.
+API v2.0
+Subcategory + |
+Description + |
+
|---|---|
Connection APIs + |
+Used to manage connections, including the API used to create a hosted connection, the APIs used to query, delete, and update a connection, and the API to query the connection list. + |
+
Virtual gateway APIs + |
+Used to manage virtual gateways, including the APIs used to create, delete, query, and update a virtual gateway, and the API to query the virtual gateway list. + |
+
Virtual interface APIs + |
+Used to manage virtual interfaces, including the APIs used to create, delete, query, and update a virtual interface, and the API to query the virtual interface list. + |
+
Direct Connect endpoint group APIs + |
+Used to manage Direct Connect endpoint groups, including the APIs used to create, delete, query, and update an endpoint group, and the API used to query the endpoint group list. + |
+
API v3
+Subcategory + |
+Description + |
+
|---|---|
Connection APIs + |
+APIs for querying connection details, updating connection information, deleting a connection, querying the connection list, querying the hosted connection list, creating a hosted connection, querying hosted connection details, updating hosted connection information, and deleting a hosted connection + |
+
Virtual gateway APIs + |
+APIs for querying virtual gateway details, updating virtual gateway information, deleting a virtual gateway, querying the virtual gateway list, and creating a virtual gateway + |
+
Virtual interface APIs + |
+APIs for querying virtual interface details, updating virtual interface information, deleting a virtual interface, querying the virtual interface list, and creating a virtual interface + |
+
API Usage
-Direct Connect has independent endpoints. When API calls are made to Direct Connect, the Direct Connect APIs are used. Therefore, you need pay special attention to the service endpoints used when you make calls to the Direct Connect APIs.
+Direct Connect has independent endpoints. When API calls are made to Direct Connect, the Direct Connect APIs are used. Therefore, you need pay special attention to the service endpoints used when you make calls to the Direct Connect APIs.
APIs v2.0
+ +-
+
Obtaining the API Version Information
+API Version
Querying All API Versions
-Function
This API is used to query all API versions supported by Direct Connect.
+Function
This API is used to query all API versions supported by Direct Connect.
URI
GET /
+URI
GET /
Request
None
+Request
None
Response
Table 1 lists the response parameters.
+Response
Table 1 lists the response parameters.
-Parameter +
Examples |
|---|