getList
- 印刷する
- PDF
getList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
AIワークスペースのすべてのリストを照会します。
リクエスト
リクエストパラメータ
パラメータ名 | 要否 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
search.accountId | YES | String | 最大22文字まで入力 | 照会するアカウントの UUID(base62) |
リクエストヘッダ
リクエストボディ
- JSON
{ "search": { "accountId": "string" } }
- XML
<?xml version="1.0" encoding="UTF-8"?> <GetAiWorkspaceListRequest> <search> <accountId>string</accountId> </search> </GetAiWorkspaceListRequest>
レスポンス
レスポンスボディ
- JSON
{ "contents": [ { "accountName": "string", "createdAt": "2023-05-15T02:23:55.752Z", "description": "string", "disabled": true, "id": "string", "imageVersion": "string", "modifiedAt": "2023-05-15T02:23:55.752Z", "name": "string" } ], "message": "string", "success": true, "total": 0 }
- XML
<?xml version="1.0" encoding="UTF-8"?> <GetAiWorkspaceListResponse> <contents> <accountName>string</accountName> <createdAt>2023-05-15T02:26:26.689Z</createdAt> <description>string</description> <disabled>true</disabled> <id>string</id> <imageVersion>string</imageVersion> <modifiedAt>2023-05-15T02:26:26.689Z</modifiedAt> <name>string</name> </contents> <message>string</message> <success>true</success> <total>0</total> </GetAiWorkspaceListResponse>
エラーコード
例
リクエスト例
POST https://df.apigw.ntruss.com/api/v2/aiworkspaces/getList
HOST: df.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: Azm1WBMWDgEONUCUbsVkB4tRIpc053uOHU8bitbQRtU=
x-ncp-apigw-timestamp: 1658898041497
x-ncp-iam-access-key: 17F9A6E9F72BD92ED94B
{
"search": {
"accountId": "azjdAVRBx7cdEZqjvxSabH"
}
}
curl -X POST "https://df.apigw.ntruss.com/api/v2/aiworkspaces/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\": \"azjdAVRBx7cdEZqjvxSabH\" }}" \
レスポンス例
HTTP
HTTP Status Description 200 OK BASH
{ "success": true, "total":1, "contents": [ { "id": "9YYJ3tyxqtafSniaNvJ8uq", "name": "<AIワークスペース-名>", "accountName": "<アカウント-名>", "description": "<AIワークスペース-説明>", "imageVersion": "<Docker画像>:<Docker画像バージョン>", "createdAt": "2022-07-27T16:17:44.055+09:00", "modifiedAt": "2022-07-27T16:17:44.092+09:00", "disabled": true } ] }
この記事は役に立ちましたか?