forked from docs/enterprise-router
Compare commits
4 Commits
propose-er
...
main
Author | SHA1 | Date | |
---|---|---|---|
47d598aed2 | |||
5b1d5d43ce | |||
3fd175fa72 | |||
bdabc93498 |
BIN
api-ref/source/_static/images/en-us_image_0000001294957952.png
Normal file
BIN
api-ref/source/_static/images/en-us_image_0000001294957952.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 48 KiB |
30
api-ref/source/api_usage_guidelines.rst
Normal file
30
api-ref/source/api_usage_guidelines.rst
Normal file
@ -0,0 +1,30 @@
|
||||
:original_name: er_02_0001.html
|
||||
|
||||
.. _er_02_0001:
|
||||
|
||||
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 <https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API%20Documents>`__.
|
||||
|
||||
Network instances can be attached to an enterprise router as its attachments. The attachment type varies depending on the network instance.
|
||||
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0000001294957952.png
|
||||
:alt: **Figure 1** Attachments
|
||||
|
||||
**Figure 1** Attachments
|
||||
|
||||
.. table:: **Table 1** Enterprise Router attachments
|
||||
|
||||
+----------------------------+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Attachment Type | Network Instance | Creating an Attachment | Querying Attachment Details | Deleting an Attachment |
|
||||
+============================+===================================+==================================================================================================================================================================================================================================+====================================================================+=============================================================================================================================================+
|
||||
| VPC attachment | VPC | :ref:`Creating a VPC Attachment <createvpcattachment>` | :ref:`Querying Details About a VPC Attachment <showvpcattachment>` | :ref:`Deleting a VPC Attachment <deletevpcattachment>` |
|
||||
+----------------------------+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Virtual gateway attachment | Virtual gateway of Direct Connect | Create a virtual gateway by referring to `Creating a Virtual Gateway <https://docs.otc.t-systems.com/direct-connect/api-ref/apis/virtual_gateway/creating_a_virtual_gateway.html>`__ and then attach it to an enterprise router. | :ref:`Querying Details About an Attachment <showattachment>` | `Deleting a Virtual Gateway <https://docs.otc.t-systems.com/direct-connect/api-ref/apis/virtual_gateway/deleting_a_virtual_gateway.html>`__ |
|
||||
+----------------------------+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,92 @@
|
||||
:original_name: DisassociateRouteTable.html
|
||||
|
||||
.. _DisassociateRouteTable:
|
||||
|
||||
Deleting a Route Association
|
||||
============================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to delete an association from the route table of an enterprise router for an attachment.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/disassociate
|
||||
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
============== ========= ====== ====================
|
||||
Parameter Mandatory Type Description
|
||||
============== ========= ====== ====================
|
||||
project_id Yes String Project ID
|
||||
er_id Yes String Enterprise router ID
|
||||
route_table_id Yes String Route table ID
|
||||
============== ========= ====== ====================
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
|
||||
.. table:: **Table 2** Request body parameters
|
||||
|
||||
+-----------------+-----------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+=================+=================+=====================================================================================+===========================================================================================================================+
|
||||
| attachment_id | No | String | Unique ID of the attachment |
|
||||
| | | | |
|
||||
| | | | Maximum: **36** |
|
||||
+-----------------+-----------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| route_policy | No | :ref:`ExportRoutePolicy <disassociateroutetable__request_exportroutepolicy>` object | Route that controls outbound traffic. Note that this is not currently supported. This parameter is not supported for now. |
|
||||
+-----------------+-----------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _disassociateroutetable__request_exportroutepolicy:
|
||||
|
||||
.. table:: **Table 3** ExportRoutePolicy
|
||||
|
||||
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+==================+=================+=================+=================================================================================================+
|
||||
| export_policy_id | No | String | ID of the route policy that controls outbound traffic. This parameter is not supported for now. |
|
||||
| | | | |
|
||||
| | | | Minimum: **0** |
|
||||
| | | | |
|
||||
| | | | Maximum: **36** |
|
||||
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------+
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
||||
Deleting a route table association
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/915a14a6-867b-4af7-83d1-70efceb146f8/route-tables/915a14a6-867b-4af7-83d1-70efceb146f9/disassociate
|
||||
|
||||
{
|
||||
"attachment_id" : "2609ec92-ac19-4467-a527-7f9e690e7836"
|
||||
}
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
None
|
||||
|
||||
Status Codes
|
||||
------------
|
||||
|
||||
=========== ===========
|
||||
Status Code Description
|
||||
=========== ===========
|
||||
202 Accepted
|
||||
=========== ===========
|
||||
|
||||
Error Codes
|
||||
-----------
|
||||
|
||||
See :ref:`Error Codes <errorcode>`.
|
18
api-ref/source/apis/associations/index.rst
Normal file
18
api-ref/source/apis/associations/index.rst
Normal file
@ -0,0 +1,18 @@
|
||||
:original_name: Association.html
|
||||
|
||||
.. _Association:
|
||||
|
||||
Associations
|
||||
============
|
||||
|
||||
- :ref:`Creating a Route Association <associateroutetable>`
|
||||
- :ref:`Querying Route Associations <listassociations>`
|
||||
- :ref:`Deleting a Route Association <disassociateroutetable>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
creating_a_route_association
|
||||
querying_route_associations
|
||||
deleting_a_route_association
|
202
api-ref/source/apis/associations/querying_route_associations.rst
Normal file
202
api-ref/source/apis/associations/querying_route_associations.rst
Normal file
File diff suppressed because it is too large
Load Diff
18
api-ref/source/apis/attachments/index.rst
Normal file
18
api-ref/source/apis/attachments/index.rst
Normal file
@ -0,0 +1,18 @@
|
||||
:original_name: Attachments.html
|
||||
|
||||
.. _Attachments:
|
||||
|
||||
Attachments
|
||||
===========
|
||||
|
||||
- :ref:`Updating an Attachment <updateattachment>`
|
||||
- :ref:`Querying Details About an Attachment <showattachment>`
|
||||
- :ref:`Querying Attachments <listattachments>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
updating_an_attachment
|
||||
querying_details_about_an_attachment
|
||||
querying_attachments
|
221
api-ref/source/apis/attachments/querying_attachments.rst
Normal file
221
api-ref/source/apis/attachments/querying_attachments.rst
Normal file
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
181
api-ref/source/apis/attachments/updating_an_attachment.rst
Normal file
181
api-ref/source/apis/attachments/updating_an_attachment.rst
Normal file
File diff suppressed because it is too large
Load Diff
14
api-ref/source/apis/azs/index.rst
Normal file
14
api-ref/source/apis/azs/index.rst
Normal file
@ -0,0 +1,14 @@
|
||||
:original_name: AvailableZone.html
|
||||
|
||||
.. _AvailableZone:
|
||||
|
||||
AZs
|
||||
===
|
||||
|
||||
- :ref:`Querying AZs <listavailabilityzone>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
querying_azs
|
110
api-ref/source/apis/azs/querying_azs.rst
Normal file
110
api-ref/source/apis/azs/querying_azs.rst
Normal file
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,63 @@
|
||||
:original_name: DeleteEnterpriseRouter.html
|
||||
|
||||
.. _DeleteEnterpriseRouter:
|
||||
|
||||
Deleting an Enterprise Router
|
||||
=============================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to delete an enterprise router.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
DELETE /v3/{project_id}/enterprise-router/instances/{er_id}
|
||||
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
========== ========= ====== ====================
|
||||
Parameter Mandatory Type Description
|
||||
========== ========= ====== ====================
|
||||
project_id Yes String Project ID
|
||||
er_id Yes String Enterprise router ID
|
||||
========== ========= ====== ====================
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
|
||||
None
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
||||
Deleting an enterprise router
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/instances/94c2b814-99dc-939a-e811-ae84c61ea3ff
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
None
|
||||
|
||||
Status Codes
|
||||
------------
|
||||
|
||||
=========== ===========
|
||||
Status Code Description
|
||||
=========== ===========
|
||||
202 Accepted
|
||||
=========== ===========
|
||||
|
||||
Error Codes
|
||||
-----------
|
||||
|
||||
See :ref:`Error Codes <errorcode>`.
|
22
api-ref/source/apis/enterprise_routers/index.rst
Normal file
22
api-ref/source/apis/enterprise_routers/index.rst
Normal file
@ -0,0 +1,22 @@
|
||||
:original_name: EnterpriseRouterInstance.html
|
||||
|
||||
.. _EnterpriseRouterInstance:
|
||||
|
||||
Enterprise Routers
|
||||
==================
|
||||
|
||||
- :ref:`Creating an Enterprise Router <createenterpriserouter>`
|
||||
- :ref:`Updating an Enterprise Router <updateenterpriserouter>`
|
||||
- :ref:`Querying Details About an Enterprise Router <showenterpriserouter>`
|
||||
- :ref:`Querying Enterprise Routers <listenterpriserouters>`
|
||||
- :ref:`Deleting an Enterprise Router <deleteenterpriserouter>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
creating_an_enterprise_router
|
||||
updating_an_enterprise_router
|
||||
querying_details_about_an_enterprise_router
|
||||
querying_enterprise_routers
|
||||
deleting_an_enterprise_router
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
215
api-ref/source/apis/flow_logs/creating_a_flow_log.rst
Normal file
215
api-ref/source/apis/flow_logs/creating_a_flow_log.rst
Normal file
File diff suppressed because it is too large
Load Diff
69
api-ref/source/apis/flow_logs/deleting_a_flow_log.rst
Normal file
69
api-ref/source/apis/flow_logs/deleting_a_flow_log.rst
Normal file
@ -0,0 +1,69 @@
|
||||
:original_name: DeleteFlowLog.html
|
||||
|
||||
.. _DeleteFlowLog:
|
||||
|
||||
Deleting a Flow Log
|
||||
===================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to delete a flow log.
|
||||
|
||||
Constraints
|
||||
-----------
|
||||
|
||||
A flow log can be deleted only when it is in the **available**, **deleting**, or **failed** state.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
DELETE /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}
|
||||
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
=========== ========= ====== ====================
|
||||
Parameter Mandatory Type Description
|
||||
=========== ========= ====== ====================
|
||||
project_id Yes String Project ID
|
||||
er_id Yes String Enterprise router ID
|
||||
flow_log_id Yes String Flow log ID
|
||||
=========== ========= ====== ====================
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
|
||||
None
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
||||
Deleting a flow log
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{erouter_endpoint}/v3/0605767a9980d5762fbcc00b3537e757/enterprise-router/6f83b848-8331-4271-ac0c-ef94b7686402/flow_logs/b216bc1d-5963-41a7-89f9-779a5128c5ac
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
None
|
||||
|
||||
Status Codes
|
||||
------------
|
||||
|
||||
=========== ===========
|
||||
Status Code Description
|
||||
=========== ===========
|
||||
202 Accepted
|
||||
=========== ===========
|
||||
|
||||
Error Codes
|
||||
-----------
|
||||
|
||||
See :ref:`Error Codes <errorcode>`.
|
136
api-ref/source/apis/flow_logs/disabling_flow_logs.rst
Normal file
136
api-ref/source/apis/flow_logs/disabling_flow_logs.rst
Normal file
File diff suppressed because it is too large
Load Diff
136
api-ref/source/apis/flow_logs/enabling_flow_logs.rst
Normal file
136
api-ref/source/apis/flow_logs/enabling_flow_logs.rst
Normal file
File diff suppressed because it is too large
Load Diff
26
api-ref/source/apis/flow_logs/index.rst
Normal file
26
api-ref/source/apis/flow_logs/index.rst
Normal file
@ -0,0 +1,26 @@
|
||||
:original_name: FlowLog.html
|
||||
|
||||
.. _FlowLog:
|
||||
|
||||
Flow Logs
|
||||
=========
|
||||
|
||||
- :ref:`Creating a Flow Log <createflowlog>`
|
||||
- :ref:`Querying Flow Logs <listflowlogs>`
|
||||
- :ref:`Querying Details About a Flow Log <showflowlog>`
|
||||
- :ref:`Updating a Flow Log <updateflowlog>`
|
||||
- :ref:`Deleting a Flow Log <deleteflowlog>`
|
||||
- :ref:`Enabling Flow Logs <enableflowlog>`
|
||||
- :ref:`Disabling Flow Logs <disableflowlog>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
creating_a_flow_log
|
||||
querying_flow_logs
|
||||
querying_details_about_a_flow_log
|
||||
updating_a_flow_log
|
||||
deleting_a_flow_log
|
||||
enabling_flow_logs
|
||||
disabling_flow_logs
|
File diff suppressed because it is too large
Load Diff
188
api-ref/source/apis/flow_logs/querying_flow_logs.rst
Normal file
188
api-ref/source/apis/flow_logs/querying_flow_logs.rst
Normal file
File diff suppressed because it is too large
Load Diff
155
api-ref/source/apis/flow_logs/updating_a_flow_log.rst
Normal file
155
api-ref/source/apis/flow_logs/updating_a_flow_log.rst
Normal file
File diff suppressed because it is too large
Load Diff
36
api-ref/source/apis/index.rst
Normal file
36
api-ref/source/apis/index.rst
Normal file
@ -0,0 +1,36 @@
|
||||
:original_name: er_02_0014.html
|
||||
|
||||
.. _er_02_0014:
|
||||
|
||||
APIs
|
||||
====
|
||||
|
||||
- :ref:`Enterprise Routers <enterpriserouterinstance>`
|
||||
- :ref:`VPC Attachments <vpcattachment>`
|
||||
- :ref:`Attachments <attachments>`
|
||||
- :ref:`Route Tables <routetable>`
|
||||
- :ref:`Associations <association>`
|
||||
- :ref:`Propagations <propagation>`
|
||||
- :ref:`Routes <route>`
|
||||
- :ref:`Tags <tags>`
|
||||
- :ref:`Quota Management <quotamanager>`
|
||||
- :ref:`AZs <availablezone>`
|
||||
- :ref:`Flow Logs <flowlog>`
|
||||
- :ref:`Sharing <er_02_0035>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
enterprise_routers/index
|
||||
vpc_attachments/index
|
||||
attachments/index
|
||||
route_tables/index
|
||||
associations/index
|
||||
propagations/index
|
||||
routes/index
|
||||
tags/index
|
||||
quota_management/index
|
||||
azs/index
|
||||
flow_logs/index
|
||||
sharing
|
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,90 @@
|
||||
:original_name: DisablePropagation.html
|
||||
|
||||
.. _DisablePropagation:
|
||||
|
||||
Deleting a Route Propagation
|
||||
============================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to delete a propagation from the route table of an enterprise router for an attachment.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/disable-propagations
|
||||
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
============== ========= ====== ====================
|
||||
Parameter Mandatory Type Description
|
||||
============== ========= ====== ====================
|
||||
project_id Yes String Project ID
|
||||
er_id Yes String Enterprise router ID
|
||||
route_table_id Yes String Route table ID
|
||||
============== ========= ====== ====================
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
|
||||
.. table:: **Table 2** Request body parameters
|
||||
|
||||
+---------------+-----------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+===============+===========+=================================================================================+===============================================================================+
|
||||
| attachment_id | No | String | Unique ID of the attachment |
|
||||
+---------------+-----------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||||
| route_policy | No | :ref:`ImportRoutePolicy <disablepropagation__request_importroutepolicy>` object | Route that controls inbound traffic. This parameter is not supported for now. |
|
||||
+---------------+-----------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
|
||||
|
||||
.. _disablepropagation__request_importroutepolicy:
|
||||
|
||||
.. table:: **Table 3** ImportRoutePolicy
|
||||
|
||||
+------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+==================+=================+=================+================================================================================================+
|
||||
| import_policy_id | No | String | ID of the route policy that controls inbound traffic. This parameter is not supported for now. |
|
||||
| | | | |
|
||||
| | | | Minimum: **0** |
|
||||
| | | | |
|
||||
| | | | Maximum: **36** |
|
||||
+------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------+
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
||||
Deleting a route table propagation
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/ad838a5e-dbef-22cc-b1d9-cb46bef77ae8/route-tables/915a14a6-867b-4af7-83d1-70efceb146f9/disable-propagations
|
||||
|
||||
{
|
||||
"attachment_id" : "a5b7d209-dc02-4c46-a51f-805eadd3de64"
|
||||
}
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
None
|
||||
|
||||
Status Codes
|
||||
------------
|
||||
|
||||
=========== ===========
|
||||
Status Code Description
|
||||
=========== ===========
|
||||
202 Accepted
|
||||
=========== ===========
|
||||
|
||||
Error Codes
|
||||
-----------
|
||||
|
||||
See :ref:`Error Codes <errorcode>`.
|
18
api-ref/source/apis/propagations/index.rst
Normal file
18
api-ref/source/apis/propagations/index.rst
Normal file
@ -0,0 +1,18 @@
|
||||
:original_name: Propagation.html
|
||||
|
||||
.. _Propagation:
|
||||
|
||||
Propagations
|
||||
============
|
||||
|
||||
- :ref:`Creating a Route Propagation <enablepropagation>`
|
||||
- :ref:`Querying Route Propagations <listpropagations>`
|
||||
- :ref:`Deleting a Route Propagation <disablepropagation>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
creating_a_route_propagation
|
||||
querying_route_propagations
|
||||
deleting_a_route_propagation
|
201
api-ref/source/apis/propagations/querying_route_propagations.rst
Normal file
201
api-ref/source/apis/propagations/querying_route_propagations.rst
Normal file
File diff suppressed because it is too large
Load Diff
14
api-ref/source/apis/quota_management/index.rst
Normal file
14
api-ref/source/apis/quota_management/index.rst
Normal file
@ -0,0 +1,14 @@
|
||||
:original_name: QuotaManager.html
|
||||
|
||||
.. _QuotaManager:
|
||||
|
||||
Quota Management
|
||||
================
|
||||
|
||||
- :ref:`Querying Quotas <showquotas>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
querying_quotas
|
175
api-ref/source/apis/quota_management/querying_quotas.rst
Normal file
175
api-ref/source/apis/quota_management/querying_quotas.rst
Normal file
File diff suppressed because it is too large
Load Diff
248
api-ref/source/apis/route_tables/creating_a_route_table.rst
Normal file
248
api-ref/source/apis/route_tables/creating_a_route_table.rst
Normal file
File diff suppressed because it is too large
Load Diff
62
api-ref/source/apis/route_tables/deleting_a_route_table.rst
Normal file
62
api-ref/source/apis/route_tables/deleting_a_route_table.rst
Normal file
@ -0,0 +1,62 @@
|
||||
:original_name: DeleteRouteTable.html
|
||||
|
||||
.. _DeleteRouteTable:
|
||||
|
||||
Deleting a Route Table
|
||||
======================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to delete a route table.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
DELETE /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}
|
||||
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
============== ========= ====== ====================
|
||||
Parameter Mandatory Type Description
|
||||
============== ========= ====== ====================
|
||||
project_id Yes String Project ID
|
||||
er_id Yes String Enterprise router ID
|
||||
route_table_id Yes String Route table ID
|
||||
============== ========= ====== ====================
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
|
||||
None
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/4ab54142-7c92-48ad-8288-77727a231056/route-tables/4ab54142-7c92-48ad-8288-77727a231052
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
None
|
||||
|
||||
Status Codes
|
||||
------------
|
||||
|
||||
=========== ===========
|
||||
Status Code Description
|
||||
=========== ===========
|
||||
202 Accepted
|
||||
=========== ===========
|
||||
|
||||
Error Codes
|
||||
-----------
|
||||
|
||||
See :ref:`Error Codes <errorcode>`.
|
22
api-ref/source/apis/route_tables/index.rst
Normal file
22
api-ref/source/apis/route_tables/index.rst
Normal file
@ -0,0 +1,22 @@
|
||||
:original_name: RouteTable.html
|
||||
|
||||
.. _RouteTable:
|
||||
|
||||
Route Tables
|
||||
============
|
||||
|
||||
- :ref:`Creating a Route Table <createroutetable>`
|
||||
- :ref:`Updating Route Table Information <updateroutetable>`
|
||||
- :ref:`Querying Details About a Route Table <showroutetable>`
|
||||
- :ref:`Querying Route Tables <listroutetables>`
|
||||
- :ref:`Deleting a Route Table <deleteroutetable>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
creating_a_route_table
|
||||
updating_route_table_information
|
||||
querying_details_about_a_route_table
|
||||
querying_route_tables
|
||||
deleting_a_route_table
|
File diff suppressed because it is too large
Load Diff
217
api-ref/source/apis/route_tables/querying_route_tables.rst
Normal file
217
api-ref/source/apis/route_tables/querying_route_tables.rst
Normal file
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
197
api-ref/source/apis/routes/creating_a_static_route.rst
Normal file
197
api-ref/source/apis/routes/creating_a_static_route.rst
Normal file
File diff suppressed because it is too large
Load Diff
62
api-ref/source/apis/routes/deleting_a_static_route.rst
Normal file
62
api-ref/source/apis/routes/deleting_a_static_route.rst
Normal file
@ -0,0 +1,62 @@
|
||||
:original_name: DeleteStaticRoute.html
|
||||
|
||||
.. _DeleteStaticRoute:
|
||||
|
||||
Deleting a Static Route
|
||||
=======================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to delete a static route.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
DELETE /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes/{route_id}
|
||||
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
============== ========= ====== ==============
|
||||
Parameter Mandatory Type Description
|
||||
============== ========= ====== ==============
|
||||
project_id Yes String Project ID
|
||||
route_table_id Yes String Route table ID
|
||||
route_id Yes String Route ID
|
||||
============== ========= ====== ==============
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
|
||||
None
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/route-tables/3ddb4dc2-174e-4d43-9328-b805d5c0c774/static-routes/19d334b7-78c1-4e0e-ba29-b797e641e23c
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
None
|
||||
|
||||
Status Codes
|
||||
------------
|
||||
|
||||
=========== ===========
|
||||
Status Code Description
|
||||
=========== ===========
|
||||
202 Accepted
|
||||
=========== ===========
|
||||
|
||||
Error Codes
|
||||
-----------
|
||||
|
||||
See :ref:`Error Codes <errorcode>`.
|
24
api-ref/source/apis/routes/index.rst
Normal file
24
api-ref/source/apis/routes/index.rst
Normal file
@ -0,0 +1,24 @@
|
||||
:original_name: Route.html
|
||||
|
||||
.. _Route:
|
||||
|
||||
Routes
|
||||
======
|
||||
|
||||
- :ref:`Creating a Static Route <createstaticroute>`
|
||||
- :ref:`Updating a Static Route <updatestaticroute>`
|
||||
- :ref:`Querying Details About a Static Route <showstaticroute>`
|
||||
- :ref:`Querying Static Routes <liststaticroutes>`
|
||||
- :ref:`Querying Effective Routes <listeffectiveroutes>`
|
||||
- :ref:`Deleting a Static Route <deletestaticroute>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
creating_a_static_route
|
||||
updating_a_static_route
|
||||
querying_details_about_a_static_route
|
||||
querying_static_routes
|
||||
querying_effective_routes
|
||||
deleting_a_static_route
|
File diff suppressed because it is too large
Load Diff
174
api-ref/source/apis/routes/querying_effective_routes.rst
Normal file
174
api-ref/source/apis/routes/querying_effective_routes.rst
Normal file
File diff suppressed because it is too large
Load Diff
196
api-ref/source/apis/routes/querying_static_routes.rst
Normal file
196
api-ref/source/apis/routes/querying_static_routes.rst
Normal file
File diff suppressed because it is too large
Load Diff
170
api-ref/source/apis/routes/updating_a_static_route.rst
Normal file
170
api-ref/source/apis/routes/updating_a_static_route.rst
Normal file
File diff suppressed because it is too large
Load Diff
17
api-ref/source/apis/sharing.rst
Normal file
17
api-ref/source/apis/sharing.rst
Normal file
@ -0,0 +1,17 @@
|
||||
:original_name: er_02_0035.html
|
||||
|
||||
.. _er_02_0035:
|
||||
|
||||
Sharing
|
||||
=======
|
||||
|
||||
You can share an enterprise router in your account with other accounts.
|
||||
|
||||
- You are the owner of the enterprise router.
|
||||
- Other accounts are the users of the enterprise router.
|
||||
|
||||
After you share your enterprise router with other accounts, these other users can attach their network instances to your enterprise router, so that their network instances can access your enterprise router.
|
||||
|
||||
.. important::
|
||||
|
||||
Enterprise routers cannot be shared through APIs. You can only use this function on the management console. For details, see section "Sharing Overview" in the *Enterprise Router User Guide*.
|
116
api-ref/source/apis/tags/creating_resource_tags.rst
Normal file
116
api-ref/source/apis/tags/creating_resource_tags.rst
Normal file
File diff suppressed because it is too large
Load Diff
79
api-ref/source/apis/tags/deleting_resource_tags.rst
Normal file
79
api-ref/source/apis/tags/deleting_resource_tags.rst
Normal file
@ -0,0 +1,79 @@
|
||||
:original_name: DeleteResourceTag.html
|
||||
|
||||
.. _DeleteResourceTag:
|
||||
|
||||
Deleting Resource Tags
|
||||
======================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to delete tags for resources of a specific type.
|
||||
|
||||
Constraints
|
||||
-----------
|
||||
|
||||
This API is idempotent. The key cannot be left blank or be an empty string.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
DELETE /v3/{project_id}/{resource_type}/{resource_id}/tags/{key}
|
||||
|
||||
.. table:: **Table 1** Path Parameters
|
||||
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+=================+=================+=================+===================================================+
|
||||
| key | Yes | String | Tag key |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------+
|
||||
| project_id | Yes | String | Project ID |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------+
|
||||
| resource_id | Yes | String | Resource ID |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------+
|
||||
| resource_type | Yes | String | Resource type. |
|
||||
| | | | |
|
||||
| | | | - **instance**: enterprise router |
|
||||
| | | | |
|
||||
| | | | - **route-table**: route table |
|
||||
| | | | |
|
||||
| | | | - **vpc-attachment**: VPC attachment |
|
||||
| | | | |
|
||||
| | | | - **vgw-attachment**: virtual gateway attachment |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------+
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
|
||||
None
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{erouter-endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/instance/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags/key1
|
||||
|
||||
Example Responses
|
||||
-----------------
|
||||
|
||||
None
|
||||
|
||||
Status Codes
|
||||
------------
|
||||
|
||||
=========== ===========
|
||||
Status Code Description
|
||||
=========== ===========
|
||||
204 No Content
|
||||
=========== ===========
|
||||
|
||||
Error Codes
|
||||
-----------
|
||||
|
||||
See :ref:`Error Codes <errorcode>`.
|
20
api-ref/source/apis/tags/index.rst
Normal file
20
api-ref/source/apis/tags/index.rst
Normal file
@ -0,0 +1,20 @@
|
||||
:original_name: Tags.html
|
||||
|
||||
.. _Tags:
|
||||
|
||||
Tags
|
||||
====
|
||||
|
||||
- :ref:`Querying Project Tags <listprojecttags>`
|
||||
- :ref:`Querying Resource Tags <showresourcetag>`
|
||||
- :ref:`Creating Resource Tags <createresourcetag>`
|
||||
- :ref:`Deleting Resource Tags <deleteresourcetag>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
querying_project_tags
|
||||
querying_resource_tags
|
||||
creating_resource_tags
|
||||
deleting_resource_tags
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user