API overview-阿里云帮助中心

API standards and multilingual preset SDKs

The OpenAPI of this product (eflo/2022-05-30) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

Lingjun CIDR block

API	Title	Description
GetVpd	GetVpd	Queries the details of a Lingjun CIDR block, including the status of the Lingjun CIDR block, the CIDR block, the number of subnets and NCs.
ListVpds	ListVpds	Queries the details of one or more Lingjun CIDR blocks, including the status of Lingjun CIDR blocks, Cidr addresses, service CIDR blocks, and Subnet.
Cross-account authorization	Cross-account authorization
CreateVpdGrantRule	CreateVpdGrantRule	Users can use this API to authorize Lingjun HUB instances of the target account. After authorization, the target account can be associated with your Lingjun CIDR block by using the authorized Lingjun HUB instance.
DeleteVpdGrantRule	DeleteVpdGrantRule	Delete the Lingjun HUB cross-account authorization for a Lingjun CIDR block. After the deletion, the related data is lost and cannot be recovered.
GetVpdGrantRule	GetVpdGrantRule	Queries the details of cross-account resource authorization for a Lingjun CIDR block, including the authorized tenant ID, Lingjun HUB instance ID, and network instance ID.
ListVpdGrantRules	ListVpdGrantRules	Queries the details of one or more route entries in the CIDR block of Lingjun, including the route type, route entry status, destination CIDR block, and instance information of the next route entry.
Route entry	Route entry
GetVpdRouteEntry	GetVpdRouteEntry	Queries route entries.
ListVpdRouteEntries	ListVpdRouteEntries	Queries the route entries of the Lingjun CIDR block.
Cross-account authorization	Cross-account authorization
Route entry	Route entry

Lingjun subnet

API	Title	Description
GetSubnet	GetSubnet	Queries the details of a Lingjun subnet, including the type, CIDR block, instance ID, instance status, and number of NCs.
ListSubnets	ListSubnets	You can call this operation to query the details of one or more Lingjun subnets, including the Lingjun subnet type, network address segment, and instance ID of the Lingjun CIDR block.

Lingjun connection

API	Title	Description
InitializeVcc	InitializeVcc	Initialize the Lingjun connection and authorize Intelligent Computing Lingjun to create an SLR in your account.
DescribeSlr	DescribeSlr	Query whether the user has the SLR role-AliyunServiceRoleForEfloVcc required for Lingjun connection.
UpdateVcc	UpdateVcc	Updates the information about a Lingjun connection instance, including the peak bandwidth and name of the Lingjun connection instance.
GetVcc	GetVcc	Queries the details of a Lingjun connection, including the specification, Express Connect circuit access port type, instance status, bandwidth, and BGP CIDR block.
ListVccs	ListVccs	query the details of one or more lingjun connections, including the specification, Express Connect circuit access port type, instance status, bandwidth, and bgp network segment.
ListVccFlowInfos	ListVccFlowInfos	Queries the traffic rate of a Lingjun connection.
Cross-account authorization	Cross-account authorization
CreateVccGrantRule	CreateVccGrantRule	Users can use this API to connect Lingjun instance to the Lingjun HUB instance of the target account. After authorization, the target account can be associated with your Lingjun connection by using the authorized Lingjun HUB instance.
DeleteVccGrantRule	DeleteVccGrantRule	If you delete a Lingjun HUB cross-account authorization that is connected to Lingjun, the related data is lost and cannot be recovered.
Route entry	Route entry
CreateVccRouteEntry	CreateVccRouteEntry	Create a Lingjun connection route entry.
DeleteVccRouteEntry	DeleteVccRouteEntry	Delete a Lingjun connection route entry.
GetVccRouteEntry	GetVccRouteEntry	Queries route entries.
Cross-account authorization	Cross-account authorization
Route entry	Route entry

Lingjun elastic network interface

API	Title	Description
CreateElasticNetworkInterface	CreateElasticNetworkInterface	Creates a Lingjun Elastic Network Interface (ENI).
DeleteElasticNetworkInterface	DeleteElasticNetworkInterface	Delete a Lingjun elastic network interface (ENI). All associated data is permanently lost and cannot be recovered. Proceed with caution.
GetElasticNetworkInterface	GetElasticNetworkInterface	Retrieves the details of a Lingjun Elastic Network Interface (ENI).
ListElasticNetworkInterfaces	ListElasticNetworkInterfaces	Lists the Lingjun elastic network interfaces.
UpdateElasticNetworkInterface	UpdateElasticNetworkInterface	Updates information for the Lingjun Elastic Network Interface.
AttachElasticNetworkInterface	AttachElasticNetworkInterface	Attaches an Elastic Network Interface (ENI) to a node.
DetachElasticNetworkInterface	DetachElasticNetworkInterface	Detach an Elastic Network Interface (ENI) from a Lingjun node.
AssignLeniPrivateIpAddress	AssignLeniPrivateIpAddress	Assign a secondary private IP address to the specified Lingjun Elastic Network Interface (ENI). You can optionally let the system auto-assign the IP address.
UnassignLeniPrivateIpAddress	UnassignLeniPrivateIpAddress	Unassigns a secondary private IP address from a Lingjun elastic network interface (ENI).
GetLeniPrivateIpAddress	GetLeniPrivateIpAddress	Retrieves detailed information about an auxiliary private IP address on a specified Lingjun Elastic Network Interface (ENI).
UpdateLeniPrivateIpAddress	UpdateLeniPrivateIpAddress	Update the description of an auxiliary private IP address assigned to a Lingjun Elastic Network Interface (ENI).
ListLeniPrivateIpAddresses	ListLeniPrivateIpAddresses	Lists the auxiliary private IP addresses assigned to the current Leni elastic network interface.

Lingjun network interface

API	Title	Description
GetNetworkInterface	GetNetworkInterface	Queries information about an LNI.
ListNetworkInterfaces	ListNetworkInterfaces	Queries Lingjun network interfaces (LNIs).
ListLniPrivateIpAddress	ListLniPrivateIpAddress	Queries the list of secondary private IP addresses of Lingjun network interface controller.
AssignPrivateIpAddress	AssignPrivateIpAddress	Applies for a private secondary IP address for the current LNI. You can also call this operation to assign a secondary MAC address to the current LNI.
UnAssignPrivateIpAddress	UnAssignPrivateIpAddress	Deletes an assigned secondary private IP address.
GetLniPrivateIpAddress	GetLniPrivateIpAddress	Obtains the details about the secondary private IP address.

Lingjun HUB

API	Title	Description
Instance management	Instance management
CreateEr	CreateEr	Create a Lingjun HUB.
DeleteEr	DeleteEr	After you delete a Lingjun HUB instance, the related data is lost and cannot be recovered.
GetEr	GetEr	Queries the Lingjun HUB.
ListErs	ListErs	Queries the Lingjun HUB.
UpdateEr	UpdateEr	Updated Lingjun HUB.
Network instance connection	Network instance connection
CreateErAttachment	CreateErAttachment	Create a network instance connection.
UpdateErAttachment	UpdateErAttachment	Updates a network instance connection.
GetErAttachment	GetErAttachment	Queries network instance connections.
ListErAttachments	ListErAttachments	Queries network instance connections.
Routing policy	Routing policy
UpdateErRouteMap	UpdateErRouteMap	Update some information about the routing policy, including the description and name of the routing policy.
ListErRouteMaps	ListErRouteMaps	Routing policies are queried.
GetErRouteMap	GetErRouteMap	query lingjun hub routing policy details.
DeleteErRouteMap	DeleteErRouteMap	If you delete a routing policy instance, the related data is lost and cannot be recovered.
CreateErRouteMap	CreateErRouteMap	Users can use this API to create routing policy by specifying the network instance connection under Lingjun HUB.
Route entry	Route entry
GetErRouteEntry	GetErRouteEntry	Queries the details of Lingjun HUB route entries.

Network communication distance

API	Title	Description
ListInstancesByNcd	ListInstancesByNcd	Queries the GPU node list of a specified GPU node whose communication distance does not exceed the specified NCD.
QueryInstanceNcd	QueryInstanceNcd	Query the network communication distance (Network Communication Distance,NCD) between instances (Lingjun node, Lingjun network interface controller).

Others

API	Title	Description
GetNodeInfoForPod	GetNodeInfoForPod	Queries the network information of a node.
ListNodeInfosForPod	ListNodeInfosForPod	Queries node network information.
GetDestinationCidrBlock	GetDestinationCidrBlock	Users can use this API to query the destination CIDR block of the source policy instance when creating a routing strategy.
SwitchVccConnection	SwitchVccConnection	Switch the VCC connection instance or type
AssociateVpdCidrBlock	AssociateVpdCidrBlock	When the VPD primary network segment address is not enough to allocate, you can choose to create an additional network segment as the additional network segment of the VPD primary network segment.
CreateSubnet	CreateSubnet	Users can use this API to create a Lingjun subnet under the Lingjun network segment.
CreateVcc	CreateVcc	You can create a Lingjun connection to connect Lingjun network environment and Alibaba Cloud network environment.
CreateVpd	CreateVpd	Create a private Lingjun CIDR block. This CIDR block has an independent network environment.
DeleteErAttachment	DeleteErAttachment	If you delete a network instance that is connected to an instance, the related data is lost and cannot be recovered.
DeleteSubnet	DeleteSubnet	If you delete a Lingjun subnet instance, the related data is lost and cannot be recovered.
DeleteVpd	DeleteVpd	After you delete a Lingjun CIDR block, the related data is lost and cannot be recovered.
GetFabricTopology	GetFabricTopology	Query the physical topology information of Lingjun network interface controller and Lingjun nodes under VPD.
GetVccGrantRule	GetVccGrantRule	Queries the details of cross-account resource authorization for a Lingjun connection, including the authorized tenant ID, Lingjun HUB instance ID, and network instance ID.
ListErRouteEntries	ListErRouteEntries	Queries the route entries of the Lingjun HUB.
ListVccGrantRules	ListVccGrantRules	Queries the details of a Lingjun connection authorization, including the authorized tenant ID, region, and Lingjun HUB instance information.
ListVccRouteEntries	ListVccRouteEntries	Queries Lingjun connection route entries.
RefundVcc	RefundVcc	Unsubscribe inactive Lingjun connection
RetryVcc	RetryVcc	Retry trying to create /delete a Lingjun connection.
UnAssociateVpdCidrBlock	UnAssociateVpdCidrBlock	This function can be used to delete the additional network segment of VPD.
UpdateSubnet	UpdateSubnet	Updates some information about a specified subnet instance, including the name of the subnet instance.
UpdateVpd	UpdateVpd	Updates the information about the Lingjun CIDR block, including the name of the Lingjun CIDR block.