GetEr-阿里云帮助中心

Queries the Lingjun HUB.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eflo:GetEr

get

*Er

acs:eflo:{#regionId}:{#accountId}:Er/{#ErId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-wulanchabu
ErId	string	Yes	Lingjun HUB ID	er-kkopgtne

Response elements

Element	Type	Description	Example
	object	AjaxResult
Code	integer	The response status code.	0
Message	string	Information returned when the call fails	success
RequestId	string	Request ID of the current request	308DE9D2-03A6-5B44-A369-67B75D1EE091
Content	object	The response parameters.
CreateTime	string	The time when the data address was created.	1644283112720
GmtModified	string	The time when the agent was last modified.	1627545952000
Message	string	The message that is returned.	Success
ErId	string	Lingjun HUB Instance ID	er-aueyxxsy
RegionId	string	The region ID.	cn-wulanchabu
TenantId	string	The ID of the tenant.	1620939556166277
Status	string	The status of the intervention entry. Valid value:	Available
ErName	string	Lingjun HUB Instance Name	er-heyuan-main
MasterZoneId	string	Primary Zone	cn-wulanchabu-b
Description	string	Description	Description
ErAttachments	array<object>	Network instance information list
	object	Network Instance Information
Status	string	The status of the intervention entry. Valid value:	Available
Message	string	The returned message.	available
ResourceGroupId	string	Resource group instance ID	rg-acfmyoj5mg3w54y
InstanceId	string	The instance ID.	vpd-kkopgtne
CreateTime	string	The time when the data address was created.	1644283112720
GmtModified	string	The time when the agent was last modified.	1649303733000
ErId	string	Lingjun HUB Instance ID	er-kkopgtne
Across	boolean	Cross-account	false
InstanceName	string	The name of the ECU.	Lingjun network segment instance
TenantId	string	The ID of the tenant.	1620939556166277
ResourceTenantId	string	The ID of the tenant to which the resource belongs.	xxxxxxxx
AutoReceiveAllRoute	boolean	Receive all routes automatically	true
ErAttachmentName	string	Network Instance Name	ernetwork instance-vpd-kkopgtne
ErAttachmentId	string	The connection ID of the Lingjun HUB network instance.	er-attachment-f32hxfsu
RegionId	string	The synchronized region where the ECS instances are deployed.	cn-wulanchabu
InstanceType	string	Instance type: VPD and VCC Valid value: VCC: Lingjun Connection. VPD: Lingjun network segment. Valid values: VCC : VPD :	VPD
ErRouteMaps	array<object>	routing policy information list
	object	routing policy information
Status	string	The status of the intervention entry. Valid value:	Available
TransmissionInstanceType	string	The type of the source instance.	VPD
Action	string	Policy behavior Valid value: deny: rejects the. permit: The allows. Valid values: deny : permit :	permit
Description	string	Policy description	test
ReceptionInstanceType	string	The type of the destination instance.	VPD
Message	string	The message that is returned.	Success
ErRouteMapName	string	The name of the routing policy.	route entry information
ReceptionInstanceId	string	The ID of the destination instance.	vpd-sdkd2gkx
ResourceGroupId	string	Resource group instance ID	rg-1234567890
CreateTime	string	The time when the data address was created.	1645766599809
GmtModified	string	The time when the agent was last modified.	1623899444000
ErId	string	Lingjun HUB ID	er-kkopgtne
TransmissionInstanceName	string	Source instance name	sender instance
DestinationCidrBlock	string	Destination CIDR Block	10.0.0.0/8
ReceptionInstanceOwner	string	The tenant to which the destination instance belongs.	1620939556166277
TenantId	string	The ID of the tenant.	XXQGPROD-zh_CN
ReceptionInstanceName	string	The name of the destination instance.	receiver instance
ErRouteMapId	string	routing policy ID	er-rmap-xkslnmsr
TransmissionInstanceOwner	string	The tenant to which the source instance belongs.	1620939556166277
RegionId	string	The region ID.	cn-wulanchabu
TransmissionInstanceId	string	The ID of the source instance.	vpd-xmglsymg
RouteMapNum	integer	Policy sequence number (1001-2000)	1001
ErRouteEntrys	array<object>	The list of route entry information.
	object	Route entry information
Status	string	The status of the intervention entry. Valid value:	Available
NextHopType	string	Next Hop Instance Type	VCC
TenantId	string	The ID of the tenant.	1620939556166277
ResourceTenantId	string	The ID of the tenant to which the resource belongs.	1620939556166277
RouteType	string	Route type	System
ErRouteEntryId	string	The ID of the route entry.	er-rte-xnmsd2kl
ResourceGroupId	string	Resource group instance ID	rg-acfmyoj5mg3w54y
NextHopId	string	Next Hop Instance	vcc-xxkmggkw
GmtModified	string	The time when the cluster was updated.	1623317089000
ErId	string	Lingjun HUB Instance ID	er-kkopgtne
RegionId	string	The region ID.	cn-wulanchabu
DestinationCidrBlock	string	Destination CIDR Block	10.0.0.0/9
ResourceGroupId	string	Resource group instance ID	rg-aek2l4sq6l7unhi
Tags	array<object>	List of Tags
	object	The tag information
TagKey	string	The tag key.	key
TagValue	string	The tag value.	value
AccessDeniedDetail	string	The details about the access denial.	{}

Examples

Success response

JSON format

{
  "Code": 0,
  "Message": "success",
  "RequestId": "308DE9D2-03A6-5B44-A369-67B75D1EE091",
  "Content": {
    "CreateTime": "1644283112720",
    "GmtModified": "1627545952000",
    "Message": "Success",
    "ErId": "er-aueyxxsy",
    "RegionId": "cn-wulanchabu",
    "TenantId": "1620939556166277",
    "Status": "Available",
    "ErName": "er-heyuan-main",
    "MasterZoneId": "cn-wulanchabu-b",
    "Description": "description",
    "ErAttachments": [
      {
        "Status": "Available",
        "Message": "available",
        "ResourceGroupId": "rg-acfmyoj5mg3w54y",
        "InstanceId": "vpd-kkopgtne",
        "CreateTime": "1644283112720",
        "GmtModified": "1649303733000",
        "ErId": "er-kkopgtne",
        "Across": false,
        "InstanceName": "Lingjun network segment instance",
        "TenantId": "1620939556166277",
        "ResourceTenantId": "xxxxxxxx",
        "AutoReceiveAllRoute": true,
        "ErAttachmentName": "ernetwork instance-vpd-kkopgtne",
        "ErAttachmentId": "er-attachment-f32hxfsu",
        "RegionId": "cn-wulanchabu",
        "InstanceType": "VPD"
      }
    ],
    "ErRouteMaps": [
      {
        "Status": "Available",
        "TransmissionInstanceType": "VPD",
        "Action": " permit",
        "Description": "test",
        "ReceptionInstanceType": "VPD",
        "Message": "Success",
        "ErRouteMapName": "route entry information",
        "ReceptionInstanceId": "vpd-sdkd2gkx",
        "ResourceGroupId": "rg-1234567890",
        "CreateTime": "1645766599809",
        "GmtModified": "1623899444000",
        "ErId": "er-kkopgtne",
        "TransmissionInstanceName": "sender instance",
        "DestinationCidrBlock": "10.0.0.0/8",
        "ReceptionInstanceOwner": "1620939556166277",
        "TenantId": "XXQGPROD-zh_CN",
        "ReceptionInstanceName": "receiver instance",
        "ErRouteMapId": "er-rmap-xkslnmsr",
        "TransmissionInstanceOwner": "1620939556166277",
        "RegionId": "cn-wulanchabu",
        "TransmissionInstanceId": "vpd-xmglsymg",
        "RouteMapNum": 1001
      }
    ],
    "ErRouteEntrys": [
      {
        "Status": "Available",
        "NextHopType": "VCC",
        "TenantId": "1620939556166277",
        "ResourceTenantId": "1620939556166277",
        "RouteType": "System",
        "ErRouteEntryId": "er-rte-xnmsd2kl",
        "ResourceGroupId": "rg-acfmyoj5mg3w54y",
        "NextHopId": "vcc-xxkmggkw",
        "GmtModified": "1623317089000",
        "ErId": "er-kkopgtne",
        "RegionId": "cn-wulanchabu",
        "DestinationCidrBlock": "10.0.0.0/9"
      }
    ],
    "ResourceGroupId": "rg-aek2l4sq6l7unhi",
    "Tags": [
      {
        "TagKey": "key",
        "TagValue": "value"
      }
    ]
  },
  "AccessDeniedDetail": "{}"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.