Runに属する Nodeリストの照会

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

VPC環境で利用できます。

Runに属するノードの全リストを照会します。

リクエスト

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

メソッド	URI
GET	/projects/{projectId}/runs/{runName}

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`projectId`	String	Required	プロジェクト ID Projectリストの照会を通じて確認
`runName`	String	Required	Run名作成順に自動で付与される数字 Runリストの照会を通じて確認

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

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`page`	Integer	Optional	ページ番号 1(デフォルト)
`pageSize`	Integer	Optional	ページの出力数 10(デフォルト)

リクエスト例

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

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'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`nodes`	Array	-	ノードリスト
`totalCount`	Integer	-	レスポンス結果数

`nodes`

nodesの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`nodeId`	String	-	ノード ID
`projectId`	String	-	プロジェクト ID
`projectName`	String	-	プロジェクト名
`runName`	String	-	Run名
`state`	String	-	ノード状態
`resourceType`	String	-	GPUサーバの英語名
`containerImage`	String	-	Container Image
`rank`	Integer	-	Run内ノードの順序
`exitCode`	Integer	-	終了コード
`host`	String	-	SSHアクセスホスト IPアドレス
`sshPort`	Integer	-	SSHアクセスポート
`tcpProts`	Array	-	TCPアクセスポートリスト
`command`	String	-	コマンド
`createTime`	String	-	ノードの作成日時
`updateTime`	String	-	ノードの更新日時

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

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

レスポンス例

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

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

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

What's Next

Base Imageリストの照会

リクエスト
レスポンス