Projectリストの照会

印刷する
共有
PDF

記事の要約

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

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

VPC環境で利用できます。

作成されたプロジェクトの全リストを照会します。

リクエスト

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

メソッド	URI
GET	/projects

リクエストヘッダ

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

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

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

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

リクエスト例

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

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' \

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`projects`	Array	-	プロジェクト情報
`totalCount`	Integer	-	レスポンス結果数

`projects`

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

フィールド	タイプ	必須の有無	説明
`projectId`	String	-	プロジェクト ID
`vpcNo`	Integer	-	VPC番号
`projectName`	String	-	プロジェクト名
`status`	String	-	プロジェクトの状態 `CREATING` \| `CREATED` \| `CHANGING` \| `DELETING` \| `DELETED` `CREATING`: 作成中 `CREATED`: 作成完了 `CHANGING`: 変更中 `DELETING`: 削除中 `DELETED`: 削除完了
`userNo`	Integer	-	ユーザー番号
`runCount`	Integer	-	Run数
`nodeCount`	Integer	-	ノード数
`createdDate`	String	-	プロジェクトの作成日時
`updatedDate`	String	-	プロジェクトの更新日時

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

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

レスポンス例

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

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

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

What's Next

Projectの照会

リクエスト
レスポンス