Help Center/ Enterprise Router/ API Reference/ APIs/ Enterprise Routers/ Querying Details About an Enterprise Router

Updated on 2026-03-20 GMT+08:00

View PDF

Querying Details About an Enterprise Router

Function

This API is used to query the details about an enterprise router.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
er:instances:get	Read	instances *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
er_id	Yes	String	Enterprise router ID

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
instance	EnterpriseRouter object	Enterprise router
request_id	String	Request ID

**Table 3** EnterpriseRouter
Parameter	Type	Description
id	String	Enterprise router ID
name	String	Enterprise router name
description	String	Description of an enterprise router
state	String	Definition: Running status. Range: pending available modifying deleting deleted failed
tags	Array of Tag objects	Tag information
charge_mode	String	Billing mode (pay-per-use) Default: postPaid
created_at	String	Creation time in the format of YYYY-MM-DDTHH:mm:ss.sssZ
updated_at	String	Update time in the format of 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 Default Route Table Propagation. The default value is false, indicating that this option is disabled.
enable_default_association	Boolean	Whether to enable Default Route Table Association. The default value is false, indicating that this option 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 enable Auto Accept Shared Attachments. The default value is false, indicating that this option is disabled.

**Table 4** Tag
Parameter	Type	Description
key	String	Tag key. A tag key can contain letters, digits, spaces encoded using UTF-8, and special characters _.:=+-@ A tag key cannot be left blank. A tag key can contain 1 to 128 characters. Tags with the tag key starting with _sys_ are system tags and cannot be added by tenants. Minimum: 1 Maximum: 128
value	String	Tag value. A tag value can contain letters, digits, spaces encoded using UTF-8, and special characters _.:=+-@ A tag value can be left blank or set to null. A tag value can contain 0 to 255 characters. Minimum: 0 Maximum: 255

Example Requests

Querying details about an enterprise router with a specified ID

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

Example Responses

Status code: 200

{
  "instance" : {
    "id" : "94c2b814-99dc-939a-e811-ae84c61ea3ff",
    "name" : "my_er",
    "description" : "this is my first enterprise router",
    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
    "state" : "pending",
    "asn" : 64512,
    "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,
    "availability_zone_ids" : [ "az1" ],
    "created_at" : "2019-09-06 02:11:13Z",
    "updated_at" : "2019-09-06 02:11:13Z"
  },
  "request_id" : "14c2b814-99dc-939b-e81c-ae84c61ea3f7"
}