forked from docs/enterprise-router
198 lines
17 KiB
ReStructuredText
198 lines
17 KiB
ReStructuredText
:original_name: ListPropagations.html
|
|
|
|
.. _ListPropagations:
|
|
|
|
Querying Route Propagations
|
|
===========================
|
|
|
|
Function
|
|
--------
|
|
|
|
This API is used to query route propagations.
|
|
|
|
Constraints
|
|
-----------
|
|
|
|
Pagination query is supported. You can query by state, resource type, or attachment ID. Only sorting by a single field (**id**, **created_at**, or **updated_at**) is supported.
|
|
|
|
URI
|
|
---
|
|
|
|
GET /v3/{project_id}/enterprise-router/{er_id}/route-tables/{route_table_id}/propagations
|
|
|
|
.. table:: **Table 1** Path Parameters
|
|
|
|
============== ========= ====== ====================
|
|
Parameter Mandatory Type Description
|
|
============== ========= ====== ====================
|
|
project_id Yes String Project ID
|
|
er_id Yes String Enterprise router ID
|
|
route_table_id Yes String Route table ID
|
|
============== ========= ====== ====================
|
|
|
|
.. 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** |
|
|
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| attachment_id | No | Array | Attachment ID |
|
|
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| resource_type | No | Array | Attachment type: |
|
|
| | | | |
|
|
| | | | - **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_dir | No | Array | Sorting order, including **asc** (ascending order) and **desc** (descending order). The default value is **asc**. |
|
|
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Request Parameters
|
|
------------------
|
|
|
|
None
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
**Status code: 200**
|
|
|
|
.. table:: **Table 3** Response body parameters
|
|
|
|
+--------------+------------------------------------------------------------------------------+------------------------------+
|
|
| Parameter | Type | Description |
|
|
+==============+==============================================================================+==============================+
|
|
| propagations | Array of :ref:`Propagation <listpropagations__response_propagation>` objects | Route propagations |
|
|
+--------------+------------------------------------------------------------------------------+------------------------------+
|
|
| request_id | String | Request ID |
|
|
+--------------+------------------------------------------------------------------------------+------------------------------+
|
|
| page_info | :ref:`PageInfo <listpropagations__response_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 <listpropagations__response_importroutepolicy>` object | Route that controls inbound traffic |
|
|
+----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+
|
|
| state | String | Status |
|
|
+----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+
|
|
| created_at | String | Time when the resource was created UTC time Format: YYYY-MM-DDTHH:MM:SS |
|
|
+----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+
|
|
| updated_at | String | Time when the resource was updated UTC time Format: YYYY-MM-DDTHH:MM:SS |
|
|
+----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------+
|
|
|
|
.. _listpropagations__response_importroutepolicy:
|
|
|
|
.. table:: **Table 5** ImportRoutePolicy
|
|
|
|
+-----------------------+-----------------------+------------------------------------------------------+
|
|
| Parameter | Type | Description |
|
|
+=======================+=======================+======================================================+
|
|
| import_policy_id | String | ID of the route policy that controls inbound traffic |
|
|
| | | |
|
|
| | | Minimum: **0** |
|
|
| | | |
|
|
| | | Maximum: **36** |
|
|
+-----------------------+-----------------------+------------------------------------------------------+
|
|
|
|
.. _listpropagations__response_pageinfo:
|
|
|
|
.. table:: **Table 6** PageInfo
|
|
|
|
+---------------+---------+-------------------------------------------------------------------------------------------------------------------+
|
|
| Parameter | Type | Description |
|
|
+===============+=========+===================================================================================================================+
|
|
| next_marker | String | Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page. |
|
|
+---------------+---------+-------------------------------------------------------------------------------------------------------------------+
|
|
| current_count | Integer | Number of resources in the list |
|
|
+---------------+---------+-------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Example Requests
|
|
----------------
|
|
|
|
Querying route table propagations
|
|
|
|
.. code-block:: text
|
|
|
|
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/7dec531a-7714-11eb-9439-0242ac130002/route-tables/91c013e2-d65a-474e-9177-c3e1799ca726/propagations
|
|
|
|
Example Responses
|
|
-----------------
|
|
|
|
**Status code: 200**
|
|
|
|
OK
|
|
|
|
.. code-block::
|
|
|
|
{
|
|
"propagations" : [ {
|
|
"id" : "915a14a6-867b-4af7-83d1-70efceb146f9",
|
|
"er_id" : "7dec531a-7714-11eb-9439-0242ac130002",
|
|
"route_table_id" : "91c013e2-d65a-474e-9177-c3e1799ca726",
|
|
"attachment_id" : "a5b7d209-dc02-4c46-a51f-805eadd3de64",
|
|
"resource_type" : "vpc",
|
|
"resource_id" : "4e5fe97c-82bc-432e-87d8-06d7e157dffa",
|
|
"route_policy" : {
|
|
"import_policy_id" : ""
|
|
},
|
|
"state" : "pending",
|
|
"created_at" : "2020-03-11T15:13:31Z",
|
|
"updated_at" : "2020-03-11T15:13:31Z"
|
|
} ],
|
|
"page_info" : {
|
|
"next_marker" : 1,
|
|
"current_count" : 1
|
|
},
|
|
"request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
|
|
}
|
|
|
|
Status Codes
|
|
------------
|
|
|
|
=========== ===========
|
|
Status Code Description
|
|
=========== ===========
|
|
200 OK
|
|
=========== ===========
|
|
|
|
Error Codes
|
|
-----------
|
|
|
|
See :ref:`Error Codes <errorcode>`.
|