GetFabricTopology-阿里云帮助中心

Query the physical topology information of Lingjun network interface controller and Lingjun nodes under VPD.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-wulanchabu
VpdId	string	No	Lingjun CIDR block ID	vpd-aof7****
VpcId	string	No	The ID of the virtual private cloud (VPC).	vpc-k8i0g9fk68t7u0u2w****
ClusterId	string	No	The cluster ID.	i-169263721924****
NodeIds	array	No	Node ID list
	string	No	The ID of the node.	e01-cn-1234*****
LniIds	array	No	Lingjun network interface controller ID List
	string	No	Lingjun network interface controller ID	lni-1234****

Response elements

Element	Type	Description	Example
	object	AjaxResult
Code	integer	The response status code.	0
Message	string	The returned message.	success
RequestId	string	The ID of the request.	AC8C713A-A9F4-5984-A5E1-76496DF35153
Content	object	The response parameters.
RegionId	string	The region ID.	cn-wulanchabu
VpdId	string	Lingjun CIDR block ID	vpd-fuli****
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-j6ctp4n75306****
ClusterId	string	The cluster ID.	cluster-****
TopoInfo	array<object>	network interface controller Topology Information
	object	Level information
LayerType	string	Hierarchical resource types Valid value: core: core layer. node: Lingjun node. lni: lingjun network interface controller. spine: backbone layer. leaf: access layer Valid values: core : node : lni : spine : leaf :	core
LayerName	string	The resource name.	core-1
NextLayer	array	Next Level
	any	Level information	{layerType: "node", layerName: "e01-22215****"}
AccessDeniedDetail	string	The details about the access denial.	None

Examples

Success response

JSON format

{
  "Code": 0,
  "Message": "success",
  "RequestId": "AC8C713A-A9F4-5984-A5E1-76496DF35153",
  "Content": {
    "RegionId": "cn-wulanchabu",
    "VpdId": "vpd-fuli****",
    "VpcId": "vpc-j6ctp4n75306****",
    "ClusterId": "cluster-****",
    "TopoInfo": [
      {
        "LayerType": "core",
        "LayerName": "core-1",
        "NextLayer": [
          "\n{layerType: \"node\", layerName: \"e01-22215****\"}"
        ]
      }
    ]
  },
  "AccessDeniedDetail": "None"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.