CreateNetTestTask - Platform For AI - Alibaba Cloud Documentation Center

Creates a network test task.

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

create

*Cluster

acs:eflo:{#regionId}:{#accountId}:cluster/{#ClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
NetTestType	string	No	The type of network test. Valid values: DelayTest, TrafficTest, and CommTest.	DelayTest
Port	string	No	The test port number.	23604
TrafficTest	object	No	This field is empty if TrafficModel is set to Fullmesh.
Protocol	string	No	The network protocol. Valid values: RDMA and TCP.	TCP
TrafficModel	string	No	The traffic model. Valid values: MTON and Fullmesh.	Fullmesh
Duration	integer	No	The runtime duration of the flow task, in seconds.	1
QP	integer	No	If Protocol is set to TCP, specify the number of concurrent connections for the test. If Protocol is set to RDMA, specify the QP value.	1
GDR	boolean	No	If Protocol is set to RDMA, specify True or False. This field is empty if Protocol is set to TCP.	False
Clients	array	No	The client resources.
	object	No	A client resource.
ResourceId	string	No	The resource ID.	e01-cn-20s41p6cx01
Bond	string	No	The bonded port of the network interface card (NIC).	bond1
IP	string	No	The IP address of the node.	192.168.1.1
ServerName	string	No	The service name.	xMv
NodeId	string	No	The node ID.	e01-tw-w5elqg7pw18
Servers	array	No	The list of servers.
	object	No	A server in the list.
ResourceId	string	No	The resource ID.	e01-cn-wwo3etaqu0b
Bond	string	No	The bonded NIC port.	bond1
IP	string	No	The IP address of the node.	47.121.110.190
ServerName	string	No	The service name.	xMv
NodeId	string	No	The node ID.	e01-tw-bqisacl3z6l
DelayTest	object	No	Specify this parameter if NetTestType is set to DelayTest.
Hosts	array	No	The hosts of the test nodes.
	object	No	A host of a test node.
ResourceId	string	No	The resource ID.	e01-cn-bcd3u1aee06
Bond	string	No	The bonded NIC port.	bond1
IP	string	No	The IP address of the node.	125.210.225.48
ServerName	string	No	The service name.	NQU
NodeId	string	No	The node ID.	e01-cn-fou43an0a05
CommTest	object	No	Specify this parameter if NetTestType is set to CommTest.
Type	string	No	The type of communication library test. Valid values: ACCL and NCCL.	ACCL
Model	string	No	The communication library model.	intention_v4
GPUNum	integer	No	The number of GPUs.	1
Hosts	array	No	The hosts.
	object	No	A host.
ResourceId	string	No	The resource ID.	i111670831721110797708
IP	string	No	The IP address.	169.253.253.15
ServerName	string	No	The service name.	VBw
NodeId	string	No	The node ID.	e01-tw-bqisacl3z6l
ClusterId	string	No	The cluster ID.	i119982311660892626523
NetworkMode	string	No	The network mode.	2
ClusterName	string	No	The cluster name.	Eflo-YJ-Test-Cluster

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE*****
TestId	string	The ID of the network test task. This ID is the unique identifier for the task.	dr-uf6i0tv2refv8wz*****

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE*****",
  "TestId": "dr-uf6i0tv2refv8wz*****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.