Permanently Deleting a Dataset

Function

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

Authorization Information

An account has required permissions to call all APIs by default. To call this API as an IAM user, the IAM user must be granted the required permissions. For details, see Permissions and Supported Actions.

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 Figure 4. Constraints: N/A Value range: N/A Default value: N/A
Content-Type	Yes	String	Definition: MIME type of the body in the request. Constraints: N/A Value 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]. Value range: N/A Default value: N/A
catalog	No	CatalogEnum	Definition: Dataset form. Constraints: N/A Value 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 Value 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 Value range: The name length ranges from [1,128]. Default value: N/A
catalog	CatalogEnum	Definition: Dataset form. Constraints: N/A Value 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 Value range: true: Deletion success. false: Deletion failure. Default value: N/A

Parameter

Type

Description

dataset_name

string

Definition:

Dataset name.

Constraints:

N/A

Value range:

The name length ranges from [1,128].

Default value:

N/A

catalog

CatalogEnum

Definition:

Dataset form.

Constraints:

N/A

Value 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

Value 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

Request 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,
        },
     ]
}