Querying Enterprise Routers¶

Function¶

This API is used to query enterprise routers.

Constraints¶

Parameters marker and limit are used for pagination query. The two parameters take effect only when they are used together. Only sorting by a single field (id, name, description, created_at, or updated_at) is supported.

URI¶

GET /v3/{project_id}/enterprise-router/instances

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**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
enterprise_project_id	No	Array	Enterprise project ID
state	No	Array	Enterprise router status. Value options: pending, available, modifying, deleting, deleted, failed and freezed
id	No	Array	Query by resource ID. Multiple resources can be queried at a time.
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¶

None

Response Parameters¶

Status code: 200

**Table 3** Response body parameters¶
Parameter	Type	Description
instances	Array of EnterpriseRouter objects	Enterprise routers
page_info	PageInfo object	Pagination query information
request_id	String	Request ID

**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	Enterprise router status. Value options: pending, available, modifying, deleting, deleted, and failed
tags	Array of Tag objects	Tag information
charge_mode	String	Default: postPaid
created_at	String	Creation time in the format YYYY-MM-DDTHH:mm:ss.sssZ
updated_at	String	Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ
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.
cidr_blocks	Array of strings	Enterprise router CIDR block. This parameter is not supported for now.

**Table 5** Tag¶
Parameter	Type	Description
key	String	Tag key. The value contain up to 128 characters (36 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@). Minimum: 1 Maximum: 128
value	String	Tag value. The value contain up to 128 characters in API (43 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@). Minimum: 0 Maximum: 128

**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 two records in pagination

GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/instances?limit=2&marker=1

Querying all enterprise routers

GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/instances

Example Responses¶

Status code: 200

{
  "instances" : [ {
    "id" : "94c2b814-99dc-939a-e811-ae84c61ea3ff",
    "name" : "my_er",
    "description" : "this is my first enterprise router",
    "asn" : 64512,
    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
    "enable_default_association" : true,
    "enable_default_propagation" : true,
    "default_association_route_table_id" : "7f7f738f-453c-40b1-be26-28e7b9e390c1",
    "default_propagation_route_table_id" : "7f7f738f-453c-40b1-be26-28e7b9e390c1",
    "auto_accept_shared_attachments" : false,
    "created_at" : "2019-09-06 02:11:13Z",
    "updated_at" : "2019-09-06 02:11:13Z",
    "tags" : [ {
      "key" : "key",
      "value" : "value"
    } ],
    "enterprise_project_id" : 0,
    "availability_zone_ids" : [ "az1", "az2" ]
  } ],
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9",
  "page_info" : {
    "next_marker" : "2",
    "current_count" : 1
  }
}

Status Codes¶

Status Code	Description
200	OK

Error Codes¶

See Error Codes.

last updated: 2024-07-04 01:07