Get list of nodes belonging to run

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

Get the list of all nodes that belong to a run.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
GET	/projects/{projectId}/runs/{runName}

Request headers

For headers common to all CLOVA NSML APIs, see Common CLOVA NSML headers.

Request path parameters

The following describes the request path parameters.

Field	Type	Required	Description
`projectId`	String	Required	Project ID Check through Get project list
`runName`	String	Required	Run name Numeric value automatically assigned in order of creation Check through Get run list

Request query parameters

The following describes the parameters.

Field	Type	Required	Description
`page`	Integer	Optional	Page number 1 (default)
`pageSize`	Integer	Optional	Page output count 10 (default)

Request example

The following is a sample request.

curl --location --request GET 'https://nsml.apigw.ntruss.com/nsml/v1/projects/******ygz0iujn******/runs/2/nodes' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-apigw-api-key: {API Key}' \
--header 'Content-Type: application/json'

Response

The following describes the response format.

Response body

The following describes the response body.

Field	Type	Required	Description
`nodes`	Array	-	List of nodes
`totalCount`	Integer	-	Number of response results

`nodes`

The following describes nodes.

Field	Type	Required	Description
`nodeId`	String	-	Node ID
`projectId`	String	-	Project ID
`projectName`	String	-	Project name
`runName`	String	-	Run name
`state`	String	-	Node status
`resourceType`	String	-	English name of the GPU server
`containerImage`	String	-	Container Image
`rank`	Integer	-	Node order in the run
`exitCode`	Integer	-	Exit code
`host`	String	-	SSH access host IP
`sshPort`	Integer	-	SSH access port
`tcpProts`	Array	-	TCP access port list
`command`	String	-	Command
`createTime`	String	-	Node creation date and time
`updateTime`	String	-	Node update date and time

Response status codes

For response status codes common to all CLOVA NSML APIs, see Common CLOVA NSML response status codes.

Response example

The following is a sample example.

{
    "nodes": [
        {
            "nodeId": "******0lonwq7k******",
            "projectId": "******ygz0iujn******",
            "projectName": "project",
            "runName": "2",
            "state": "NODE_STATE_RUNNING",
            "resourceType": "[Notebook] 4vCPU, 16GB Mem",
            "containerImage": "nvcr.io/nvidia/tensorflow:21.02-tf1-py3",
            "rank": 0,
            "exitCode": -1,
            "host": "223.130.154.166",
            "sshPort": 15001,
            "tcpPorts": [
                15002,
                15003
            ],
            "command": "",
            "createTime": "2024-09-03T01:38:26",
            "updateTime": "2024-09-03T01:39:51"
        }
    ],
    "totalCount": 1
}

Was this article helpful?

What's Next

Get base image list

Table of contents

Request
Response