VPC環境で利用できます。
ワークスペースを削除します。
注意
ワークスペース削除の際は、次の点にご注意ください。
- 分析中の案件が存在するワークスペースは削除できません。
- 削除されたワークスペースは復旧できません。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| DELETE | /api/v1/workspaces/{workspace_name} |
リクエストヘッダ
Media Intelligence APIで共通して使用されるヘッダの詳細は、Media Intelligenceのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
workspace_name |
String | Required | ワークスペース名 |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request DELETE 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace' \
--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'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
code |
String | Required | API処理結果コード |
message |
String | Required | API処理結果メッセージ |
result |
Object | Required | 削除されたワークスペース情報 |
result.workspaceName |
String | Required | 削除されたワークスペースの名前 |
レスポンスステータスコード
Media Intelligence APIで共通して使用されるレスポンスステータスコードの詳細は、Media Intelligenceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"code": "0",
"message": "success",
"result": {
"workspaceName": "my-workspace"
}
}