API standards and multilingual preset SDKs
The OpenAPI of this product (eflo-controller/2022-12-15) 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 cluster
|
API |
Title |
Description |
| CreateCluster | Create a cluster | Creates a Lingjun AI Computing Service cluster. |
| DeleteCluster | DeleteCluster | Deletes a Lingjun cluster. |
| DescribeCluster | DescribeCluster | Queries the details of a cluster. |
| ExtendCluster | Scale out a cluster | Scales out a cluster. |
| ListClusters | ListClusters | Query cluster instances with optional filtering by resource group and tags. |
| ListClusterNodes | ListClusterNodes | Queries the nodes in a cluster. |
| ShrinkCluster | ShrinkCluster | Scales in a CC cluster. |
Lingjun node group
|
API |
Title |
Description |
| CreateNodeGroup | Create a node group in a cluster | Creates a node group in a cluster. |
| UpdateNodeGroup | Update a node group | Updates a node group. |
| DeleteNodeGroup | Delete Node Group | Delete Node Group |
| ListNodeGroups | Query Node Group Information Under the Cluster | Query Node Group Information Under the Cluster |
Lingjun node
|
API |
Title |
Description |
| DeleteNode | DeleteNode | Releases a pay-as-you-go node. |
| DescribeNode | DescribeNode | Queries the list of nodes. |
| ListFreeNodes | ListFreeNodes | Lists all unused nodes. |
| RebootNodes | RebootNodes | Restarts nodes. |
| ReimageNodes | Reinstall machines | Reinstalls machines. |
Lingjun VSC
|
API |
Title |
Description |
| CreateVsc | CreateVsc | Creates a VSC. |
| DescribeVsc | DescribeVsc | Retrieves the details of a specific virtual switch controller (Vsc). |
| DeleteVsc | DeleteVsc | Deletes a VSC. |
| ListVscs | ListVscs | Queries a list of VSCs. |
Others
|
API |
Title |
Description |
| DescribeNodeType | DescribeNodeType | Describes the constraints for a node type. |
| UntagResources | UntagResources | Removes custom tags from resources. |
| TagResources | TagResources | Applies tags to resources. |
| ListTagResources | ListTagResources | Queries the tags that are attached to resources. |
| DescribeZones | DescribeZones | Queries a list of zones. |
| DescribeTask | DescribeTask | Queries the details of a task. |
| DescribeRegions | DescribeRegions | Queries a list of regions. |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group of a resource. |
| ApproveOperation | ApproveOperation | Approves an O\\\&M operation. |
| StopInvocation | StopInvocation | Stops the O\\\&M assistant command execution. |
| RunCommand | RunCommand | Runs a Shell script on one or more Lingjun nodes. |
| DescribeInvocations | DescribeInvocations | Queries the execution history and status of Cloud Assistant commands. |
| DescribeSendFileResults | DescribeSendFileResults | Queries the files that are sent by an O\\\&M assistant and the status of the files. |
| SendFile | SendFile | Sends a file to one or more Lingjun nodes. |
| ListMachineTypes | Query machine type list | Queries the list of available machine types for the user. |
| CreateDiagnosticTask | CreateDiagnosticTask | Creates a diagnostics task. |
| StopNodes | StopNodes | Stops nodes. |
| ListImages | ListImages | Lists available images. |
| DescribeDiagnosticResult | DescribeDiagnosticResult | Queries the results of a diagnostic task. |
| CloseSession | Disconnect Link | Disconnect Connection |
| CreateSession | CreateSession | Creates a Web Terminal session. |
| CreateNetTestTask | CreateNetTestTask | Creates a network test task. |
| ListUserClusterTypes | Query the cluster types available to the user | Query the cluster types available to the user |
| ListNetTestResults | ListNetTestResults | Lists network test results. |
| ListDiagnosticResults | List of Diagnostic Tasks | List of Diagnostic Tasks |
| DescribeNetTestResult | Query Network Test Result | Queries the results of a network test. |
| ListMachineNetworkInfo | Query Machine Network Configuration | Queries the network configurations for machine types. |
| ChangeNodeGroup | ChangeNodeGroup | Changes the node group of a node. |
| ChangeNodeTypes | ChangeNodeTypes | Upgrades or downgrades the specifications of one or more nodes. Before you change the specifications, ensure that the node resources meet the requirements of the target specifications. If a node does not meet the new specification requirements, the task reports success, but the specifications are not changed. Therefore, do not rely on the task status. To confirm a successful change, query the node after the task is complete and check the returned specifications. |
| DeleteHyperNode | DeleteHyperNode | Deletes an unused hyper node. |
| DescribeHyperNode | DescribeHyperNode | Queries the details of a hyper node. |
| DescribeNodeGroup | DescribeNodeGroup | Queries the details of a node group. |
| GetHyperNode | GetHyperNode | Queries the details of a hypernode. |
| ListClusterHyperNodes | ListClusterHyperNodes | Lists the node groups of a cluster and the nodes in each group. |
| ListFreeHyperNodes | ListFreeHyperNodes | Lists the active physical servers in the rack. |
| ListHyperNodes | ListHyperNodes | Machines |
| ListSyslogs | ListSyslogs | Queries system logs. |
| ReportNodesStatus | ReportNodesStatus | Reports issues with abnormal nodes. |
| DescribeFaultReport | Query fault report details | Queries the details of a fault report after a user submits one. |
| DescribeNodeGroupRefreshTask | Query node group configuration refresh task details | Queries the detailed progress of a node group configuration refresh task. Returns the actual execution result for each node, including refreshed properties, properties skipped because they exceeded the MaxDisruptiveAction constraint, and failure reasons. |
| ListFaultReports | Query fault report list | Queries the list of historical fault reports. |
| ListNodeGroupDriftedNodes | Query nodes with configuration drift in a node group | Queries nodes with configuration drift within a node group and the drift details. |
| ListNodeGroupRefreshTasks | Query node group configuration refresh tasks | Queries the list of node group configuration refresh tasks by paging. |
| RefreshNodeGroupNodes | Refresh node group configurations to existing nodes | Refreshes node group configurations to existing nodes. Manually triggers the node group configuration to take effect on existing nodes. After node group properties are changed, existing nodes do not perform automatic synchronization by default, which causes configuration drift. You can call this operation to refresh node properties. The operation returns an asynchronous refresh task ID, and the result can be queried through DescribeNodeGroupRefreshTask. |
| ReportNodeStatus | Report a fault | Reports a fault for an abnormal node. |
| StopNodeDiagnostic | Stop fault report | Stops an ongoing fault reporting diagnostics process after a user initiates a fault report. |