DescribeNetTestResult - Platform For AI - Alibaba Cloud Documentation Center

Queries the results of a network test.

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

get

*Cluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
TestId	string	No	The ID of the test task.	dr-uf6i0tv2refv8wz*****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	8F065DDD-6996-5973-9691-9EC57BD0072E
NetTestType	string	The type of the network test.	DelayTest
Port	string	The test port number.	23604
TestId	string	The ID of the test task. This ID uniquely identifies the network test task.	af35ce53-7c35-4277-834a-fbf49c316a96
Status	string	The status of the diagnostic task. Valid values: InProgress: The task is in progress. Finished: The task is complete. Failed: The task failed.	Failed
CreationTime	string	The time when the diagnostic task was created.	2024-10-15T10:25:42+08:00
FinishedTime	string	The time when the diagnostic task was completed.	2024-10-16T02:04Z
ResultDetial	string	The details of the diagnostic result. The value is a JSON string.	{}
TrafficTest	object	The configuration for the traffic test. This parameter is returned when the network test type is a traffic test.
Protocol	string	The network protocol. Valid values: Remote Direct Memory Access (RDMA) and Transmission Control Protocol (TCP).	TCP
TrafficModel	string	The traffic model. Valid values: MTON and Fullmesh.	Fullmesh
Duration	integer	The runtime of the flow task in seconds.	1
QP	integer	If the protocol is TCP, this is the number of concurrent connections for the test. If the protocol is RDMA, this is the Queue Pair (QP) value.	1
GDR	string	Indicates whether GPUDirect RDMA (GDR) is enabled. This parameter is returned only if the protocol is RDMA. Valid values: True and False. If the protocol is TCP, this field is empty.	False
Clients	array<object>	The client nodes.
	object	A client node.
ResourceId	string	The resource ID.	e01-cn-20s41p6cx01
Bond	string	The bonded port of the network interface card (NIC).	bond1
IP	string	The IP address of the node.	192.168.1.1
ServerName	string	The service name.	xMv
Servers	array<object>	The list of servers.
	object	A server in the list.
ResourceId	string	The resource ID.	e01-cn-wwo3etaqu0b
Bond	string	The bonded port of the NIC.	bond1
IP	string	The IP address of the node.	47.121.110.190
ServerName	string	The service name.	xMv
DelayTest	object	The configuration for the delay test. This parameter is returned when the network test type is a delay test.
Hosts	array<object>	The hosts of the test nodes.
	object	A host of a test node.
ResourceId	string	The resource ID.	e01-cn-bcd3u1aee06
Bond	string	The bonded port of the NIC.	bond1
IP	string	The IP address of the node.	125.210.225.48
ServerName	string	The service name.	NQU
CommTest	object	The configuration for the communication library test. This parameter is returned when the network test type is a communication library test.
Type	string	The type of the communication library test. Valid values: Alibaba Cloud Collective Communication Library (ACCL) and NVIDIA Collective Communication Library (NCCL).	ACCL
Model	string	The communication library model.	intention_v4
GPUNum	string	The number of GPUs.	1
Hosts	array<object>	The hosts for the test.
	object	A host for the test.
ResourceId	string	The resource ID.	i111670831721110797708
IP	string	The IP address.	169.253.253.15
ServerName	string	The service name.	VBw
ClusterId	string	The cluster ID.	i119982311660892626523
ClusterName	string	The cluster name.	Standard_Cluster

Examples

Success response

JSON format

{
  "RequestId": "8F065DDD-6996-5973-9691-9EC57BD0072E",
  "NetTestType": "DelayTest",
  "Port": "23604",
  "TestId": "af35ce53-7c35-4277-834a-fbf49c316a96",
  "Status": "Failed",
  "CreationTime": "2024-10-15T10:25:42+08:00",
  "FinishedTime": "2024-10-16T02:04Z",
  "ResultDetial": "{}",
  "TrafficTest": {
    "Protocol": "TCP",
    "TrafficModel": "Fullmesh",
    "Duration": 1,
    "QP": 1,
    "GDR": "False",
    "Clients": [
      {
        "ResourceId": "e01-cn-20s41p6cx01",
        "Bond": "bond1",
        "IP": "192.168.1.1",
        "ServerName": "xMv"
      }
    ],
    "Servers": [
      {
        "ResourceId": "e01-cn-wwo3etaqu0b",
        "Bond": "bond1",
        "IP": "47.121.110.190",
        "ServerName": "xMv"
      }
    ]
  },
  "DelayTest": {
    "Hosts": [
      {
        "ResourceId": "e01-cn-bcd3u1aee06",
        "Bond": "bond1",
        "IP": "125.210.225.48",
        "ServerName": "NQU"
      }
    ]
  },
  "CommTest": {
    "Type": "ACCL",
    "Model": "intention_v4",
    "GPUNum": "1",
    "Hosts": [
      {
        "ResourceId": "i111670831721110797708",
        "IP": "169.253.253.15",
        "ServerName": "VBw"
      }
    ]
  },
  "ClusterId": "i119982311660892626523",
  "ClusterName": "Standard_Cluster"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.