ListNetTestResults - Platform For AI - Alibaba Cloud Documentation Center

Lists network test results.

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

get

*Cluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The token that is used to retrieve the next page of results. Set this parameter to the value of `NextToken` that is returned in the last response.	3a6b93229825ac667104463b5679****
MaxResults	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: If you do not set this parameter or you set it to a value less than 20, the default value is 20. If you set the value to greater than 100, the default value is 100.	20
NetTestType	string	No	The type of the network test.	DelayTest
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmxno4vh5****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	3C683243-7915-57FB-9570-A2932C1C0F78
NetTestResults	array<object>	The list of nodes.
	object	The list of nodes.
Port	string	The test port.	80
NetTestType	string	The type of the network test.	NetDiag
TestId	string	The test ID. It is the unique identifier of the resource test task.	String i-uf6i0tv2refv8wz*****
Status	string	The status of the network test task. Valid values: ● InProgress: The test is in progress. ● Finished: The test is complete. ● Failed: The test failed.	InProgress
CreationTime	string	The time when the task was created.	2024-01-19T02:18:12Z
FinishedTime	string	The time when the task was completed.	2024-10-30T02:07Z
TrafficTest	object	The details of the traffic test. This object is returned if the value of `NetTestType` is `TrafficTest`.
Protocol	string	The network protocol. Valid values are RDMA and TCP.	TCP
TrafficModel	string	The traffic model. Valid values are MTON and Fullmesh.	Fullmesh
Duration	integer	The runtime of the flow task, in seconds.	1
QP	integer	If the protocol is TCP, this parameter specifies the number of concurrent connections for the test. If the protocol is RDMA, this parameter specifies the QP value.	RDMA
GDR	string	If the protocol is RDMA, specify True or False. If the protocol is TCP, this field is empty.	True
Clients	array<object>	The client.
	object	The client.
ResourceId	string	The resource ID.	e01-cn-20p36bqet39
Bond	string	The bonded port of the network interface card.	bond1
IP	string	The IP address.	74.73.100.1
ServerName	string	The service name.	prod-gf-cn.juequling.com
Servers	array<object>	This field is empty if `TrafficModel` is set to `Fullmesh`.
	object	This field is empty if `TrafficModel` is set to `Fullmesh`.
ResourceId	string	The resource ID.	e01-cn-wwo3ete****
Bond	string	The bonded port of the network interface card.	bond1
IP	string	The IP address of the node.	10.1.168.183
ServerName	string	The service name.	prod-gf-cn.juequling.com
DelayTest	object	The details of the delay test. This object is returned if the value of `NetTestType` is `DelayTest`.
Hosts	array<object>	The list of resources.
	object	The list of resources.
ResourceId	string	The resource ID.	e01-cn-wwo3ete****
Bond	string	The bonded port of the network interface card.	bond1
IP	string	The IP address of the node.	pgm-bp174z988a27wre71o.pg.rds.aliyuncs.com
ServerName	string	The service name.	WrF
CommTest	object	The details of the communication library test. This object is returned if the value of `NetTestType` is `CommTest`.
Type	string	The type of the communication library test. Valid values: ACCL or NCCL.	ACCL
Model	string	The communication library model.	AllToAll
GPUNum	string	The number of GPUs.	4
Hosts	array<object>	The hosts of the test nodes.
	object	The hosts of the test nodes.
ResourceId	string	The resource ID.	e01-cn-wwo3ete****
IP	string	The IP address of the node.	10.51.16.21
ServerName	string	The service name.	www.xinjiaoyu.com
ClusterId	string	The cluster ID.	i11066721171826501****
NetworkMode	string	The network mode.	01
ClusterName	string	The cluster name.	test
NextToken	string	The token that is used to retrieve the next page of results. If this parameter is not returned, it indicates that all results have been returned.	3a6b93229825ac667104463b5679****
MaxResults	integer	The number of entries returned on each page. Maximum value: 100. Default value: If you do not set this parameter or you set it to a value less than 20, the default value is 20. If you set the value to greater than 100, the default value is 100.	20

Examples

Success response

JSON format

{
  "RequestId": "3C683243-7915-57FB-9570-A2932C1C0F78",
  "NetTestResults": [
    {
      "Port": "80",
      "NetTestType": "NetDiag",
      "TestId": "String\ti-uf6i0tv2refv8wz*****",
      "Status": "InProgress",
      "CreationTime": "2024-01-19T02:18:12Z",
      "FinishedTime": "2024-10-30T02:07Z",
      "TrafficTest": {
        "Protocol": "TCP",
        "TrafficModel": "Fullmesh",
        "Duration": 1,
        "QP": 0,
        "GDR": "True",
        "Clients": [
          {
            "ResourceId": "e01-cn-20p36bqet39",
            "Bond": "bond1",
            "IP": "74.73.100.1",
            "ServerName": "prod-gf-cn.juequling.com"
          }
        ],
        "Servers": [
          {
            "ResourceId": "e01-cn-wwo3ete****",
            "Bond": "bond1",
            "IP": "10.1.168.183",
            "ServerName": "prod-gf-cn.juequling.com"
          }
        ]
      },
      "DelayTest": {
        "Hosts": [
          {
            "ResourceId": "e01-cn-wwo3ete****",
            "Bond": "bond1",
            "IP": "pgm-bp174z988a27wre71o.pg.rds.aliyuncs.com",
            "ServerName": "WrF"
          }
        ]
      },
      "CommTest": {
        "Type": "ACCL",
        "Model": "AllToAll",
        "GPUNum": "4",
        "Hosts": [
          {
            "ResourceId": "e01-cn-wwo3ete****",
            "IP": "10.51.16.21",
            "ServerName": "www.xinjiaoyu.com"
          }
        ]
      },
      "ClusterId": "i11066721171826501****",
      "NetworkMode": "01",
      "ClusterName": "test"
    }
  ],
  "NextToken": "3a6b93229825ac667104463b5679****",
  "MaxResults": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.