MENU
      Get list of nodes belonging to run

        Get list of nodes belonging to run


        Article summary

        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:

        MethodURI
        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.

        FieldTypeRequiredDescription
        projectIdStringRequiredProject ID
        runNameStringRequiredRun name
        • Numeric value automatically assigned in order of creation
        • Check through Get run list

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        pageIntegerOptionalPage number
        • 1 (default)
        pageSizeIntegerOptionalPage 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'
        Shell

        Response

        The following describes the response format.

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        nodesArray-List of nodes
        totalCountInteger-Number of response results

        nodes

        The following describes nodes.

        FieldTypeRequiredDescription
        nodeIdString-Node ID
        projectIdString-Project ID
        projectNameString-Project name
        runNameString-Run name
        stateString-Node status
        resourceTypeString-English name of the GPU server
        containerImageString-Container Image
        rankInteger-Node order in the run
        exitCodeInteger-Exit code
        hostString-SSH access host IP
        sshPortInteger-SSH access port
        tcpProtsArray-TCP access port list
        commandString-Command
        createTimeString-Node creation date and time
        updateTimeString-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
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.