Get run
    • PDF

    Get run

    • PDF

    Article summary

    Available in VPC

    Get details about a specific run among the created runs.

    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 example

    The following is a sample request.

    curl --location --request GET 'https://nsml.apigw.ntruss.com/nsml/v1/projects/******ygz0iujn******/runs/2' \
    --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.

    FieldTypeRequiredDescription
    runNameString-Run name
    • Numeric value automatically assigned in order of creation
    projectIdString-Project ID
    projectNameString-Project name
    statusString-Run status
    creatorString-User who created the run
    engFullNameString-English name of the GPU server
    gpuSvrCodeInteger-GPU server code
    imageTypeString-Image type
    • BASE | CUSTOM
      • BASE: Use Base Image
      • CUSTOM: Use Custom Image
    imagePathString-Image path
    commandString-Command to run on the node
    envsObject-Node internal environment variable
    noteString-Description of run

    Response status codes

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

    Response example

    The following is a sample example.

    {
        "runName": "2",
        "projectId": "******ygz0iujn******",
        "projectName": "project",
        "status": "RUN_STATE_IN_PROGRESS",
        "creator": "ncp-user-2689076",
        "engFullName": "[Notebook] 4vCPU, 16GB Mem",
        "gpuSvrCode": 4,
        "imageType": "BASE",
        "imagePath": "nvcr.io/nvidia/tensorflow:21.02-tf1-py3",
        "command": "",
        "envs": {},
        "note": ""
    }
    

    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.