ListErs-阿里云帮助中心

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:ListErs

list

*Er

acs:eflo:{#regionId}:{#accountId}:er/*

None

Request parameters

Parameter	Type	Required	Description	Example
MasterZoneId	string	No	The primary zone.	cn-wulanchabu-b
ErName	string	No	Lingjun HUB name.	er-heyuan-main
RegionId	string	Yes	The region ID.	cn-wulanchabu
ErId	string	No	The ID of the Lingjun HUB instance.	er-kkop****
InstanceId	string	No	The ID of the network instance.	vcc-cn-209300q****
InstanceType	string	No	The type of the attached network instance. Valid values: VPD VCC	VCC
ResourceGroupId	string	No	Resource group instance ID	rg-acfmzzka6bnjvbi
Tag	array<object>	No	List of tags.
	object	No	The tag information.
Value	string	No	The value of the tag.	value-test
Key	string	No	The key of the tag.	key-test
PageNumber	integer	No	The page number to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
EnablePage	boolean	No	Specifies whether to enable paged query. Valid values: true: enables paged query. false: Paged query is disabled.	false

Response elements

Element	Type	Description	Example
	object	The response parameters.
Code	integer	The response status code.	0
Message	string	The error message. (If the instance is in the Exception state, the exception cause is displayed.)	成功
RequestId	string	The request ID.	AC8C713A-A9F4-5984-A5E1-76496DF35153
Content	object	The response data.
Total	integer	The total number of entries.	1
Data	array<object>	lingjun hub information list.
	array<object>	Lingjun HUB information.
Status	string	The task status.	Available
Connections	integer	The number of connections to the Lingjun HUB network instance.	2
Description	string	The description of the synchronization task.	描述
Message	string	The returned message.	成功
ResourceGroupId	string	Resource group instance ID	rg-1234567890
CreateTime	string	The time when the activation code was created.	1640930671000
GmtModified	string	The time when the O&M task was modified.	1640930671000
ErId	string	The ID of the Lingjun HUB instance.	er-kkop****
RouteMaps	integer	Number of Lingjun HUB routing policy.	2
ErName	string	The name of the Lingjun HUB instance.	er-wulanchabu-main
TenantId	string	The tenant ID.	165544950****
RegionId	string	The region ID.	cn-wulanchabu
MasterZoneId	string	The primary zone.	cn-wulanchabu-b
Tags	array<object>	The list of tags.
	object	The information about the tag.
TagKey	string	The tag key.	mytest
TagValue	string	The tag value.	user
AccessDeniedDetail	string	The details about the access denial.	None

Examples

Success response

JSON format

{
  "Code": 0,
  "Message": "成功",
  "RequestId": "AC8C713A-A9F4-5984-A5E1-76496DF35153",
  "Content": {
    "Total": 1,
    "Data": [
      {
        "Status": "Available",
        "Connections": 2,
        "Description": "描述",
        "Message": "成功",
        "ResourceGroupId": "rg-1234567890",
        "CreateTime": "1640930671000",
        "GmtModified": "1640930671000",
        "ErId": "er-kkop****",
        "RouteMaps": 2,
        "ErName": "er-wulanchabu-main",
        "TenantId": "165544950****",
        "RegionId": "cn-wulanchabu",
        "MasterZoneId": "cn-wulanchabu-b",
        "Tags": [
          {
            "TagKey": "mytest",
            "TagValue": "user"
          }
        ]
      }
    ]
  },
  "AccessDeniedDetail": "None"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.