データセットの変更
- 印刷する
- PDF
データセットの変更
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
データセットの名前、説明、スキーマなどの情報を変更します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
POST | /datasets/{datasetId} |
リクエストヘッダ
AiTEMS APIで共通して使用されるヘッダの詳細は、AiTEMSの共通ヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
datasetId | String | Required | データセット ID
|
リクエストボディ
リクエストボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
type | String | Required | データセットタイプ
|
name | String | Required | データセット名
|
description | String | Optional | データセットの説明
|
schemaName | String | Required | データセットのスキーマ名 |
osInfo | Object | Required | データファイルが保存された Object Storage情報 |
osInfo.region | String | Required | データファイルが保存された Object Storageのリージョン
|
osInfo.bucket | String | Required | データファイルが保存された Object Storageのバケット名 |
osInfo.key | String | Required | データファイルが保存された Object Storageのパス(Prefix) |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://aitems.apigw.ntruss.com/api/v1/datasets/bu457******' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"type": "item",
"name": "item_dataset1",
"description": "item dataset",
"schemaName": "item_schema",
"osInfo": {
"region": "KR",
"bucket": "aitems",
"key": "bookmarks-items.csv"
}
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
datasetId | String | - | データセット ID |
type | String | - | データセットタイプ
|
name | String | - | データセット名 |
description | String | - | データセットの説明 |
schemaName | String | - | データセットのスキーマ名 |
status | String | - | データセットの状態
|
osInfo | Object | - | データファイルが保存された Object Storage情報 |
osInfo.region | String | - | データファイルが保存された Object Storageのリージョン
|
osInfo.bucket | String | - | データファイルが保存された Object Storageのバケット名 |
osInfo.key | String | - | データファイルが保存された Object Storageのパス(Prefix) |
connectedServices | Array | - | データセットを使用中のサービス情報 |
createdDate | String | - | データセットの作成日時 |
updatedDate | String | - | データセットの最終更新日時 |
connectedServices
connectedServices
の説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
serviceId | String | - | サービス ID |
name | String | - | サービス名 |
レスポンスステータスコード
AiTEMS APIで共通して使用されるレスポンスステータスコードの詳細は、AiTEMS APIの共通レスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"datasetId": "bu457******",
"type": "interaction",
"name": "item_dataset1",
"description": "item dataset",
"schemaName": "item_schema",
"status": "waiting",
"osInfo": {
"region": "KR",
"bucket": "aitems",
"key": "bookmarks-items.csv"
},
"connectedServices": [
{
"serviceId": "fboyb******",
"name": "service"
},
{
"serviceId": "xv94v******",
"name": "service1"
},
{
"serviceId": "6wxgu******",
"name": "service3"
}
],
"createdDate": "2024-07-30T09:49:19.254",
"updatedDate": "2024-07-30T15:45:54.217"
}
この記事は役に立ちましたか?