Get project list
    • PDF

    Get project list

    • PDF

    Article summary

    Available in VPC

    Get the list of all created projects.

    Request

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

    MethodURI
    GET/projects

    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?page=0&pagesize=1' \
    --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
    projectsArray-Project information
    totalCountInteger-Number of response results

    projects

    The following describes projects.

    FieldTypeRequiredDescription
    projectIdString-Project ID
    vpcNoInteger-VPC number
    projectNameString-Project name
    statusString-Project status
    • CREATING | CREATED | CHANGING | DELETING | DELETED
      • CREATING: creating
      • CREATED: creation completed
      • CHANGING: changing
      • DELETING: deleting
      • DELETED: deletion completed
    userNoInteger-User number
    runCountInteger-Run count
    nodeCountInteger-Number of nodes
    createdDateString-Project creation date and time
    updatedDateString-Project 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.

    {
        "projects": [
            {
                "projectId": "******ygz0iujn******",
                "vpcNo": 34***,
                "projectName": "project",
                "status": "CREATED",
                "userNo": 268****,
                "runCount": 0,
                "nodeCount": 0,
                "createDate": "2024-09-02T15:44:43",
                "updateDate": "2024-09-02T15:44:59"
            }
        ],
        "totalCount": 1
    }
    

    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.