Runリストの照会
    • PDF

    Runリストの照会

    • PDF

    記事の要約

    VPC環境で利用できます。

    作成された Runの全リストを照会します。

    リクエスト

    リクエスト形式を説明します。リクエスト形式は次の通りです。

    メソッドURI
    GET/projects/runs

    リクエストヘッダ

    CLOVA NSML APIで共通して使用されるヘッダの詳細は、CLOVA NSMLの共通ヘッダをご参照ください。

    リクエストクエリパラメータ

    リクエストクエリパラメータの説明は次の通りです。

    フィールドタイプ必須の有無説明
    pageIntegerOptionalページ番号
    • 1(デフォルト)
    pageSizeIntegerOptionalページの出力数
    • 10(デフォルト)

    リクエスト例

    リクエストのサンプルコードは次の通りです。

    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'
    

    レスポンス

    レスポンス形式を説明します。

    レスポンスボディ

    レスポンスボディの説明は次の通りです。

    フィールドタイプ必須の有無説明
    runNameString-Run名
    • 作成順に自動で付与される数字
    projectIdString-プロジェクト ID
    projectNameString-プロジェクト名
    statusString-Runの状態
    creatorString-Runを作成したユーザー
    createTimeString-Runの作成日時
    updateTimeString-Runの更新日時

    レスポンスステータスコード

    CLOVA NSML APIで共通して使用されるレスポンスステータスコードの詳細は、CLOVA NSMLの共通レスポンスステータスコードをご参照ください。

    レスポンス例

    レスポンスのサンプルコードは次の通りです。

    {
        "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
    }
    

    この記事は役に立ちましたか?

    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.