Update content

api-ref/source/api_usage_guidelines.rst

@@ -0,0 +1,12 @@
+: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>`__.

api-ref/source/apis/associations/deleting_a_route_association.rst

@@ -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 |
+   +-----------------+-----------------+-------------------------------------------------------------------------------------+--------------------------------------+
+
+.. _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 |
+   |                  |                 |                 |                                                       |
+   |                  |                 |                 | 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>`.

api-ref/source/apis/associations/index.rst

@@ -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

api-ref/source/apis/attachments/index.rst

@@ -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

api-ref/source/apis/azs/index.rst

@@ -0,0 +1,14 @@
+:original_name: AvailableZone.html
+
+.. _AvailableZone:
+
+AZs
+===
+
+-  :ref:`Querying AZs <listavailabilityzone>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   querying_azs

api-ref/source/apis/enterprise_routers/deleting_an_enterprise_router.rst

@@ -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         No Content
+=========== ===========
+
+Error Codes
+-----------
+
+See :ref:`Error Codes <errorcode>`.

api-ref/source/apis/enterprise_routers/index.rst

@@ -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

api-ref/source/apis/flow_logs/deleting_a_flow_log.rst

@@ -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>`.

api-ref/source/apis/flow_logs/index.rst

@@ -0,0 +1,26 @@
+:original_name: FlowLog.html
+
+.. _FlowLog:
+
+Flow Logs
+=========
+
+-  :ref:`Creating a Flow Log <createflowlog>`
+-  :ref:`Querying the Flow Log List <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_the_flow_log_list
+   querying_details_about_a_flow_log
+   updating_a_flow_log
+   deleting_a_flow_log
+   enabling_flow_logs
+   disabling_flow_logs

api-ref/source/apis/index.rst

@@ -0,0 +1,32 @@
+: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:`AZs <availablezone>`
+-  :ref:`Flow Logs <flowlog>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   enterprise_routers/index
+   vpc_attachments/index
+   attachments/index
+   route_tables/index
+   associations/index
+   propagations/index
+   routes/index
+   tags/index
+   azs/index
+   flow_logs/index

api-ref/source/apis/propagations/deleting_a_route_propagation.rst

@@ -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 |
+   +---------------+-----------+---------------------------------------------------------------------------------+-------------------------------------+
+
+.. _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 |
+   |                  |                 |                 |                                                      |
+   |                  |                 |                 | 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>`.

api-ref/source/apis/propagations/index.rst

@@ -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

api-ref/source/apis/route_tables/deleting_a_route_table.rst

@@ -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         No Content
+=========== ===========
+
+Error Codes
+-----------
+
+See :ref:`Error Codes <errorcode>`.

api-ref/source/apis/route_tables/index.rst

@@ -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

api-ref/source/apis/routes/deleting_a_static_route.rst

@@ -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         No Content
+=========== ===========
+
+Error Codes
+-----------
+
+See :ref:`Error Codes <errorcode>`.

api-ref/source/apis/routes/index.rst

@@ -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 Valid 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_valid_routes
+   deleting_a_static_route

api-ref/source/apis/tags/deleting_resource_tags.rst

@@ -0,0 +1,81 @@
+: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          | -  instance: Enterprise router                |
+   |                 |                 |                 |                                               |
+   |                 |                 |                 | -  route-table: Route table                   |
+   |                 |                 |                 |                                               |
+   |                 |                 |                 | -  vpc-attachment: VPC attachment             |
+   |                 |                 |                 |                                               |
+   |                 |                 |                 | -  vgw-attachment: Virtual gateway attachment |
+   |                 |                 |                 |                                               |
+   |                 |                 |                 | -  vpn-attachment: VPN gateway attachment     |
+   |                 |                 |                 |                                               |
+   |                 |                 |                 | -  attachments: All attachment types          |
+   +-----------------+-----------------+-----------------+-----------------------------------------------+
+
+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>`.

api-ref/source/apis/tags/index.rst

@@ -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

api-ref/source/apis/vpc_attachments/deleting_a_vpc_attachment.rst

@@ -0,0 +1,69 @@
+:original_name: DeleteVpcAttachment.html
+
+.. _DeleteVpcAttachment:
+
+Deleting a VPC Attachment
+=========================
+
+Function
+--------
+
+This API is used to delete a VPC attachment.
+
+Constraints
+-----------
+
+A VPC attachment can be deleted only when it is in the available, deleting, or failed state.
+
+URI
+---
+
+DELETE /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments/{vpc_attachment_id}
+
+.. table:: **Table 1** Path Parameters
+
+   ================= ========= ====== ====================
+   Parameter         Mandatory Type   Description
+   ================= ========= ====== ====================
+   project_id        Yes       String Project ID
+   er_id             Yes       String Enterprise router ID
+   vpc_attachment_id Yes       String VPC attachment ID
+   ================= ========= ====== ====================
+
+Request Parameters
+------------------
+
+None
+
+Response Parameters
+-------------------
+
+None
+
+Example Requests
+----------------
+
+Deleting a VPC attachment
+
+.. code-block:: text
+
+   DELETE https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/4ba931b6-5273-4ed9-8eeb-484d16a4786f/vpc-attachments/b70aee08-c671-4cad-9fd5-7381d163bcc8
+
+Example Responses
+-----------------
+
+None
+
+Status Codes
+------------
+
+=========== ===========
+Status Code Description
+=========== ===========
+202         No Content
+=========== ===========
+
+Error Codes
+-----------
+
+See :ref:`Error Codes <errorcode>`.