getList

VPC環境で利用できます。

AIアプリのすべてのリストを照会します。

リクエスト

リクエストパラメータ

リクエストヘッダ

共通ガイド参照

リクエストボディ

• JSON

    {
        "search": {
            "accountId": "string"
        }
    }
  

• XML

    <?xml version="1.0" encoding="UTF-8"?>
    <GetAiAppListRequest>
        <search>
            <accountId>string</accountId>
        </search>
    </GetAiAppListRequest>
  

レスポンス

レスポンスボディ

GetAiAppListResponse

• JSON

    {
        "contents": [
            {
            "accountName": "string",
            "appId": "string",
            "disabled": true,
            "finalStatus": "string",
            "finishedAt": "2023-05-17T01:25:31.929Z",
            "id": "string",
            "modifiedAt": "2023-05-17T01:25:31.929Z",
            "name": "string",
            "queueName": "gpu",
            "startedAt": "2023-05-17T01:25:31.929Z",
            "state": "string",
            "workspaceName": "string"
            }
        ],
        "message": "string",
        "success": true
    }
  

• XML

    <?xml version="1.0" encoding="UTF-8"?>
    <GetAiAppListResponse>
        <contents>
            <accountName>string</accountName>
            <appId>string</appId>
            <disabled>true</disabled>
            <finalStatus>string</finalStatus>
            <finishedAt>2023-05-17T01:26:31.283Z</finishedAt>
            <id>string</id>
            <modifiedAt>2023-05-17T01:26:31.283Z</modifiedAt>
            <name>string</name>
            <queueName>gpu</queueName>
            <startedAt>2023-05-17T01:26:31.283Z</startedAt>
            <state>string</state>
            <workspaceName>string</workspaceName>
        </contents>
        <message>string</message>
        <success>true</success>
    </GetAiAppListResponse>
  

エラーコード

DataForest概要参照

例

リクエスト例

POST https://df.apigw.ntruss.com/api/v2/aiapps/getList
HOST: df.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
x-ncp-apigw-timestamp: 1505290625682
x-ncp-iam-access-key: D78BB444D6D3C84CA38A

{
  "search": {
    "accountId": "9QDeb59ZeUJwKNqssE66oM"
  }
}

curl -X POST "https://df.apigw.ntruss.com/api/v2/aiapps/getList" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-ncp-apigw-timestamp:1505290625682" \
-H "x-ncp-iam-access-key:D78BB444D6D3C84CA38A" \
-H "x-ncp-apigw-signature-v2:WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=" \
-d "{ \"search\": { \"accountId\": \"9QDeb59ZeUJwKNqssE66oM\" }}" \

レスポンス例

• HTTP

  HTTP Status	Description
  200	OK

• BASH

  {
      "success": true,
      "message": "success",
      "contents": [
          {
          "id": "1Wzx0zyQ2ZTcg0p1DF6IRP",
          "appId": "application_1637836036417_0351",
          "name": "mnist-sdjw-zwcp",
          "accountName": "cloud1",
          "queueName": "gpu",
          "workspaceName": "workspace",
          "state": "FINISHED",
          "finalStatus": "SUCCEEDED",
          "startedAt": "2023-05-17T01:28:40.189Z",
          "finishedAt": "2023-05-17T01:28:40.189Z",
          "modifiedAt": "2023-05-17T01:28:40.189Z",
          "disabled": true
          }
      ]
  }