diff --git a/api-ref/source/apis/associations/creating_a_route_association.rst b/api-ref/source/apis/associations/creating_a_route_association.rst index e3ef758..722d2b2 100644 --- a/api-ref/source/apis/associations/creating_a_route_association.rst +++ b/api-ref/source/apis/associations/creating_a_route_association.rst @@ -93,33 +93,33 @@ Response Parameters .. table:: **Table 7** Association - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===================================================================================+=========================================================================+ - | id | String | Unique association ID | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | route_table_id | String | Unique ID of the route table | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | attachment_id | String | Unique ID of the attachment | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | resource_type | String | Attachment type | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | resource_id | String | Unique ID of the attachment | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | state | String | Status | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | created_at | String | Time when the resource was created UTC time Format: YYYY-MM-DDTHH:MM:SS | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | updated_at | String | Time when the resource was updated UTC time Format: YYYY-MM-DDTHH:MM:SS | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | route_policy | :ref:`ExportRoutePolicy ` object | Route that controls outbound traffic | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------+ + +-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+===================================================================================+=====================================================================+ + | id | String | Unique association ID | + | | | | + | | | Maximum: **36** | + +-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | route_table_id | String | Unique ID of the route table | + | | | | + | | | Maximum: **36** | + +-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | attachment_id | String | Unique ID of the attachment | + | | | | + | | | Maximum: **36** | + +-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | resource_type | String | Attachment type | + +-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | resource_id | String | Unique ID of the attachment | + +-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | state | String | Status | + +-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | created_at | String | Creation time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. | + +-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | updated_at | String | Update time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. | + +-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | route_policy | :ref:`ExportRoutePolicy ` object | Route that controls outbound traffic | + +-----------------------+-----------------------------------------------------------------------------------+---------------------------------------------------------------------+ .. _associateroutetable__response_exportroutepolicy: diff --git a/api-ref/source/apis/associations/querying_route_associations.rst b/api-ref/source/apis/associations/querying_route_associations.rst index 36042b7..fcbd8c0 100644 --- a/api-ref/source/apis/associations/querying_route_associations.rst +++ b/api-ref/source/apis/associations/querying_route_associations.rst @@ -35,7 +35,7 @@ GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/ass +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+=================+=====================================================================================================================================================================+ - | limit | No | Integer | Number of records on each page. Value range: 0 to 2000 | + | limit | No | Integer | Number of records on each page. Value range: **0** to **2000** | | | | | | | | | | Minimum: **0** | | | | | | @@ -49,19 +49,17 @@ GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/ass +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | attachment_id | No | Array | Attachment ID | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | No | Array | Attachment type: | + | resource_type | No | Array | Attachment type. Value options are as follows: | | | | | | | | | | - **vpc**: VPC attachment | | | | | | - | | | | - **vpn**: VPN gateway attachment | - | | | | | | | | | - **vgw**: virtual gateway attachment | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | state | No | Array | Status | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_key | No | Array | Sort by ID, name, or state. By default, ID is used. | + | sort_key | No | Array | Keyword for sorting. The keyword can be **id**, **name**, or **state**. By default, **id** is used. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_dir | No | Array | Sorting order, including **asc** (ascending order) and **desc** (descending order). The default value is **asc**. | + | sort_dir | No | Array | Sorting order. There are two value options: **asc** (ascending order) and **desc** (descending order). The default value is **asc**. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters @@ -76,47 +74,49 @@ Response Parameters .. table:: **Table 3** Response body parameters - +--------------+------------------------------------------------------------------------------+------------------------------+ - | Parameter | Type | Description | - +==============+==============================================================================+==============================+ - | associations | Array of :ref:`Association ` objects | Route table associations | - +--------------+------------------------------------------------------------------------------+------------------------------+ - | request_id | String | Request ID | - +--------------+------------------------------------------------------------------------------+------------------------------+ - | page_info | :ref:`PageInfo ` object | Pagination query information | - +--------------+------------------------------------------------------------------------------+------------------------------+ + +-----------------------+------------------------------------------------------------------------------+------------------------------+ + | Parameter | Type | Description | + +=======================+==============================================================================+==============================+ + | associations | Array of :ref:`Association ` objects | Route table associations | + | | | | + | | | Array Length: **0 - 2000** | + +-----------------------+------------------------------------------------------------------------------+------------------------------+ + | request_id | String | Request ID | + +-----------------------+------------------------------------------------------------------------------+------------------------------+ + | page_info | :ref:`PageInfo ` object | Pagination query information | + +-----------------------+------------------------------------------------------------------------------+------------------------------+ .. _listassociations__response_association: .. table:: **Table 4** Association - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+================================================================================+=========================================================================+ - | id | String | Unique association ID | - | | | | - | | | Maximum: **36** | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | route_table_id | String | Unique ID of the route table | - | | | | - | | | Maximum: **36** | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | attachment_id | String | Unique ID of the attachment | - | | | | - | | | Maximum: **36** | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | resource_type | String | Attachment type | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | resource_id | String | Unique ID of the attachment | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | state | String | Status | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | created_at | String | Time when the resource was created UTC time Format: YYYY-MM-DDTHH:MM:SS | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | updated_at | String | Time when the resource was updated UTC time Format: YYYY-MM-DDTHH:MM:SS | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | route_policy | :ref:`ExportRoutePolicy ` object | Route that controls outbound traffic | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ + +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+================================================================================+=====================================================================+ + | id | String | Unique association ID | + | | | | + | | | Maximum: **36** | + +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | route_table_id | String | Unique ID of the route table | + | | | | + | | | Maximum: **36** | + +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | attachment_id | String | Unique ID of the attachment | + | | | | + | | | Maximum: **36** | + +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | resource_type | String | Attachment type | + +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | resource_id | String | Unique ID of the attachment | + +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | state | String | Status | + +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | created_at | String | Creation time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. | + +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | updated_at | String | Update time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. | + +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | route_policy | :ref:`ExportRoutePolicy ` object | Route that controls outbound traffic | + +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ .. _listassociations__response_exportroutepolicy: @@ -177,7 +177,7 @@ OK } } ], "page_info" : { - "next_marker" : 1, + "next_marker" : "1", "current_count" : 1 }, "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9" diff --git a/api-ref/source/apis/attachments/querying_attachments.rst b/api-ref/source/apis/attachments/querying_attachments.rst index 9d84b50..be8b1f2 100644 --- a/api-ref/source/apis/attachments/querying_attachments.rst +++ b/api-ref/source/apis/attachments/querying_attachments.rst @@ -13,11 +13,11 @@ This API is used to query the attachments of the enterprise router. Constraints ----------- -#. Filtering query is supported. The filtering criteria include **state**, **resource_type**, and **resource_id**. You can query multiple resources at a time or use combined criteria to query resources. +- Filtering query is supported. The filtering criteria include **state**, **resource_type**, and **resource_id**. You can query multiple resources at a time or use combined criteria to query resources. -#. Pagination query is supported. You can use **limit** and **marker** together for pagination query. +- Pagination query is supported. You can use **limit** and **marker** together for pagination query. -#. Only sorting by a single field (**id**, **name**, **description**, **created_at**, or **updated_at**) is supported. +- Only sorting by a single field (**id**, **name**, **description**, **created_at**, or **updated_at**) is supported. URI --- @@ -35,37 +35,35 @@ GET /v3/{project_id}/enterprise-router/{er_id}/attachments .. table:: **Table 2** Query Parameters - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=======================================================================================================================================================================+ - | limit | No | Integer | Number of records on each page. Value range: 0 to 2000 | - | | | | | - | | | | Minimum: **0** | - | | | | | - | | | | Maximum: **2000** | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | marker | No | String | ID of the last enterprise router on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit. | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **128** | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | state | No | Array | Attachment status: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **pending_acceptance**, **rejected**, and **initiating_request** | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | No | Array | Attachment type: | - | | | | | - | | | | - **vpc**: VPC attachment | - | | | | | - | | | | - **vpn**: VPN gateway attachment | - | | | | | - | | | | - **vgw**: virtual gateway attachment | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_id | No | Array | Attachment resource IDs | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_key | No | Array | Sort by ID, name, or state. By default, ID is used. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_dir | No | Array | Sorting order, including **asc** (ascending order) and **desc** (descending order). The default value is **asc**. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+======================================================================================================================================================================================+ + | limit | No | Integer | Number of records on each page. Value range: **0** to **2000** | + | | | | | + | | | | Minimum: **0** | + | | | | | + | | | | Maximum: **2000** | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | marker | No | String | ID of the last enterprise router on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit. | + | | | | | + | | | | Minimum: **1** | + | | | | | + | | | | Maximum: **128** | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | No | Array | Attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **pending_acceptance**, **rejected**, and **initiating_request** | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | No | Array | Attachment type. Value options are as follows: | + | | | | | + | | | | - **vpc**: VPC attachment | + | | | | | + | | | | - **vgw**: virtual gateway attachment | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | No | Array | Attachment resource IDs | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sort_key | No | Array | Keyword for sorting. The keyword can be **id**, **name**, or **state**. By default, **id** is used. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sort_dir | No | Array | Sorting order. There are two value options: **asc** (ascending order) and **desc** (descending order). The default value is **asc**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ @@ -93,39 +91,41 @@ Response Parameters .. table:: **Table 4** AttachmentDetails - +-----------------------+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=============================================================+=======================================================================================================================================================================+ - | id | String | Attachment ID | - +-----------------------+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Attachment name | - +-----------------------+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Attachment description | - +-----------------------+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | state | String | Attachment status: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **pending_acceptance**, **rejected**, and **initiating_request** | - +-----------------------+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Creation time | - +-----------------------+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Update time | - +-----------------------+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of :ref:`Tag ` objects | Enterprise router tags | - +-----------------------+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID | - +-----------------------+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | er_id | String | er id | - +-----------------------+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_id | String | Attached resource ID on its own service console | - +-----------------------+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | String | - vgw: Direct Connect virtual gateway | - | | | | - | | | - vpn: VPN gateway | - +-----------------------+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_project_id | String | ID of the project that the resource belongs to | - +-----------------------+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | associated | Boolean | Whether the attachment is associated. | - +-----------------------+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | route_table_id | String | Association route table ID | - +-----------------------+-------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=============================================================+======================================================================================================================================================================================+ + | id | String | Attachment ID | + +-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Attachment name | + +-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Attachment description | + +-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | Attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **pending_acceptance**, **rejected**, and **initiating_request** | + +-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`Tag ` objects | Enterprise router tags | + +-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID | + +-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | er_id | String | er id | + +-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | Attached resource ID on its own service console | + +-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | Attachment type. Value options are as follows: | + | | | | + | | | - **vgw**: virtual gateway attachment | + | | | | + | | | - **vpc**: VPC attachment | + +-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resource_project_id | String | ID of the project that the resource belongs to | + +-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | associated | Boolean | Whether the attachment is associated. | + +-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | route_table_id | String | Association route table ID | + +-----------------------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listattachments__response_tag: @@ -162,7 +162,7 @@ Response Parameters Example Requests ---------------- -Querying attachments. +Querying attachments .. code-block:: text @@ -200,7 +200,7 @@ OK "updated_at" : "2020-03-11T15:13:31Z" } ], "page_info" : { - "next_marker" : 1, + "next_marker" : "1", "current_count" : 2 }, "request_id" : "b715e131-3371-4e17-a2de-4f669e24439a" diff --git a/api-ref/source/apis/attachments/querying_details_about_an_attachment.rst b/api-ref/source/apis/attachments/querying_details_about_an_attachment.rst index 42262b3..79492c1 100644 --- a/api-ref/source/apis/attachments/querying_details_about_an_attachment.rst +++ b/api-ref/source/apis/attachments/querying_details_about_an_attachment.rst @@ -49,35 +49,35 @@ Response Parameters .. table:: **Table 3** AttachmentResponse - +-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+============================================================+=======================================================================================================================================================================+ - | name | String | Attachment name | - +-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Attachment ID | - +-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Supplementary information | - +-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | state | String | Attachment status: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **pending_acceptance**, **rejected**, and **initiating_request** | - +-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Creation time | - +-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Update time | - +-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of :ref:`Tag ` objects | Enterprise router tags | - +-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID | - +-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_id | String | Attached resource ID on its own service console | - +-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | String | The following types of attachments are available: | - | | | | - | | | - **vgw**: Virtual gateway attachment | - | | | | - | | | - **vpn**: VPN gateway attachment | - +-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_project_id | String | ID of the project that the resource belongs to | - +-----------------------+------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+============================================================+======================================================================================================================================================================================+ + | name | String | Attachment name | + +-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Attachment ID | + +-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Supplementary information | + +-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | Attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **pending_acceptance**, **rejected**, and **initiating_request** | + +-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`Tag ` objects | Enterprise router tags | + +-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID | + +-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | Attached resource ID on its own service console | + +-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | Attachment type. Value options are as follows: | + | | | | + | | | - **vpc**: VPC attachment | + | | | | + | | | - **vgw**: virtual gateway attachment | + +-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resource_project_id | String | ID of the project that the resource belongs to | + +-----------------------+------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _showattachment__response_tag: diff --git a/api-ref/source/apis/attachments/updating_an_attachment.rst b/api-ref/source/apis/attachments/updating_an_attachment.rst index 7090aba..f534268 100644 --- a/api-ref/source/apis/attachments/updating_an_attachment.rst +++ b/api-ref/source/apis/attachments/updating_an_attachment.rst @@ -75,35 +75,35 @@ Response Parameters .. table:: **Table 5** AttachmentResponse - +-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==============================================================+=======================================================================================================================================================================+ - | name | String | Attachment name | - +-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Attachment ID | - +-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Supplementary information | - +-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | state | String | Attachment status: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **pending_acceptance**, **rejected**, and **initiating_request** | - +-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Creation time | - +-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Update time | - +-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of :ref:`Tag ` objects | Enterprise router tags | - +-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID | - +-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_id | String | Attached resource ID on its own service console | - +-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | String | The following types of attachments are available: | - | | | | - | | | - **vgw**: Virtual gateway attachment | - | | | | - | | | - **vpn**: VPN gateway attachment | - +-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_project_id | String | ID of the project that the resource belongs to | - +-----------------------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+==============================================================+======================================================================================================================================================================================+ + | name | String | Attachment name | + +-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Attachment ID | + +-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Supplementary information | + +-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | Attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **pending_acceptance**, **rejected**, and **initiating_request** | + +-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`Tag ` objects | Enterprise router tags | + +-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID | + +-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | Attached resource ID on its own service console | + +-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | Attachment type. Value options are as follows: | + | | | | + | | | - **vpc**: VPC attachment | + | | | | + | | | - **vgw**: virtual gateway attachment | + +-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resource_project_id | String | ID of the project that the resource belongs to | + +-----------------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updateattachment__response_tag: @@ -128,7 +128,7 @@ Response Parameters Example Requests ---------------- -Updating basic information about an attachment +Updating an attachment (not a VPC attachment) .. code-block:: text diff --git a/api-ref/source/apis/azs/querying_azs.rst b/api-ref/source/apis/azs/querying_azs.rst index 380dabd..728b9ec 100644 --- a/api-ref/source/apis/azs/querying_azs.rst +++ b/api-ref/source/apis/azs/querying_azs.rst @@ -25,11 +25,15 @@ GET /v3/{project_id}/enterprise-router/availability-zones .. table:: **Table 2** Query Parameters - =========== ========= ====== ==================== - Parameter Mandatory Type Description - =========== ========= ====== ==================== - instance_id No String Enterprise router ID - =========== ========= ====== ==================== + +-----------------+-----------------+-----------------+---------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+===========================+ + | instance_id | No | String | Enterprise router ID | + +-----------------+-----------------+-----------------+---------------------------+ + | bandwidth_size | No | Integer | Bandwidth size, in Mbit/s | + | | | | | + | | | | Minimum: **-1** | + +-----------------+-----------------+-----------------+---------------------------+ Request Parameters ------------------ @@ -46,7 +50,7 @@ Response Parameters +--------------------+--------------------------------------------------------------------------------------+-------------+ | Parameter | Type | Description | +====================+======================================================================================+=============+ - | availability_zones | Array of :ref:`AvailableZone ` objects | AZs | + | availability_zones | Array of :ref:`AvailableZone ` objects | AZ list | +--------------------+--------------------------------------------------------------------------------------+-------------+ | request_id | String | Request ID | +--------------------+--------------------------------------------------------------------------------------+-------------+ @@ -55,13 +59,13 @@ Response Parameters .. table:: **Table 4** AvailableZone - +-----------+--------+-------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+=========================================================================+ - | code | String | AZ code | - +-----------+--------+-------------------------------------------------------------------------+ - | state | String | Whether the AZ is available. The value can be available or unavailable. | - +-----------+--------+-------------------------------------------------------------------------+ + +-----------+--------+-------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+===============================================================================+ + | code | String | AZ code | + +-----------+--------+-------------------------------------------------------------------------------+ + | state | String | Whether the AZ is available. Value options: **available** and **unavailable** | + +-----------+--------+-------------------------------------------------------------------------------+ Example Requests ---------------- diff --git a/api-ref/source/apis/enterprise_routers/creating_an_enterprise_router.rst b/api-ref/source/apis/enterprise_routers/creating_an_enterprise_router.rst index 0300269..9175764 100644 --- a/api-ref/source/apis/enterprise_routers/creating_an_enterprise_router.rst +++ b/api-ref/source/apis/enterprise_routers/creating_an_enterprise_router.rst @@ -50,49 +50,45 @@ Request Parameters .. table:: **Table 4** CreateEnterpriseRouter - +--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================================+=================+===================================================================+=======================================================================================================================================+ - | name | Yes | String | Enterprise router name | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **64** | - +--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Supplementary information about an enterprise router | - | | | | | - | | | | Minimum: **0** | - | | | | | - | | | | Maximum: **255** | - +--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | asn | Yes | Long | Enterprise router BGP ASN | - +--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project ID | - +--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | charge_mode | No | String | Billing mode: Pay-per-use | - | | | | | - | | | | Default: **postPaid** | - +--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | tags | No | Array of :ref:`Tag ` objects | Tag information | - +--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | enable_default_propagation | No | Boolean | Whether to enable the Default Route Table Propagation function. The default value is false, indicating that the function is disabled. | - | | | | | - | | | | Default: **false** | - +--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | enable_default_association | No | Boolean | Whether to enable the Default Route Table Association function. The default value is false, indicating that the function is disabled. | - | | | | | - | | | | Default: **false** | - +--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone_ids | Yes | Array of strings | AZs where the enterprise router is located | - | | | | | - | | | | Minimum: **0** | - | | | | | - | | | | Maximum: **128** | - +--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | auto_accept_shared_attachments | No | Boolean | Whether to enable Auto Accept Shared Attachments. The default value is false, indicating that the function is disabled. | - | | | | | - | | | | Default: **false** | - +--------------------------------+-----------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------------+-----------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +================================+=================+===================================================================+===========================================================================================================================================+ + | name | Yes | String | Enterprise router name | + | | | | | + | | | | Minimum: **1** | + | | | | | + | | | | Maximum: **64** | + +--------------------------------+-----------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Supplementary information about an enterprise router | + | | | | | + | | | | Minimum: **0** | + | | | | | + | | | | Maximum: **255** | + +--------------------------------+-----------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | asn | Yes | Long | Enterprise router BGP ASN | + +--------------------------------+-----------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project ID | + +--------------------------------+-----------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | No | Array of :ref:`Tag ` objects | Tag information | + +--------------------------------+-----------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_default_propagation | No | Boolean | Whether to enable the Default Route Table Propagation function. The default value is **false**, indicating that the function is disabled. | + | | | | | + | | | | Default: **false** | + +--------------------------------+-----------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_default_association | No | Boolean | Whether to enable the Default Route Table Association function. The default value is **false**, indicating that the function is disabled. | + | | | | | + | | | | Default: **false** | + +--------------------------------+-----------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_ids | Yes | Array of strings | AZs where the enterprise router is located | + | | | | | + | | | | Minimum: **0** | + | | | | | + | | | | Maximum: **128** | + +--------------------------------+-----------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | auto_accept_shared_attachments | No | Boolean | Whether to enable Auto Accept Shared Attachments. The default value is **false**, indicating that the function is disabled. | + | | | | | + | | | | Default: **false** | + +--------------------------------+-----------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ .. _createenterpriserouter__request_tag: @@ -141,45 +137,41 @@ Response Parameters .. table:: **Table 8** EnterpriseRouter - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +====================================+====================================================================+=======================================================================================================================================+ - | id | String | Enterprise router ID | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Enterprise router name | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Supplementary information about an enterprise router | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | state | String | Running status | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of :ref:`Tag ` objects | Tag information | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | charge_mode | String | Billing mode: Pay-per-use | - | | | | - | | | Default: **postPaid** | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Creation time | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Update time | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project ID | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | asn | Long | Enterprise router BGP ASN | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | enable_default_propagation | Boolean | Whether to enable the Default Route Table Propagation function. The default value is false, indicating that the function is disabled. | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | enable_default_association | Boolean | Whether to enable the Default Route Table Association function. The default value is false, indicating that the function is disabled. | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | default_propagation_route_table_id | String | Default propagation route table ID | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | default_association_route_table_id | String | Default association route table ID | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone_ids | Array of strings | AZs where the enterprise router is located | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | auto_accept_shared_attachments | Boolean | Whether to automatically accept shared attachments. The default value is false, indicating that the function is disabled. | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +====================================+====================================================================+===========================================================================================================================================+ + | id | String | Enterprise router ID | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Enterprise router name | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Supplementary information about an enterprise router | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | Enterprise router status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`Tag ` objects | Tag information | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | asn | Long | Enterprise router BGP ASN | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_default_propagation | Boolean | Whether to enable the Default Route Table Propagation function. The default value is **false**, indicating that the function is disabled. | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_default_association | Boolean | Whether to enable the Default Route Table Association function. The default value is **false**, indicating that the function is disabled. | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | default_propagation_route_table_id | String | Default propagation route table ID | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | default_association_route_table_id | String | Default association route table ID | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_ids | Array of strings | AZs where the enterprise router is located | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | auto_accept_shared_attachments | Boolean | Whether to automatically accept shared attachments. The default value is **false**, indicating that the function is disabled. | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ .. _createenterpriserouter__response_tag: diff --git a/api-ref/source/apis/enterprise_routers/querying_details_about_an_enterprise_router.rst b/api-ref/source/apis/enterprise_routers/querying_details_about_an_enterprise_router.rst index 4704d27..269e8f2 100644 --- a/api-ref/source/apis/enterprise_routers/querying_details_about_an_enterprise_router.rst +++ b/api-ref/source/apis/enterprise_routers/querying_details_about_an_enterprise_router.rst @@ -48,45 +48,41 @@ Response Parameters .. table:: **Table 3** EnterpriseRouter - +------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +====================================+==================================================================+=======================================================================================================================================+ - | id | String | Enterprise router ID | - +------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Enterprise router name | - +------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Supplementary information about an enterprise router | - +------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | state | String | Running status | - +------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of :ref:`Tag ` objects | Tag information | - +------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | charge_mode | String | Billing mode: Pay-per-use | - | | | | - | | | Default: **postPaid** | - +------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Creation time | - +------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Update time | - +------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project ID | - +------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID | - +------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | asn | Long | Enterprise router BGP ASN | - +------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | enable_default_propagation | Boolean | Whether to enable the Default Route Table Propagation function. The default value is false, indicating that the function is disabled. | - +------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | enable_default_association | Boolean | Whether to enable the Default Route Table Association function. The default value is false, indicating that the function is disabled. | - +------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | default_propagation_route_table_id | String | Default propagation route table ID | - +------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | default_association_route_table_id | String | Default association route table ID | - +------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone_ids | Array of strings | AZs where the enterprise router is located | - +------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | auto_accept_shared_attachments | Boolean | Whether to automatically accept shared attachments. The default value is false, indicating that the function is disabled. | - +------------------------------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +====================================+==================================================================+===========================================================================================================================================+ + | id | String | Enterprise router ID | + +------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Enterprise router name | + +------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Supplementary information about an enterprise router | + +------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | Enterprise router status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** | + +------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`Tag ` objects | Tag information | + +------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID | + +------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID | + +------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | asn | Long | Enterprise router BGP ASN | + +------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_default_propagation | Boolean | Whether to enable the Default Route Table Propagation function. The default value is **false**, indicating that the function is disabled. | + +------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_default_association | Boolean | Whether to enable the Default Route Table Association function. The default value is **false**, indicating that the function is disabled. | + +------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | default_propagation_route_table_id | String | Default propagation route table ID | + +------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | default_association_route_table_id | String | Default association route table ID | + +------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_ids | Array of strings | AZs where the enterprise router is located | + +------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | auto_accept_shared_attachments | Boolean | Whether to automatically accept shared attachments. The default value is **false**, indicating that the function is disabled. | + +------------------------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ .. _showenterpriserouter__response_tag: diff --git a/api-ref/source/apis/enterprise_routers/querying_enterprise_routers.rst b/api-ref/source/apis/enterprise_routers/querying_enterprise_routers.rst index 8acbe16..b8d9dc2 100644 --- a/api-ref/source/apis/enterprise_routers/querying_enterprise_routers.rst +++ b/api-ref/source/apis/enterprise_routers/querying_enterprise_routers.rst @@ -33,7 +33,7 @@ GET /v3/{project_id}/enterprise-router/instances +-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=======================+=================+=================+=====================================================================================================================================================================+ - | limit | No | Integer | Number of records on each page. Value range: 0 to 2000 | + | limit | No | Integer | Number of records on each page. Value range: **0** to **2000** | | | | | | | | | | Minimum: **0** | | | | | | @@ -53,9 +53,15 @@ GET /v3/{project_id}/enterprise-router/instances +-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | resource_id | No | Array | Attachment resource IDs | +-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_key | No | Array | Sort by ID, name, or state. By default, ID is used. | + | owned_by_self | No | Boolean | Whether the resources belong to the current account. | + | | | | | + | | | | - If the value is **true**, the resources belong to the current account. | + | | | | | + | | | | - If the value is **false**, the resources include those in the current account and those shared with the current account. | +-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_dir | No | Array | Sorting order, including **asc** (ascending order) and **desc** (descending order). The default value is **asc**. | + | sort_key | No | Array | Keyword for sorting. The keyword can be **id**, **name**, or **state**. By default, **id** is used. | + +-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sort_dir | No | Array | Sorting order. There are two value options: **asc** (ascending order) and **desc** (descending order). The default value is **asc**. | +-----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters @@ -84,45 +90,41 @@ Response Parameters .. table:: **Table 4** EnterpriseRouter - +------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +====================================+===================================================================+=======================================================================================================================================+ - | id | String | Enterprise router ID | - +------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Enterprise router name | - +------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Supplementary information about an enterprise router | - +------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | state | String | Running status | - +------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of :ref:`Tag ` objects | Tag information | - +------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | charge_mode | String | Billing mode: Pay-per-use | - | | | | - | | | Default: **postPaid** | - +------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Creation time | - +------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Update time | - +------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project ID | - +------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID | - +------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | asn | Long | Enterprise router BGP ASN | - +------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | enable_default_propagation | Boolean | Whether to enable the Default Route Table Propagation function. The default value is false, indicating that the function is disabled. | - +------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | enable_default_association | Boolean | Whether to enable the Default Route Table Association function. The default value is false, indicating that the function is disabled. | - +------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | default_propagation_route_table_id | String | Default propagation route table ID | - +------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | default_association_route_table_id | String | Default association route table ID | - +------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone_ids | Array of strings | AZs where the enterprise router is located | - +------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | auto_accept_shared_attachments | Boolean | Whether to automatically accept shared attachments. The default value is false, indicating that the function is disabled. | - +------------------------------------+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +====================================+===================================================================+===========================================================================================================================================+ + | id | String | Enterprise router ID | + +------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Enterprise router name | + +------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Supplementary information about an enterprise router | + +------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | Enterprise router status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** | + +------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`Tag ` objects | Tag information | + +------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID | + +------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID | + +------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | asn | Long | Enterprise router BGP ASN | + +------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_default_propagation | Boolean | Whether to enable the Default Route Table Propagation function. The default value is **false**, indicating that the function is disabled. | + +------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_default_association | Boolean | Whether to enable the Default Route Table Association function. The default value is **false**, indicating that the function is disabled. | + +------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | default_propagation_route_table_id | String | Default propagation route table ID | + +------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | default_association_route_table_id | String | Default association route table ID | + +------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_ids | Array of strings | AZs where the enterprise router is located | + +------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | auto_accept_shared_attachments | Boolean | Whether to automatically accept shared attachments. The default value is **false**, indicating that the function is disabled. | + +------------------------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ .. _listenterpriserouters__response_tag: @@ -203,7 +205,7 @@ OK } ], "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9", "page_info" : { - "next_marker" : 2, + "next_marker" : "2", "current_count" : 1 } } diff --git a/api-ref/source/apis/enterprise_routers/updating_an_enterprise_router.rst b/api-ref/source/apis/enterprise_routers/updating_an_enterprise_router.rst index 783a996..315f03a 100644 --- a/api-ref/source/apis/enterprise_routers/updating_an_enterprise_router.rst +++ b/api-ref/source/apis/enterprise_routers/updating_an_enterprise_router.rst @@ -44,31 +44,31 @@ Request Parameters .. table:: **Table 3** UpdateEnterpriseRouter - +------------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================================+=================+=================+===========================================================================================================================+ - | name | No | String | Enterprise router name | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **64** | - +------------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Supplementary information about an enterprise router | - | | | | | - | | | | Minimum: **0** | - | | | | | - | | | | Maximum: **255** | - +------------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ - | enable_default_propagation | No | Boolean | Whether to enable Default Route Table Propagation. | - +------------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ - | enable_default_association | No | Boolean | Whether to enable Default Route Table Association. | - +------------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ - | default_propagation_route_table_id | No | String | Default propagation route table ID | - +------------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ - | default_association_route_table_id | No | String | Default association route table ID | - +------------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ - | auto_accept_shared_attachments | No | Boolean | Whether to automatically accept shared attachments. The default value is false, indicating that the function is disabled. | - +------------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +====================================+=================+=================+===============================================================================================================================+ + | name | No | String | Enterprise router name | + | | | | | + | | | | Minimum: **1** | + | | | | | + | | | | Maximum: **64** | + +------------------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Supplementary information about an enterprise router | + | | | | | + | | | | Minimum: **0** | + | | | | | + | | | | Maximum: **255** | + +------------------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ + | enable_default_propagation | No | Boolean | Whether to enable Default Route Table Propagation. | + +------------------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ + | enable_default_association | No | Boolean | Whether to enable Default Route Table Association. | + +------------------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ + | default_propagation_route_table_id | No | String | Default propagation route table ID | + +------------------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ + | default_association_route_table_id | No | String | Default association route table ID | + +------------------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ + | auto_accept_shared_attachments | No | Boolean | Whether to automatically accept shared attachments. The default value is **false**, indicating that the function is disabled. | + +------------------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -89,45 +89,41 @@ Response Parameters .. table:: **Table 5** EnterpriseRouter - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +====================================+====================================================================+=======================================================================================================================================+ - | id | String | Enterprise router ID | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Enterprise router name | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Supplementary information about an enterprise router | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | state | String | Running status | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of :ref:`Tag ` objects | Tag information | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | charge_mode | String | Billing mode: Pay-per-use | - | | | | - | | | Default: **postPaid** | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Creation time | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Update time | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project ID | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | asn | Long | Enterprise router BGP ASN | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | enable_default_propagation | Boolean | Whether to enable the Default Route Table Propagation function. The default value is false, indicating that the function is disabled. | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | enable_default_association | Boolean | Whether to enable the Default Route Table Association function. The default value is false, indicating that the function is disabled. | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | default_propagation_route_table_id | String | Default propagation route table ID | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | default_association_route_table_id | String | Default association route table ID | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone_ids | Array of strings | AZs where the enterprise router is located | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | auto_accept_shared_attachments | Boolean | Whether to automatically accept shared attachments. The default value is false, indicating that the function is disabled. | - +------------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +====================================+====================================================================+===========================================================================================================================================+ + | id | String | Enterprise router ID | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Enterprise router name | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Supplementary information about an enterprise router | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | Enterprise router status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`Tag ` objects | Tag information | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project ID | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | asn | Long | Enterprise router BGP ASN | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_default_propagation | Boolean | Whether to enable the Default Route Table Propagation function. The default value is **false**, indicating that the function is disabled. | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_default_association | Boolean | Whether to enable the Default Route Table Association function. The default value is **false**, indicating that the function is disabled. | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | default_propagation_route_table_id | String | Default propagation route table ID | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | default_association_route_table_id | String | Default association route table ID | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_ids | Array of strings | AZs where the enterprise router is located | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ + | auto_accept_shared_attachments | Boolean | Whether to automatically accept shared attachments. The default value is **false**, indicating that the function is disabled. | + +------------------------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ .. _updateenterpriserouter__response_tag: @@ -152,6 +148,8 @@ Response Parameters Example Requests ---------------- +Updating an enterprise router to enable Default Route Table Association and Default Route Table Propagation and specify route table + .. code-block:: text PUT https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/instances/94c2b814-99dc-939a-e811-ae84c61ea3ff diff --git a/api-ref/source/apis/flow_logs/creating_a_flow_log.rst b/api-ref/source/apis/flow_logs/creating_a_flow_log.rst index 11a2f4c..edc09e2 100644 --- a/api-ref/source/apis/flow_logs/creating_a_flow_log.rst +++ b/api-ref/source/apis/flow_logs/creating_a_flow_log.rst @@ -66,7 +66,9 @@ Request Parameters | | | | | | | | | Maximum: **255** | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+ - | resource_type | Yes | String | Resource type. | + | resource_type | Yes | String | Type of resource whose flow logs are collected. | + | | | | | + | | | | - VPC attachment | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+ | resource_id | Yes | String | Resource ID | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------+ @@ -104,37 +106,37 @@ Response Parameters .. table:: **Table 7** FlowLog - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=========+========================================================================================================================+ - | id | String | Flow log ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | name | String | Flow log name | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | description | String | Flow log description | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID of the flow log task creator | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | resource_type | String | Resource type. The value is **attachment**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | resource_id | String | Resource ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_group_id | String | Log group ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_stream_id | String | Log stream ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_store_type | String | Flow log storage type | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Time when the flow log was created | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Time when the flow log was updated | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | state | String | Flow log status. The options are **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | enabled | Boolean | Whether to enable flow logs. The options are **true** and **false**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==========================+=========+======================================================================================================================+ + | id | String | Flow log ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | name | String | Flow log name | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | description | String | Flow log description | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID of the flow log task creator | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | Resource type. The value is **attachment**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | Resource ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_group_id | String | Log group ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_stream_id | String | Log stream ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_store_type | String | Flow log storage type | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | state | String | Flow log status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | enabled | Boolean | Whether to enable flow logs. The value can be **true** or **false**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ Example Requests ---------------- @@ -145,6 +147,18 @@ Creating a flow log POST https://{erouter_endpoint}/v3/0605767a9980d5762fbcc00b3537e757/enterprise-router/a43c55e9-4911-4030-90e1-5c2bf6ae6fe2/flow-logs + { + "flow_log" : { + "name" : "flow-log", + "description" : "flow log test", + "resource_type" : "attachment", + "resource_id" : "6f83b848-8331-4271-ac0c-ef94b7686402", + "log_group_id" : "0139393c-eeb2-49f0-bbd4-c5faec6b1497", + "log_stream_id" : "d22c3b44-2f71-470f-83f3-96a8af6956ad", + "log_store_type" : "LTS" + } + } + Example Responses ----------------- diff --git a/api-ref/source/apis/flow_logs/disabling_flow_logs.rst b/api-ref/source/apis/flow_logs/disabling_flow_logs.rst index e9aed75..49b52aa 100644 --- a/api-ref/source/apis/flow_logs/disabling_flow_logs.rst +++ b/api-ref/source/apis/flow_logs/disabling_flow_logs.rst @@ -49,37 +49,37 @@ Response Parameters .. table:: **Table 3** FlowLog - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=========+========================================================================================================================+ - | id | String | Flow log ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | name | String | Flow log name | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | description | String | Flow log description | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID of the flow log task creator | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | resource_type | String | Resource type. The value is **attachment**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | resource_id | String | Resource ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_group_id | String | Log group ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_stream_id | String | Log stream ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_store_type | String | Flow log storage type | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Time when the flow log was created | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Time when the flow log was updated | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | state | String | Flow log status. The options are **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | enabled | Boolean | Whether to enable flow logs. The options are **true** and **false**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==========================+=========+======================================================================================================================+ + | id | String | Flow log ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | name | String | Flow log name | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | description | String | Flow log description | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID of the flow log task creator | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | Resource type. The value is **attachment**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | Resource ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_group_id | String | Log group ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_stream_id | String | Log stream ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_store_type | String | Flow log storage type | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | state | String | Flow log status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | enabled | Boolean | Whether to enable flow logs. The value can be **true** or **false**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ Example Requests ---------------- diff --git a/api-ref/source/apis/flow_logs/enabling_flow_logs.rst b/api-ref/source/apis/flow_logs/enabling_flow_logs.rst index af5fbd9..14296e0 100644 --- a/api-ref/source/apis/flow_logs/enabling_flow_logs.rst +++ b/api-ref/source/apis/flow_logs/enabling_flow_logs.rst @@ -49,37 +49,37 @@ Response Parameters .. table:: **Table 3** FlowLog - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=========+========================================================================================================================+ - | id | String | Flow log ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | name | String | Flow log name | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | description | String | Flow log description | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID of the flow log task creator | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | resource_type | String | Resource type. The value is **attachment**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | resource_id | String | Resource ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_group_id | String | Log group ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_stream_id | String | Log stream ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_store_type | String | Flow log storage type | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Time when the flow log was created | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Time when the flow log was updated | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | state | String | Flow log status. The options are **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | enabled | Boolean | Whether to enable flow logs. The options are **true** and **false**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==========================+=========+======================================================================================================================+ + | id | String | Flow log ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | name | String | Flow log name | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | description | String | Flow log description | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID of the flow log task creator | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | Resource type. The value is **attachment**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | Resource ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_group_id | String | Log group ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_stream_id | String | Log stream ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_store_type | String | Flow log storage type | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | state | String | Flow log status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | enabled | Boolean | Whether to enable flow logs. The value can be **true** or **false**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ Example Requests ---------------- diff --git a/api-ref/source/apis/flow_logs/index.rst b/api-ref/source/apis/flow_logs/index.rst index 9ac9104..d3f3d23 100644 --- a/api-ref/source/apis/flow_logs/index.rst +++ b/api-ref/source/apis/flow_logs/index.rst @@ -6,7 +6,7 @@ Flow Logs ========= - :ref:`Creating a Flow Log ` -- :ref:`Querying the Flow Log List ` +- :ref:`Querying Flow Logs ` - :ref:`Querying Details About a Flow Log ` - :ref:`Updating a Flow Log ` - :ref:`Deleting a Flow Log ` @@ -18,7 +18,7 @@ Flow Logs :hidden: creating_a_flow_log - querying_the_flow_log_list + querying_flow_logs querying_details_about_a_flow_log updating_a_flow_log deleting_a_flow_log diff --git a/api-ref/source/apis/flow_logs/querying_details_about_a_flow_log.rst b/api-ref/source/apis/flow_logs/querying_details_about_a_flow_log.rst index 144db11..e64b7cc 100644 --- a/api-ref/source/apis/flow_logs/querying_details_about_a_flow_log.rst +++ b/api-ref/source/apis/flow_logs/querying_details_about_a_flow_log.rst @@ -49,42 +49,42 @@ Response Parameters .. table:: **Table 3** FlowLog - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=========+========================================================================================================================+ - | id | String | Flow log ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | name | String | Flow log name | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | description | String | Flow log description | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID of the flow log task creator | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | resource_type | String | Resource type. The value is **attachment**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | resource_id | String | Resource ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_group_id | String | Log group ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_stream_id | String | Log stream ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_store_type | String | Flow log storage type | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Time when the flow log was created | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Time when the flow log was updated | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | state | String | Flow log status. The options are **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | enabled | Boolean | Whether to enable flow logs. The options are **true** and **false**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==========================+=========+======================================================================================================================+ + | id | String | Flow log ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | name | String | Flow log name | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | description | String | Flow log description | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID of the flow log task creator | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | Resource type. The value is **attachment**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | Resource ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_group_id | String | Log group ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_stream_id | String | Log stream ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_store_type | String | Flow log storage type | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | state | String | Flow log status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | enabled | Boolean | Whether to enable flow logs. The value can be **true** or **false**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ Example Requests ---------------- -Querying the flow log list +Querying flow logs .. code-block:: text diff --git a/api-ref/source/apis/flow_logs/querying_the_flow_log_list.rst b/api-ref/source/apis/flow_logs/querying_flow_logs.rst similarity index 86% rename from api-ref/source/apis/flow_logs/querying_the_flow_log_list.rst rename to api-ref/source/apis/flow_logs/querying_flow_logs.rst index a46dc0e..eea14d1 100644 --- a/api-ref/source/apis/flow_logs/querying_the_flow_log_list.rst +++ b/api-ref/source/apis/flow_logs/querying_flow_logs.rst @@ -2,8 +2,8 @@ .. _ListFlowLogs: -Querying the Flow Log List -========================== +Querying Flow Logs +================== Function -------- @@ -42,7 +42,7 @@ GET /v3/{project_id}/enterprise-router/{er_id}/flow-logs +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | resource_id | No | Array | Attachment resource IDs | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Number of records on each page. Value range: 0 to 2000 | + | limit | No | Integer | Number of records on each page. Value range: **0** to **2000** | | | | | | | | | | Minimum: **0** | | | | | | @@ -54,9 +54,9 @@ GET /v3/{project_id}/enterprise-router/{er_id}/flow-logs | | | | | | | | | Maximum: **128** | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_key | No | Array | Sort by ID, name, or state. By default, ID is used. | + | sort_key | No | Array | Keyword for sorting. The keyword can be **id**, **name**, or **state**. By default, **id** is used. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_dir | No | Array | Sorting order, including **asc** (ascending order) and **desc** (descending order). The default value is **asc**. | + | sort_dir | No | Array | Sorting order. There are two value options: **asc** (ascending order) and **desc** (descending order). The default value is **asc**. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters @@ -85,37 +85,37 @@ Response Parameters .. table:: **Table 4** FlowLog - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=========+========================================================================================================================+ - | id | String | Flow log ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | name | String | Flow log name | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | description | String | Flow log description | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID of the flow log task creator | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | resource_type | String | Resource type. The value is **attachment**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | resource_id | String | Resource ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_group_id | String | Log group ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_stream_id | String | Log stream ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_store_type | String | Flow log storage type | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Time when the flow log was created | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Time when the flow log was updated | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | state | String | Flow log status. The options are **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | enabled | Boolean | Whether to enable flow logs. The options are **true** and **false**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==========================+=========+======================================================================================================================+ + | id | String | Flow log ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | name | String | Flow log name | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | description | String | Flow log description | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID of the flow log task creator | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | Resource type. The value is **attachment**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | Resource ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_group_id | String | Log group ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_stream_id | String | Log stream ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_store_type | String | Flow log storage type | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | state | String | Flow log status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | enabled | Boolean | Whether to enable flow logs. The value can be **true** or **false**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ .. _listflowlogs__response_pageinfo: @@ -132,7 +132,7 @@ Response Parameters Example Requests ---------------- -Querying the flow log list +Querying flow logs .. code-block:: text @@ -152,7 +152,6 @@ OK "id" : "b216bc1d-5963-41a7-89f9-779a5128c5ac", "name" : "flow_log", "project_id" : "0605767a9980d5762fbcc00b3537e757", - "domain_id" : "0605767a9980d5762fbcc00b3537e757", "resource_type" : "attachment", "resource_id" : "6f83b848-8331-4271-ac0c-ef94b7686402", "log_group_id" : "0139393c-eeb2-49f0-bbd4-c5faec6b1497", @@ -166,7 +165,7 @@ OK "description" : "Flow Logs" } ], "page_info" : { - "next_marker" : 1, + "next_marker" : "1", "current_count" : 1 }, "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9" diff --git a/api-ref/source/apis/flow_logs/updating_a_flow_log.rst b/api-ref/source/apis/flow_logs/updating_a_flow_log.rst index e211a3e..0a247d3 100644 --- a/api-ref/source/apis/flow_logs/updating_a_flow_log.rst +++ b/api-ref/source/apis/flow_logs/updating_a_flow_log.rst @@ -63,37 +63,37 @@ Response Parameters .. table:: **Table 4** FlowLog - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=========+========================================================================================================================+ - | id | String | Flow log ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | name | String | Flow log name | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | description | String | Flow log description | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID of the flow log task creator | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | resource_type | String | Resource type. The value is **attachment**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | resource_id | String | Resource ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_group_id | String | Log group ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_stream_id | String | Log stream ID | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_store_type | String | Flow log storage type | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Time when the flow log was created | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Time when the flow log was updated | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | state | String | Flow log status. The options are **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ - | enabled | Boolean | Whether to enable flow logs. The options are **true** and **false**. | - +--------------------------+---------+------------------------------------------------------------------------------------------------------------------------+ + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==========================+=========+======================================================================================================================+ + | id | String | Flow log ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | name | String | Flow log name | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | description | String | Flow log description | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID of the flow log task creator | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | Resource type. The value is **attachment**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | Resource ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_group_id | String | Log group ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_stream_id | String | Log stream ID | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_store_type | String | Flow log storage type | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | log_aggregation_interval | Integer | Log aggregation time, in seconds. The value ranges from **60** to **600**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | state | String | Flow log status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ + | enabled | Boolean | Whether to enable flow logs. The value can be **true** or **false**. | + +--------------------------+---------+----------------------------------------------------------------------------------------------------------------------+ Example Requests ---------------- @@ -104,6 +104,11 @@ Updating a flow log PUT https://{erouter_endpoint}/v3/0605767a9980d5762fbcc00b3537e757/enterprise-router/6f83b848-8331-4271-ac0c-ef94b7686402/flow_logs/b216bc1d-5963-41a7-89f9-779a5128c5ac + { + "name" : "flow_log_update", + "description" : "flow log update test" + } + Example Responses ----------------- diff --git a/api-ref/source/apis/index.rst b/api-ref/source/apis/index.rst index c17201d..2fd413a 100644 --- a/api-ref/source/apis/index.rst +++ b/api-ref/source/apis/index.rst @@ -13,6 +13,7 @@ APIs - :ref:`Propagations ` - :ref:`Routes ` - :ref:`Tags ` +- :ref:`Quota Management ` - :ref:`AZs ` - :ref:`Flow Logs ` @@ -28,5 +29,6 @@ APIs propagations/index routes/index tags/index + quota_management/index azs/index flow_logs/index diff --git a/api-ref/source/apis/propagations/creating_a_route_propagation.rst b/api-ref/source/apis/propagations/creating_a_route_propagation.rst index ad7dcb1..0c5df2e 100644 --- a/api-ref/source/apis/propagations/creating_a_route_propagation.rst +++ b/api-ref/source/apis/propagations/creating_a_route_propagation.rst @@ -91,31 +91,31 @@ Response Parameters .. table:: **Table 7** Propagation - +----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+=================================================================================+=========================================================================+ - | id | String | Unique association ID | - +----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | project_id | String | Project ID | - +----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | er_id | String | Enterprise router ID | - +----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | route_table_id | String | Unique ID of the route table | - +----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | attachment_id | String | Unique ID of the attachment | - +----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | resource_type | String | Attachment type | - +----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | resource_id | String | Unique ID of the attachment | - +----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | route_policy | :ref:`ImportRoutePolicy ` object | Route that controls inbound traffic | - +----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | state | String | Status | - +----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | created_at | String | Time when the resource was created UTC time Format: YYYY-MM-DDTHH:MM:SS | - +----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | updated_at | String | Time when the resource was updated UTC time Format: YYYY-MM-DDTHH:MM:SS | - +----------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------+ + +----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | Parameter | Type | Description | + +================+=================================================================================+=====================================================================+ + | id | String | Unique association ID | + +----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | project_id | String | Project ID | + +----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | er_id | String | Enterprise router ID | + +----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | route_table_id | String | Unique ID of the route table | + +----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | attachment_id | String | Unique ID of the attachment | + +----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | resource_type | String | Attachment type | + +----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | resource_id | String | Unique ID of the attachment | + +----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | route_policy | :ref:`ImportRoutePolicy ` object | Route that controls inbound traffic | + +----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | state | String | Status | + +----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | created_at | String | Creation time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. | + +----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | updated_at | String | Update time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. | + +----------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------+ .. _enablepropagation__response_importroutepolicy: diff --git a/api-ref/source/apis/propagations/querying_route_propagations.rst b/api-ref/source/apis/propagations/querying_route_propagations.rst index 27b3874..82f967e 100644 --- a/api-ref/source/apis/propagations/querying_route_propagations.rst +++ b/api-ref/source/apis/propagations/querying_route_propagations.rst @@ -35,7 +35,7 @@ GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/pro +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+=================+=====================================================================================================================================================================+ - | limit | No | Integer | Number of records on each page. Value range: 0 to 2000 | + | limit | No | Integer | Number of records on each page. Value range: **0** to **2000** | | | | | | | | | | Minimum: **0** | | | | | | @@ -49,19 +49,17 @@ GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/pro +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | attachment_id | No | Array | Attachment ID | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | No | Array | Attachment type: | + | resource_type | No | Array | Attachment type. Value options are as follows: | | | | | | | | | | - **vpc**: VPC attachment | | | | | | - | | | | - **vpn**: VPN gateway attachment | - | | | | | | | | | - **vgw**: virtual gateway attachment | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | state | No | Array | Enterprise router status | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_key | No | Array | Sort by ID, name, or state. By default, ID is used. | + | sort_key | No | Array | Keyword for sorting. The keyword can be **id**, **name**, or **state**. By default, **id** is used. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_dir | No | Array | Sorting order, including **asc** (ascending order) and **desc** (descending order). The default value is **asc**. | + | sort_dir | No | Array | Sorting order. There are two value options: **asc** (ascending order) and **desc** (descending order). The default value is **asc**. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters @@ -76,45 +74,47 @@ Response Parameters .. table:: **Table 3** Response body parameters - +--------------+------------------------------------------------------------------------------+------------------------------+ - | Parameter | Type | Description | - +==============+==============================================================================+==============================+ - | propagations | Array of :ref:`Propagation ` objects | Route propagations | - +--------------+------------------------------------------------------------------------------+------------------------------+ - | request_id | String | Request ID | - +--------------+------------------------------------------------------------------------------+------------------------------+ - | page_info | :ref:`PageInfo ` object | Pagination query information | - +--------------+------------------------------------------------------------------------------+------------------------------+ + +-----------------------+------------------------------------------------------------------------------+------------------------------+ + | Parameter | Type | Description | + +=======================+==============================================================================+==============================+ + | propagations | Array of :ref:`Propagation ` objects | Route propagations | + | | | | + | | | Array Length: **0 - 2000** | + +-----------------------+------------------------------------------------------------------------------+------------------------------+ + | request_id | String | Request ID | + +-----------------------+------------------------------------------------------------------------------+------------------------------+ + | page_info | :ref:`PageInfo ` object | Pagination query information | + +-----------------------+------------------------------------------------------------------------------+------------------------------+ .. _listpropagations__response_propagation: .. table:: **Table 4** Propagation - +----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+================================================================================+=========================================================================+ - | id | String | Unique association ID | - +----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | project_id | String | Project ID | - +----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | er_id | String | Enterprise router ID | - +----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | route_table_id | String | Unique ID of the route table | - +----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | attachment_id | String | Unique ID of the attachment | - +----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | resource_type | String | Attachment type | - +----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | resource_id | String | Unique ID of the attachment | - +----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | route_policy | :ref:`ImportRoutePolicy ` object | Route that controls inbound traffic | - +----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | state | String | Status | - +----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | created_at | String | Time when the resource was created UTC time Format: YYYY-MM-DDTHH:MM:SS | - +----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ - | updated_at | String | Time when the resource was updated UTC time Format: YYYY-MM-DDTHH:MM:SS | - +----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+ + +----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | Parameter | Type | Description | + +================+================================================================================+=====================================================================+ + | id | String | Unique association ID | + +----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | project_id | String | Project ID | + +----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | er_id | String | Enterprise router ID | + +----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | route_table_id | String | Unique ID of the route table | + +----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | attachment_id | String | Unique ID of the attachment | + +----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | resource_type | String | Attachment type | + +----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | resource_id | String | Unique ID of the attachment | + +----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | route_policy | :ref:`ImportRoutePolicy ` object | Route that controls inbound traffic | + +----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | state | String | Status | + +----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | created_at | String | Creation time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. | + +----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ + | updated_at | String | Update time. It is UTC time in the format of YYYY-MM-DDTHH:MM:SS. | + +----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------+ .. _listpropagations__response_importroutepolicy: @@ -176,7 +176,7 @@ OK "updated_at" : "2020-03-11T15:13:31Z" } ], "page_info" : { - "next_marker" : 1, + "next_marker" : "1", "current_count" : 1 }, "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9" diff --git a/api-ref/source/apis/quota_management/index.rst b/api-ref/source/apis/quota_management/index.rst new file mode 100644 index 0000000..a9df082 --- /dev/null +++ b/api-ref/source/apis/quota_management/index.rst @@ -0,0 +1,14 @@ +:original_name: QuotaManager.html + +.. _QuotaManager: + +Quota Management +================ + +- :ref:`Querying Quotas ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_quotas diff --git a/api-ref/source/apis/quota_management/querying_quotas.rst b/api-ref/source/apis/quota_management/querying_quotas.rst new file mode 100644 index 0000000..48c802c --- /dev/null +++ b/api-ref/source/apis/quota_management/querying_quotas.rst @@ -0,0 +1,125 @@ +:original_name: ShowQuotas.html + +.. _ShowQuotas: + +Querying Quotas +=============== + +Function +-------- + +This API is used to query the used quotas of resources, such as enterprise routers and VPC attachments. + +URI +--- + +GET /v3/{project_id}/enterprise-router/quotas + +.. table:: **Table 1** Path Parameters + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID + ========== ========= ====== =========== + +.. 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 | + | | | | | + | | | | - **vpc_attachment**: total and used quotas of VPC attachments | + | | | | | + | | | | - **route_table**: total and used quotas of route tables | + | | | | | + | | | | - **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 | + | | | | | + | | | | - **flow_log**: total and used quotas of flow logs that can be created for each attachment | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+ + | erId | No | Object | Enterprise router ID | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+ + | routeTableId | No | Object | Route table ID | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+ + | vpcId | No | Object | VPC ID | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameters + + +-----------+------------------------------------------------------------+--------------------+ + | Parameter | Type | Description | + +===========+============================================================+====================+ + | quotas | Array of :ref:`Quota ` objects | Used quota details | + +-----------+------------------------------------------------------------+--------------------+ + +.. _showquotas__response_quota: + +.. table:: **Table 4** Quota + + +-------------+--------+---------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=============+========+===========================================================================+ + | quota_key | String | Quota type | + +-------------+--------+---------------------------------------------------------------------------+ + | quota_limit | Long | Available quota. The value **-1** indicates that there is no quota limit. | + +-------------+--------+---------------------------------------------------------------------------+ + | used | Long | Used quota | + +-------------+--------+---------------------------------------------------------------------------+ + | unit | String | Measurement unit of used quotas | + +-------------+--------+---------------------------------------------------------------------------+ + +Example Requests +---------------- + +Querying the resource quotas + +.. code-block:: text + + GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/quotas + +Example Responses +----------------- + +**Status code: 200** + +The quota is queried. + +.. code-block:: + + { + "quotas" : [ { + "quota_key" : "er_instance", + "quota_limit" : 1, + "used" : 0, + "unit" : "count" + } ] + } + +Status Codes +------------ + +=========== ===================== +Status Code Description +=========== ===================== +200 The quota is queried. +=========== ===================== + +Error Codes +----------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/route_tables/deleting_a_route_table.rst b/api-ref/source/apis/route_tables/deleting_a_route_table.rst index ea08510..82d5dd7 100644 --- a/api-ref/source/apis/route_tables/deleting_a_route_table.rst +++ b/api-ref/source/apis/route_tables/deleting_a_route_table.rst @@ -53,7 +53,7 @@ Status Codes =========== =========== Status Code Description =========== =========== -202 No Content +202 Accepted =========== =========== Error Codes diff --git a/api-ref/source/apis/route_tables/querying_route_tables.rst b/api-ref/source/apis/route_tables/querying_route_tables.rst index bfaf7e2..a4fc1ca 100644 --- a/api-ref/source/apis/route_tables/querying_route_tables.rst +++ b/api-ref/source/apis/route_tables/querying_route_tables.rst @@ -13,7 +13,9 @@ This API is used to query route tables. Constraints ----------- -Pagination query is supported. The supported query criteria are **state**, **is_default_propagation_route_table**, and **is_default_association_route_table**. Only sorting by a single field (**id**, **name**, **description**, **created_at**, or **updated_at**) is supported. +- Pagination query is supported. The supported query criteria are **state**, **is_default_propagation_route_table**, and **is_default_association_route_table**. + +- Only sorting by a single field (**id**, **name**, **description**, **created_at**, or **updated_at**) is supported. URI --- @@ -34,7 +36,7 @@ GET /v3/{project_id}/enterprise-router/{er_id}/route-tables +------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +==============================+=================+=================+=====================================================================================================================================================================+ - | limit | No | Integer | Number of records on each page. Value range: 0 to 2000 | + | limit | No | Integer | Number of records on each page. Value range: **0** to **2000** | | | | | | | | | | Minimum: **0** | | | | | | @@ -48,13 +50,13 @@ GET /v3/{project_id}/enterprise-router/{er_id}/route-tables +------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | state | No | Array | Status | +------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_default_propagation_table | No | Boolean | Whether the route table is the default propagation route table. | + | is_default_propagation_table | No | Boolean | Whether the route table is the default propagation route table | +------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_default_association_table | No | Boolean | Whether the route table is the default association route table. | + | is_default_association_table | No | Boolean | Whether the route table is the default association route table | +------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_key | No | Array | Sort by ID, name, or state. By default, ID is used. | + | sort_key | No | Array | Keyword for sorting. The keyword can be **id**, **name**, or **state**. By default, **id** is used. | +------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_dir | No | Array | Sorting order, including **asc** (ascending order) and **desc** (descending order). The default value is **asc**. | + | sort_dir | No | Array | Sorting order. There are two value options: **asc** (ascending order) and **desc** (descending order). The default value is **asc**. | +------------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters @@ -180,7 +182,7 @@ OK } ] } ], "page_info" : { - "next_marker" : 1, + "next_marker" : "1", "current_count" : 2 }, "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9" diff --git a/api-ref/source/apis/route_tables/updating_route_table_information.rst b/api-ref/source/apis/route_tables/updating_route_table_information.rst index c6b422b..b5c6cbf 100644 --- a/api-ref/source/apis/route_tables/updating_route_table_information.rst +++ b/api-ref/source/apis/route_tables/updating_route_table_information.rst @@ -122,6 +122,8 @@ Response Parameters Example Requests ---------------- +Changing the name of a route table of an enterprise router to **new-rtb** + .. code-block:: text PUT https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/915a14a6-867b-4af7-83d1-70efceb146f5/route-tables/4ab54142-7c92-48ad-8288-77727a231052 diff --git a/api-ref/source/apis/routes/creating_a_static_route.rst b/api-ref/source/apis/routes/creating_a_static_route.rst index bfef052..7bcc9c8 100644 --- a/api-ref/source/apis/routes/creating_a_static_route.rst +++ b/api-ref/source/apis/routes/creating_a_static_route.rst @@ -97,47 +97,45 @@ Response Parameters .. table:: **Table 7** Route - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ - | Parameter | Type | Description | - +================+=======================================================================================+========================================+ - | id | String | Route ID | - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ - | type | String | Route type | - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ - | state | String | Route status | - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ - | is_blackhole | Boolean | Whether the route is a blackhole route | - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ - | destination | String | Destination address of the route | - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ - | attachments | Array of :ref:`RouteAttachment ` objects | Next hops | - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ - | route_table_id | String | Route table ID | - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ - | created_at | String | Creation time | - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ - | updated_at | String | Update time | - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +================+=======================================================================================+===================================================================================================================+ + | id | String | Route ID | + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | type | String | Route type. The value is **static**. | + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | state | String | Route status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** | + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | is_blackhole | Boolean | Whether the route is a blackhole route | + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | destination | String | Destination address of the route | + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | attachments | Array of :ref:`RouteAttachment ` objects | Next hops | + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | route_table_id | String | Route table ID | + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ .. _createstaticroute__response_routeattachment: .. table:: **Table 8** RouteAttachment - +-----------------------+-----------------------+----------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================+ - | resource_id | String | Attached resource ID | - +-----------------------+-----------------------+----------------------------------------+ - | resource_type | String | Attachment type: | - | | | | - | | | - **vpc**: VPC attachment | - | | | | - | | | - **vpn**: VPN gateway attachment | - | | | | - | | | - **vgw**: virtual gateway attachment | - +-----------------------+-----------------------+----------------------------------------+ - | attachment_id | String | Attachment ID | - +-----------------------+-----------------------+----------------------------------------+ + +-----------------------+-----------------------+------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+================================================+ + | resource_id | String | Attached resource ID | + +-----------------------+-----------------------+------------------------------------------------+ + | resource_type | String | Attachment type. Value options are as follows: | + | | | | + | | | - **vpc**: VPC attachment | + | | | | + | | | - **vgw**: virtual gateway attachment | + +-----------------------+-----------------------+------------------------------------------------+ + | attachment_id | String | Attachment ID | + +-----------------------+-----------------------+------------------------------------------------+ Example Requests ---------------- diff --git a/api-ref/source/apis/routes/index.rst b/api-ref/source/apis/routes/index.rst index 80ef7cd..771bfdb 100644 --- a/api-ref/source/apis/routes/index.rst +++ b/api-ref/source/apis/routes/index.rst @@ -9,7 +9,7 @@ Routes - :ref:`Updating a Static Route ` - :ref:`Querying Details About a Static Route ` - :ref:`Querying Static Routes ` -- :ref:`Querying Valid Routes ` +- :ref:`Querying Effective Routes ` - :ref:`Deleting a Static Route ` .. toctree:: @@ -20,5 +20,5 @@ Routes updating_a_static_route querying_details_about_a_static_route querying_static_routes - querying_valid_routes + querying_effective_routes deleting_a_static_route diff --git a/api-ref/source/apis/routes/querying_details_about_a_static_route.rst b/api-ref/source/apis/routes/querying_details_about_a_static_route.rst index 9f3bca6..ab74a67 100644 --- a/api-ref/source/apis/routes/querying_details_about_a_static_route.rst +++ b/api-ref/source/apis/routes/querying_details_about_a_static_route.rst @@ -49,47 +49,45 @@ Response Parameters .. table:: **Table 3** Route - +----------------+-------------------------------------------------------------------------------------+----------------------------------------+ - | Parameter | Type | Description | - +================+=====================================================================================+========================================+ - | id | String | Route ID | - +----------------+-------------------------------------------------------------------------------------+----------------------------------------+ - | type | String | Route type | - +----------------+-------------------------------------------------------------------------------------+----------------------------------------+ - | state | String | Route status | - +----------------+-------------------------------------------------------------------------------------+----------------------------------------+ - | is_blackhole | Boolean | Whether the route is a blackhole route | - +----------------+-------------------------------------------------------------------------------------+----------------------------------------+ - | destination | String | Destination address of the route | - +----------------+-------------------------------------------------------------------------------------+----------------------------------------+ - | attachments | Array of :ref:`RouteAttachment ` objects | Next hops | - +----------------+-------------------------------------------------------------------------------------+----------------------------------------+ - | route_table_id | String | Route table ID | - +----------------+-------------------------------------------------------------------------------------+----------------------------------------+ - | created_at | String | Creation time | - +----------------+-------------------------------------------------------------------------------------+----------------------------------------+ - | updated_at | String | Update time | - +----------------+-------------------------------------------------------------------------------------+----------------------------------------+ + +----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +================+=====================================================================================+===================================================================================================================+ + | id | String | Route ID | + +----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | type | String | Route type. The value is **static**. | + +----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | state | String | Route status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** | + +----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | is_blackhole | Boolean | Whether the route is a blackhole route | + +----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | destination | String | Destination address of the route | + +----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | attachments | Array of :ref:`RouteAttachment ` objects | Next hops | + +----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | route_table_id | String | Route table ID | + +----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +----------------+-------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ .. _showstaticroute__response_routeattachment: .. table:: **Table 4** RouteAttachment - +-----------------------+-----------------------+----------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================+ - | resource_id | String | Attached resource ID | - +-----------------------+-----------------------+----------------------------------------+ - | resource_type | String | Attachment type: | - | | | | - | | | - **vpc**: VPC attachment | - | | | | - | | | - **vpn**: VPN gateway attachment | - | | | | - | | | - **vgw**: virtual gateway attachment | - +-----------------------+-----------------------+----------------------------------------+ - | attachment_id | String | Attachment ID | - +-----------------------+-----------------------+----------------------------------------+ + +-----------------------+-----------------------+------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+================================================+ + | resource_id | String | Attached resource ID | + +-----------------------+-----------------------+------------------------------------------------+ + | resource_type | String | Attachment type. Value options are as follows: | + | | | | + | | | - **vpc**: VPC attachment | + | | | | + | | | - **vgw**: virtual gateway attachment | + +-----------------------+-----------------------+------------------------------------------------+ + | attachment_id | String | Attachment ID | + +-----------------------+-----------------------+------------------------------------------------+ Example Requests ---------------- diff --git a/api-ref/source/apis/routes/querying_valid_routes.rst b/api-ref/source/apis/routes/querying_effective_routes.rst similarity index 66% rename from api-ref/source/apis/routes/querying_valid_routes.rst rename to api-ref/source/apis/routes/querying_effective_routes.rst index e613337..d50e3b1 100644 --- a/api-ref/source/apis/routes/querying_valid_routes.rst +++ b/api-ref/source/apis/routes/querying_effective_routes.rst @@ -2,13 +2,13 @@ .. _ListEffectiveRoutes: -Querying Valid Routes -===================== +Querying Effective Routes +========================= Function -------- -This API is used to query valid routes. Pagination query is supported. +This API is used to query effective routes. Pagination query is supported. URI --- @@ -26,31 +26,29 @@ GET /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/routes .. table:: **Table 2** Query Parameters - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================================================================================================================+ - | limit | No | Integer | Number of records on each page. Value range: 0 to 2000 | - | | | | | - | | | | Minimum: **0** | - | | | | | - | | | | Maximum: **2000** | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | marker | No | String | ID of the last enterprise router on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit. | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **128** | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | destination | No | Array | Destination address of the route | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | No | Array | Attachment type: | - | | | | | - | | | | - **vpc**: VPC attachment | - | | | | | - | | | | - **vpn**: VPN gateway attachment | - | | | | | - | | | | - **vgw**: virtual gateway attachment | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=========================================================================================================================================================+ + | limit | No | Integer | Number of records on each page. Value range: **0** to **2000** | + | | | | | + | | | | Minimum: **0** | + | | | | | + | | | | Maximum: **2000** | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | marker | No | String | ID of the last route on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit. | + | | | | | + | | | | Minimum: **1** | + | | | | | + | | | | Maximum: **128** | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | destination | No | Array | Destination address of the route | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | No | Array | Attachment type. Value options are as follows: | + | | | | | + | | | | - **vpc**: VPC attachment | + | | | | | + | | | | - **vgw**: virtual gateway attachment | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ @@ -78,41 +76,37 @@ 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 ` objects | Next hops of the routes | - +------------------+-----------------------------------------------------------------------------------------+----------------------------------------+ - | is_blackhole | Boolean | Whether the route is a blackhole route | - +------------------+-----------------------------------------------------------------------------------------+----------------------------------------+ - | route_type | String | Route type | - +------------------+-----------------------------------------------------------------------------------------+----------------------------------------+ - | address_group_id | String | IP address group ID | - +------------------+-----------------------------------------------------------------------------------------+----------------------------------------+ + +--------------+-----------------------------------------------------------------------------------------+-----------------------------------------------------------+ + | Parameter | Type | Description | + +==============+=========================================================================================+===========================================================+ + | route_id | String | Route ID | + +--------------+-----------------------------------------------------------------------------------------+-----------------------------------------------------------+ + | destination | String | Destination address of the route | + +--------------+-----------------------------------------------------------------------------------------+-----------------------------------------------------------+ + | next_hops | Array of :ref:`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** | + +--------------+-----------------------------------------------------------------------------------------+-----------------------------------------------------------+ .. _listeffectiveroutes__response_routeattachment: .. table:: **Table 5** RouteAttachment - +-----------------------+-----------------------+----------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================+ - | resource_id | String | Attached resource ID | - +-----------------------+-----------------------+----------------------------------------+ - | resource_type | String | Attachment type: | - | | | | - | | | - **vpc**: VPC attachment | - | | | | - | | | - **vpn**: VPN gateway attachment | - | | | | - | | | - **vgw**: virtual gateway attachment | - +-----------------------+-----------------------+----------------------------------------+ - | attachment_id | String | Attachment ID | - +-----------------------+-----------------------+----------------------------------------+ + +-----------------------+-----------------------+------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+================================================+ + | resource_id | String | Attached resource ID | + +-----------------------+-----------------------+------------------------------------------------+ + | resource_type | String | Attachment type. Value options are as follows: | + | | | | + | | | - **vpc**: VPC attachment | + | | | | + | | | - **vgw**: virtual gateway attachment | + +-----------------------+-----------------------+------------------------------------------------+ + | attachment_id | String | Attachment ID | + +-----------------------+-----------------------+------------------------------------------------+ .. _listeffectiveroutes__response_pageinfo: @@ -129,7 +123,7 @@ Response Parameters Example Requests ---------------- -Querying valid routes +Querying effective routes .. code-block:: text @@ -154,11 +148,10 @@ OK "attachment_id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289" } ], "is_blackhole" : false, - "route_type" : "static", - "address_group_id" : "b6d2f843-dc53-4ab4-9722-e45867038643" + "route_type" : "static" } ], "page_info" : { - "next_marker" : 1, + "next_marker" : "1", "current_count" : 1 }, "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9" diff --git a/api-ref/source/apis/routes/querying_static_routes.rst b/api-ref/source/apis/routes/querying_static_routes.rst index b5cd85e..8576279 100644 --- a/api-ref/source/apis/routes/querying_static_routes.rst +++ b/api-ref/source/apis/routes/querying_static_routes.rst @@ -13,7 +13,9 @@ This API is used to query static routes. Constraints ----------- -Pagination query is supported. The supported query criteria are **destination**, **attachment_id**, **resource_type**, and **type**. Only sorting by a single field (**id**, **destination**, **created_at**, or **updated_at**) is supported. +- Pagination query is supported. The supported query criteria are **destination**, **attachment_id**, **resource_type**, and **type**. + +- Only sorting by a single field (**id**, **destination**, **created_at**, or **updated_at**) is supported. URI --- @@ -34,7 +36,7 @@ GET /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-rout +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+=================+=====================================================================================================================================================================+ - | limit | No | Integer | Number of records on each page. Value range: 0 to 2000 | + | limit | No | Integer | Number of records on each page. Value range: **0** to **2000** | | | | | | | | | | Minimum: **0** | | | | | | @@ -50,17 +52,15 @@ GET /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-rout +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | attachment_id | No | Array | Attachment ID | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | No | Array | Attachment type: | + | resource_type | No | Array | Attachment type. Value options are as follows: | | | | | | | | | | - **vpc**: VPC attachment | | | | | | - | | | | - **vpn**: VPN gateway attachment | - | | | | | | | | | - **vgw**: virtual gateway attachment | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_key | No | Array | Sort by ID, name, or state. By default, ID is used. | + | sort_key | No | Array | Keyword for sorting. The keyword can be **id**, **name**, or **state**. By default, **id** is used. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_dir | No | Array | Sorting order, including **asc** (ascending order) and **desc** (descending order). The default value is **asc**. | + | sort_dir | No | Array | Sorting order. There are two value options: **asc** (ascending order) and **desc** (descending order). The default value is **asc**. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters @@ -89,47 +89,45 @@ Response Parameters .. table:: **Table 4** Route - +----------------+--------------------------------------------------------------------------------------+----------------------------------------+ - | Parameter | Type | Description | - +================+======================================================================================+========================================+ - | id | String | Route ID | - +----------------+--------------------------------------------------------------------------------------+----------------------------------------+ - | type | String | Route type | - +----------------+--------------------------------------------------------------------------------------+----------------------------------------+ - | state | String | Route status | - +----------------+--------------------------------------------------------------------------------------+----------------------------------------+ - | is_blackhole | Boolean | Whether the route is a blackhole route | - +----------------+--------------------------------------------------------------------------------------+----------------------------------------+ - | destination | String | Destination address of the route | - +----------------+--------------------------------------------------------------------------------------+----------------------------------------+ - | attachments | Array of :ref:`RouteAttachment ` objects | Next hops | - +----------------+--------------------------------------------------------------------------------------+----------------------------------------+ - | route_table_id | String | Route table ID | - +----------------+--------------------------------------------------------------------------------------+----------------------------------------+ - | created_at | String | Creation time | - +----------------+--------------------------------------------------------------------------------------+----------------------------------------+ - | updated_at | String | Update time | - +----------------+--------------------------------------------------------------------------------------+----------------------------------------+ + +----------------+--------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +================+======================================================================================+===================================================================================================================+ + | id | String | Route ID | + +----------------+--------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | type | String | Route type. The value is **static**. | + +----------------+--------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | state | String | Route status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** | + +----------------+--------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | is_blackhole | Boolean | Whether the route is a blackhole route | + +----------------+--------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | destination | String | Destination address of the route | + +----------------+--------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | attachments | Array of :ref:`RouteAttachment ` objects | Next hops | + +----------------+--------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | route_table_id | String | Route table ID | + +----------------+--------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +----------------+--------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +----------------+--------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ .. _liststaticroutes__response_routeattachment: .. table:: **Table 5** RouteAttachment - +-----------------------+-----------------------+----------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================+ - | resource_id | String | Attached resource ID | - +-----------------------+-----------------------+----------------------------------------+ - | resource_type | String | Attachment type: | - | | | | - | | | - **vpc**: VPC attachment | - | | | | - | | | - **vpn**: VPN gateway attachment | - | | | | - | | | - **vgw**: virtual gateway attachment | - +-----------------------+-----------------------+----------------------------------------+ - | attachment_id | String | Attachment ID | - +-----------------------+-----------------------+----------------------------------------+ + +-----------------------+-----------------------+------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+================================================+ + | resource_id | String | Attached resource ID | + +-----------------------+-----------------------+------------------------------------------------+ + | resource_type | String | Attachment type. Value options are as follows: | + | | | | + | | | - **vpc**: VPC attachment | + | | | | + | | | - **vgw**: virtual gateway attachment | + +-----------------------+-----------------------+------------------------------------------------+ + | attachment_id | String | Attachment ID | + +-----------------------+-----------------------+------------------------------------------------+ .. _liststaticroutes__response_pageinfo: @@ -177,7 +175,7 @@ OK "updated_at" : "2020-03-11T15:13:31Z" } ], "page_info" : { - "next_marker" : 1, + "next_marker" : "1", "current_count" : 1 }, "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9" diff --git a/api-ref/source/apis/routes/updating_a_static_route.rst b/api-ref/source/apis/routes/updating_a_static_route.rst index c47a211..a23de3b 100644 --- a/api-ref/source/apis/routes/updating_a_static_route.rst +++ b/api-ref/source/apis/routes/updating_a_static_route.rst @@ -66,47 +66,45 @@ Response Parameters .. table:: **Table 5** Route - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ - | Parameter | Type | Description | - +================+=======================================================================================+========================================+ - | id | String | Route ID | - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ - | type | String | Route type | - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ - | state | String | Route status | - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ - | is_blackhole | Boolean | Whether the route is a blackhole route | - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ - | destination | String | Destination address of the route | - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ - | attachments | Array of :ref:`RouteAttachment ` objects | Next hops | - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ - | route_table_id | String | Route table ID | - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ - | created_at | String | Creation time | - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ - | updated_at | String | Update time | - +----------------+---------------------------------------------------------------------------------------+----------------------------------------+ + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +================+=======================================================================================+===================================================================================================================+ + | id | String | Route ID | + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | type | String | Route type. The value is **static**. | + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | state | String | Route status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, and **failed** | + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | is_blackhole | Boolean | Whether the route is a blackhole route | + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | destination | String | Destination address of the route | + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | attachments | Array of :ref:`RouteAttachment ` objects | Next hops | + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | route_table_id | String | Route table ID | + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +----------------+---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ .. _updatestaticroute__response_routeattachment: .. table:: **Table 6** RouteAttachment - +-----------------------+-----------------------+----------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================+ - | resource_id | String | Attached resource ID | - +-----------------------+-----------------------+----------------------------------------+ - | resource_type | String | Attachment type: | - | | | | - | | | - **vpc**: VPC attachment | - | | | | - | | | - **vpn**: VPN gateway attachment | - | | | | - | | | - **vgw**: virtual gateway attachment | - +-----------------------+-----------------------+----------------------------------------+ - | attachment_id | String | Attachment ID | - +-----------------------+-----------------------+----------------------------------------+ + +-----------------------+-----------------------+------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+================================================+ + | resource_id | String | Attached resource ID | + +-----------------------+-----------------------+------------------------------------------------+ + | resource_type | String | Attachment type. Value options are as follows: | + | | | | + | | | - **vpc**: VPC attachment | + | | | | + | | | - **vgw**: virtual gateway attachment | + +-----------------------+-----------------------+------------------------------------------------+ + | attachment_id | String | Attachment ID | + +-----------------------+-----------------------+------------------------------------------------+ Example Requests ---------------- diff --git a/api-ref/source/apis/tags/creating_resource_tags.rst b/api-ref/source/apis/tags/creating_resource_tags.rst index efd989d..9d41c7d 100644 --- a/api-ref/source/apis/tags/creating_resource_tags.rst +++ b/api-ref/source/apis/tags/creating_resource_tags.rst @@ -26,25 +26,25 @@ POST /v3/{project_id}/{resource_type}/{resource_id}/tags .. table:: **Table 1** Path Parameters - +-----------------+-----------------+-----------------+-----------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===============================================+ - | project_id | Yes | String | Project ID | - +-----------------+-----------------+-----------------+-----------------------------------------------+ - | resource_id | Yes | String | Resource ID | - +-----------------+-----------------+-----------------+-----------------------------------------------+ - | resource_type | Yes | String | - instance: Enterprise router | - | | | | | - | | | | - route-table: Route table | - | | | | | - | | | | - vpc-attachment: VPC attachment | - | | | | | - | | | | - vgw-attachment: Virtual gateway attachment | - | | | | | - | | | | - vpn-attachment: VPN gateway attachment | - | | | | | - | | | | - attachments: All attachment types | - +-----------------+-----------------+-----------------+-----------------------------------------------+ + +-----------------+-----------------+-----------------+---------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+===================================================+ + | project_id | Yes | String | Project ID | + +-----------------+-----------------+-----------------+---------------------------------------------------+ + | resource_id | Yes | String | Resource ID | + +-----------------+-----------------+-----------------+---------------------------------------------------+ + | resource_type | Yes | String | Resource type. Value options: | + | | | | | + | | | | - **instance**: enterprise router | + | | | | | + | | | | - **route-table**: route table | + | | | | | + | | | | - **vpc-attachment**: VPC attachment | + | | | | | + | | | | - **vgw-attachment**: virtual gateway attachment | + | | | | | + | | | | - **attachments**: all attachment types | + +-----------------+-----------------+-----------------+---------------------------------------------------+ Request Parameters ------------------ diff --git a/api-ref/source/apis/tags/deleting_resource_tags.rst b/api-ref/source/apis/tags/deleting_resource_tags.rst index 60535d1..6c7fa78 100644 --- a/api-ref/source/apis/tags/deleting_resource_tags.rst +++ b/api-ref/source/apis/tags/deleting_resource_tags.rst @@ -22,27 +22,27 @@ DELETE /v3/{project_id}/{resource_type}/{resource_id}/tags/{key} .. table:: **Table 1** Path Parameters - +-----------------+-----------------+-----------------+-----------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===============================================+ - | key | Yes | String | Tag key | - +-----------------+-----------------+-----------------+-----------------------------------------------+ - | project_id | Yes | String | Project ID | - +-----------------+-----------------+-----------------+-----------------------------------------------+ - | resource_id | Yes | String | Resource ID | - +-----------------+-----------------+-----------------+-----------------------------------------------+ - | resource_type | Yes | String | - instance: Enterprise router | - | | | | | - | | | | - route-table: Route table | - | | | | | - | | | | - vpc-attachment: VPC attachment | - | | | | | - | | | | - vgw-attachment: Virtual gateway attachment | - | | | | | - | | | | - vpn-attachment: VPN gateway attachment | - | | | | | - | | | | - attachments: All attachment types | - +-----------------+-----------------+-----------------+-----------------------------------------------+ + +-----------------+-----------------+-----------------+---------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+===================================================+ + | key | Yes | String | Tag key | + +-----------------+-----------------+-----------------+---------------------------------------------------+ + | project_id | Yes | String | Project ID | + +-----------------+-----------------+-----------------+---------------------------------------------------+ + | resource_id | Yes | String | Resource ID | + +-----------------+-----------------+-----------------+---------------------------------------------------+ + | resource_type | Yes | String | Resource type. Value options: | + | | | | | + | | | | - **instance**: enterprise router | + | | | | | + | | | | - **route-table**: route table | + | | | | | + | | | | - **vpc-attachment**: VPC attachment | + | | | | | + | | | | - **vgw-attachment**: virtual gateway attachment | + | | | | | + | | | | - **attachments**: all attachment types | + +-----------------+-----------------+-----------------+---------------------------------------------------+ Request Parameters ------------------ diff --git a/api-ref/source/apis/tags/querying_project_tags.rst b/api-ref/source/apis/tags/querying_project_tags.rst index 24ee12f..52ce0dc 100644 --- a/api-ref/source/apis/tags/querying_project_tags.rst +++ b/api-ref/source/apis/tags/querying_project_tags.rst @@ -17,23 +17,23 @@ GET /v3/{project_id}/{resource_type}/tags .. table:: **Table 1** Path Parameters - +-----------------+-----------------+-----------------+-----------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===============================================+ - | project_id | Yes | String | Project ID | - +-----------------+-----------------+-----------------+-----------------------------------------------+ - | resource_type | Yes | String | - instance: Enterprise router | - | | | | | - | | | | - route-table: Route table | - | | | | | - | | | | - vpc-attachment: VPC attachment | - | | | | | - | | | | - vgw-attachment: Virtual gateway attachment | - | | | | | - | | | | - vpn-attachment: VPN gateway attachment | - | | | | | - | | | | - attachments: All attachment types | - +-----------------+-----------------+-----------------+-----------------------------------------------+ + +-----------------+-----------------+-----------------+---------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+===================================================+ + | project_id | Yes | String | Project ID | + +-----------------+-----------------+-----------------+---------------------------------------------------+ + | resource_type | Yes | String | Resource type. Value options: | + | | | | | + | | | | - **instance**: enterprise router | + | | | | | + | | | | - **route-table**: route table | + | | | | | + | | | | - **vpc-attachment**: VPC attachment | + | | | | | + | | | | - **vgw-attachment**: virtual gateway attachment | + | | | | | + | | | | - **attachments**: all attachment types | + +-----------------+-----------------+-----------------+---------------------------------------------------+ Request Parameters ------------------ diff --git a/api-ref/source/apis/tags/querying_resource_tags.rst b/api-ref/source/apis/tags/querying_resource_tags.rst index 9993ba0..9463674 100644 --- a/api-ref/source/apis/tags/querying_resource_tags.rst +++ b/api-ref/source/apis/tags/querying_resource_tags.rst @@ -17,25 +17,25 @@ GET /v3/{project_id}/{resource_type}/{resource_id}/tags .. table:: **Table 1** Path Parameters - +-----------------+-----------------+-----------------+-----------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===============================================+ - | project_id | Yes | String | Project ID | - +-----------------+-----------------+-----------------+-----------------------------------------------+ - | resource_id | Yes | String | Resource ID | - +-----------------+-----------------+-----------------+-----------------------------------------------+ - | resource_type | Yes | String | - instance: Enterprise router | - | | | | | - | | | | - route-table: Route table | - | | | | | - | | | | - vpc-attachment: VPC attachment | - | | | | | - | | | | - vgw-attachment: Virtual gateway attachment | - | | | | | - | | | | - vpn-attachment: VPN gateway attachment | - | | | | | - | | | | - attachments: All attachment types | - +-----------------+-----------------+-----------------+-----------------------------------------------+ + +-----------------+-----------------+-----------------+---------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+===================================================+ + | project_id | Yes | String | Project ID | + +-----------------+-----------------+-----------------+---------------------------------------------------+ + | resource_id | Yes | String | Resource ID | + +-----------------+-----------------+-----------------+---------------------------------------------------+ + | resource_type | Yes | String | Resource type. Value options: | + | | | | | + | | | | - **instance**: enterprise router | + | | | | | + | | | | - **route-table**: route table | + | | | | | + | | | | - **vpc-attachment**: VPC attachment | + | | | | | + | | | | - **vgw-attachment**: virtual gateway attachment | + | | | | | + | | | | - **attachments**: all attachment types | + +-----------------+-----------------+-----------------+---------------------------------------------------+ Request Parameters ------------------ diff --git a/api-ref/source/apis/vpc_attachments/creating_a_vpc_attachment.rst b/api-ref/source/apis/vpc_attachments/creating_a_vpc_attachment.rst index 163a7a0..9a6d45f 100644 --- a/api-ref/source/apis/vpc_attachments/creating_a_vpc_attachment.rst +++ b/api-ref/source/apis/vpc_attachments/creating_a_vpc_attachment.rst @@ -124,35 +124,35 @@ Response Parameters .. table:: **Table 8** VpcAttachmentDetails - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +========================+=================================================================+====================================================================================================================================================================================================================================================+ - | id | String | VPC attachment ID | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | VPC attachment name | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | VPC id | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | virsubnet_id | String | VPC subnet ID | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auto_create_vpc_routes | Boolean | The default value is false. If this parameter is set to true, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC. | - | | | | - | | | Default: **false** | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | state | String | VPC attachment status: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **initiating_request**, **rejected**, and **pending_acceptance** | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Creation time | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Update time | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of :ref:`Tag ` objects | Tag information | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Supplementary information about the VPC attachment | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_project_id | String | ID of the project that the VPC belongs to | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+=================================================================+============================================================================================================================================================================================================================================================+ + | id | String | VPC attachment ID | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | VPC attachment name | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC id | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | virsubnet_id | String | VPC subnet ID | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | auto_create_vpc_routes | Boolean | The default value is **false**. If this parameter is set to **true**, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC. | + | | | | + | | | Default: **false** | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | VPC attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **initiating_request**, **rejected**, and **pending_acceptance** | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`Tag ` objects | Tag information | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Supplementary information about the VPC attachment | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_project_id | String | ID of the project that the VPC belongs to | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _createvpcattachment__response_tag: @@ -177,7 +177,7 @@ Response Parameters Example Requests ---------------- -Creating a VPC attachment +Creating a VPC attachment named **vpc-atta** .. code-block:: text @@ -187,7 +187,7 @@ Creating a VPC attachment "vpc_attachment" : { "name" : "vpc-atta", "vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a", - "virsubnet_id" : "0605767a9980d5762fbcc00b3537e757" + "virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8" } } @@ -205,7 +205,7 @@ Accepted "id" : "6f83b848-8331-4271-ac0c-ef94b7686402", "name" : "vpc-atta", "vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a", - "virsubnet_id" : "0605767a9980d5762fbcc00b3537e757", + "virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8", "project_id" : "08d5a9564a704afda6039ae2babbef3c", "state" : "pending", "auto_create_vpc_routes" : false, diff --git a/api-ref/source/apis/vpc_attachments/querying_details_about_a_vpc_attachment.rst b/api-ref/source/apis/vpc_attachments/querying_details_about_a_vpc_attachment.rst index d438e83..74f853e 100644 --- a/api-ref/source/apis/vpc_attachments/querying_details_about_a_vpc_attachment.rst +++ b/api-ref/source/apis/vpc_attachments/querying_details_about_a_vpc_attachment.rst @@ -49,35 +49,35 @@ Response Parameters .. table:: **Table 3** VpcAttachmentDetails - +------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +========================+===============================================================+====================================================================================================================================================================================================================================================+ - | id | String | VPC attachment ID | - +------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | VPC attachment name | - +------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | VPC id | - +------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | virsubnet_id | String | VPC subnet ID | - +------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auto_create_vpc_routes | Boolean | The default value is false. If this parameter is set to true, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC. | - | | | | - | | | Default: **false** | - +------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | state | String | VPC attachment status: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **initiating_request**, **rejected**, and **pending_acceptance** | - +------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Creation time | - +------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Update time | - +------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of :ref:`Tag ` objects | Tag information | - +------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Supplementary information about the VPC attachment | - +------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID | - +------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_project_id | String | ID of the project that the VPC belongs to | - +------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+===============================================================+============================================================================================================================================================================================================================================================+ + | id | String | VPC attachment ID | + +------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | VPC attachment name | + +------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC id | + +------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | virsubnet_id | String | VPC subnet ID | + +------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | auto_create_vpc_routes | Boolean | The default value is **false**. If this parameter is set to **true**, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC. | + | | | | + | | | Default: **false** | + +------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | VPC attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **initiating_request**, **rejected**, and **pending_acceptance** | + +------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`Tag ` objects | Tag information | + +------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Supplementary information about the VPC attachment | + +------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID | + +------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_project_id | String | ID of the project that the VPC belongs to | + +------------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _showvpcattachment__response_tag: @@ -122,7 +122,7 @@ OK "id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8", "name" : "vpc-attach", "vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a", - "virsubnet_id" : "0605767a9980d5762fbcc00b3537e757", + "virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8", "project_id" : "08d5a9564a704afda6039ae2babbef3c", "state" : "available", "created_at" : "2020-03-11T15:13:31Z", diff --git a/api-ref/source/apis/vpc_attachments/querying_vpc_attachments.rst b/api-ref/source/apis/vpc_attachments/querying_vpc_attachments.rst index 592c72e..9ddf74b 100644 --- a/api-ref/source/apis/vpc_attachments/querying_vpc_attachments.rst +++ b/api-ref/source/apis/vpc_attachments/querying_vpc_attachments.rst @@ -37,31 +37,31 @@ GET /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments .. table:: **Table 2** Query Parameters - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=======================================================================================================================================================================+ - | limit | No | Integer | Number of records on each page. Value range: 0 to 2000 | - | | | | | - | | | | Minimum: **0** | - | | | | | - | | | | Maximum: **2000** | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | marker | No | String | ID of the last enterprise router on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit. | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **128** | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | state | No | Array | Attachment status: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **pending_acceptance**, **rejected**, and **initiating_request** | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | No | Array | Query by resource ID. Multiple resources can be queried at a time. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_key | No | Array | Sort by ID, name, or state. By default, ID is used. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_dir | No | Array | Sorting order, including **asc** (ascending order) and **desc** (descending order). The default value is **asc**. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | No | Array | VPC id | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+======================================================================================================================================================================================+ + | limit | No | Integer | Number of records on each page. Value range: **0** to **2000** | + | | | | | + | | | | Minimum: **0** | + | | | | | + | | | | Maximum: **2000** | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | marker | No | String | ID of the last enterprise router on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit. | + | | | | | + | | | | Minimum: **1** | + | | | | | + | | | | Maximum: **128** | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | No | Array | Attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **pending_acceptance**, **rejected**, and **initiating_request** | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | No | Array | Query by resource ID. Multiple resources can be queried at a time. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sort_key | No | Array | Keyword for sorting. The keyword can be **id**, **name**, or **state**. By default, **id** is used. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | sort_dir | No | Array | Sorting order. There are two value options: **asc** (ascending order) and **desc** (descending order). The default value is **asc**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | No | Array | VPC id | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ @@ -89,35 +89,35 @@ Response Parameters .. table:: **Table 4** VpcAttachmentDetails - +------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +========================+================================================================+====================================================================================================================================================================================================================================================+ - | id | String | VPC attachment ID | - +------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | VPC attachment name | - +------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | VPC id | - +------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | virsubnet_id | String | VPC subnet ID | - +------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auto_create_vpc_routes | Boolean | The default value is false. If this parameter is set to true, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC. | - | | | | - | | | Default: **false** | - +------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | state | String | VPC attachment status: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **initiating_request**, **rejected**, and **pending_acceptance** | - +------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Creation time | - +------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Update time | - +------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of :ref:`Tag ` objects | Tag information | - +------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Supplementary information about the VPC attachment | - +------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID | - +------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_project_id | String | ID of the project that the VPC belongs to | - +------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+================================================================+============================================================================================================================================================================================================================================================+ + | id | String | VPC attachment ID | + +------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | VPC attachment name | + +------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC id | + +------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | virsubnet_id | String | VPC subnet ID | + +------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | auto_create_vpc_routes | Boolean | The default value is **false**. If this parameter is set to **true**, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC. | + | | | | + | | | Default: **false** | + +------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | VPC attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **initiating_request**, **rejected**, and **pending_acceptance** | + +------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`Tag ` objects | Tag information | + +------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Supplementary information about the VPC attachment | + +------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID | + +------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_project_id | String | ID of the project that the VPC belongs to | + +------------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listvpcattachments__response_tag: @@ -180,7 +180,7 @@ OK "id" : "6f83b848-8331-4271-ac0c-ef94b7686402", "name" : "vpc-attach-01", "vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a", - "virsubnet_id" : "0605767a9980d5762fbcc00b3537e757", + "virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8", "project_id" : "08d5a9564a704afda6039ae2babbef3c", "state" : "available", "created_at" : "2020-03-11T15:13:31Z", @@ -196,7 +196,7 @@ OK "updated_at" : "2020-03-11T15:13:31Z" } ], "page_info" : { - "next_marker" : 1, + "next_marker" : "1", "current_count" : 2 }, "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9" diff --git a/api-ref/source/apis/vpc_attachments/updating_a_vpc_attachment.rst b/api-ref/source/apis/vpc_attachments/updating_a_vpc_attachment.rst index 2185315..0737ad1 100644 --- a/api-ref/source/apis/vpc_attachments/updating_a_vpc_attachment.rst +++ b/api-ref/source/apis/vpc_attachments/updating_a_vpc_attachment.rst @@ -75,35 +75,35 @@ Response Parameters .. table:: **Table 5** VpcAttachmentDetails - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +========================+=================================================================+====================================================================================================================================================================================================================================================+ - | id | String | VPC attachment ID | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | VPC attachment name | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | VPC id | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | virsubnet_id | String | VPC subnet ID | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auto_create_vpc_routes | Boolean | The default value is false. If this parameter is set to true, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC. | - | | | | - | | | Default: **false** | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | state | String | VPC attachment status: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **initiating_request**, **rejected**, and **pending_acceptance** | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Creation time | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Update time | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of :ref:`Tag ` objects | Tag information | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Supplementary information about the VPC attachment | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Project ID | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_project_id | String | ID of the project that the VPC belongs to | - +------------------------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +========================+=================================================================+============================================================================================================================================================================================================================================================+ + | id | String | VPC attachment ID | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | VPC attachment name | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | VPC id | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | virsubnet_id | String | VPC subnet ID | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | auto_create_vpc_routes | Boolean | The default value is **false**. If this parameter is set to **true**, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC. | + | | | | + | | | Default: **false** | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | state | String | VPC attachment status. Value options: **pending**, **available**, **modifying**, **deleting**, **deleted**, **failed**, **initiating_request**, **rejected**, and **pending_acceptance** | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Creation time | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Update time | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`Tag ` objects | Tag information | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Supplementary information about the VPC attachment | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_project_id | String | ID of the project that the VPC belongs to | + +------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updatevpcattachment__response_tag: @@ -128,7 +128,7 @@ Response Parameters Example Requests ---------------- -Updating basic information about a VPC attachment +Updating a VPC attachment (changing its name to **new-vpc-attach**) .. code-block:: text @@ -154,7 +154,7 @@ OK "id" : "3b9724e9-49ec-4d21-9191-3d703133b910", "name" : "new-vpc-attach", "vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a", - "virsubnet_id" : "0605767a9980d5762fbcc00b3537e757", + "virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8", "auto_create_vpc_routes" : false, "project_id" : "08d5a9564a704afda6039ae2babbef3c", "state" : "available", diff --git a/api-ref/source/error_codes.rst b/api-ref/source/appendixes/error_codes.rst similarity index 91% rename from api-ref/source/error_codes.rst rename to api-ref/source/appendixes/error_codes.rst index 10ae51b..62d0f74 100644 --- a/api-ref/source/error_codes.rst +++ b/api-ref/source/appendixes/error_codes.rst @@ -34,8 +34,6 @@ Error Codes +-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | 400 | ER.04004102 | Failed to add the route to the VPC route table. | Failed to add the route to the VPC route table. | Check whether a route with the same destination already exists in the VPC route table. | +-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| 400 | ER.04004106 | Invalid attachment for data transmission. | Invalid attachment for data transmission. | Check the transport_attachment_id attribute. | -+-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | 400 | ER.04005003 | This route table is unavailable or is being operated. | This route table is unavailable or is being operated. | Check whether the route table is available and try again. | +-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | 400 | ER.04006002 | The destination of the route already exists. | The destination of the route already exists. | Check the destination in the route. | @@ -48,6 +46,14 @@ Error Codes +-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | 400 | ER.04006106 | A blackhole route cannot have a next hop. A non-blackhole route must have a next hop. | Invalid route. | Check the route. | +-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| 400 | ER.04008500 | Flow logs are not supported by the resource type. | Flow logs are not supported by the resource type. | Check the resource type. | ++-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| 400 | ER.04008501 | The flow log task does not exist. | The flow log task does not exist. | Check the flow log ID. | ++-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| 400 | ER.04008502 | The flow log task is being operated. | The flow log task is being operated. | Check the flow log task status and try again later. | ++-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| 400 | ER.04008503 | The flow log task already exists. | The flow log task already exists. | Check the flow log task. | ++-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | 400 | ER.04009005 | Invalid parameters. | Invalid parameters. | Check the parameters. | +-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | 400 | ER.04009008 | Insufficient quota. | Insufficient quota. | Submit a service ticket to apply for quota increase. | diff --git a/api-ref/source/appendixes/index.rst b/api-ref/source/appendixes/index.rst new file mode 100644 index 0000000..e1f2b8e --- /dev/null +++ b/api-ref/source/appendixes/index.rst @@ -0,0 +1,16 @@ +:original_name: er_02_appendix.html + +.. _er_02_appendix: + +Appendixes +========== + +- :ref:`Status Codes ` +- :ref:`Error Codes ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + status_codes + error_codes diff --git a/api-ref/source/status_codes.rst b/api-ref/source/appendixes/status_codes.rst similarity index 87% rename from api-ref/source/status_codes.rst rename to api-ref/source/appendixes/status_codes.rst index b80db6d..2c665e0 100644 --- a/api-ref/source/status_codes.rst +++ b/api-ref/source/appendixes/status_codes.rst @@ -7,19 +7,19 @@ Status Codes .. table:: **Table 1** Normal status codes - +-----------------------+-----------------------+---------------------------------------------------------------------------+ - | Status Code | Message | Description | - +=======================+=======================+===========================================================================+ - | 200 | OK | Normal response code for the GET, PUT, and POST operations | - +-----------------------+-----------------------+---------------------------------------------------------------------------+ - | 201 | Created | Normal response code for the POST operations of the OpenStack Neutron API | - +-----------------------+-----------------------+---------------------------------------------------------------------------+ - | 202 | Accepted | Operations that take a long time to process. | - | | | | - | | | The request has been accepted but the processing is not complete. | - +-----------------------+-----------------------+---------------------------------------------------------------------------+ - | 204 | No Content | Normal response code for DELETE operations | - +-----------------------+-----------------------+---------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------+ + | Status Code | Message | Description | + +=======================+=======================+===================================================================+ + | 200 | OK | Normal response code for the GET, PUT, and POST operations | + +-----------------------+-----------------------+-------------------------------------------------------------------+ + | 201 | Created | Normal response code for POST operations | + +-----------------------+-----------------------+-------------------------------------------------------------------+ + | 202 | Accepted | Operations that take a long time to process. | + | | | | + | | | The request has been accepted but the processing is not complete. | + +-----------------------+-----------------------+-------------------------------------------------------------------+ + | 204 | No Content | Normal response code for DELETE operations | + +-----------------------+-----------------------+-------------------------------------------------------------------+ .. table:: **Table 2** Abnormal status codes diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 18c9366..6f0565b 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -5,8 +5,15 @@ Change History ============== -=========== ========================================= -Released On Description -=========== ========================================= -2023-04-07 This issue is the first official release. -=========== ========================================= ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Released On | Description | ++===================================+================================================================================================================================================================================+ +| 2023-09-22 | This release incorporates the following changes: | +| | | +| | - Modified the description of the **state** parameter in "Creating an Enterprise Router", "Updating an Enterprise Router", and "Querying Details About an Enterprise Router". | +| | - Modified the example response in "Querying VPC Attachments". | +| | - Modified the description of the **type** parameter in "Creating a Static Route". | +| | - Modified the description of the **route_type** parameter in "Querying Effective Routes". | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2023-04-07 | This issue is the first official release. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 5f93899..3796885 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -7,7 +7,5 @@ Enterprise Router - API Reference api_usage_guidelines apis/index - permissions_policies_and_supported_actions/index - status_codes - error_codes + appendixes/index change_history diff --git a/api-ref/source/permissions_policies_and_supported_actions/association.rst b/api-ref/source/permissions_policies_and_supported_actions/association.rst deleted file mode 100644 index 45c6f05..0000000 --- a/api-ref/source/permissions_policies_and_supported_actions/association.rst +++ /dev/null @@ -1,16 +0,0 @@ -:original_name: er_02_0021.html - -.. _er_02_0021: - -Association -=========== - -+-------------------------------+--------------------------------------------------------------------------------------------+------------------------------+-------------+--------------------+ -| Permission | API | Action | IAM Project | Enterprise Project | -+===============================+============================================================================================+==============================+=============+====================+ -| Creating an association | POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/associate | er:associations:associate | Y | Y | -+-------------------------------+--------------------------------------------------------------------------------------------+------------------------------+-------------+--------------------+ -| Querying the association list | GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/associations | er:associations:list | Y | Y | -+-------------------------------+--------------------------------------------------------------------------------------------+------------------------------+-------------+--------------------+ -| Deleting an association | POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/disassociate | er:associations:disassociate | Y | Y | -+-------------------------------+--------------------------------------------------------------------------------------------+------------------------------+-------------+--------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/enterprise_router.rst b/api-ref/source/permissions_policies_and_supported_actions/enterprise_router.rst deleted file mode 100644 index 02903cc..0000000 --- a/api-ref/source/permissions_policies_and_supported_actions/enterprise_router.rst +++ /dev/null @@ -1,22 +0,0 @@ -:original_name: er_02_0017.html - -.. _er_02_0017: - -Enterprise Router -================= - -+---------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+-------------+--------------------+ -| Permission | API | Action | IAM Project | Enterprise Project | -+=============================================+=======================================================================================================+=======================+=============+====================+ -| Creating an enterprise router | POST /v3/{project_id}/enterprise-router/instances | er:instances:create | Y | Y | -+---------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+-------------+--------------------+ -| Updating an enterprise router | PUT /v3/{project_id}/enterprise-router/instances/{enterprise_router_id} | er:instances:update | Y | Y | -+---------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+-------------+--------------------+ -| Querying details about an enterprise router | GET /v3/{project_id}/enterprise-router/instances/{enterprise_router_id} | er:instances:get | Y | Y | -+---------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+-------------+--------------------+ -| Querying the enterprise router list | GET /v3/{project_id}/enterprise-router/instances | er:instances:list | Y | Y | -+---------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+-------------+--------------------+ -| Changing the AZs of an enterprise router | POST /v3/{project_id}/enterprise-router/instances/{enterprise_router_id}/change-availability-zone-ids | er:instances:changeAZ | Y | Y | -+---------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+-------------+--------------------+ -| Deleting an enterprise router | DELETE /v3/{project_id}/enterprise-router/instances/{enterprise_router_id} | er:instances:delete | Y | Y | -+---------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+-------------+--------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/index.rst b/api-ref/source/permissions_policies_and_supported_actions/index.rst deleted file mode 100644 index a25a782..0000000 --- a/api-ref/source/permissions_policies_and_supported_actions/index.rst +++ /dev/null @@ -1,28 +0,0 @@ -:original_name: er_02_0015.html - -.. _er_02_0015: - -Permissions Policies and Supported Actions -========================================== - -- :ref:`Introduction ` -- :ref:`Enterprise Router ` -- :ref:`VPC Attachment ` -- :ref:`Other Type of Attachments ` -- :ref:`Route Table ` -- :ref:`Association ` -- :ref:`Propagation ` -- :ref:`Route ` - -.. toctree:: - :maxdepth: 1 - :hidden: - - introduction - enterprise_router - vpc_attachment - other_type_of_attachments - route_table - association - propagation - route diff --git a/api-ref/source/permissions_policies_and_supported_actions/introduction.rst b/api-ref/source/permissions_policies_and_supported_actions/introduction.rst deleted file mode 100644 index 09d33c2..0000000 --- a/api-ref/source/permissions_policies_and_supported_actions/introduction.rst +++ /dev/null @@ -1,39 +0,0 @@ -:original_name: er_02_0016.html - -.. _er_02_0016: - -Introduction -============ - -This section describes fine-grained permissions management for your Enterprise Router resources. If your account does not need individual IAM users, you may skip this section. - -By default, new IAM users do not have any permissions assigned. You need to add a user to one or more groups, and assign policies or roles to these groups. The user then inherits permissions from the groups. After authorization, the user can perform specified operations on cloud services based on the permissions. - -You can grant users permissions by using and . Roles: A type of coarse-grained authorization mechanism that defines service-level permissions based on user responsibilities. There are only a limited number of roles for granting permissions to users. Policies: A type of fine-grained authorization mechanism that defines permissions required to perform operations on specific cloud resources under certain conditions. This mechanism allows for more flexible policy-based authorization and secure access control. - -.. note:: - - Policy-based authorization is useful if you want to allow or deny the access to an API. - -An account has all of the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions can call the API successfully. For example, if an IAM user wants to query ECSs using an API, the user must have been granted permissions that allow the **ecs:servers:list** action. - -Supported Actions ------------------ - -IAM provides system-defined policies that can be directly used. You can also create custom policies to work with system-defined policies for more refined access control. Actions supported by policies are specific to APIs. Common concepts related to policies include: - -- Permissions: allow or deny operations on specified resources under specific conditions. -- APIs: REST APIs that can be called by a user who has been granted specific permissions -- Actions: specific operations that are allowed or denied -- Related actions: actions on which a specific action depends. When assigning permissions for the action to a user, you also need to assign permissions for the dependent actions. -- IAM projects or enterprise projects: type of projects for which an action will take effect. For example, if you set the authorization scope of a custom policy to both IAM projects and enterprise projects, the policy takes effect for user groups in either IAM or enterprise projects. If the authorization scope is set to IAM projects only, the custom policy will take effect only for user groups in IAM projects. Administrators can check whether an action supports IAM projects or enterprise projects in the action list. "Y" indicates that the action supports the project and "x" indicates that the action does not support the project. - -Enterprise Router supports the following actions that can be defined in custom policies: - -- :ref:`Enterprise Router ` -- :ref:`VPC Attachment ` -- :ref:`Other Type of Attachments ` -- :ref:`Route Table ` -- :ref:`Association ` -- :ref:`Propagation ` -- :ref:`Route ` diff --git a/api-ref/source/permissions_policies_and_supported_actions/other_type_of_attachments.rst b/api-ref/source/permissions_policies_and_supported_actions/other_type_of_attachments.rst deleted file mode 100644 index 809f830..0000000 --- a/api-ref/source/permissions_policies_and_supported_actions/other_type_of_attachments.rst +++ /dev/null @@ -1,16 +0,0 @@ -:original_name: er_02_0019.html - -.. _er_02_0019: - -Other Type of Attachments -========================= - -+--------------------------------------+----------------------------------------------------------------------------+-----------------------+-------------+--------------------+ -| Permission | API | Action | IAM Project | Enterprise Project | -+======================================+============================================================================+=======================+=============+====================+ -| Updating an attachment | PUT /v3/{project_id}/enterprise-router/{er_id}/attachments/{attachment_id} | er:attachments:update | Y | Y | -+--------------------------------------+----------------------------------------------------------------------------+-----------------------+-------------+--------------------+ -| Querying details about an attachment | GET /v3/{project_id}/enterprise-router/{er_id}/attachments/{attachment_id} | er:attachments:get | Y | Y | -+--------------------------------------+----------------------------------------------------------------------------+-----------------------+-------------+--------------------+ -| Querying the attachment list | GET /v3/{project_id}/enterprise-router/{er_id}/attachments | er:attachments:list | Y | Y | -+--------------------------------------+----------------------------------------------------------------------------+-----------------------+-------------+--------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/propagation.rst b/api-ref/source/permissions_policies_and_supported_actions/propagation.rst deleted file mode 100644 index 3468c7d..0000000 --- a/api-ref/source/permissions_policies_and_supported_actions/propagation.rst +++ /dev/null @@ -1,16 +0,0 @@ -:original_name: er_02_0022.html - -.. _er_02_0022: - -Propagation -=========== - -+-------------------------------+----------------------------------------------------------------------------------------------------+-------------------------+-------------+--------------------+ -| Permission | API | Action | IAM Project | Enterprise Project | -+===============================+====================================================================================================+=========================+=============+====================+ -| Creating a propagation | POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/enable-propagations | er:propagations:enable | Y | Y | -+-------------------------------+----------------------------------------------------------------------------------------------------+-------------------------+-------------+--------------------+ -| Querying the propagation list | GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/propagations | er:propagations:list | Y | Y | -+-------------------------------+----------------------------------------------------------------------------------------------------+-------------------------+-------------+--------------------+ -| Deleting a propagation | POST /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/disable-propagations | er:propagations:disable | Y | Y | -+-------------------------------+----------------------------------------------------------------------------------------------------+-------------------------+-------------+--------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/route.rst b/api-ref/source/permissions_policies_and_supported_actions/route.rst deleted file mode 100644 index 59eb44a..0000000 --- a/api-ref/source/permissions_policies_and_supported_actions/route.rst +++ /dev/null @@ -1,22 +0,0 @@ -:original_name: er_02_0023.html - -.. _er_02_0023: - -Route -===== - -+---------------------------------------+--------------------------------------------------------------------------------------------------+------------------+-------------+--------------------+ -| 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 | -+---------------------------------------+--------------------------------------------------------------------------------------------------+------------------+-------------+--------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/route_table.rst b/api-ref/source/permissions_policies_and_supported_actions/route_table.rst deleted file mode 100644 index 7bf7b9e..0000000 --- a/api-ref/source/permissions_policies_and_supported_actions/route_table.rst +++ /dev/null @@ -1,20 +0,0 @@ -:original_name: er_02_0020.html - -.. _er_02_0020: - -Route Table -=========== - -+--------------------------------------+---------------------------------------------------------------------------------+-----------------------+-------------+--------------------+ -| 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 | -+--------------------------------------+---------------------------------------------------------------------------------+-----------------------+-------------+--------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/vpc_attachment.rst b/api-ref/source/permissions_policies_and_supported_actions/vpc_attachment.rst deleted file mode 100644 index 8a68800..0000000 --- a/api-ref/source/permissions_policies_and_supported_actions/vpc_attachment.rst +++ /dev/null @@ -1,20 +0,0 @@ -:original_name: er_02_0018.html - -.. _er_02_0018: - -VPC Attachment -============== - -+-----------------------------------------+---------------------------------------------------------------------------------------+-----------------------+---------+--------------------+ -| 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 | -+-----------------------------------------+---------------------------------------------------------------------------------------+-----------------------+---------+--------------------+