diff --git a/api-ref/source/_static/images/en-us_image_0000001294957952.png b/api-ref/source/_static/images/en-us_image_0000001294957952.png new file mode 100644 index 0000000..cf85379 Binary files /dev/null and b/api-ref/source/_static/images/en-us_image_0000001294957952.png differ diff --git a/api-ref/source/api_usage_guidelines.rst b/api-ref/source/api_usage_guidelines.rst index 7275d7f..482bf0b 100644 --- a/api-ref/source/api_usage_guidelines.rst +++ b/api-ref/source/api_usage_guidelines.rst @@ -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 `__. + +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 ` | :ref:`Querying Details About a VPC Attachment ` | :ref:`Deleting a VPC Attachment ` | + +----------------------------+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ + | Virtual gateway attachment | Virtual gateway of Direct Connect | Create a virtual gateway by referring to `Creating a Virtual Gateway `__ and then attach it to an enterprise router. | :ref:`Querying Details About an Attachment ` | `Deleting a Virtual Gateway `__ | + +----------------------------+-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/associations/creating_a_route_association.rst b/api-ref/source/apis/associations/creating_a_route_association.rst index 722d2b2..e41fac8 100644 --- a/api-ref/source/apis/associations/creating_a_route_association.rst +++ b/api-ref/source/apis/associations/creating_a_route_association.rst @@ -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 ` 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 ` 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 ` 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 ` object | Route that controls outbound traffic. Note that this is not currently supported. | + +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ .. _associateroutetable__response_exportroutepolicy: diff --git a/api-ref/source/apis/associations/deleting_a_route_association.rst b/api-ref/source/apis/associations/deleting_a_route_association.rst index e952294..618e0c5 100644 --- a/api-ref/source/apis/associations/deleting_a_route_association.rst +++ b/api-ref/source/apis/associations/deleting_a_route_association.rst @@ -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 ` 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 ` object | Route that controls outbound traffic. Note that this is not currently supported. | + +-----------------+-----------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ .. _disassociateroutetable__request_exportroutepolicy: diff --git a/api-ref/source/apis/associations/querying_route_associations.rst b/api-ref/source/apis/associations/querying_route_associations.rst index fcbd8c0..b7e3580 100644 --- a/api-ref/source/apis/associations/querying_route_associations.rst +++ b/api-ref/source/apis/associations/querying_route_associations.rst @@ -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 ` 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 ` object | Route that controls outbound traffic. Note that this is not currently supported. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ .. _listassociations__response_exportroutepolicy: diff --git a/api-ref/source/apis/attachments/querying_attachments.rst b/api-ref/source/apis/attachments/querying_attachments.rst index be8b1f2..c2be39d 100644 --- a/api-ref/source/apis/attachments/querying_attachments.rst +++ b/api-ref/source/apis/attachments/querying_attachments.rst @@ -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 ` 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 | +-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/attachments/querying_details_about_an_attachment.rst b/api-ref/source/apis/attachments/querying_details_about_an_attachment.rst index 79492c1..5746a0c 100644 --- a/api-ref/source/apis/attachments/querying_details_about_an_attachment.rst +++ b/api-ref/source/apis/attachments/querying_details_about_an_attachment.rst @@ -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 ` 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 | +-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/attachments/updating_an_attachment.rst b/api-ref/source/apis/attachments/updating_an_attachment.rst index f534268..a621158 100644 --- a/api-ref/source/apis/attachments/updating_an_attachment.rst +++ b/api-ref/source/apis/attachments/updating_an_attachment.rst @@ -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 ` 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 | +-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/enterprise_routers/creating_an_enterprise_router.rst b/api-ref/source/apis/enterprise_routers/creating_an_enterprise_router.rst index 9175764..0edcbda 100644 --- a/api-ref/source/apis/enterprise_routers/creating_an_enterprise_router.rst +++ b/api-ref/source/apis/enterprise_routers/creating_an_enterprise_router.rst @@ -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 ` 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 ` 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 | +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/enterprise_routers/querying_details_about_an_enterprise_router.rst b/api-ref/source/apis/enterprise_routers/querying_details_about_an_enterprise_router.rst index 269e8f2..1bfbf20 100644 --- a/api-ref/source/apis/enterprise_routers/querying_details_about_an_enterprise_router.rst +++ b/api-ref/source/apis/enterprise_routers/querying_details_about_an_enterprise_router.rst @@ -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 ` 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 | +------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/enterprise_routers/querying_enterprise_routers.rst b/api-ref/source/apis/enterprise_routers/querying_enterprise_routers.rst index b8d9dc2..88ad559 100644 --- a/api-ref/source/apis/enterprise_routers/querying_enterprise_routers.rst +++ b/api-ref/source/apis/enterprise_routers/querying_enterprise_routers.rst @@ -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 ` 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 | +------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/enterprise_routers/updating_an_enterprise_router.rst b/api-ref/source/apis/enterprise_routers/updating_an_enterprise_router.rst index 315f03a..e5e444f 100644 --- a/api-ref/source/apis/enterprise_routers/updating_an_enterprise_router.rst +++ b/api-ref/source/apis/enterprise_routers/updating_an_enterprise_router.rst @@ -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 ` 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 | +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/flow_logs/creating_a_flow_log.rst b/api-ref/source/apis/flow_logs/creating_a_flow_log.rst index edc09e2..53863c2 100644 --- a/api-ref/source/apis/flow_logs/creating_a_flow_log.rst +++ b/api-ref/source/apis/flow_logs/creating_a_flow_log.rst @@ -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** | +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/flow_logs/disabling_flow_logs.rst b/api-ref/source/apis/flow_logs/disabling_flow_logs.rst index 49b52aa..09ab39a 100644 --- a/api-ref/source/apis/flow_logs/disabling_flow_logs.rst +++ b/api-ref/source/apis/flow_logs/disabling_flow_logs.rst @@ -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** | +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/flow_logs/enabling_flow_logs.rst b/api-ref/source/apis/flow_logs/enabling_flow_logs.rst index 14296e0..55dbe4c 100644 --- a/api-ref/source/apis/flow_logs/enabling_flow_logs.rst +++ b/api-ref/source/apis/flow_logs/enabling_flow_logs.rst @@ -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** | +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/flow_logs/querying_details_about_a_flow_log.rst b/api-ref/source/apis/flow_logs/querying_details_about_a_flow_log.rst index e64b7cc..1b25737 100644 --- a/api-ref/source/apis/flow_logs/querying_details_about_a_flow_log.rst +++ b/api-ref/source/apis/flow_logs/querying_details_about_a_flow_log.rst @@ -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** | +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/flow_logs/querying_flow_logs.rst b/api-ref/source/apis/flow_logs/querying_flow_logs.rst index eea14d1..b824b5e 100644 --- a/api-ref/source/apis/flow_logs/querying_flow_logs.rst +++ b/api-ref/source/apis/flow_logs/querying_flow_logs.rst @@ -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** | +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/flow_logs/updating_a_flow_log.rst b/api-ref/source/apis/flow_logs/updating_a_flow_log.rst index 0a247d3..181828b 100644 --- a/api-ref/source/apis/flow_logs/updating_a_flow_log.rst +++ b/api-ref/source/apis/flow_logs/updating_a_flow_log.rst @@ -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** | +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/propagations/creating_a_route_propagation.rst b/api-ref/source/apis/propagations/creating_a_route_propagation.rst index 0c5df2e..9a0e9cb 100644 --- a/api-ref/source/apis/propagations/creating_a_route_propagation.rst +++ b/api-ref/source/apis/propagations/creating_a_route_propagation.rst @@ -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 ` object | Route that controls inbound traffic | - +---------------+-----------+--------------------------------------------------------------------------------+-------------------------------------+ + +---------------+-----------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===============+===========+================================================================================+=================================================================================+ + | attachment_id | No | String | Unique ID of the attachment | + +---------------+-----------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ + | route_policy | No | :ref:`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 ` 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 ` 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: diff --git a/api-ref/source/apis/propagations/deleting_a_route_propagation.rst b/api-ref/source/apis/propagations/deleting_a_route_propagation.rst index 85b904d..6e58259 100644 --- a/api-ref/source/apis/propagations/deleting_a_route_propagation.rst +++ b/api-ref/source/apis/propagations/deleting_a_route_propagation.rst @@ -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 ` object | Route that controls inbound traffic | - +---------------+-----------+---------------------------------------------------------------------------------+-------------------------------------+ + +---------------+-----------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===============+===========+=================================================================================+=================================================================================+ + | attachment_id | No | String | Unique ID of the attachment | + +---------------+-----------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ + | route_policy | No | :ref:`ImportRoutePolicy ` object | Route that controls inbound traffic. Note that this is not currently supported. | + +---------------+-----------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ .. _disablepropagation__request_importroutepolicy: diff --git a/api-ref/source/apis/propagations/querying_route_propagations.rst b/api-ref/source/apis/propagations/querying_route_propagations.rst index 82f967e..689e96b 100644 --- a/api-ref/source/apis/propagations/querying_route_propagations.rst +++ b/api-ref/source/apis/propagations/querying_route_propagations.rst @@ -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 ` 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 ` 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: diff --git a/api-ref/source/apis/route_tables/creating_a_route_table.rst b/api-ref/source/apis/route_tables/creating_a_route_table.rst index bd4a255..5ca8a77 100644 --- a/api-ref/source/apis/route_tables/creating_a_route_table.rst +++ b/api-ref/source/apis/route_tables/creating_a_route_table.rst @@ -135,9 +135,9 @@ Response Parameters +------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ | tags | Array of :ref:`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: diff --git a/api-ref/source/apis/route_tables/querying_details_about_a_route_table.rst b/api-ref/source/apis/route_tables/querying_details_about_a_route_table.rst index ba5c5cb..2514190 100644 --- a/api-ref/source/apis/route_tables/querying_details_about_a_route_table.rst +++ b/api-ref/source/apis/route_tables/querying_details_about_a_route_table.rst @@ -68,9 +68,9 @@ Response Parameters +------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+ | tags | Array of :ref:`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: diff --git a/api-ref/source/apis/route_tables/querying_route_tables.rst b/api-ref/source/apis/route_tables/querying_route_tables.rst index a4fc1ca..5e8e509 100644 --- a/api-ref/source/apis/route_tables/querying_route_tables.rst +++ b/api-ref/source/apis/route_tables/querying_route_tables.rst @@ -104,9 +104,9 @@ Response Parameters +------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+ | tags | Array of :ref:`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: diff --git a/api-ref/source/apis/route_tables/updating_route_table_information.rst b/api-ref/source/apis/route_tables/updating_route_table_information.rst index b5c6cbf..a46c7c2 100644 --- a/api-ref/source/apis/route_tables/updating_route_table_information.rst +++ b/api-ref/source/apis/route_tables/updating_route_table_information.rst @@ -94,9 +94,9 @@ Response Parameters +------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ | tags | Array of :ref:`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: diff --git a/api-ref/source/apis/routes/creating_a_static_route.rst b/api-ref/source/apis/routes/creating_a_static_route.rst index 7bcc9c8..109e941 100644 --- a/api-ref/source/apis/routes/creating_a_static_route.rst +++ b/api-ref/source/apis/routes/creating_a_static_route.rst @@ -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 ---------------- diff --git a/api-ref/source/apis/routes/querying_details_about_a_static_route.rst b/api-ref/source/apis/routes/querying_details_about_a_static_route.rst index ab74a67..7dfeb6f 100644 --- a/api-ref/source/apis/routes/querying_details_about_a_static_route.rst +++ b/api-ref/source/apis/routes/querying_details_about_a_static_route.rst @@ -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 ---------------- diff --git a/api-ref/source/apis/routes/querying_effective_routes.rst b/api-ref/source/apis/routes/querying_effective_routes.rst index d50e3b1..f3adc26 100644 --- a/api-ref/source/apis/routes/querying_effective_routes.rst +++ b/api-ref/source/apis/routes/querying_effective_routes.rst @@ -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: diff --git a/api-ref/source/apis/routes/querying_static_routes.rst b/api-ref/source/apis/routes/querying_static_routes.rst index 8576279..67c3d37 100644 --- a/api-ref/source/apis/routes/querying_static_routes.rst +++ b/api-ref/source/apis/routes/querying_static_routes.rst @@ -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: diff --git a/api-ref/source/apis/routes/updating_a_static_route.rst b/api-ref/source/apis/routes/updating_a_static_route.rst index a23de3b..bfce97a 100644 --- a/api-ref/source/apis/routes/updating_a_static_route.rst +++ b/api-ref/source/apis/routes/updating_a_static_route.rst @@ -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 ---------------- diff --git a/api-ref/source/apis/tags/creating_resource_tags.rst b/api-ref/source/apis/tags/creating_resource_tags.rst index 9d41c7d..2739bb5 100644 --- a/api-ref/source/apis/tags/creating_resource_tags.rst +++ b/api-ref/source/apis/tags/creating_resource_tags.rst @@ -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 | | | | | | diff --git a/api-ref/source/apis/tags/deleting_resource_tags.rst b/api-ref/source/apis/tags/deleting_resource_tags.rst index 6c7fa78..5f06999 100644 --- a/api-ref/source/apis/tags/deleting_resource_tags.rst +++ b/api-ref/source/apis/tags/deleting_resource_tags.rst @@ -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 | | | | | | diff --git a/api-ref/source/apis/tags/querying_project_tags.rst b/api-ref/source/apis/tags/querying_project_tags.rst index 52ce0dc..7017d55 100644 --- a/api-ref/source/apis/tags/querying_project_tags.rst +++ b/api-ref/source/apis/tags/querying_project_tags.rst @@ -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 | | | | | | diff --git a/api-ref/source/apis/tags/querying_resource_tags.rst b/api-ref/source/apis/tags/querying_resource_tags.rst index 9463674..3e0bb39 100644 --- a/api-ref/source/apis/tags/querying_resource_tags.rst +++ b/api-ref/source/apis/tags/querying_resource_tags.rst @@ -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 | | | | | | diff --git a/api-ref/source/apis/vpc_attachments/creating_a_vpc_attachment.rst b/api-ref/source/apis/vpc_attachments/creating_a_vpc_attachment.rst index 9a6d45f..a44ce24 100644 --- a/api-ref/source/apis/vpc_attachments/creating_a_vpc_attachment.rst +++ b/api-ref/source/apis/vpc_attachments/creating_a_vpc_attachment.rst @@ -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 ` objects | Tag information | +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/vpc_attachments/querying_details_about_a_vpc_attachment.rst b/api-ref/source/apis/vpc_attachments/querying_details_about_a_vpc_attachment.rst index 74f853e..324f4b3 100644 --- a/api-ref/source/apis/vpc_attachments/querying_details_about_a_vpc_attachment.rst +++ b/api-ref/source/apis/vpc_attachments/querying_details_about_a_vpc_attachment.rst @@ -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 ` objects | Tag information | +------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/vpc_attachments/querying_vpc_attachments.rst b/api-ref/source/apis/vpc_attachments/querying_vpc_attachments.rst index 9ddf74b..4b4afab 100644 --- a/api-ref/source/apis/vpc_attachments/querying_vpc_attachments.rst +++ b/api-ref/source/apis/vpc_attachments/querying_vpc_attachments.rst @@ -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 ` objects | Tag information | +------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/vpc_attachments/updating_a_vpc_attachment.rst b/api-ref/source/apis/vpc_attachments/updating_a_vpc_attachment.rst index 0737ad1..986e512 100644 --- a/api-ref/source/apis/vpc_attachments/updating_a_vpc_attachment.rst +++ b/api-ref/source/apis/vpc_attachments/updating_a_vpc_attachment.rst @@ -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 ` objects | Tag information | +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 6f0565b..a2b2f3e 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -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". |