Update content

This commit is contained in:
OpenTelekomCloud Proposal Bot 2023-11-20 03:29:55 +00:00 committed by lhajba
parent 5d115f17b5
commit 19696e40a6
45 changed files with 858 additions and 392 deletions

View File

@ -30,29 +30,29 @@ Request Parameters
.. table:: **Table 2** Request body parameters
+-----------------+-----------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
+-----------------+-----------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=====================================================================================+==================================================================================+
+=================+=================+=====================================================================================+===========================================================================================================================+
| attachment_id | No | String | Unique ID of the attachment |
| | | | |
| | | | Maximum: **36** |
+-----------------+-----------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
| route_policy | No | :ref:`ExportRoutePolicy <disassociateroutetable__request_exportroutepolicy>` object | Route that controls outbound traffic. Note that this is not currently supported. |
+-----------------+-----------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+
+-----------------+-----------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| route_policy | No | :ref:`ExportRoutePolicy <disassociateroutetable__request_exportroutepolicy>` object | Route that controls outbound traffic. Note that this is not currently supported. This parameter is not supported for now. |
+-----------------+-----------------+-------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
.. _disassociateroutetable__request_exportroutepolicy:
.. table:: **Table 3** ExportRoutePolicy
+------------------+-----------------+-----------------+-------------------------------------------------------+
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==================+=================+=================+=======================================================+
| export_policy_id | No | String | ID of the route policy that controls outbound traffic |
+==================+=================+=================+=================================================================================================+
| export_policy_id | No | String | ID of the route policy that controls outbound traffic. This parameter is not supported for now. |
| | | | |
| | | | Minimum: **0** |
| | | | |
| | | | Maximum: **36** |
+------------------+-----------------+-----------------+-------------------------------------------------------+
+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------+
Response Parameters
-------------------

View File

@ -90,51 +90,51 @@ Response Parameters
.. table:: **Table 4** Association
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+================================================================================+=============================================================================================================+
+=======================+================================================================================+===========================================================================================================================+
| id | String | Unique association ID |
| | | |
| | | Maximum: **36** |
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| route_table_id | String | Unique ID of the route table |
| | | |
| | | Maximum: **36** |
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| attachment_id | String | Unique ID of the attachment |
| | | |
| | | Maximum: **36** |
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| resource_type | String | Attachment type. |
| | | |
| | | - **vpc**: VPC attachments |
| | | |
| | | - **vgw**: virtual gateway attachments |
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| resource_id | String | Unique ID of the attachment |
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| state | String | Status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ. |
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Update time. It is UTC time in the format of YYYY-MM-DDTHH:mm:ss.sssZ. |
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| route_policy | :ref:`ExportRoutePolicy <listassociations__response_exportroutepolicy>` object | Route that controls outbound traffic. Note that this is not currently supported. |
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| route_policy | :ref:`ExportRoutePolicy <listassociations__response_exportroutepolicy>` object | Route that controls outbound traffic. Note that this is not currently supported. This parameter is not supported for now. |
+-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
.. _listassociations__response_exportroutepolicy:
.. table:: **Table 5** ExportRoutePolicy
+-----------------------+-----------------------+-------------------------------------------------------+
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+=======================================================+
| export_policy_id | String | ID of the route policy that controls outbound traffic |
+=======================+=======================+=================================================================================================+
| export_policy_id | String | ID of the route policy that controls outbound traffic. This parameter is not supported for now. |
| | | |
| | | Minimum: **0** |
| | | |
| | | Maximum: **36** |
+-----------------------+-----------------------+-------------------------------------------------------+
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------+
.. _listassociations__response_pageinfo:

View File

@ -69,9 +69,7 @@ Request Parameters
+--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | No | String | Enterprise project ID |
+--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| charge_mode | No | String | Billing mode: Pay-per-use Billing mode: Pay-per-use |
| | | | |
| | | | Default: **postPaid** |
| charge_mode | No | String | Default: **postPaid** |
+--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| tags | No | Array of :ref:`Tag <createenterpriserouter__request_tag>` objects | Tag information |
+--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
@ -83,7 +81,7 @@ Request Parameters
| | | | |
| | | | Default: **false** |
+--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zone_ids | Yes | Array of strings | AZs where the enterprise router is located |
| availability_zone_ids | Yes | Array of Strings | AZs where the enterprise router is located |
| | | | |
| | | | Minimum: **0** |
| | | | |
@ -93,6 +91,14 @@ Request Parameters
| | | | |
| | | | Default: **false** |
+--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| cidr_blocks | No | Array of Strings | Enterprise router CIDR block. This parameter is not supported for now. |
| | | | |
| | | | Minimum: **1** |
| | | | |
| | | | Maximum: **64** |
| | | | |
| | | | Array Length: **0 - 100** |
+--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
.. _createenterpriserouter__request_tag:
@ -154,9 +160,7 @@ Response Parameters
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of :ref:`Tag <createenterpriserouter__response_tag>` objects | Tag information |
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| charge_mode | String | Billing mode: pay-per-use |
| | | |
| | | Default: **postPaid** |
| charge_mode | String | Default: **postPaid** |
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ |
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
@ -176,10 +180,12 @@ Response Parameters
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| default_association_route_table_id | String | Default association route table ID |
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zone_ids | Array of strings | AZs where the enterprise router is located |
| 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. |
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| cidr_blocks | Array of Strings | Enterprise router CIDR block. This parameter is not supported for now. |
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
.. _createenterpriserouter__response_tag:

View File

@ -61,9 +61,7 @@ Response Parameters
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of :ref:`Tag <showenterpriserouter__response_tag>` objects | Tag information |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| charge_mode | String | Billing mode: pay-per-use |
| | | |
| | | Default: **postPaid** |
| charge_mode | String | Default: **postPaid** |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
@ -83,10 +81,12 @@ Response Parameters
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| default_association_route_table_id | String | Default association route table ID |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zone_ids | Array of strings | AZs where the enterprise router is located |
| 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. |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| cidr_blocks | Array of Strings | Enterprise router CIDR block. This parameter is not supported for now. |
+------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
.. _showenterpriserouter__response_tag:

View File

@ -97,9 +97,7 @@ Response Parameters
+------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of :ref:`Tag <listenterpriserouters__response_tag>` objects | Tag information |
+------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| charge_mode | String | Billing mode: pay-per-use |
| | | |
| | | Default: **postPaid** |
| charge_mode | String | Default: **postPaid** |
+------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ |
+------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
@ -119,10 +117,12 @@ Response Parameters
+------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| default_association_route_table_id | String | Default association route table ID |
+------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zone_ids | Array of strings | AZs where the enterprise router is located |
| 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. |
+------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| cidr_blocks | Array of Strings | Enterprise router CIDR block. This parameter is not supported for now. |
+------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
.. _listenterpriserouters__response_tag:

View File

@ -102,9 +102,7 @@ Response Parameters
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of :ref:`Tag <updateenterpriserouter__response_tag>` objects | Tag information |
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| charge_mode | String | Billing mode: pay-per-use |
| | | |
| | | Default: **postPaid** |
| charge_mode | String | Default: **postPaid** |
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ |
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
@ -124,10 +122,12 @@ Response Parameters
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| default_association_route_table_id | String | Default association route table ID |
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zone_ids | Array of strings | AZs where the enterprise router is located |
| 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. |
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| cidr_blocks | Array of Strings | Enterprise router CIDR block. This parameter is not supported for now. |
+------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
.. _updateenterpriserouter__response_tag:

View File

@ -51,37 +51,43 @@ Request Parameters
.. table:: **Table 4** FlowLogRequest
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+============================================================================================+
+=================+=================+=================+================================================================================================================================================================================+
| name | Yes | String | Flow log name |
| | | | |
| | | | Minimum: **1** |
| | | | |
| | | | Maximum: **64** |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | No | String | Flow log description |
| | | | |
| | | | Minimum: **0** |
| | | | |
| | | | Maximum: **255** |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| resource_type | Yes | String | Type of resource whose flow logs are collected. |
| | | | |
| | | | - VPC attachments |
| | | | |
| | | | - Virtual gateway attachments |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| resource_id | Yes | String | Resource ID |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+
| log_group_id | Yes | String | Log group ID. Obtain the log group ID by referring to the *Log Tank Service User Guide*. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+
| log_stream_id | Yes | String | Log stream ID. Obtain the log stream ID by referring to the *Log Tank Service User Guide*. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| log_group_id | Yes | String | Log group ID. Obtain the log group ID by referring to the `Log Tank Service User Guide <https://docs.otc.t-systems.com/log-tank-service/umn/service_overview/index.html>`__. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| log_stream_id | Yes | String | Log stream ID. Obtain the log stream ID by referring to the `Log Tank Service User Guide <https://docs.otc.t-systems.com/log-tank-service/umn/service_overview/index.html>`__. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| log_store_type | Yes | String | Flow log storage type. |
| | | | |
| | | | LTS: Logs are stored on LTS servers. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| log_store_name | No | String | Flow log storage name. This parameter is not supported for now. |
| | | | |
| | | | Minimum: **1** |
| | | | |
| | | | Maximum: **255** |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Response Parameters
-------------------
@ -131,6 +137,8 @@ Response Parameters
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_store_type | String | Flow log storage type. LTS is used for log storage. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_store_name | String | Flow log storage name. This parameter is not supported for now. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ |

View File

@ -70,6 +70,8 @@ Response Parameters
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_store_type | String | Flow log storage type. LTS is used for log storage. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_store_name | String | Flow log storage name. This parameter is not supported for now. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ |

View File

@ -70,6 +70,8 @@ Response Parameters
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_store_type | String | Flow log storage type. LTS is used for log storage. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_store_name | String | Flow log storage name. This parameter is not supported for now. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ |

View File

@ -70,6 +70,8 @@ Response Parameters
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_store_type | String | Flow log storage type. LTS is used for log storage. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_store_name | String | Flow log storage name. This parameter is not supported for now. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ |

View File

@ -106,6 +106,8 @@ Response Parameters
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_store_type | String | Flow log storage type. LTS is used for log storage. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_store_name | String | Flow log storage name. This parameter is not supported for now. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ |

View File

@ -84,6 +84,8 @@ Response Parameters
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_store_type | String | Flow log storage type. LTS is used for log storage. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_store_name | String | Flow log storage name. This parameter is not supported for now. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. |
+--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+
| created_at | String | Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ |

View File

@ -16,6 +16,7 @@ APIs
- :ref:`Quota Management <quotamanager>`
- :ref:`AZs <availablezone>`
- :ref:`Flow Logs <flowlog>`
- :ref:`Sharing <er_02_0035>`
.. toctree::
:maxdepth: 1
@ -32,3 +33,4 @@ APIs
quota_management/index
azs/index
flow_logs/index
sharing

View File

@ -42,27 +42,27 @@ Request Parameters
.. table:: **Table 3** Request body parameters
+---------------+-----------+--------------------------------------------------------------------------------+-------------------------------------+
+---------------+-----------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===============+===========+================================================================================+=====================================+
+===============+===========+================================================================================+===============================================================================+
| attachment_id | No | String | Unique ID of the attachment |
+---------------+-----------+--------------------------------------------------------------------------------+-------------------------------------+
| route_policy | No | :ref:`ImportRoutePolicy <enablepropagation__request_importroutepolicy>` object | Route that controls inbound traffic |
+---------------+-----------+--------------------------------------------------------------------------------+-------------------------------------+
+---------------+-----------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| route_policy | No | :ref:`ImportRoutePolicy <enablepropagation__request_importroutepolicy>` object | Route that controls inbound traffic. This parameter is not supported for now. |
+---------------+-----------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
.. _enablepropagation__request_importroutepolicy:
.. table:: **Table 4** ImportRoutePolicy
+------------------+-----------------+-----------------+------------------------------------------------------+
+------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==================+=================+=================+======================================================+
| import_policy_id | No | String | ID of the route policy that controls inbound traffic |
+==================+=================+=================+================================================================================================+
| import_policy_id | No | String | ID of the route policy that controls inbound traffic. This parameter is not supported for now. |
| | | | |
| | | | Minimum: **0** |
| | | | |
| | | | Maximum: **36** |
+------------------+-----------------+-----------------+------------------------------------------------------+
+------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------+
Response Parameters
-------------------
@ -112,7 +112,7 @@ Response Parameters
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| resource_id | String | Unique ID of the attachment |
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| route_policy | :ref:`ImportRoutePolicy <enablepropagation__response_importroutepolicy>` object | Route that controls inbound traffic |
| route_policy | :ref:`ImportRoutePolicy <enablepropagation__response_importroutepolicy>` object | Route that controls inbound traffic. This parameter is not supported for now. |
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| state | String | Status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
@ -125,15 +125,15 @@ Response Parameters
.. table:: **Table 8** ImportRoutePolicy
+-----------------------+-----------------------+------------------------------------------------------+
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+======================================================+
| import_policy_id | String | ID of the route policy that controls inbound traffic |
+=======================+=======================+================================================================================================+
| import_policy_id | String | ID of the route policy that controls inbound traffic. This parameter is not supported for now. |
| | | |
| | | Minimum: **0** |
| | | |
| | | Maximum: **36** |
+-----------------------+-----------------------+------------------------------------------------------+
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------+
Example Requests
----------------

View File

@ -30,27 +30,27 @@ Request Parameters
.. table:: **Table 2** Request body parameters
+---------------+-----------+---------------------------------------------------------------------------------+-------------------------------------+
+---------------+-----------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===============+===========+=================================================================================+=====================================+
+===============+===========+=================================================================================+===============================================================================+
| attachment_id | No | String | Unique ID of the attachment |
+---------------+-----------+---------------------------------------------------------------------------------+-------------------------------------+
| route_policy | No | :ref:`ImportRoutePolicy <disablepropagation__request_importroutepolicy>` object | Route that controls inbound traffic |
+---------------+-----------+---------------------------------------------------------------------------------+-------------------------------------+
+---------------+-----------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| route_policy | No | :ref:`ImportRoutePolicy <disablepropagation__request_importroutepolicy>` object | Route that controls inbound traffic. This parameter is not supported for now. |
+---------------+-----------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
.. _disablepropagation__request_importroutepolicy:
.. table:: **Table 3** ImportRoutePolicy
+------------------+-----------------+-----------------+------------------------------------------------------+
+------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==================+=================+=================+======================================================+
| import_policy_id | No | String | ID of the route policy that controls inbound traffic |
+==================+=================+=================+================================================================================================+
| import_policy_id | No | String | ID of the route policy that controls inbound traffic. This parameter is not supported for now. |
| | | | |
| | | | Minimum: **0** |
| | | | |
| | | | Maximum: **36** |
+------------------+-----------------+-----------------+------------------------------------------------------+
+------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------+
Response Parameters
-------------------

View File

@ -111,7 +111,7 @@ Response Parameters
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| resource_id | String | Unique ID of the attachment |
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| route_policy | :ref:`ImportRoutePolicy <listpropagations__response_importroutepolicy>` object | Route that controls inbound traffic |
| route_policy | :ref:`ImportRoutePolicy <listpropagations__response_importroutepolicy>` object | Route that controls inbound traffic. This parameter is not supported for now. |
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| state | String | Status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** |
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
@ -124,15 +124,15 @@ Response Parameters
.. table:: **Table 5** ImportRoutePolicy
+-----------------------+-----------------------+------------------------------------------------------+
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+======================================================+
| import_policy_id | String | ID of the route policy that controls inbound traffic |
+=======================+=======================+================================================================================================+
| import_policy_id | String | ID of the route policy that controls inbound traffic. This parameter is not supported for now. |
| | | |
| | | Minimum: **0** |
| | | |
| | | Maximum: **36** |
+-----------------------+-----------------------+------------------------------------------------------+
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------+
.. _listpropagations__response_pageinfo:

View File

@ -25,29 +25,39 @@ GET /v3/{project_id}/enterprise-router/quotas
.. table:: **Table 2** Query Parameters
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+=============================================================================================+
+=================+=================+=================+====================================================================================================================================+
| type | No | Array | You can query the quotas of the following resources: |
| | | | |
| | | | - **er_instance**: total and used quotas of enterprise routers |
| | | | - **er_instance**: Total and used quotas of enterprise routers |
| | | | |
| | | | - **vpc_attachment**: total and used quotas of VPC attachments |
| | | | - **vpc_attachment**: Total and used quotas of VPC attachments |
| | | | |
| | | | - **route_table**: total and used quotas of route tables |
| | | | - **route_table**: Total and used quotas of route tables |
| | | | |
| | | | - **static_route**: total and used quotas of static routes |
| | | | - **static_route**: Total and used quotas of static routes |
| | | | |
| | | | - **vpc_er**: total and used quotas of enterprise routers that a VPC can be attached to |
| | | | - **vpc_er**: Total and used quotas of enterprise routers that a VPC can be attached to |
| | | | |
| | | | - **flow_log**: total and used quotas of flow logs that can be created for each attachment |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+
| | | | - **flow_log**: Total and used quotas of flow logs that can be created for each attachment |
| | | | |
| | | | - **connect_attachment**: Total and used quotas of Connect attachments. This type of attachments is not supported. |
| | | | |
| | | | - **dc_attachment**: Total and used quotas of virtual gateway attachments. This type of attachments is not supported. |
| | | | |
| | | | - **vpn_attachment**: Total and used quotas of VPN gateway attachments. This type of attachments is not supported. |
| | | | |
| | | | - **peering_attachment**: Total and used quotas of peering connection attachments. This type of attachments is not supported. |
| | | | |
| | | | - **can_attachment**: Total and used quotas of intelligent access gateway attachments. This type of attachments is not supported. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+
| erId | No | Object | Enterprise router ID |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+
| routeTableId | No | Object | Route table ID |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+
| vpcId | No | Object | VPC ID |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
@ -107,6 +117,46 @@ OK
"quota_limit" : 1,
"used" : 0,
"unit" : "count"
}, {
"quota_key" : "dc_attachment",
"quota_limit" : 2,
"used" : 0,
"unit" : "count"
}, {
"quota_key" : "route_table",
"quota_limit" : 20,
"used" : 5,
"unit" : "count"
}, {
"quota_key" : "static_route",
"quota_limit" : 500,
"used" : 2,
"unit" : "count"
}, {
"quota_key" : "can_attachment",
"quota_limit" : 10,
"used" : 0,
"unit" : "count"
}, {
"quota_key" : "connect_attachment",
"quota_limit" : 20,
"used" : 0,
"unit" : "count"
}, {
"quota_key" : "peering_attachment",
"quota_limit" : 10,
"used" : 0,
"unit" : "count"
}, {
"quota_key" : "vpn_attachment",
"quota_limit" : 10,
"used" : 0,
"unit" : "count"
}, {
"quota_key" : "flow_log",
"quota_limit" : 20,
"used" : 4,
"unit" : "count"
} ]
}

File diff suppressed because it is too large Load Diff

View File

@ -49,29 +49,31 @@ Response Parameters
.. table:: **Table 3** RouteTable
+------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+========================+============================================================+========================================================================================+
+========================+================================================================+========================================================================================+
| id | String | Route table ID |
+------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| name | String | Route table name |
+------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| description | String | Supplementary information |
+------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| is_default_association | Boolean | Whether the route table is the default association route table. |
| | | |
| | | Default: **false** |
+------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| is_default_propagation | Boolean | Whether the route table is the default propagation route table. |
+------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| state | String | Route table status. The value can be pending, available, deleting, deleted, or failed. |
+------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| tags | Array of :ref:`Tag <showroutetable__response_tag>` objects | Tag |
+------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| bgp_options | :ref:`BgpOptions <showroutetable__response_bgpoptions>` object | BGP route selection parameters. This parameter is not supported for now. |
+------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| created_at | String | Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ |
+------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| updated_at | String | Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ |
+------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------+
.. _showroutetable__response_tag:
@ -93,6 +95,18 @@ Response Parameters
| | | Maximum: **128** |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _showroutetable__response_bgpoptions:
.. table:: **Table 5** BgpOptions
+-------------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===============================+=========+=====================================================================================================================================================+
| load_balancing_as_path_ignore | Boolean | BGP option to specify that AS-Path attributes are not compared during load balancing. This parameter is not supported for now. |
+-------------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| load_balancing_as_path_relax | Boolean | BGP option to specify that AS-Path attributes with the same length are not compared during load balancing. This parameter is not supported for now. |
+-------------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
Example Requests
----------------

View File

@ -85,29 +85,31 @@ Response Parameters
.. table:: **Table 4** RouteTable
+------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+========================+=============================================================+========================================================================================+
+========================+=================================================================+========================================================================================+
| id | String | Route table ID |
+------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| name | String | Route table name |
+------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| description | String | Supplementary information |
+------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| is_default_association | Boolean | Whether the route table is the default association route table. |
| | | |
| | | Default: **false** |
+------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| is_default_propagation | Boolean | Whether the route table is the default propagation route table. |
+------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| state | String | Route table status. The value can be pending, available, deleting, deleted, or failed. |
+------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| tags | Array of :ref:`Tag <listroutetables__response_tag>` objects | Tag |
+------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| bgp_options | :ref:`BgpOptions <listroutetables__response_bgpoptions>` object | BGP route selection parameters. This parameter is not supported for now. |
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| created_at | String | Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ |
+------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| updated_at | String | Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ |
+------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
+------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------+
.. _listroutetables__response_tag:
@ -129,9 +131,21 @@ Response Parameters
| | | Maximum: **128** |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _listroutetables__response_bgpoptions:
.. table:: **Table 6** BgpOptions
+-------------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===============================+=========+=====================================================================================================================================================+
| load_balancing_as_path_ignore | Boolean | BGP option to specify that AS-Path attributes are not compared during load balancing. This parameter is not supported for now. |
+-------------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
| load_balancing_as_path_relax | Boolean | BGP option to specify that AS-Path attributes with the same length are not compared during load balancing. This parameter is not supported for now. |
+-------------------------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
.. _listroutetables__response_pageinfo:
.. table:: **Table 6** PageInfo
.. table:: **Table 7** PageInfo
+---------------+---------+-------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |

View File

@ -8,7 +8,7 @@ Creating a Static Route
Function
--------
This API is used to create a static route.
This API is used to create a static route. Static routes are manually created, and effective routes are preferred routes.
Constraints
-----------

View File

@ -8,7 +8,7 @@ Querying Effective Routes
Function
--------
This API is used to query effective routes. Pagination query is supported.
This API is used to query effective routes. Pagination query is supported. Effective routes are preferred routes.
URI
---
@ -76,19 +76,21 @@ Response Parameters
.. table:: **Table 4** EffectiveRoute
+--------------+-----------------------------------------------------------------------------------------+-----------------------------------------------------------+
+------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------+
| Parameter | Type | Description |
+==============+=========================================================================================+===========================================================+
+==================+=========================================================================================+===============================================================+
| route_id | String | Route ID |
+--------------+-----------------------------------------------------------------------------------------+-----------------------------------------------------------+
+------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------+
| destination | String | Destination address of the route |
+--------------+-----------------------------------------------------------------------------------------+-----------------------------------------------------------+
+------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------+
| next_hops | Array of :ref:`RouteAttachment <listeffectiveroutes__response_routeattachment>` objects | Next hops of the routes |
+--------------+-----------------------------------------------------------------------------------------+-----------------------------------------------------------+
+------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------+
| is_blackhole | Boolean | Whether the route is a blackhole route |
+--------------+-----------------------------------------------------------------------------------------+-----------------------------------------------------------+
+------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------+
| route_type | String | Route type. Value options: **static** and **propagation** |
+--------------+-----------------------------------------------------------------------------------------+-----------------------------------------------------------+
+------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------+
| address_group_id | String | IP address group ID. This parameter is not supported for now. |
+------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------+
.. _listeffectiveroutes__response_routeattachment:

View File

@ -0,0 +1,17 @@
:original_name: er_02_0035.html
.. _er_02_0035:
Sharing
=======
You can share an enterprise router in your account with other accounts.
- You are the owner of the enterprise router.
- Other accounts are the users of the enterprise router.
After you share your enterprise router with other accounts, these other users can attach their network instances to your enterprise router, so that their network instances can access your enterprise router.
.. important::
Enterprise routers cannot be shared through APIs. You can only use this function on the management console. For details, see section "Sharing Overview" in the *Enterprise Router User Guide*.

View File

@ -13,7 +13,7 @@ This API is used to create tags for resources of a specific type.
Constraints
-----------
- A resource can have up to 10 tags.
- A resource can have up to 20 tags.
- This API is idempotent.

View File

@ -62,7 +62,7 @@ Response Parameters
+===========+==================+=====================================================================================+
| key | String | Tag key, which cannot be empty and can contain a maximum of 127 Unicode characters. |
+-----------+------------------+-------------------------------------------------------------------------------------+
| values | Array of strings | Tag values. Each value can contain a maximum of 255 Unicode characters. |
| values | Array of Strings | Tag values. Each value can contain a maximum of 255 Unicode characters. |
+-----------+------------------+-------------------------------------------------------------------------------------+
Example Requests

View File

@ -74,6 +74,10 @@ Request Parameters
| | | | |
| | | | Default: **false** |
+------------------------+-----------------+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_enable | No | Boolean | The default value is **false**. If the value is **true**, IPv6 is enabled for the VPC attachment. This parameter is not supported for now. |
| | | | |
| | | | Default: **false** |
+------------------------+-----------------+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | No | Array of :ref:`Tag <createvpcattachment__request_tag>` objects | Tag information |
+------------------------+-----------------+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -153,6 +157,10 @@ Response Parameters
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_project_id | String | ID of the project that the VPC belongs to |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_enable | Boolean | The default value is **false**. If the value is **true**, IPv6 is enabled for the VPC attachment. This parameter is not supported for now. |
| | | |
| | | Default: **false** |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _createvpcattachment__response_tag:
@ -207,6 +215,7 @@ Accepted
"vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
"virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8",
"project_id" : "08d5a9564a704afda6039ae2babbef3c",
"ipv6_enable" : false,
"state" : "pending",
"auto_create_vpc_routes" : false,
"created_at" : "2020-03-11T15:13:31Z",

View File

@ -78,6 +78,10 @@ Response Parameters
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_project_id | String | ID of the project that the VPC belongs to |
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_enable | Boolean | The default value is **false**. If the value is **true**, IPv6 is enabled for the VPC attachment. This parameter is not supported for now. |
| | | |
| | | Default: **false** |
+------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _showvpcattachment__response_tag:
@ -124,6 +128,7 @@ OK
"vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
"virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8",
"project_id" : "08d5a9564a704afda6039ae2babbef3c",
"ipv6_enable" : false,
"state" : "available",
"created_at" : "2020-03-11T15:13:31Z",
"updated_at" : "2020-03-11T15:13:31Z"

View File

@ -118,6 +118,10 @@ Response Parameters
+------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_project_id | String | ID of the project that the VPC belongs to |
+------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_enable | Boolean | The default value is **false**. If the value is **true**, IPv6 is enabled for the VPC attachment. This parameter is not supported for now. |
| | | |
| | | Default: **false** |
+------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _listvpcattachments__response_tag:
@ -182,6 +186,7 @@ OK
"vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
"virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8",
"project_id" : "08d5a9564a704afda6039ae2babbef3c",
"ipv6_enable" : false,
"state" : "available",
"created_at" : "2020-03-11T15:13:31Z",
"updated_at" : "2020-03-11T15:13:31Z"
@ -191,6 +196,7 @@ OK
"vpc_id" : "4b8567f6-358f-4a7f-8cd3-3cbb82c0b25f",
"virsubnet_id" : "2b55f334-a15e-43a9-ab11-b34c2dbb6fac",
"project_id" : "08d5a9564a704afda6039ae2babbef3c",
"ipv6_enable" : false,
"state" : "available",
"created_at" : "2020-03-11T15:13:31Z",
"updated_at" : "2020-03-11T15:13:31Z"

View File

@ -104,6 +104,10 @@ Response Parameters
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_project_id | String | ID of the project that the VPC belongs to |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_enable | Boolean | The default value is **false**. If the value is **true**, IPv6 is enabled for the VPC attachment. This parameter is not supported for now. |
| | | |
| | | Default: **false** |
+------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _updatevpcattachment__response_tag:
@ -157,6 +161,7 @@ OK
"virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8",
"auto_create_vpc_routes" : false,
"project_id" : "08d5a9564a704afda6039ae2babbef3c",
"ipv6_enable" : false,
"state" : "available",
"created_at" : "2020-03-11T15:13:31Z",
"updated_at" : "2020-03-11T15:13:31Z"

View File

@ -8,6 +8,11 @@ Change History
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Released On | Description |
+===================================+================================================================================================================================================================================+
| 2023-11-17 | This release incorporates the following changes: |
| | |
| | - Added section "Sharing" to state that this function cannot be used through APIs. |
| | - Added section "Permissions and Supported Actions" to describe enterprise router permissions. |
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2023-11-01 | This release incorporates the following changes: |
| | |
| | - Modified the **name** parameter in "Creating an Enterprise Router", "Creating a Route Table", and "Updating Route Table Information". |

View File

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

View File

@ -0,0 +1,16 @@
:original_name: er_02_0021.html
.. _er_02_0021:
Associations
============
+-------------------------------+--------------------------------------------------------------------------------------------+------------------------------+-------------+--------------------+
| 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 |
+-------------------------------+--------------------------------------------------------------------------------------------+------------------------------+-------------+--------------------+

View File

@ -0,0 +1,16 @@
:original_name: er_02_0019.html
.. _er_02_0019:
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 |
+--------------------------------------+----------------------------------------------------------------------------+-----------------------+-------------+--------------------+

View File

@ -0,0 +1,20 @@
:original_name: er_02_0017.html
.. _er_02_0017:
Enterprise Routers
==================
+---------------------------------------------+----------------------------------------------------------------------------+---------------------+-------------+--------------------+
| 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 |
+---------------------------------------------+----------------------------------------------------------------------------+---------------------+-------------+--------------------+
| Deleting an enterprise router | DELETE /v3/{project_id}/enterprise-router/instances/{enterprise_router_id} | er:instances:delete | Y | Y |
+---------------------------------------------+----------------------------------------------------------------------------+---------------------+-------------+--------------------+

View File

@ -0,0 +1,24 @@
:original_name: er_02_0024.html
.. _er_02_0024:
Flow Logs
=========
+-----------------------------------+---------------------------------------------------------------------------------+---------------------+-------------+--------------------+
| Permission | API | Action | IAM Project | Enterprise Project |
+===================================+=================================================================================+=====================+=============+====================+
| Creating a flow log | POST /v3/{project_id}/enterprise-router/{er_id}/flow-logs | er:flowlogs:create | Y | Y |
+-----------------------------------+---------------------------------------------------------------------------------+---------------------+-------------+--------------------+
| Querying the flow log list | GET /v3/{project_id}/enterprise-router/{er_id}/flow-logs | er:flowlogs:list | Y | Y |
+-----------------------------------+---------------------------------------------------------------------------------+---------------------+-------------+--------------------+
| Querying details about a flow log | GET /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id} | er:flowlogs:show | Y | Y |
+-----------------------------------+---------------------------------------------------------------------------------+---------------------+-------------+--------------------+
| Updating a flow log | PUT /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id} | er:flowlogs:update | Y | Y |
+-----------------------------------+---------------------------------------------------------------------------------+---------------------+-------------+--------------------+
| Deleting a flow log | DELETE /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id} | er:flowlogs:delete | Y | Y |
+-----------------------------------+---------------------------------------------------------------------------------+---------------------+-------------+--------------------+
| Enabling flow logging | POST /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}/enable | er:flowlogs:enable | Y | Y |
+-----------------------------------+---------------------------------------------------------------------------------+---------------------+-------------+--------------------+
| Disabling flow logging | POST /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}/disable | er:flowlogs:disable | Y | Y |
+-----------------------------------+---------------------------------------------------------------------------------+---------------------+-------------+--------------------+

View File

@ -0,0 +1,34 @@
:original_name: er_02_0015.html
.. _er_02_0015:
Permissions Policies and Supported Actions
==========================================
- :ref:`Introduction <er_02_0016>`
- :ref:`Enterprise Routers <er_02_0017>`
- :ref:`VPC Attachments <er_02_0018>`
- :ref:`Attachments <er_02_0019>`
- :ref:`Route Tables <er_02_0020>`
- :ref:`Associations <er_02_0021>`
- :ref:`Propagations <er_02_0022>`
- :ref:`Routes <er_02_0023>`
- :ref:`Flow Logs <er_02_0024>`
- :ref:`Tags <er_02_0033>`
- :ref:`Quota Management <er_02_0034>`
.. toctree::
:maxdepth: 1
:hidden:
introduction
enterprise_routers
vpc_attachments
attachments
route_tables
associations
propagations
routes
flow_logs
tags
quota_management

View File

@ -0,0 +1,36 @@
: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.
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 enterprise routers using an API, the user must have been granted permissions that allow the **er:instances: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 Routers <er_02_0017>`
- :ref:`VPC Attachments <er_02_0018>`
- :ref:`Attachments <er_02_0019>`
- :ref:`Route Tables <er_02_0020>`
- :ref:`Associations <er_02_0021>`
- :ref:`Propagations <er_02_0022>`
- :ref:`Routes <er_02_0023>`
- :ref:`Flow Logs <er_02_0024>`
- :ref:`Tags <er_02_0033>`
- :ref:`Quota Management <er_02_0034>`

View File

@ -0,0 +1,16 @@
:original_name: er_02_0022.html
.. _er_02_0022:
Propagations
============
+-------------------------------+----------------------------------------------------------------------------------------------------+-------------------------+-------------+--------------------+
| 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 |
+-------------------------------+----------------------------------------------------------------------------------------------------+-------------------------+-------------+--------------------+

View File

@ -0,0 +1,12 @@
:original_name: er_02_0034.html
.. _er_02_0034:
Quota Management
================
+-----------------+-----------------------------------------------+----------------+-------------+--------------------+
| Permission | API | Action | IAM Project | Enterprise Project |
+=================+===============================================+================+=============+====================+
| Querying quotas | GET /v3/{project_id}/enterprise-router/quotas | er:quotas:list | Y | Y |
+-----------------+-----------------------------------------------+----------------+-------------+--------------------+

View File

@ -0,0 +1,20 @@
:original_name: er_02_0020.html
.. _er_02_0020:
Route Tables
============
+--------------------------------------+---------------------------------------------------------------------------------+-----------------------+-------------+--------------------+
| Permission | API | Action | IAM Project | Enterprise Project |
+======================================+=================================================================================+=======================+=============+====================+
| Creating a route table | POST /v3/{project_id}/enterprise-router/{er_id}/route-tables | er:routeTables:create | Y | Y |
+--------------------------------------+---------------------------------------------------------------------------------+-----------------------+-------------+--------------------+
| Updating a route table | PUT /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id} | er:routeTables:update | Y | Y |
+--------------------------------------+---------------------------------------------------------------------------------+-----------------------+-------------+--------------------+
| Querying details about a route table | GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id} | er:routeTables:get | Y | Y |
+--------------------------------------+---------------------------------------------------------------------------------+-----------------------+-------------+--------------------+
| Querying the route table list | GET /v3/{project_id}/enterprise-router/{er_id}/route-tables | er:routeTables:list | Y | Y |
+--------------------------------------+---------------------------------------------------------------------------------+-----------------------+-------------+--------------------+
| Deleting a route table | DELETE /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id} | er:routeTables:delete | Y | Y |
+--------------------------------------+---------------------------------------------------------------------------------+-----------------------+-------------+--------------------+

View File

@ -0,0 +1,22 @@
:original_name: er_02_0023.html
.. _er_02_0023:
Routes
======
+---------------------------------------+--------------------------------------------------------------------------------------------------+------------------+-------------+--------------------+
| Permission | API | Action | IAM Project | Enterprise Project |
+=======================================+==================================================================================================+==================+=============+====================+
| Creating a static route | POST /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes | er:routes:create | Y | Y |
+---------------------------------------+--------------------------------------------------------------------------------------------------+------------------+-------------+--------------------+
| Updating a static route | PUT /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes/{route_id} | er:routes:update | Y | Y |
+---------------------------------------+--------------------------------------------------------------------------------------------------+------------------+-------------+--------------------+
| Querying details about a static route | GET /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes/{route_id} | er:routes:get | Y | Y |
+---------------------------------------+--------------------------------------------------------------------------------------------------+------------------+-------------+--------------------+
| Querying static routes | GET /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes | er:routes:list | Y | Y |
+---------------------------------------+--------------------------------------------------------------------------------------------------+------------------+-------------+--------------------+
| Querying valid routes | GET /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/routes | er:routes:list | Y | Y |
+---------------------------------------+--------------------------------------------------------------------------------------------------+------------------+-------------+--------------------+
| Deleting a static route | DELETE /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes/{route_id} | er:routes:delete | Y | Y |
+---------------------------------------+--------------------------------------------------------------------------------------------------+------------------+-------------+--------------------+

View File

@ -0,0 +1,20 @@
:original_name: er_02_0033.html
.. _er_02_0033:
Tags
====
+---------------------------------------------+-----------------------------------------------------------------+----------------+-------------+--------------------+
| Permission | API | Action | IAM Project | Enterprise Project |
+=============================================+=================================================================+================+=============+====================+
| Querying tags by resource type | GET /v3/{project_id}/{resource_type}/tags | er:tags:list | Y | Y |
+---------------------------------------------+-----------------------------------------------------------------+----------------+-------------+--------------------+
| Querying resource tags | GET /v3/{project_id}/{resource_type}/{resource_id}/tags | er:tags:get | Y | Y |
+---------------------------------------------+-----------------------------------------------------------------+----------------+-------------+--------------------+
| Creating a resource tag | POST /v3/{project_id}/{resource_type}/{resource_id}/tags | er:tags:create | Y | Y |
+---------------------------------------------+-----------------------------------------------------------------+----------------+-------------+--------------------+
| Adding or deleting resource tags in batches | POST /v3/{project_id}/{resource_type}/{resource_id}/tags/action | er:tags:create | Y | Y |
+---------------------------------------------+-----------------------------------------------------------------+----------------+-------------+--------------------+
| Deleting a resource tag | POST /v3/{project_id}/{resource_type}/{resource_id}/tags/{key} | er:tags:delete | Y | Y |
+---------------------------------------------+-----------------------------------------------------------------+----------------+-------------+--------------------+

View File

@ -0,0 +1,20 @@
:original_name: er_02_0018.html
.. _er_02_0018:
VPC Attachments
===============
+-----------------------------------------+---------------------------------------------------------------------------------------+-----------------------+---------+--------------------+
| Permission | API | Action | Project | Enterprise Project |
+=========================================+=======================================================================================+=======================+=========+====================+
| Creating a VPC attachment | POST /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments | er:attachments:create | Y | Y |
+-----------------------------------------+---------------------------------------------------------------------------------------+-----------------------+---------+--------------------+
| Updating a VPC attachment | PUT /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments/{vpc_attachment_id} | er:attachments:update | Y | Y |
+-----------------------------------------+---------------------------------------------------------------------------------------+-----------------------+---------+--------------------+
| Querying details about a VPC attachment | GET /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments/{vpc_attachment_id} | er:attachments:get | Y | Y |
+-----------------------------------------+---------------------------------------------------------------------------------------+-----------------------+---------+--------------------+
| Querying the VPC attachment list | GET /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments | er:attachments:list | Y | Y |
+-----------------------------------------+---------------------------------------------------------------------------------------+-----------------------+---------+--------------------+
| Deleting a VPC attachment | DELETE /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments/{vpc_attachment_id} | er:attachments:delete | Y | Y |
+-----------------------------------------+---------------------------------------------------------------------------------------+-----------------------+---------+--------------------+