dadrobna/enterprise-router
1
0
Fork 0
forked from docs/enterprise-router
Code Pull Requests Activity

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2023-09-22 07:56:42 +00:00 committed by lhajba
parent 81b16efc9a
commit 3520722fab
53 changed files with 1342 additions and 1374 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
api-ref/source/apis/associations/creating_a_route_association.rst
View File

@ -93,33 +93,33 @@ 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 | Time when the resource was created UTC time Format: YYYY-MM-DDTHH:MM:SS |
+-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| updated_at | String | Time when the resource was updated UTC time Format: YYYY-MM-DDTHH:MM:SS |
+-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| route_policy | :ref:`ExportRoutePolicy <associateroutetable__response_exportroutepolicy>` object | Route that controls outbound traffic |
+-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------+
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+===================================================================================+=====================================================================+
| id | String | Unique association ID |
| | | |
| | | Maximum: **36** |
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
| route_table_id | String | Unique ID of the route table |
| | | |
| | | Maximum: **36** |
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
| attachment_id | String | Unique ID of the attachment |
| | | |
| | | Maximum: **36** |
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
| resource_type | String | Attachment type |
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
| resource_id | String | Unique ID of the attachment |
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
| state | String | Status |
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
| created_at | String | Creation time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
| updated_at | String | Update time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
| route_policy | :ref:`ExportRoutePolicy <associateroutetable__response_exportroutepolicy>` object | Route that controls outbound traffic |
+-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+
.. _associateroutetable__response_exportroutepolicy:

86
api-ref/source/apis/associations/querying_route_associations.rst
View File

File diff suppressed because it is too large Load Diff

138
api-ref/source/apis/attachments/querying_attachments.rst
View File

File diff suppressed because it is too large Load Diff

58
api-ref/source/apis/attachments/querying_details_about_an_attachment.rst
View File

@ -49,35 +49,35 @@ Response Parameters
.. table:: **Table 3** AttachmentResponse
+-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+============================================================+=======================================================================================================================================================================+
| name | String | Attachment name |
+-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | String | Attachment ID |
+-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Supplementary information |
+-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| state | String | Attachment status: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **pending_acceptance**, **rejected**, and **initiating_request** |
+-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of :ref:`Tag <showattachment__response_tag>` objects | Enterprise router tags |
+-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID |
+-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| resource_id | String | Attached resource ID on its own service console |
+-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| resource_type | String | The following types of attachments are available: |
| | | |
| | | - **vgw**: Virtual gateway attachment |
| | | |
| | | - **vpn**: VPN gateway attachment |
+-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| resource_project_id | String | ID of the project that the resource belongs to |
+-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+============================================================+======================================================================================================================================================================================+
| name | String | Attachment name |
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | String | Attachment ID |
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Supplementary information |
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| state | String | Attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **pending_acceptance**, **rejected**, and **initiating_request** |
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of :ref:`Tag <showattachment__response_tag>` objects | Enterprise router tags |
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID |
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| resource_id | String | Attached resource ID on its own service console |
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| resource_type | String | Attachment type. Value options are as follows: |
| | | |
| | | - **vpc**: VPC attachment |
| | | |
| | | - **vgw**: virtual gateway attachment |
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| resource_project_id | String | ID of the project that the resource belongs to |
+-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _showattachment__response_tag:

60
api-ref/source/apis/attachments/updating_an_attachment.rst
View File

@ -75,35 +75,35 @@ Response Parameters
.. table:: **Table 5** AttachmentResponse
+-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+==============================================================+=======================================================================================================================================================================+
| name | String | Attachment name |
+-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | String | Attachment ID |
+-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Supplementary information |
+-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| state | String | Attachment status: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **pending_acceptance**, **rejected**, and **initiating_request** |
+-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of :ref:`Tag <updateattachment__response_tag>` objects | Enterprise router tags |
+-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID |
+-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| resource_id | String | Attached resource ID on its own service console |
+-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| resource_type | String | The following types of attachments are available: |
| | | |
| | | - **vgw**: Virtual gateway attachment |
| | | |
| | | - **vpn**: VPN gateway attachment |
+-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| resource_project_id | String | ID of the project that the resource belongs to |
+-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+==============================================================+======================================================================================================================================================================================+
| name | String | Attachment name |
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | String | Attachment ID |
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Supplementary information |
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| state | String | Attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **pending_acceptance**, **rejected**, and **initiating_request** |
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of :ref:`Tag <updateattachment__response_tag>` objects | Enterprise router tags |
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID |
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| resource_id | String | Attached resource ID on its own service console |
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| resource_type | String | Attachment type. Value options are as follows: |
| | | |
| | | - **vpc**: VPC attachment |
| | | |
| | | - **vgw**: virtual gateway attachment |
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| resource_project_id | String | ID of the project that the resource belongs to |
+-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _updateattachment__response_tag:
@ -128,7 +128,7 @@ Response Parameters
Example Requests
----------------
Updating basic information about an attachment
Updating an attachment (not a VPC attachment)
.. code-block:: text

30
api-ref/source/apis/azs/querying_azs.rst
View File

@ -25,11 +25,15 @@ GET /v3/{project_id}/enterprise-router/availability-zones
.. table:: **Table 2** Query Parameters
=========== ========= ====== ====================
Parameter Mandatory Type Description
=========== ========= ====== ====================
instance_id No String Enterprise router ID
=========== ========= ====== ====================
+-----------------+-----------------+-----------------+---------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+===========================+
| instance_id | No | String | Enterprise router ID |
+-----------------+-----------------+-----------------+---------------------------+
| bandwidth_size | No | Integer | Bandwidth size, in Mbit/s |
| | | | |
| | | | Minimum: **-1** |
+-----------------+-----------------+-----------------+---------------------------+
Request Parameters
------------------
@ -46,7 +50,7 @@ Response Parameters
+--------------------+--------------------------------------------------------------------------------------+-------------+
| Parameter | Type | Description |
+====================+======================================================================================+=============+
| availability_zones | Array of :ref:`AvailableZone <listavailabilityzone__response_availablezone>` objects | AZs |
| availability_zones | Array of :ref:`AvailableZone <listavailabilityzone__response_availablezone>` objects | AZ list |
+--------------------+--------------------------------------------------------------------------------------+-------------+
| request_id | String | Request ID |
+--------------------+--------------------------------------------------------------------------------------+-------------+
@ -55,13 +59,13 @@ Response Parameters
.. table:: **Table 4** AvailableZone
+-----------+--------+-------------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+========+=========================================================================+
| code | String | AZ code |
+-----------+--------+-------------------------------------------------------------------------+
| state | String | Whether the AZ is available. The value can be available or unavailable. |
+-----------+--------+-------------------------------------------------------------------------+
+-----------+--------+-------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+========+===============================================================================+
| code | String | AZ code |
+-----------+--------+-------------------------------------------------------------------------------+
| state | String | Whether the AZ is available. Value options: **available** and **unavailable** |
+-----------+--------+-------------------------------------------------------------------------------+
Example Requests
----------------

156
api-ref/source/apis/enterprise_routers/creating_an_enterprise_router.rst
View File

File diff suppressed because it is too large Load Diff

74
api-ref/source/apis/enterprise_routers/querying_details_about_an_enterprise_router.rst
View File

@ -48,45 +48,41 @@ Response Parameters
.. table:: **Table 3** EnterpriseRouter
+------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+====================================+==================================================================+=======================================================================================================================================+
| id | String | Enterprise router ID |
+------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| name | String | Enterprise router name |
+------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Supplementary information about an enterprise router |
+------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| state | String | Running status |
+------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of :ref:`Tag <showenterpriserouter__response_tag>` objects | Tag information |
+------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| charge_mode | String | Billing mode: Pay-per-use |
| | | |
| | | Default: **postPaid** |
+------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | String | Enterprise project ID |
+------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID |
+------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| asn | Long | Enterprise router BGP ASN |
+------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| enable_default_propagation | Boolean | Whether to enable the Default Route Table Propagation function. The default value is false, indicating that the function is disabled. |
+------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| enable_default_association | Boolean | Whether to enable the Default Route Table Association function. The default value is false, indicating that the function is disabled. |
+------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| default_propagation_route_table_id | String | Default propagation route table ID |
+------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| default_association_route_table_id | String | Default association route table ID |
+------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| availability_zone_ids | Array of strings | AZs where the enterprise router is located |
+------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| auto_accept_shared_attachments | Boolean | Whether to automatically accept shared attachments. The default value is false, indicating that the function is disabled. |
+------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+====================================+==================================================================+===========================================================================================================================================+
| id | String | Enterprise router ID |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| name | String | Enterprise router name |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Supplementary information about an enterprise router |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| state | String | Enterprise router status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of :ref:`Tag <showenterpriserouter__response_tag>` objects | Tag information |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | String | Enterprise project ID |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| asn | Long | Enterprise router BGP ASN |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| enable_default_propagation | Boolean | Whether to enable the Default Route Table Propagation function. The default value is **false**, indicating that the function is disabled. |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| enable_default_association | Boolean | Whether to enable the Default Route Table Association function. The default value is **false**, indicating that the function is disabled. |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| default_propagation_route_table_id | String | Default propagation route table ID |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| default_association_route_table_id | String | Default association route table ID |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zone_ids | Array of strings | AZs where the enterprise router is located |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| auto_accept_shared_attachments | Boolean | Whether to automatically accept shared attachments. The default value is **false**, indicating that the function is disabled. |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
.. _showenterpriserouter__response_tag:

88
api-ref/source/apis/enterprise_routers/querying_enterprise_routers.rst
View File

File diff suppressed because it is too large Load Diff

126
api-ref/source/apis/enterprise_routers/updating_an_enterprise_router.rst
View File

File diff suppressed because it is too large Load Diff

78
api-ref/source/apis/flow_logs/creating_a_flow_log.rst
View File

@ -66,7 +66,9 @@ Request Parameters
| | | | |
| | | | Maximum: **255** |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+
| resource_type | Yes | String | Resource type. |
| resource_type | Yes | String | Type of resource whose flow logs are collected. |
| | | | |
| | | | - VPC attachment |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+
| resource_id | Yes | String | Resource ID |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+
@ -104,37 +106,37 @@ Response Parameters
.. table:: **Table 7** FlowLog
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==========================+=========+========================================================================================================================+
| id | String | Flow log ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| name | String | Flow log name |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| description | String | Flow log description |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID of the flow log task creator |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| resource_type | String | Resource type. The value is **attachment**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| resource_id | String | Resource ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_group_id | String | Log group ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_stream_id | String | Log stream ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_store_type | String | Flow log storage type |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Time when the flow log was created |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Time when the flow log was updated |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| state | String | Flow log status. The options are **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| enabled | Boolean | Whether to enable flow logs. The options are **true** and **false**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==========================+=========+======================================================================================================================+
| id | String | Flow log ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| name | String | Flow log name |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| description | String | Flow log description |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID of the flow log task creator |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| resource_type | String | Resource type. The value is **attachment**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| resource_id | String | Resource ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_group_id | String | Log group ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_stream_id | String | Log stream ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_store_type | String | Flow log storage type |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| state | String | Flow log status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| enabled | Boolean | Whether to enable flow logs. The value can be **true** or **false**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
Example Requests
----------------
@ -145,6 +147,18 @@ Creating a flow log
POST https://{erouter_endpoint}/v3/0605767a9980d5762fbcc00b3537e757/enterprise-router/a43c55e9-4911-4030-90e1-5c2bf6ae6fe2/flow-logs
{
"flow_log" : {
"name" : "flow-log",
"description" : "flow log test",
"resource_type" : "attachment",
"resource_id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
"log_group_id" : "0139393c-eeb2-49f0-bbd4-c5faec6b1497",
"log_stream_id" : "d22c3b44-2f71-470f-83f3-96a8af6956ad",
"log_store_type" : "LTS"
}
}
Example Responses
-----------------

62
api-ref/source/apis/flow_logs/disabling_flow_logs.rst
View File

@ -49,37 +49,37 @@ Response Parameters
.. table:: **Table 3** FlowLog
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==========================+=========+========================================================================================================================+
| id | String | Flow log ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| name | String | Flow log name |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| description | String | Flow log description |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID of the flow log task creator |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| resource_type | String | Resource type. The value is **attachment**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| resource_id | String | Resource ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_group_id | String | Log group ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_stream_id | String | Log stream ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_store_type | String | Flow log storage type |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Time when the flow log was created |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Time when the flow log was updated |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| state | String | Flow log status. The options are **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| enabled | Boolean | Whether to enable flow logs. The options are **true** and **false**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==========================+=========+======================================================================================================================+
| id | String | Flow log ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| name | String | Flow log name |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| description | String | Flow log description |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID of the flow log task creator |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| resource_type | String | Resource type. The value is **attachment**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| resource_id | String | Resource ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_group_id | String | Log group ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_stream_id | String | Log stream ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_store_type | String | Flow log storage type |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| state | String | Flow log status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| enabled | Boolean | Whether to enable flow logs. The value can be **true** or **false**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
Example Requests
----------------

62
api-ref/source/apis/flow_logs/enabling_flow_logs.rst
View File

@ -49,37 +49,37 @@ Response Parameters
.. table:: **Table 3** FlowLog
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==========================+=========+========================================================================================================================+
| id | String | Flow log ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| name | String | Flow log name |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| description | String | Flow log description |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID of the flow log task creator |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| resource_type | String | Resource type. The value is **attachment**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| resource_id | String | Resource ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_group_id | String | Log group ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_stream_id | String | Log stream ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_store_type | String | Flow log storage type |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Time when the flow log was created |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Time when the flow log was updated |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| state | String | Flow log status. The options are **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| enabled | Boolean | Whether to enable flow logs. The options are **true** and **false**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==========================+=========+======================================================================================================================+
| id | String | Flow log ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| name | String | Flow log name |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| description | String | Flow log description |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID of the flow log task creator |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| resource_type | String | Resource type. The value is **attachment**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| resource_id | String | Resource ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_group_id | String | Log group ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_stream_id | String | Log stream ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_store_type | String | Flow log storage type |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| state | String | Flow log status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| enabled | Boolean | Whether to enable flow logs. The value can be **true** or **false**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
Example Requests
----------------

4
api-ref/source/apis/flow_logs/index.rst
View File

@ -6,7 +6,7 @@ Flow Logs
=========
- :ref:`Creating a Flow Log <createflowlog>`
- :ref:`Querying the Flow Log List <listflowlogs>`
- :ref:`Querying Flow Logs <listflowlogs>`
- :ref:`Querying Details About a Flow Log <showflowlog>`
- :ref:`Updating a Flow Log <updateflowlog>`
- :ref:`Deleting a Flow Log <deleteflowlog>`
@ -18,7 +18,7 @@ Flow Logs
:hidden:
creating_a_flow_log
querying_the_flow_log_list
querying_flow_logs
querying_details_about_a_flow_log
updating_a_flow_log
deleting_a_flow_log

64
api-ref/source/apis/flow_logs/querying_details_about_a_flow_log.rst
View File

@ -49,42 +49,42 @@ Response Parameters
.. table:: **Table 3** FlowLog
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==========================+=========+========================================================================================================================+
| id | String | Flow log ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| name | String | Flow log name |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| description | String | Flow log description |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID of the flow log task creator |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| resource_type | String | Resource type. The value is **attachment**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| resource_id | String | Resource ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_group_id | String | Log group ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_stream_id | String | Log stream ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_store_type | String | Flow log storage type |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Time when the flow log was created |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Time when the flow log was updated |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| state | String | Flow log status. The options are **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| enabled | Boolean | Whether to enable flow logs. The options are **true** and **false**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==========================+=========+======================================================================================================================+
| id | String | Flow log ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| name | String | Flow log name |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| description | String | Flow log description |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID of the flow log task creator |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| resource_type | String | Resource type. The value is **attachment**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| resource_id | String | Resource ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_group_id | String | Log group ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_stream_id | String | Log stream ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_store_type | String | Flow log storage type |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| state | String | Flow log status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| enabled | Boolean | Whether to enable flow logs. The value can be **true** or **false**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
Example Requests
----------------
Querying the flow log list
Querying flow logs
.. code-block:: text

77
api-ref/source/apis/flow_logs/querying_the_flow_log_list.rst → api-ref/source/apis/flow_logs/querying_flow_logs.rst
View File

File diff suppressed because it is too large Load Diff

67
api-ref/source/apis/flow_logs/updating_a_flow_log.rst
View File

@ -63,37 +63,37 @@ Response Parameters
.. table:: **Table 4** FlowLog
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==========================+=========+========================================================================================================================+
| id | String | Flow log ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| name | String | Flow log name |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| description | String | Flow log description |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID of the flow log task creator |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| resource_type | String | Resource type. The value is **attachment**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| resource_id | String | Resource ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_group_id | String | Log group ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_stream_id | String | Log stream ID |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_store_type | String | Flow log storage type |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Time when the flow log was created |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Time when the flow log was updated |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| state | String | Flow log status. The options are **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
| enabled | Boolean | Whether to enable flow logs. The options are **true** and **false**. |
+--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==========================+=========+======================================================================================================================+
| id | String | Flow log ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| name | String | Flow log name |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| description | String | Flow log description |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID of the flow log task creator |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| resource_type | String | Resource type. The value is **attachment**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| resource_id | String | Resource ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_group_id | String | Log group ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_stream_id | String | Log stream ID |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_store_type | String | Flow log storage type |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| state | String | Flow log status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| enabled | Boolean | Whether to enable flow logs. The value can be **true** or **false**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
Example Requests
----------------
@ -104,6 +104,11 @@ Updating a flow log
PUT https://{erouter_endpoint}/v3/0605767a9980d5762fbcc00b3537e757/enterprise-router/6f83b848-8331-4271-ac0c-ef94b7686402/flow_logs/b216bc1d-5963-41a7-89f9-779a5128c5ac
{
"name" : "flow_log_update",
"description" : "flow log update test"
}
Example Responses
-----------------

2
api-ref/source/apis/index.rst
View File

@ -13,6 +13,7 @@ APIs
- :ref:`Propagations <propagation>`
- :ref:`Routes <route>`
- :ref:`Tags <tags>`
- :ref:`Quota Management <quotamanager>`
- :ref:`AZs <availablezone>`
- :ref:`Flow Logs <flowlog>`
@ -28,5 +29,6 @@ APIs
propagations/index
routes/index
tags/index
quota_management/index
azs/index
flow_logs/index

50
api-ref/source/apis/propagations/creating_a_route_propagation.rst
View File

@ -91,31 +91,31 @@ Response Parameters
.. table:: **Table 7** Propagation
+----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| Parameter | Type | Description |
+================+=================================================================================+=========================================================================+
| id | String | Unique association ID |
+----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| project_id | String | Project ID |
+----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| er_id | String | Enterprise router ID |
+----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| route_table_id | String | Unique ID of the route table |
+----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| attachment_id | String | Unique ID of the attachment |
+----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| resource_type | String | Attachment type |
+----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| resource_id | String | Unique ID of the attachment |
+----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| route_policy | :ref:`ImportRoutePolicy <enablepropagation__response_importroutepolicy>` object | Route that controls inbound traffic |
+----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| state | String | Status |
+----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| created_at | String | Time when the resource was created UTC time Format: YYYY-MM-DDTHH:MM:SS |
+----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| updated_at | String | Time when the resource was updated UTC time Format: 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 |
+----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+
| resource_id | String | Unique ID of the attachment |
+----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+
| route_policy | :ref:`ImportRoutePolicy <enablepropagation__response_importroutepolicy>` object | Route that controls inbound traffic |
+----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+
| state | String | Status |
+----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+
| created_at | String | Creation time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
+----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+
| updated_at | String | Update time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. |
+----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+
.. _enablepropagation__response_importroutepolicy:

82
api-ref/source/apis/propagations/querying_route_propagations.rst
View File

File diff suppressed because it is too large Load Diff

14
api-ref/source/apis/quota_management/index.rst Normal file
View File

@ -0,0 +1,14 @@
:original_name: QuotaManager.html
.. _QuotaManager:
Quota Management
================
- :ref:`Querying Quotas <showquotas>`
.. toctree::
:maxdepth: 1
:hidden:
querying_quotas

125
api-ref/source/apis/quota_management/querying_quotas.rst Normal file
View File

File diff suppressed because it is too large Load Diff

2
api-ref/source/apis/route_tables/deleting_a_route_table.rst
View File

@ -53,7 +53,7 @@ Status Codes
=========== ===========
Status Code Description
=========== ===========
202 No Content
202 Accepted
=========== ===========
Error Codes

16
api-ref/source/apis/route_tables/querying_route_tables.rst
View File

@ -13,7 +13,9 @@ This API is used to query route tables.
Constraints
-----------
Pagination query is supported. The supported query criteria are **state**, **is_default_propagation_route_table**, and **is_default_association_route_table**. Only sorting by a single field (**id**, **name**, **description**, **created_at**, or **updated_at**) is supported.
- Pagination query is supported. The supported query criteria are **state**, **is_default_propagation_route_table**, and **is_default_association_route_table**.
- Only sorting by a single field (**id**, **name**, **description**, **created_at**, or **updated_at**) is supported.
URI
---
@ -34,7 +36,7 @@ GET /v3/{project_id}/enterprise-router/{er_id}/route-tables
+------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============================+=================+=================+=====================================================================================================================================================================+
| limit | No | Integer | Number of records on each page. Value range: 0 to 2000 |
| limit | No | Integer | Number of records on each page. Value range: **0** to **2000** |
| | | | |
| | | | Minimum: **0** |
| | | | |
@ -48,13 +50,13 @@ GET /v3/{project_id}/enterprise-router/{er_id}/route-tables
+------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| state | No | Array | Status |
+------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| is_default_propagation_table | No | Boolean | Whether the route table is the default propagation route table. |
| is_default_propagation_table | No | Boolean | Whether the route table is the default propagation route table |
+------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| is_default_association_table | No | Boolean | Whether the route table is the default association route table. |
| is_default_association_table | No | Boolean | Whether the route table is the default association route table |
+------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| sort_key | No | Array | Sort by ID, name, or state. By default, ID is used. |
| sort_key | No | Array | Keyword for sorting. The keyword can be **id**, **name**, or **state**. By default, **id** is used. |
+------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| sort_dir | No | Array | Sorting order, including **asc** (ascending order) and **desc** (descending order). The default value is **asc**. |
| sort_dir | No | Array | Sorting order. There are two value options: **asc** (ascending order) and **desc** (descending order). The default value is **asc**. |
+------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters
@ -180,7 +182,7 @@ OK
} ]
} ],
"page_info" : {
"next_marker" : 1,
"next_marker" : "1",
"current_count" : 2
},
"request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"

2
api-ref/source/apis/route_tables/updating_route_table_information.rst
View File

@ -122,6 +122,8 @@ Response Parameters
Example Requests
----------------
Changing the name of a route table of an enterprise router to **new-rtb**
.. code-block:: text
PUT https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/915a14a6-867b-4af7-83d1-70efceb146f5/route-tables/4ab54142-7c92-48ad-8288-77727a231052

70
api-ref/source/apis/routes/creating_a_static_route.rst
View File

@ -97,47 +97,45 @@ Response Parameters
.. table:: **Table 7** Route
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
| Parameter | Type | Description |
+================+=======================================================================================+========================================+
| id | String | Route ID |
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
| type | String | Route type |
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
| state | String | Route status |
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
| is_blackhole | Boolean | Whether the route is a blackhole route |
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
| destination | String | Destination address of the route |
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
| attachments | Array of :ref:`RouteAttachment <createstaticroute__response_routeattachment>` objects | Next hops |
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
| route_table_id | String | Route table ID |
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
| created_at | String | Creation time |
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
| updated_at | String | Update time |
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+================+=======================================================================================+===================================================================================================================+
| id | String | Route ID |
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| type | String | Route type. The value is **static**. |
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| state | String | Route status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| is_blackhole | Boolean | Whether the route is a blackhole route |
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| destination | String | Destination address of the route |
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| attachments | Array of :ref:`RouteAttachment <createstaticroute__response_routeattachment>` objects | Next hops |
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| route_table_id | String | Route table ID |
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
.. _createstaticroute__response_routeattachment:
.. table:: **Table 8** RouteAttachment
+-----------------------+-----------------------+----------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+========================================+
| resource_id | String | Attached resource ID |
+-----------------------+-----------------------+----------------------------------------+
| resource_type | String | Attachment type: |
| | | |
| | | - **vpc**: VPC attachment |
| | | |
| | | - **vpn**: VPN gateway attachment |
| | | |
| | | - **vgw**: virtual gateway attachment |
+-----------------------+-----------------------+----------------------------------------+
| attachment_id | String | Attachment ID |
+-----------------------+-----------------------+----------------------------------------+
+-----------------------+-----------------------+------------------------------------------------+
| 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 |
+-----------------------+-----------------------+------------------------------------------------+
Example Requests
----------------

4
api-ref/source/apis/routes/index.rst
View File

@ -9,7 +9,7 @@ Routes
- :ref:`Updating a Static Route <updatestaticroute>`
- :ref:`Querying Details About a Static Route <showstaticroute>`
- :ref:`Querying Static Routes <liststaticroutes>`
- :ref:`Querying Valid Routes <listeffectiveroutes>`
- :ref:`Querying Effective Routes <listeffectiveroutes>`
- :ref:`Deleting a Static Route <deletestaticroute>`
.. toctree::
@ -20,5 +20,5 @@ Routes
updating_a_static_route
querying_details_about_a_static_route
querying_static_routes
querying_valid_routes
querying_effective_routes
deleting_a_static_route

70
api-ref/source/apis/routes/querying_details_about_a_static_route.rst
View File

@ -49,47 +49,45 @@ Response Parameters
.. table:: **Table 3** Route
+----------------+-------------------------------------------------------------------------------------+----------------------------------------+
| Parameter | Type | Description |
+================+=====================================================================================+========================================+
| id | String | Route ID |
+----------------+-------------------------------------------------------------------------------------+----------------------------------------+
| type | String | Route type |
+----------------+-------------------------------------------------------------------------------------+----------------------------------------+
| state | String | Route status |
+----------------+-------------------------------------------------------------------------------------+----------------------------------------+
| is_blackhole | Boolean | Whether the route is a blackhole route |
+----------------+-------------------------------------------------------------------------------------+----------------------------------------+
| destination | String | Destination address of the route |
+----------------+-------------------------------------------------------------------------------------+----------------------------------------+
| attachments | Array of :ref:`RouteAttachment <showstaticroute__response_routeattachment>` objects | Next hops |
+----------------+-------------------------------------------------------------------------------------+----------------------------------------+
| route_table_id | String | Route table ID |
+----------------+-------------------------------------------------------------------------------------+----------------------------------------+
| created_at | String | Creation time |
+----------------+-------------------------------------------------------------------------------------+----------------------------------------+
| updated_at | String | Update time |
+----------------+-------------------------------------------------------------------------------------+----------------------------------------+
+----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+================+=====================================================================================+===================================================================================================================+
| id | String | Route ID |
+----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| type | String | Route type. The value is **static**. |
+----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| state | String | Route status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
+----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| is_blackhole | Boolean | Whether the route is a blackhole route |
+----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| destination | String | Destination address of the route |
+----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| attachments | Array of :ref:`RouteAttachment <showstaticroute__response_routeattachment>` objects | Next hops |
+----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| route_table_id | String | Route table ID |
+----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
.. _showstaticroute__response_routeattachment:
.. table:: **Table 4** RouteAttachment
+-----------------------+-----------------------+----------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+========================================+
| resource_id | String | Attached resource ID |
+-----------------------+-----------------------+----------------------------------------+
| resource_type | String | Attachment type: |
| | | |
| | | - **vpc**: VPC attachment |
| | | |
| | | - **vpn**: VPN gateway attachment |
| | | |
| | | - **vgw**: virtual gateway attachment |
+-----------------------+-----------------------+----------------------------------------+
| attachment_id | String | Attachment ID |
+-----------------------+-----------------------+----------------------------------------+
+-----------------------+-----------------------+------------------------------------------------+
| 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 |
+-----------------------+-----------------------+------------------------------------------------+
Example Requests
----------------

117
api-ref/source/apis/routes/querying_valid_routes.rst → api-ref/source/apis/routes/querying_effective_routes.rst
View File

File diff suppressed because it is too large Load Diff

86
api-ref/source/apis/routes/querying_static_routes.rst
View File

File diff suppressed because it is too large Load Diff

70
api-ref/source/apis/routes/updating_a_static_route.rst
View File

@ -66,47 +66,45 @@ Response Parameters
.. table:: **Table 5** Route
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
| Parameter | Type | Description |
+================+=======================================================================================+========================================+
| id | String | Route ID |
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
| type | String | Route type |
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
| state | String | Route status |
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
| is_blackhole | Boolean | Whether the route is a blackhole route |
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
| destination | String | Destination address of the route |
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
| attachments | Array of :ref:`RouteAttachment <updatestaticroute__response_routeattachment>` objects | Next hops |
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
| route_table_id | String | Route table ID |
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
| created_at | String | Creation time |
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
| updated_at | String | Update time |
+----------------+---------------------------------------------------------------------------------------+----------------------------------------+
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+================+=======================================================================================+===================================================================================================================+
| id | String | Route ID |
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| type | String | Route type. The value is **static**. |
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| state | String | Route status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| is_blackhole | Boolean | Whether the route is a blackhole route |
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| destination | String | Destination address of the route |
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| attachments | Array of :ref:`RouteAttachment <updatestaticroute__response_routeattachment>` objects | Next hops |
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| route_table_id | String | Route table ID |
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
.. _updatestaticroute__response_routeattachment:
.. table:: **Table 6** RouteAttachment
+-----------------------+-----------------------+----------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+========================================+
| resource_id | String | Attached resource ID |
+-----------------------+-----------------------+----------------------------------------+
| resource_type | String | Attachment type: |
| | | |
| | | - **vpc**: VPC attachment |
| | | |
| | | - **vpn**: VPN gateway attachment |
| | | |
| | | - **vgw**: virtual gateway attachment |
+-----------------------+-----------------------+----------------------------------------+
| attachment_id | String | Attachment ID |
+-----------------------+-----------------------+----------------------------------------+
+-----------------------+-----------------------+------------------------------------------------+
| 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 |
+-----------------------+-----------------------+------------------------------------------------+
Example Requests
----------------

38
api-ref/source/apis/tags/creating_resource_tags.rst
View File

@ -26,25 +26,25 @@ POST /v3/{project_id}/{resource_type}/{resource_id}/tags
.. table:: **Table 1** Path Parameters
+-----------------+-----------------+-----------------+-----------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+===============================================+
| project_id | Yes | String | Project ID |
+-----------------+-----------------+-----------------+-----------------------------------------------+
| resource_id | Yes | String | Resource ID |
+-----------------+-----------------+-----------------+-----------------------------------------------+
| resource_type | Yes | String | - instance: Enterprise router |
| | | | |
| | | | - route-table: Route table |
| | | | |
| | | | - vpc-attachment: VPC attachment |
| | | | |
| | | | - vgw-attachment: Virtual gateway attachment |
| | | | |
| | | | - vpn-attachment: VPN gateway attachment |
| | | | |
| | | | - attachments: All attachment types |
+-----------------+-----------------+-----------------+-----------------------------------------------+
+-----------------+-----------------+-----------------+---------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+===================================================+
| project_id | Yes | String | Project ID |
+-----------------+-----------------+-----------------+---------------------------------------------------+
| resource_id | Yes | String | Resource ID |
+-----------------+-----------------+-----------------+---------------------------------------------------+
| resource_type | Yes | String | Resource type. Value options: |
| | | | |
| | | | - **instance**: enterprise router |
| | | | |
| | | | - **route-table**: route table |
| | | | |
| | | | - **vpc-attachment**: VPC attachment |
| | | | |
| | | | - **vgw-attachment**: virtual gateway attachment |
| | | | |
| | | | - **attachments**: all attachment types |
+-----------------+-----------------+-----------------+---------------------------------------------------+
Request Parameters
------------------

42
api-ref/source/apis/tags/deleting_resource_tags.rst
View File

@ -22,27 +22,27 @@ DELETE /v3/{project_id}/{resource_type}/{resource_id}/tags/{key}
.. table:: **Table 1** Path Parameters
+-----------------+-----------------+-----------------+-----------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+===============================================+
| key | Yes | String | Tag key |
+-----------------+-----------------+-----------------+-----------------------------------------------+
| project_id | Yes | String | Project ID |
+-----------------+-----------------+-----------------+-----------------------------------------------+
| resource_id | Yes | String | Resource ID |
+-----------------+-----------------+-----------------+-----------------------------------------------+
| resource_type | Yes | String | - instance: Enterprise router |
| | | | |
| | | | - route-table: Route table |
| | | | |
| | | | - vpc-attachment: VPC attachment |
| | | | |
| | | | - vgw-attachment: Virtual gateway attachment |
| | | | |
| | | | - vpn-attachment: VPN gateway attachment |
| | | | |
| | | | - attachments: All attachment types |
+-----------------+-----------------+-----------------+-----------------------------------------------+
+-----------------+-----------------+-----------------+---------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+===================================================+
| key | Yes | String | Tag key |
+-----------------+-----------------+-----------------+---------------------------------------------------+
| project_id | Yes | String | Project ID |
+-----------------+-----------------+-----------------+---------------------------------------------------+
| resource_id | Yes | String | Resource ID |
+-----------------+-----------------+-----------------+---------------------------------------------------+
| resource_type | Yes | String | Resource type. Value options: |
| | | | |
| | | | - **instance**: enterprise router |
| | | | |
| | | | - **route-table**: route table |
| | | | |
| | | | - **vpc-attachment**: VPC attachment |
| | | | |
| | | | - **vgw-attachment**: virtual gateway attachment |
| | | | |
| | | | - **attachments**: all attachment types |
+-----------------+-----------------+-----------------+---------------------------------------------------+
Request Parameters
------------------

34
api-ref/source/apis/tags/querying_project_tags.rst
View File

@ -17,23 +17,23 @@ GET /v3/{project_id}/{resource_type}/tags
.. table:: **Table 1** Path Parameters
+-----------------+-----------------+-----------------+-----------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+===============================================+
| project_id | Yes | String | Project ID |
+-----------------+-----------------+-----------------+-----------------------------------------------+
| resource_type | Yes | String | - instance: Enterprise router |
| | | | |
| | | | - route-table: Route table |
| | | | |
| | | | - vpc-attachment: VPC attachment |
| | | | |
| | | | - vgw-attachment: Virtual gateway attachment |
| | | | |
| | | | - vpn-attachment: VPN gateway attachment |
| | | | |
| | | | - attachments: All attachment types |
+-----------------+-----------------+-----------------+-----------------------------------------------+
+-----------------+-----------------+-----------------+---------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+===================================================+
| project_id | Yes | String | Project ID |
+-----------------+-----------------+-----------------+---------------------------------------------------+
| resource_type | Yes | String | Resource type. Value options: |
| | | | |
| | | | - **instance**: enterprise router |
| | | | |
| | | | - **route-table**: route table |
| | | | |
| | | | - **vpc-attachment**: VPC attachment |
| | | | |
| | | | - **vgw-attachment**: virtual gateway attachment |
| | | | |
| | | | - **attachments**: all attachment types |
+-----------------+-----------------+-----------------+---------------------------------------------------+
Request Parameters
------------------

38
api-ref/source/apis/tags/querying_resource_tags.rst
View File

@ -17,25 +17,25 @@ GET /v3/{project_id}/{resource_type}/{resource_id}/tags
.. table:: **Table 1** Path Parameters
+-----------------+-----------------+-----------------+-----------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+===============================================+
| project_id | Yes | String | Project ID |
+-----------------+-----------------+-----------------+-----------------------------------------------+
| resource_id | Yes | String | Resource ID |
+-----------------+-----------------+-----------------+-----------------------------------------------+
| resource_type | Yes | String | - instance: Enterprise router |
| | | | |
| | | | - route-table: Route table |
| | | | |
| | | | - vpc-attachment: VPC attachment |
| | | | |
| | | | - vgw-attachment: Virtual gateway attachment |
| | | | |
| | | | - vpn-attachment: VPN gateway attachment |
| | | | |
| | | | - attachments: All attachment types |
+-----------------+-----------------+-----------------+-----------------------------------------------+
+-----------------+-----------------+-----------------+---------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+===================================================+
| project_id | Yes | String | Project ID |
+-----------------+-----------------+-----------------+---------------------------------------------------+
| resource_id | Yes | String | Resource ID |
+-----------------+-----------------+-----------------+---------------------------------------------------+
| resource_type | Yes | String | Resource type. Value options: |
| | | | |
| | | | - **instance**: enterprise router |
| | | | |
| | | | - **route-table**: route table |
| | | | |
| | | | - **vpc-attachment**: VPC attachment |
| | | | |
| | | | - **vgw-attachment**: virtual gateway attachment |
| | | | |
| | | | - **attachments**: all attachment types |
+-----------------+-----------------+-----------------+---------------------------------------------------+
Request Parameters
------------------

64
api-ref/source/apis/vpc_attachments/creating_a_vpc_attachment.rst
View File

@ -124,35 +124,35 @@ Response Parameters
.. table:: **Table 8** VpcAttachmentDetails
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+========================+=================================================================+====================================================================================================================================================================================================================================================+
| id | String | VPC attachment ID |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name | String | VPC attachment name |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_id | String | VPC id |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virsubnet_id | String | VPC subnet ID |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| auto_create_vpc_routes | Boolean | The default value is false. If this parameter is set to true, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC. |
| | | |
| | | Default: **false** |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| state | String | VPC attachment status: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **initiating_request**, **rejected**, and **pending_acceptance** |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of :ref:`Tag <createvpcattachment__response_tag>` objects | Tag information |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Supplementary information about the VPC attachment |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_project_id | String | ID of the project that the VPC belongs to |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+========================+=================================================================+============================================================================================================================================================================================================================================================+
| id | String | VPC attachment ID |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name | String | VPC attachment name |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_id | String | VPC id |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virsubnet_id | String | VPC subnet ID |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| auto_create_vpc_routes | Boolean | The default value is **false**. If this parameter is set to **true**, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC. |
| | | |
| | | Default: **false** |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| state | String | VPC attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **initiating_request**, **rejected**, and **pending_acceptance** |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of :ref:`Tag <createvpcattachment__response_tag>` objects | Tag information |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Supplementary information about the VPC attachment |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_project_id | String | ID of the project that the VPC belongs to |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _createvpcattachment__response_tag:
@ -177,7 +177,7 @@ Response Parameters
Example Requests
----------------
Creating a VPC attachment
Creating a VPC attachment named **vpc-atta**
.. code-block:: text
@ -187,7 +187,7 @@ Creating a VPC attachment
"vpc_attachment" : {
"name" : "vpc-atta",
"vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
"virsubnet_id" : "0605767a9980d5762fbcc00b3537e757"
"virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8"
}
}
@ -205,7 +205,7 @@ Accepted
"id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
"name" : "vpc-atta",
"vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
"virsubnet_id" : "0605767a9980d5762fbcc00b3537e757",
"virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8",
"project_id" : "08d5a9564a704afda6039ae2babbef3c",
"state" : "pending",
"auto_create_vpc_routes" : false,

60
api-ref/source/apis/vpc_attachments/querying_details_about_a_vpc_attachment.rst
View File

@ -49,35 +49,35 @@ Response Parameters
.. table:: **Table 3** VpcAttachmentDetails
+------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+========================+===============================================================+====================================================================================================================================================================================================================================================+
| id | String | VPC attachment ID |
+------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name | String | VPC attachment name |
+------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_id | String | VPC id |
+------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virsubnet_id | String | VPC subnet ID |
+------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| auto_create_vpc_routes | Boolean | The default value is false. If this parameter is set to true, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC. |
| | | |
| | | Default: **false** |
+------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| state | String | VPC attachment status: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **initiating_request**, **rejected**, and **pending_acceptance** |
+------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of :ref:`Tag <showvpcattachment__response_tag>` objects | Tag information |
+------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Supplementary information about the VPC attachment |
+------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID |
+------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_project_id | String | ID of the project that the VPC belongs to |
+------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+========================+===============================================================+============================================================================================================================================================================================================================================================+
| id | String | VPC attachment ID |
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name | String | VPC attachment name |
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_id | String | VPC id |
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virsubnet_id | String | VPC subnet ID |
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| auto_create_vpc_routes | Boolean | The default value is **false**. If this parameter is set to **true**, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC. |
| | | |
| | | Default: **false** |
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| state | String | VPC attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **initiating_request**, **rejected**, and **pending_acceptance** |
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of :ref:`Tag <showvpcattachment__response_tag>` objects | Tag information |
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Supplementary information about the VPC attachment |
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID |
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_project_id | String | ID of the project that the VPC belongs to |
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _showvpcattachment__response_tag:
@ -122,7 +122,7 @@ OK
"id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8",
"name" : "vpc-attach",
"vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
"virsubnet_id" : "0605767a9980d5762fbcc00b3537e757",
"virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8",
"project_id" : "08d5a9564a704afda6039ae2babbef3c",
"state" : "available",
"created_at" : "2020-03-11T15:13:31Z",

112
api-ref/source/apis/vpc_attachments/querying_vpc_attachments.rst
View File

File diff suppressed because it is too large Load Diff

62
api-ref/source/apis/vpc_attachments/updating_a_vpc_attachment.rst
View File

@ -75,35 +75,35 @@ Response Parameters
.. table:: **Table 5** VpcAttachmentDetails
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+========================+=================================================================+====================================================================================================================================================================================================================================================+
| id | String | VPC attachment ID |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name | String | VPC attachment name |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_id | String | VPC id |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virsubnet_id | String | VPC subnet ID |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| auto_create_vpc_routes | Boolean | The default value is false. If this parameter is set to true, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC. |
| | | |
| | | Default: **false** |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| state | String | VPC attachment status: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **initiating_request**, **rejected**, and **pending_acceptance** |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of :ref:`Tag <updatevpcattachment__response_tag>` objects | Tag information |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Supplementary information about the VPC attachment |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_project_id | String | ID of the project that the VPC belongs to |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+========================+=================================================================+============================================================================================================================================================================================================================================================+
| id | String | VPC attachment ID |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name | String | VPC attachment name |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_id | String | VPC id |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virsubnet_id | String | VPC subnet ID |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| auto_create_vpc_routes | Boolean | The default value is **false**. If this parameter is set to **true**, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC. |
| | | |
| | | Default: **false** |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| state | String | VPC attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **initiating_request**, **rejected**, and **pending_acceptance** |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of :ref:`Tag <updatevpcattachment__response_tag>` objects | Tag information |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Supplementary information about the VPC attachment |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Project ID |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_project_id | String | ID of the project that the VPC belongs to |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _updatevpcattachment__response_tag:
@ -128,7 +128,7 @@ Response Parameters
Example Requests
----------------
Updating basic information about a VPC attachment
Updating a VPC attachment (changing its name to **new-vpc-attach**)
.. code-block:: text
@ -154,7 +154,7 @@ OK
"id" : "3b9724e9-49ec-4d21-9191-3d703133b910",
"name" : "new-vpc-attach",
"vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
"virsubnet_id" : "0605767a9980d5762fbcc00b3537e757",
"virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8",
"auto_create_vpc_routes" : false,
"project_id" : "08d5a9564a704afda6039ae2babbef3c",
"state" : "available",

10
api-ref/source/error_codes.rst → api-ref/source/appendixes/error_codes.rst
View File

@ -34,8 +34,6 @@ Error Codes
+-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| 400 | ER.04004102 | Failed to add the route to the VPC route table. | Failed to add the route to the VPC route table. | Check whether a route with the same destination already exists in the VPC route table. |
+-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| 400 | ER.04004106 | Invalid attachment for data transmission. | Invalid attachment for data transmission. | Check the transport_attachment_id attribute. |
+-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| 400 | ER.04005003 | This route table is unavailable or is being operated. | This route table is unavailable or is being operated. | Check whether the route table is available and try again. |
+-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| 400 | ER.04006002 | The destination of the route already exists. | The destination of the route already exists. | Check the destination in the route. |
@ -48,6 +46,14 @@ Error Codes
+-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| 400 | ER.04006106 | A blackhole route cannot have a next hop. A non-blackhole route must have a next hop. | Invalid route. | Check the route. |
+-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| 400 | ER.04008500 | Flow logs are not supported by the resource type. | Flow logs are not supported by the resource type. | Check the resource type. |
+-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| 400 | ER.04008501 | The flow log task does not exist. | The flow log task does not exist. | Check the flow log ID. |
+-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| 400 | ER.04008502 | The flow log task is being operated. | The flow log task is being operated. | Check the flow log task status and try again later. |
+-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| 400 | ER.04008503 | The flow log task already exists. | The flow log task already exists. | Check the flow log task. |
+-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| 400 | ER.04009005 | Invalid parameters. | Invalid parameters. | Check the parameters. |
+-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| 400 | ER.04009008 | Insufficient quota. | Insufficient quota. | Submit a service ticket to apply for quota increase. |

16
api-ref/source/appendixes/index.rst Normal file
View File

@ -0,0 +1,16 @@
:original_name: er_02_appendix.html
.. _er_02_appendix:
Appendixes
==========
- :ref:`Status Codes <statecode>`
- :ref:`Error Codes <errorcode>`
.. toctree::
:maxdepth: 1
:hidden:
status_codes
error_codes

26
api-ref/source/status_codes.rst → api-ref/source/appendixes/status_codes.rst
View File

@ -7,19 +7,19 @@ Status Codes
.. table:: **Table 1** Normal status codes
+-----------------------+-----------------------+---------------------------------------------------------------------------+
| Status Code | Message | Description |
+=======================+=======================+===========================================================================+
| 200 | OK | Normal response code for the GET, PUT, and POST operations |
+-----------------------+-----------------------+---------------------------------------------------------------------------+
| 201 | Created | Normal response code for the POST operations of the OpenStack Neutron API |
+-----------------------+-----------------------+---------------------------------------------------------------------------+
| 202 | Accepted | Operations that take a long time to process. |
| | | |
| | | The request has been accepted but the processing is not complete. |
+-----------------------+-----------------------+---------------------------------------------------------------------------+
| 204 | No Content | Normal response code for DELETE operations |
+-----------------------+-----------------------+---------------------------------------------------------------------------+
+-----------------------+-----------------------+-------------------------------------------------------------------+
| Status Code | Message | Description |
+=======================+=======================+===================================================================+
| 200 | OK | Normal response code for the GET, PUT, and POST operations |
+-----------------------+-----------------------+-------------------------------------------------------------------+
| 201 | Created | Normal response code for POST operations |
+-----------------------+-----------------------+-------------------------------------------------------------------+
| 202 | Accepted | Operations that take a long time to process. |
| | | |
| | | The request has been accepted but the processing is not complete. |
+-----------------------+-----------------------+-------------------------------------------------------------------+
| 204 | No Content | Normal response code for DELETE operations |
+-----------------------+-----------------------+-------------------------------------------------------------------+
.. table:: **Table 2** Abnormal status codes

17
api-ref/source/change_history.rst
View File

@ -5,8 +5,15 @@
Change History
==============
=========== =========================================
Released On Description
=========== =========================================
2023-04-07 This issue is the first official release.
=========== =========================================
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Released On | Description |
+===================================+================================================================================================================================================================================+
| 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". |
| | - Modified the example response in "Querying VPC Attachments". |
| | - Modified the description of the **type** parameter in "Creating a Static Route". |
| | - Modified the description of the **route_type** parameter in "Querying Effective Routes". |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2023-04-07 | This issue is the first official release. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

4
api-ref/source/index.rst
View File

@ -7,7 +7,5 @@ Enterprise Router - API Reference
api_usage_guidelines
apis/index
permissions_policies_and_supported_actions/index
status_codes
error_codes
appendixes/index
change_history

16
api-ref/source/permissions_policies_and_supported_actions/association.rst
View File

@ -1,16 +0,0 @@
:original_name: er_02_0021.html
.. _er_02_0021:
Association
===========
+-------------------------------+--------------------------------------------------------------------------------------------+------------------------------+-------------+--------------------+
| Permission | API | Action | IAM Project | Enterprise Project |
+===============================+============================================================================================+==============================+=============+====================+
| Creating an association | POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/associate | er:associations:associate | Y | Y |
+-------------------------------+--------------------------------------------------------------------------------------------+------------------------------+-------------+--------------------+
| Querying the association list | GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/associations | er:associations:list | Y | Y |
+-------------------------------+--------------------------------------------------------------------------------------------+------------------------------+-------------+--------------------+
| Deleting an association | POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/disassociate | er:associations:disassociate | Y | Y |
+-------------------------------+--------------------------------------------------------------------------------------------+------------------------------+-------------+--------------------+

22
api-ref/source/permissions_policies_and_supported_actions/enterprise_router.rst
View File

@ -1,22 +0,0 @@
:original_name: er_02_0017.html
.. _er_02_0017:
Enterprise Router
=================
+---------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+-------------+--------------------+
| Permission | API | Action | IAM Project | Enterprise Project |
+=============================================+=======================================================================================================+=======================+=============+====================+
| Creating an enterprise router | POST /v3/{project_id}/enterprise-router/instances | er:instances:create | Y | Y |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+-------------+--------------------+
| Updating an enterprise router | PUT /v3/{project_id}/enterprise-router/instances/{enterprise_router_id} | er:instances:update | Y | Y |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+-------------+--------------------+
| Querying details about an enterprise router | GET /v3/{project_id}/enterprise-router/instances/{enterprise_router_id} | er:instances:get | Y | Y |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+-------------+--------------------+
| Querying the enterprise router list | GET /v3/{project_id}/enterprise-router/instances | er:instances:list | Y | Y |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+-------------+--------------------+
| Changing the AZs of an enterprise router | POST /v3/{project_id}/enterprise-router/instances/{enterprise_router_id}/change-availability-zone-ids | er:instances:changeAZ | Y | Y |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+-------------+--------------------+
| Deleting an enterprise router | DELETE /v3/{project_id}/enterprise-router/instances/{enterprise_router_id} | er:instances:delete | Y | Y |
+---------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+-------------+--------------------+

28
api-ref/source/permissions_policies_and_supported_actions/index.rst
View File

@ -1,28 +0,0 @@
:original_name: er_02_0015.html
.. _er_02_0015:
Permissions Policies and Supported Actions
==========================================
- :ref:`Introduction <er_02_0016>`
- :ref:`Enterprise Router <er_02_0017>`
- :ref:`VPC Attachment <er_02_0018>`
- :ref:`Other Type of Attachments <er_02_0019>`
- :ref:`Route Table <er_02_0020>`
- :ref:`Association <er_02_0021>`
- :ref:`Propagation <er_02_0022>`
- :ref:`Route <er_02_0023>`
.. toctree::
:maxdepth: 1
:hidden:
introduction
enterprise_router
vpc_attachment
other_type_of_attachments
route_table
association
propagation
route

39
api-ref/source/permissions_policies_and_supported_actions/introduction.rst
View File

@ -1,39 +0,0 @@
:original_name: er_02_0016.html
.. _er_02_0016:
Introduction
============
This section describes fine-grained permissions management for your Enterprise Router resources. If your account does not need individual IAM users, you may skip this section.
By default, new IAM users do not have any permissions assigned. You need to add a user to one or more groups, and assign policies or roles to these groups. The user then inherits permissions from the groups. After authorization, the user can perform specified operations on cloud services based on the permissions.
You can grant users permissions by using and . Roles: A type of coarse-grained authorization mechanism that defines service-level permissions based on user responsibilities. There are only a limited number of roles for granting permissions to users. Policies: A type of fine-grained authorization mechanism that defines permissions required to perform operations on specific cloud resources under certain conditions. This mechanism allows for more flexible policy-based authorization and secure access control.
.. note::
Policy-based authorization is useful if you want to allow or deny the access to an API.
An account has all of the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions can call the API successfully. For example, if an IAM user wants to query ECSs using an API, the user must have been granted permissions that allow the **ecs:servers:list** action.
Supported Actions
-----------------
IAM provides system-defined policies that can be directly used. You can also create custom policies to work with system-defined policies for more refined access control. Actions supported by policies are specific to APIs. Common concepts related to policies include:
- Permissions: allow or deny operations on specified resources under specific conditions.
- APIs: REST APIs that can be called by a user who has been granted specific permissions
- Actions: specific operations that are allowed or denied
- Related actions: actions on which a specific action depends. When assigning permissions for the action to a user, you also need to assign permissions for the dependent actions.
- IAM projects or enterprise projects: type of projects for which an action will take effect. For example, if you set the authorization scope of a custom policy to both IAM projects and enterprise projects, the policy takes effect for user groups in either IAM or enterprise projects. If the authorization scope is set to IAM projects only, the custom policy will take effect only for user groups in IAM projects. Administrators can check whether an action supports IAM projects or enterprise projects in the action list. "Y" indicates that the action supports the project and "x" indicates that the action does not support the project.
Enterprise Router supports the following actions that can be defined in custom policies:
- :ref:`Enterprise Router <er_02_0017>`
- :ref:`VPC Attachment <er_02_0018>`
- :ref:`Other Type of Attachments <er_02_0019>`
- :ref:`Route Table <er_02_0020>`
- :ref:`Association <er_02_0021>`
- :ref:`Propagation <er_02_0022>`
- :ref:`Route <er_02_0023>`

16
api-ref/source/permissions_policies_and_supported_actions/other_type_of_attachments.rst
View File

@ -1,16 +0,0 @@
:original_name: er_02_0019.html
.. _er_02_0019:
Other Type of Attachments
=========================
+--------------------------------------+----------------------------------------------------------------------------+-----------------------+-------------+--------------------+
| Permission | API | Action | IAM Project | Enterprise Project |
+======================================+============================================================================+=======================+=============+====================+
| Updating an attachment | PUT /v3/{project_id}/enterprise-router/{er_id}/attachments/{attachment_id} | er:attachments:update | Y | Y |
+--------------------------------------+----------------------------------------------------------------------------+-----------------------+-------------+--------------------+
| Querying details about an attachment | GET /v3/{project_id}/enterprise-router/{er_id}/attachments/{attachment_id} | er:attachments:get | Y | Y |
+--------------------------------------+----------------------------------------------------------------------------+-----------------------+-------------+--------------------+
| Querying the attachment list | GET /v3/{project_id}/enterprise-router/{er_id}/attachments | er:attachments:list | Y | Y |
+--------------------------------------+----------------------------------------------------------------------------+-----------------------+-------------+--------------------+

16
api-ref/source/permissions_policies_and_supported_actions/propagation.rst
View File

@ -1,16 +0,0 @@
:original_name: er_02_0022.html
.. _er_02_0022:
Propagation
===========
+-------------------------------+----------------------------------------------------------------------------------------------------+-------------------------+-------------+--------------------+
| Permission | API | Action | IAM Project | Enterprise Project |
+===============================+====================================================================================================+=========================+=============+====================+
| Creating a propagation | POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/enable-propagations | er:propagations:enable | Y | Y |
+-------------------------------+----------------------------------------------------------------------------------------------------+-------------------------+-------------+--------------------+
| Querying the propagation list | GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/propagations | er:propagations:list | Y | Y |
+-------------------------------+----------------------------------------------------------------------------------------------------+-------------------------+-------------+--------------------+
| Deleting a propagation | POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/disable-propagations | er:propagations:disable | Y | Y |
+-------------------------------+----------------------------------------------------------------------------------------------------+-------------------------+-------------+--------------------+

Some files were not shown because too many files have changed in this diff Show More