Permanently Deleting a Dataset

Function

For data uploaded from OBS, you need to delete the associated raw data in OBS when deleting the datasets.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/data-management/dataset/permanent-delete

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Used to obtain the permission required to call APIs. The token is the value of X-Subject-Token in the response header in Token-based Authentication. Constraints N/A Range N/A Default Value N/A
Content-Type	Yes	String	Definition MIME type of the request body. Constraints N/A Range N/A Default Value application/json

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
dataset_name	Yes	string	Definition Dataset name. Constraints The name length ranges from [1,128]. Range N/A Default Value N/A
catalog	No	CatalogEnum	Definition Dataset form. Constraints N/A Range ORIGINAL: A type of dataset generated during data importing. PROCESS: A type of the dataset generated during data processing. PUBLISH: A type of dataset generated during data publishing. Default Value N/A
delete_obs	No	boolean	Definition Whether to delete OBS data. Constraints N/A Range true: Delete OBS data. false: Do not delete OBS data. Default Value N/A

Response Parameters

Parameter	Type	Description
dataset_name	string	Definition Dataset name. Constraints N/A Range The name length ranges from [1,128]. Default Value N/A
catalog	CatalogEnum	Definition Dataset form. Constraints N/A Range ORIGINAL: A type of dataset generated during data importing. PROCESS: A type of the dataset generated during data processing. PUBLISH: A type of dataset generated during data publishing. Default Value N/A
result	boolean	Definition Operation result. Constraints N/A Range true: Deletion success. false: Deletion failure. Default Value N/A

Parameter

Type

Description

dataset_name

string

Definition

Dataset name.

Constraints

N/A

Range

The name length ranges from [1,128].

Default Value

N/A

catalog

CatalogEnum

Definition

Dataset form.

Constraints

N/A

Range

ORIGINAL: A type of dataset generated during data importing.
PROCESS: A type of the dataset generated during data processing.
PUBLISH: A type of dataset generated during data publishing.

Default Value

N/A

result

boolean

Definition

Operation result.

Constraints

N/A

Range

true: Deletion success.
false: Deletion failure.

Default Value

N/A

Example Request

Permanently delete the original OBS data corresponding to the dataset.

POST https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/data-management/dataset/permanent-delete

Requet Header:
Content_Type: application/json
X-Auth-Token: MIIVV...

Request Params:
dataset_name: pub_345135233
catalog: PROCESS
delete_obs:true

Example Response

{
    "DatasetOperationResp": [
        {
            "dataset_name": pub_345135233,
            "catalog": PROCESS,
            "result": true,
        },
     ]
}