Get run list
    • PDF

    Get run list

    • PDF

    Article summary

    Available in VPC

    Get the list of all created runs.

    Request

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

    MethodURI
    GET/projects/runs

    Request headers

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

    Request query parameters

    The following describes the request query 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/runs' \
    --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
    createTimeString-Run creation date and time
    updateTimeString-Run 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.

    {
        "runList": [
            {
                "runName": "2",
                "runType": "NOTEBOOK",
                "projectId": "******ygz0iujn******",
                "projectName": "project",
                "status": "RUN_STATE_IN_PROGRESS",
                "creator": "ncp-user-2689076",
                "createTime": "2024-09-03 10:38:21",
                "updateTime": "2024-09-03 10:39:51"
            },
            {
                "runName": "1",
                "runType": "NOTEBOOK",
                "projectId": "******ygz0iujn******",
                "projectName": "project",
                "status": "RUN_STATE_COMPLETED",
                "creator": "ncp-user-2689076",
                "createTime": "2024-09-03 10:24:54",
                "updateTime": "2024-09-03 10:37:56"
            }
        ],
        "totalCount": 2
    }
    

    Was this article helpful?

    What's Next
    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.