forked from docs/enterprise-router
Update content
This commit is contained in:
parent
3520722fab
commit
5de4cab7fc
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 |
@ -5,8 +5,26 @@
|
||||
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 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**.
|
||||
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>`__ |
|
||||
+----------------------------+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -42,15 +42,15 @@ Request Parameters
|
||||
|
||||
.. table:: **Table 3** Request body parameters
|
||||
|
||||
+-----------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+=================+=================+==================================================================================+======================================+
|
||||
| attachment_id | No | String | Unique ID of the attachment |
|
||||
| | | | |
|
||||
| | | | Maximum: **36** |
|
||||
+-----------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------+
|
||||
| route_policy | No | :ref:`ExportRoutePolicy <associateroutetable__request_exportroutepolicy>` object | Route that controls outbound traffic |
|
||||
+-----------------+-----------------+----------------------------------------------------------------------------------+--------------------------------------+
|
||||
+-----------------+-----------------+----------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+=================+=================+==================================================================================+==================================================================================+
|
||||
| attachment_id | No | String | Unique ID of the attachment |
|
||||
| | | | |
|
||||
| | | | Maximum: **36** |
|
||||
+-----------------+-----------------+----------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|
||||
| route_policy | No | :ref:`ExportRoutePolicy <associateroutetable__request_exportroutepolicy>` object | Route that controls outbound traffic. Note that this is not currently supported. |
|
||||
+-----------------+-----------------+----------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|
||||
|
||||
.. _associateroutetable__request_exportroutepolicy:
|
||||
|
||||
@ -93,33 +93,36 @@ Response Parameters
|
||||
|
||||
.. table:: **Table 7** Association
|
||||
|
||||
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+===================================================================================+=====================================================================+
|
||||
| id | String | Unique association ID |
|
||||
| | | |
|
||||
| | | Maximum: **36** |
|
||||
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| route_table_id | String | Unique ID of the route table |
|
||||
| | | |
|
||||
| | | Maximum: **36** |
|
||||
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| attachment_id | String | Unique ID of the attachment |
|
||||
| | | |
|
||||
| | | Maximum: **36** |
|
||||
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| resource_type | String | Attachment type |
|
||||
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| resource_id | String | Unique ID of the attachment |
|
||||
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| state | String | Status |
|
||||
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| created_at | String | Creation time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
|
||||
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| updated_at | String | Update time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
|
||||
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| route_policy | :ref:`ExportRoutePolicy <associateroutetable__response_exportroutepolicy>` object | Route that controls outbound traffic |
|
||||
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
+-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+===================================================================================+=============================================================================================================+
|
||||
| id | String | Unique association ID |
|
||||
| | | |
|
||||
| | | Maximum: **36** |
|
||||
+-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| route_table_id | String | Unique ID of the route table |
|
||||
| | | |
|
||||
| | | Maximum: **36** |
|
||||
+-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| attachment_id | String | Unique ID of the attachment |
|
||||
| | | |
|
||||
| | | Maximum: **36** |
|
||||
+-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| resource_type | String | Attachment type. |
|
||||
| | | |
|
||||
| | | - **vpc**: VPC attachments |
|
||||
| | | - **vgw**: virtual gateway attachments |
|
||||
+-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| resource_id | String | Unique ID of the attachment |
|
||||
+-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | Status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
|
||||
+-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
|
||||
+-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
|
||||
+-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| route_policy | :ref:`ExportRoutePolicy <associateroutetable__response_exportroutepolicy>` object | Route that controls outbound traffic. Note that this is not currently supported. |
|
||||
+-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _associateroutetable__response_exportroutepolicy:
|
||||
|
||||
|
@ -30,15 +30,15 @@ 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 |
|
||||
+-----------------+-----------------+-------------------------------------------------------------------------------------+--------------------------------------+
|
||||
+-----------------+-----------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|
||||
| 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. |
|
||||
+-----------------+-----------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
|
||||
|
||||
.. _disassociateroutetable__request_exportroutepolicy:
|
||||
|
||||
|
@ -49,13 +49,12 @@ GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/ass
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| attachment_id | No | Array | Attachment ID |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| resource_type | No | Array | Attachment type. Value options are as follows: |
|
||||
| resource_type | No | Array | Attachment type. |
|
||||
| | | | |
|
||||
| | | | - **vpc**: VPC attachment |
|
||||
| | | | |
|
||||
| | | | - **vgw**: virtual gateway attachment |
|
||||
| | | | - **vpc**: VPC attachments |
|
||||
| | | | - **vgw**: virtual gateway attachments |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| state | No | Array | Status |
|
||||
| state | No | Array | Status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| sort_key | No | Array | Keyword for sorting. The keyword can be **id**, **name**, or **state**. By default, **id** is used. |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -90,33 +89,36 @@ Response Parameters
|
||||
|
||||
.. table:: **Table 4** Association
|
||||
|
||||
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+================================================================================+=====================================================================+
|
||||
| id | String | Unique association ID |
|
||||
| | | |
|
||||
| | | Maximum: **36** |
|
||||
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| route_table_id | String | Unique ID of the route table |
|
||||
| | | |
|
||||
| | | Maximum: **36** |
|
||||
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| attachment_id | String | Unique ID of the attachment |
|
||||
| | | |
|
||||
| | | Maximum: **36** |
|
||||
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| resource_type | String | Attachment type |
|
||||
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| resource_id | String | Unique ID of the attachment |
|
||||
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| state | String | Status |
|
||||
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| created_at | String | Creation time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
|
||||
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| updated_at | String | Update time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
|
||||
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| route_policy | :ref:`ExportRoutePolicy <listassociations__response_exportroutepolicy>` object | Route that controls outbound traffic |
|
||||
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+================================================================================+=============================================================================================================+
|
||||
| id | String | Unique association ID |
|
||||
| | | |
|
||||
| | | Maximum: **36** |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| route_table_id | String | Unique ID of the route table |
|
||||
| | | |
|
||||
| | | Maximum: **36** |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| attachment_id | String | Unique ID of the attachment |
|
||||
| | | |
|
||||
| | | Maximum: **36** |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| resource_type | String | Attachment type. |
|
||||
| | | |
|
||||
| | | - **vpc**: VPC attachments |
|
||||
| | | - **vgw**: virtual gateway attachments |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| resource_id | String | Unique ID of the attachment |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | Status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| route_policy | :ref:`ExportRoutePolicy <listassociations__response_exportroutepolicy>` object | Route that controls outbound traffic. Note that this is not currently supported. |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _listassociations__response_exportroutepolicy:
|
||||
|
||||
|
@ -52,11 +52,11 @@ GET /v3/{project_id}/enterprise-router/{er_id}/attachments
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| state | No | Array | Attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **pending_acceptance**, **rejected**, and **initiating_request** |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| resource_type | No | Array | Attachment type. Value options are as follows: |
|
||||
| resource_type | No | Array | Attachment type. |
|
||||
| | | | |
|
||||
| | | | - **vpc**: VPC attachment |
|
||||
| | | | - **vpc**: VPC attachments |
|
||||
| | | | |
|
||||
| | | | - **vgw**: virtual gateway attachment |
|
||||
| | | | - **vgw**: virtual gateway attachments |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| resource_id | No | Array | Attachment resource IDs |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -102,9 +102,9 @@ Response Parameters
|
||||
+-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | Attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **pending_acceptance**, **rejected**, and **initiating_request** |
|
||||
+-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| tags | Array of :ref:`Tag <listattachments__response_tag>` objects | Enterprise router tags |
|
||||
+-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -114,11 +114,11 @@ Response Parameters
|
||||
+-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| resource_id | String | Attached resource ID on its own service console |
|
||||
+-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| resource_type | String | Attachment type. Value options are as follows: |
|
||||
| resource_type | String | Attachment type. |
|
||||
| | | |
|
||||
| | | - **vgw**: virtual gateway attachment |
|
||||
| | | - **vgw**: virtual gateway attachments |
|
||||
| | | |
|
||||
| | | - **vpc**: VPC attachment |
|
||||
| | | - **vpc**: VPC attachments |
|
||||
+-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| resource_project_id | String | ID of the project that the resource belongs to |
|
||||
+-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -60,9 +60,9 @@ Response Parameters
|
||||
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | Attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **pending_acceptance**, **rejected**, and **initiating_request** |
|
||||
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| tags | Array of :ref:`Tag <showattachment__response_tag>` objects | Enterprise router tags |
|
||||
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -70,11 +70,11 @@ Response Parameters
|
||||
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| resource_id | String | Attached resource ID on its own service console |
|
||||
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| resource_type | String | Attachment type. Value options are as follows: |
|
||||
| resource_type | String | Attachment type. |
|
||||
| | | |
|
||||
| | | - **vpc**: VPC attachment |
|
||||
| | | - **vpc**: VPC attachments |
|
||||
| | | |
|
||||
| | | - **vgw**: virtual gateway attachment |
|
||||
| | | - **vgw**: virtual gateway attachments |
|
||||
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| resource_project_id | String | ID of the project that the resource belongs to |
|
||||
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -86,9 +86,9 @@ Response Parameters
|
||||
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | Attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **pending_acceptance**, **rejected**, and **initiating_request** |
|
||||
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| tags | Array of :ref:`Tag <updateattachment__response_tag>` objects | Enterprise router tags |
|
||||
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -96,11 +96,11 @@ Response Parameters
|
||||
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| resource_id | String | Attached resource ID on its own service console |
|
||||
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| resource_type | String | Attachment type. Value options are as follows: |
|
||||
| resource_type | String | Attachment type. |
|
||||
| | | |
|
||||
| | | - **vpc**: VPC attachment |
|
||||
| | | - **vpc**: VPC attachments |
|
||||
| | | |
|
||||
| | | - **vgw**: virtual gateway attachment |
|
||||
| | | - **vgw**: virtual gateway attachments |
|
||||
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| resource_project_id | String | ID of the project that the resource belongs to |
|
||||
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -69,6 +69,10 @@ Request Parameters
|
||||
+--------------------------------+-----------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| enterprise_project_id | No | String | Enterprise project ID |
|
||||
+--------------------------------+-----------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| charge_mode | No | String | Billing mode |
|
||||
| | | | |
|
||||
| | | | Default: **postPaid** |
|
||||
+--------------------------------+-----------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| tags | No | Array of :ref:`Tag <createenterpriserouter__request_tag>` objects | Tag information |
|
||||
+--------------------------------+-----------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| enable_default_propagation | No | Boolean | Whether to enable the Default Route Table Propagation function. The default value is **false**, indicating that the function is disabled. |
|
||||
@ -146,13 +150,17 @@ Response Parameters
|
||||
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| description | String | Supplementary information about an enterprise router |
|
||||
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | Enterprise router status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
|
||||
| state | String | Enterprise router status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed** **and freezed** |
|
||||
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| tags | Array of :ref:`Tag <createenterpriserouter__response_tag>` objects | Tag information |
|
||||
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| charge_mode | String | Billing mode |
|
||||
| | | |
|
||||
| | | Default: **postPaid** |
|
||||
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| enterprise_project_id | String | Enterprise project ID |
|
||||
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -57,13 +57,17 @@ Response Parameters
|
||||
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| description | String | Supplementary information about an enterprise router |
|
||||
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | Enterprise router status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
|
||||
| state | String | Enterprise router status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed** **and freezed** |
|
||||
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| tags | Array of :ref:`Tag <showenterpriserouter__response_tag>` objects | Tag information |
|
||||
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| charge_mode | String | Billing mode |
|
||||
| | | |
|
||||
| | | Default: **postPaid** |
|
||||
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| enterprise_project_id | String | Enterprise project ID |
|
||||
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -47,7 +47,7 @@ GET /v3/{project_id}/enterprise-router/instances
|
||||
+-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| enterprise_project_id | No | Array | Enterprise project ID |
|
||||
+-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| state | No | Array | Enterprise router status |
|
||||
| state | No | Array | Enterprise router status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed and freezed** |
|
||||
+-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| id | No | Array | Query by resource ID. Multiple resources can be queried at a time. |
|
||||
+-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -56,7 +56,6 @@ GET /v3/{project_id}/enterprise-router/instances
|
||||
| owned_by_self | No | Boolean | Whether the resources belong to the current account. |
|
||||
| | | | |
|
||||
| | | | - If the value is **true**, the resources belong to the current account. |
|
||||
| | | | |
|
||||
| | | | - If the value is **false**, the resources include those in the current account and those shared with the current account. |
|
||||
+-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| sort_key | No | Array | Keyword for sorting. The keyword can be **id**, **name**, or **state**. By default, **id** is used. |
|
||||
@ -99,13 +98,17 @@ Response Parameters
|
||||
+------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| description | String | Supplementary information about an enterprise router |
|
||||
+------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | Enterprise router status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
|
||||
| state | String | Enterprise router status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed and freezed** |
|
||||
+------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| tags | Array of :ref:`Tag <listenterpriserouters__response_tag>` objects | Tag information |
|
||||
+------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| charge_mode | String | Billing mode |
|
||||
| | | |
|
||||
| | | Default: **postPaid** |
|
||||
+------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| enterprise_project_id | String | Enterprise project ID |
|
||||
+------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -98,13 +98,17 @@ Response Parameters
|
||||
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| description | String | Supplementary information about an enterprise router |
|
||||
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | Enterprise router status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
|
||||
| state | String | Enterprise router status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed and freezed** |
|
||||
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| tags | Array of :ref:`Tag <updateenterpriserouter__response_tag>` objects | Tag information |
|
||||
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| charge_mode | String | Billing mode |
|
||||
| | | |
|
||||
| | | Default: **postPaid** |
|
||||
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| enterprise_project_id | String | Enterprise project ID |
|
||||
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -68,7 +68,9 @@ Request Parameters
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+
|
||||
| resource_type | Yes | String | Type of resource whose flow logs are collected. |
|
||||
| | | | |
|
||||
| | | | - VPC attachment |
|
||||
| | | | - VPC attachments |
|
||||
| | | | |
|
||||
| | | | - Virtual gateway attachments |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+
|
||||
| resource_id | Yes | String | Resource ID |
|
||||
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+
|
||||
@ -125,13 +127,13 @@ Response Parameters
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| log_stream_id | String | Log stream ID |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| log_store_type | String | Flow log storage type |
|
||||
| log_store_type | String | Flow log storage type. LTS is used for log storage. |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | Flow log status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -68,13 +68,13 @@ Response Parameters
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| log_stream_id | String | Log stream ID |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| log_store_type | String | Flow log storage type |
|
||||
| log_store_type | String | Flow log storage type. LTS is used for log storage. |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | Flow log status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -68,13 +68,13 @@ Response Parameters
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| log_stream_id | String | Log stream ID |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| log_store_type | String | Flow log storage type |
|
||||
| log_store_type | String | Flow log storage type. LTS is used for log storage. |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | Flow log status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -68,13 +68,13 @@ Response Parameters
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| log_stream_id | String | Log stream ID |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| log_store_type | String | Flow log storage type |
|
||||
| log_store_type | String | Flow log storage type. LTS is used for log storage. |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | Flow log status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -104,13 +104,13 @@ Response Parameters
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| log_stream_id | String | Log stream ID |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| log_store_type | String | Flow log storage type |
|
||||
| log_store_type | String | Flow log storage type. LTS is used for log storage. |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | Flow log status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -82,13 +82,13 @@ Response Parameters
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| log_stream_id | String | Log stream ID |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| log_store_type | String | Flow log storage type |
|
||||
| log_store_type | String | Flow log storage type. LTS is used for log storage. |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | Flow log status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
|
||||
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -42,13 +42,13 @@ Request Parameters
|
||||
|
||||
.. table:: **Table 3** Request body parameters
|
||||
|
||||
+---------------+-----------+--------------------------------------------------------------------------------+-------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+===============+===========+================================================================================+=====================================+
|
||||
| attachment_id | No | String | Unique ID of the attachment |
|
||||
+---------------+-----------+--------------------------------------------------------------------------------+-------------------------------------+
|
||||
| route_policy | No | :ref:`ImportRoutePolicy <enablepropagation__request_importroutepolicy>` object | Route that controls inbound traffic |
|
||||
+---------------+-----------+--------------------------------------------------------------------------------+-------------------------------------+
|
||||
+---------------+-----------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| Parameter | Mandatory | Type | Description |
|
||||
+===============+===========+================================================================================+=================================================================================+
|
||||
| attachment_id | No | String | Unique ID of the attachment |
|
||||
+---------------+-----------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| route_policy | No | :ref:`ImportRoutePolicy <enablepropagation__request_importroutepolicy>` object | Route that controls inbound traffic. Note that this is not currently supported. |
|
||||
+---------------+-----------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
|
||||
.. _enablepropagation__request_importroutepolicy:
|
||||
|
||||
@ -91,31 +91,34 @@ Response Parameters
|
||||
|
||||
.. table:: **Table 7** Propagation
|
||||
|
||||
+----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+================+=================================================================================+=====================================================================+
|
||||
| id | String | Unique association ID |
|
||||
+----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| project_id | String | Project ID |
|
||||
+----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| er_id | String | Enterprise router ID |
|
||||
+----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| route_table_id | String | Unique ID of the route table |
|
||||
+----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| attachment_id | String | Unique ID of the attachment |
|
||||
+----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| resource_type | String | Attachment type |
|
||||
+----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| resource_id | String | Unique ID of the attachment |
|
||||
+----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| route_policy | :ref:`ImportRoutePolicy <enablepropagation__response_importroutepolicy>` object | Route that controls inbound traffic |
|
||||
+----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| state | String | Status |
|
||||
+----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| created_at | String | Creation time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
|
||||
+----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| updated_at | String | Update time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
|
||||
+----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=================================================================================+=============================================================================================================+
|
||||
| id | String | Unique association ID |
|
||||
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| project_id | String | Project ID |
|
||||
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| er_id | String | Enterprise router ID |
|
||||
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| route_table_id | String | Unique ID of the route table |
|
||||
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| attachment_id | String | Unique ID of the attachment |
|
||||
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| resource_type | String | Attachment type. |
|
||||
| | | |
|
||||
| | | - **vpc**: VPC attachments |
|
||||
| | | - **vgw**: virtual gateway attachments |
|
||||
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| resource_id | String | Unique ID of the attachment |
|
||||
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| route_policy | :ref:`ImportRoutePolicy <enablepropagation__response_importroutepolicy>` object | Route that controls inbound traffic. Note that this is not currently supported. |
|
||||
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | Status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
|
||||
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
|
||||
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
|
||||
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _enablepropagation__response_importroutepolicy:
|
||||
|
||||
|
@ -30,13 +30,13 @@ 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 |
|
||||
+---------------+-----------+---------------------------------------------------------------------------------+-------------------------------------+
|
||||
+---------------+-----------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
| 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. Note that this is not currently supported. |
|
||||
+---------------+-----------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+
|
||||
|
||||
.. _disablepropagation__request_importroutepolicy:
|
||||
|
||||
|
@ -49,13 +49,12 @@ GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/pro
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| attachment_id | No | Array | Attachment ID |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| resource_type | No | Array | Attachment type. Value options are as follows: |
|
||||
| resource_type | No | Array | Attachment type. |
|
||||
| | | | |
|
||||
| | | | - **vpc**: VPC attachment |
|
||||
| | | | |
|
||||
| | | | - **vgw**: virtual gateway attachment |
|
||||
| | | | - **vpc**: VPC attachments |
|
||||
| | | | - **vgw**: virtual gateway attachments |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| state | No | Array | Enterprise router status |
|
||||
| state | No | Array | Enterprise router status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed and freezed** |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| sort_key | No | Array | Keyword for sorting. The keyword can be **id**, **name**, or **state**. By default, **id** is used. |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -90,31 +89,34 @@ Response Parameters
|
||||
|
||||
.. table:: **Table 4** Propagation
|
||||
|
||||
+----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+================+================================================================================+=====================================================================+
|
||||
| id | String | Unique association ID |
|
||||
+----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| project_id | String | Project ID |
|
||||
+----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| er_id | String | Enterprise router ID |
|
||||
+----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| route_table_id | String | Unique ID of the route table |
|
||||
+----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| attachment_id | String | Unique ID of the attachment |
|
||||
+----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| resource_type | String | Attachment type |
|
||||
+----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| resource_id | String | Unique ID of the attachment |
|
||||
+----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| route_policy | :ref:`ImportRoutePolicy <listpropagations__response_importroutepolicy>` object | Route that controls inbound traffic |
|
||||
+----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| state | String | Status |
|
||||
+----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| created_at | String | Creation time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
|
||||
+----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
| updated_at | String | Update time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
|
||||
+----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+================================================================================+=============================================================================================================+
|
||||
| id | String | Unique association ID |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| project_id | String | Project ID |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| er_id | String | Enterprise router ID |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| route_table_id | String | Unique ID of the route table |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| attachment_id | String | Unique ID of the attachment |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| resource_type | String | Attachment type. |
|
||||
| | | |
|
||||
| | | - **vpc**: VPC attachments |
|
||||
| | | - **vgw**: virtual gateway attachments |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| resource_id | String | Unique ID of the attachment |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| route_policy | :ref:`ImportRoutePolicy <listpropagations__response_importroutepolicy>` object | Route that controls inbound traffic. Note that this is not currently supported. |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | Status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
|
||||
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _listpropagations__response_importroutepolicy:
|
||||
|
||||
|
@ -135,9 +135,9 @@ Response Parameters
|
||||
+------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
| tags | Array of :ref:`Tag <createroutetable__response_tag>` objects | Tag |
|
||||
+------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
|
||||
.. _createroutetable__response_tag:
|
||||
|
@ -68,9 +68,9 @@ Response Parameters
|
||||
+------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
| tags | Array of :ref:`Tag <showroutetable__response_tag>` objects | Tag |
|
||||
+------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
|
||||
.. _showroutetable__response_tag:
|
||||
|
@ -104,9 +104,9 @@ Response Parameters
|
||||
+------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
| tags | Array of :ref:`Tag <listroutetables__response_tag>` objects | Tag |
|
||||
+------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
|
||||
.. _listroutetables__response_tag:
|
||||
|
@ -94,9 +94,9 @@ Response Parameters
|
||||
+------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
| tags | Array of :ref:`Tag <updateroutetable__response_tag>` objects | Tag |
|
||||
+------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+
|
||||
|
||||
.. _updateroutetable__response_tag:
|
||||
|
@ -114,28 +114,28 @@ Response Parameters
|
||||
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| route_table_id | String | Route table ID |
|
||||
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _createstaticroute__response_routeattachment:
|
||||
|
||||
.. table:: **Table 8** RouteAttachment
|
||||
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=======================+================================================+
|
||||
| resource_id | String | Attached resource ID |
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
| resource_type | String | Attachment type. Value options are as follows: |
|
||||
| | | |
|
||||
| | | - **vpc**: VPC attachment |
|
||||
| | | |
|
||||
| | | - **vgw**: virtual gateway attachment |
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
| attachment_id | String | Attachment ID |
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=======================+=========================================+
|
||||
| resource_id | String | Attached resource ID |
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
| resource_type | String | Attachment type. |
|
||||
| | | |
|
||||
| | | - **vpc**: VPC attachments |
|
||||
| | | |
|
||||
| | | - **vgw**: virtual gateway attachments |
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
| attachment_id | String | Attachment ID |
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
@ -66,28 +66,28 @@ Response Parameters
|
||||
+----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| route_table_id | String | Route table ID |
|
||||
+----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _showstaticroute__response_routeattachment:
|
||||
|
||||
.. table:: **Table 4** RouteAttachment
|
||||
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=======================+================================================+
|
||||
| resource_id | String | Attached resource ID |
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
| resource_type | String | Attachment type. Value options are as follows: |
|
||||
| | | |
|
||||
| | | - **vpc**: VPC attachment |
|
||||
| | | |
|
||||
| | | - **vgw**: virtual gateway attachment |
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
| attachment_id | String | Attachment ID |
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=======================+=========================================+
|
||||
| resource_id | String | Attached resource ID |
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
| resource_type | String | Attachment type. |
|
||||
| | | |
|
||||
| | | - **vpc**: VPC attachments |
|
||||
| | | |
|
||||
| | | - **vgw**: virtual gateway attachments |
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
| attachment_id | String | Attachment ID |
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
@ -43,11 +43,11 @@ GET /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/routes
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| destination | No | Array | Destination address of the route |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| resource_type | No | Array | Attachment type. Value options are as follows: |
|
||||
| resource_type | No | Array | Attachment type. |
|
||||
| | | | |
|
||||
| | | | - **vpc**: VPC attachment |
|
||||
| | | | - **vpc**: VPC attachments |
|
||||
| | | | |
|
||||
| | | | - **vgw**: virtual gateway attachment |
|
||||
| | | | - **vgw**: virtual gateway attachments |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Request Parameters
|
||||
@ -94,19 +94,19 @@ Response Parameters
|
||||
|
||||
.. table:: **Table 5** RouteAttachment
|
||||
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=======================+================================================+
|
||||
| resource_id | String | Attached resource ID |
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
| resource_type | String | Attachment type. Value options are as follows: |
|
||||
| | | |
|
||||
| | | - **vpc**: VPC attachment |
|
||||
| | | |
|
||||
| | | - **vgw**: virtual gateway attachment |
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
| attachment_id | String | Attachment ID |
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=======================+=========================================+
|
||||
| resource_id | String | Attached resource ID |
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
| resource_type | String | Attachment type. |
|
||||
| | | |
|
||||
| | | - **vpc**: VPC attachments |
|
||||
| | | |
|
||||
| | | - **vgw**: virtual gateway attachments |
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
| attachment_id | String | Attachment ID |
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
|
||||
.. _listeffectiveroutes__response_pageinfo:
|
||||
|
||||
|
@ -52,11 +52,11 @@ GET /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-rout
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| attachment_id | No | Array | Attachment ID |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| resource_type | No | Array | Attachment type. Value options are as follows: |
|
||||
| resource_type | No | Array | Attachment type. |
|
||||
| | | | |
|
||||
| | | | - **vpc**: VPC attachment |
|
||||
| | | | - **vpc**: VPC attachments |
|
||||
| | | | |
|
||||
| | | | - **vgw**: virtual gateway attachment |
|
||||
| | | | - **vgw**: virtual gateway attachments |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| sort_key | No | Array | Keyword for sorting. The keyword can be **id**, **name**, or **state**. By default, **id** is used. |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -106,28 +106,28 @@ Response Parameters
|
||||
+----------------+--------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| route_table_id | String | Route table ID |
|
||||
+----------------+--------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+----------------+--------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+----------------+--------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _liststaticroutes__response_routeattachment:
|
||||
|
||||
.. table:: **Table 5** RouteAttachment
|
||||
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=======================+================================================+
|
||||
| resource_id | String | Attached resource ID |
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
| resource_type | String | Attachment type. Value options are as follows: |
|
||||
| | | |
|
||||
| | | - **vpc**: VPC attachment |
|
||||
| | | |
|
||||
| | | - **vgw**: virtual gateway attachment |
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
| attachment_id | String | Attachment ID |
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=======================+=========================================+
|
||||
| resource_id | String | Attached resource ID |
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
| resource_type | String | Attachment type. |
|
||||
| | | |
|
||||
| | | - **vpc**: VPC attachments |
|
||||
| | | |
|
||||
| | | - **vgw**: virtual gateway attachments |
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
| attachment_id | String | Attachment ID |
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
|
||||
.. _liststaticroutes__response_pageinfo:
|
||||
|
||||
|
@ -83,28 +83,28 @@ Response Parameters
|
||||
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| route_table_id | String | Route table ID |
|
||||
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _updatestaticroute__response_routeattachment:
|
||||
|
||||
.. table:: **Table 6** RouteAttachment
|
||||
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=======================+================================================+
|
||||
| resource_id | String | Attached resource ID |
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
| resource_type | String | Attachment type. Value options are as follows: |
|
||||
| | | |
|
||||
| | | - **vpc**: VPC attachment |
|
||||
| | | |
|
||||
| | | - **vgw**: virtual gateway attachment |
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
| attachment_id | String | Attachment ID |
|
||||
+-----------------------+-----------------------+------------------------------------------------+
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
+=======================+=======================+=========================================+
|
||||
| resource_id | String | Attached resource ID |
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
| resource_type | String | Attachment type. |
|
||||
| | | |
|
||||
| | | - **vpc**: VPC attachments |
|
||||
| | | |
|
||||
| | | - **vgw**: virtual gateway attachments |
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
| attachment_id | String | Attachment ID |
|
||||
+-----------------------+-----------------------+-----------------------------------------+
|
||||
|
||||
Example Requests
|
||||
----------------
|
||||
|
@ -33,7 +33,7 @@ POST /v3/{project_id}/{resource_type}/{resource_id}/tags
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------+
|
||||
| resource_id | Yes | String | Resource ID |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------+
|
||||
| resource_type | Yes | String | Resource type. Value options: |
|
||||
| resource_type | Yes | String | Resource type. |
|
||||
| | | | |
|
||||
| | | | - **instance**: enterprise router |
|
||||
| | | | |
|
||||
|
@ -31,7 +31,7 @@ DELETE /v3/{project_id}/{resource_type}/{resource_id}/tags/{key}
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------+
|
||||
| resource_id | Yes | String | Resource ID |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------+
|
||||
| resource_type | Yes | String | Resource type. Value options: |
|
||||
| resource_type | Yes | String | Resource type. |
|
||||
| | | | |
|
||||
| | | | - **instance**: enterprise router |
|
||||
| | | | |
|
||||
|
@ -22,7 +22,7 @@ GET /v3/{project_id}/{resource_type}/tags
|
||||
+=================+=================+=================+===================================================+
|
||||
| project_id | Yes | String | Project ID |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------+
|
||||
| resource_type | Yes | String | Resource type. Value options: |
|
||||
| resource_type | Yes | String | Resource type. |
|
||||
| | | | |
|
||||
| | | | - **instance**: enterprise router |
|
||||
| | | | |
|
||||
|
@ -24,7 +24,7 @@ GET /v3/{project_id}/{resource_type}/{resource_id}/tags
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------+
|
||||
| resource_id | Yes | String | Resource ID |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------+
|
||||
| resource_type | Yes | String | Resource type. Value options: |
|
||||
| resource_type | Yes | String | Resource type. |
|
||||
| | | | |
|
||||
| | | | - **instance**: enterprise router |
|
||||
| | | | |
|
||||
|
@ -141,9 +141,9 @@ Response Parameters
|
||||
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | VPC attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **initiating_request**, **rejected**, and **pending_acceptance** |
|
||||
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| tags | Array of :ref:`Tag <createvpcattachment__response_tag>` objects | Tag information |
|
||||
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -66,9 +66,9 @@ Response Parameters
|
||||
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | VPC attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **initiating_request**, **rejected**, and **pending_acceptance** |
|
||||
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| tags | Array of :ref:`Tag <showvpcattachment__response_tag>` objects | Tag information |
|
||||
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -106,9 +106,9 @@ Response Parameters
|
||||
+------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | VPC attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **initiating_request**, **rejected**, and **pending_acceptance** |
|
||||
+------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| tags | Array of :ref:`Tag <listvpcattachments__response_tag>` objects | Tag information |
|
||||
+------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -92,9 +92,9 @@ Response Parameters
|
||||
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| state | String | VPC attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **initiating_request**, **rejected**, and **pending_acceptance** |
|
||||
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| created_at | String | Creation time |
|
||||
| created_at | String | Creation time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| updated_at | String | Update time |
|
||||
| updated_at | String | Update time in the format YYYY-MM-DDTHH:MM:SS |
|
||||
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| tags | Array of :ref:`Tag <updatevpcattachment__response_tag>` objects | Tag information |
|
||||
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -8,6 +8,15 @@ Change History
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Released On | Description |
|
||||
+===================================+================================================================================================================================================================================+
|
||||
| 2023-10-09 | This release incorporates the following changes: |
|
||||
| | |
|
||||
| | - Added the description of attachments in "API Usage Guidelines". |
|
||||
| | - Modified the descriptions of parameters **created_at** and **updated_at** to add the time format. |
|
||||
| | - Modified the description of the **state** parameter to add numerated values. |
|
||||
| | - Added the **charge_mode** parameter in "Creating an Enterprise Router". |
|
||||
| | - Added a description that the **route_policy** parameter is not supported in "Creating a Route Association". |
|
||||
| | - Modified the description of the **resource_type** parameter in "Creating a Route Association" and "Creating a Route Propagation". |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2023-09-22 | This release incorporates the following changes: |
|
||||
| | |
|
||||
| | - Modified the description of the **state** parameter in "Creating an Enterprise Router", "Updating an Enterprise Router", and "Querying Details About an Enterprise Router". |
|
||||
|
Loading…
x
Reference in New Issue
Block a user