Help Center/ DataArts Studio/ API Reference/ DataArts Architecture APIs/ Compound Metrics/ Deleting Compound Metrics
Updated on 2025-11-17 GMT+08:00
View PDF

Deleting Compound Metrics

Function

This API is used to delete compound metrics with specified IDs.

Calling Method

For details, see Calling APIs.

URI

DELETE /v2/{project_id}/design/compound-metrics

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header).

This field is mandatory for authentication using tokens.

workspace

Yes

String

Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

X-Project-Id

No

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

This parameter is mandatory for API requests that use AK/SK authentication in multi-project scenarios.

Content-Type

No

String

Default value: application/json;charset=UTF-8

This parameter is optional. If the body is available, this parameter is mandatory. If the body is unavailable, you do not need to set this parameter or verify it.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ids

Yes

Array of strings

ID list, which is a string

del_types

No

String

Deletion type.

Enumerated values:

  • PHYSICAL_TABLE: whether to delete physical database tables. This parameter is valid only for tables that can be materialized. (If this parameter is set, physical database tables are deleted.)

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

data object

Indicates the final deletion result, that is, the number of objects that are successfully deleted.
Table 5 data

Parameter

Type

Description

value

Integer

Number of successfully deleted objects

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, for example, DS.6000, indicating that the request fails to be processed.

error_msg

String

Error message

data

Object

Returned data information.

Example Requests

Delete compound metrics based on the input parameters. Only compound metrics in the draft, offline, or rejected state can be deleted.

DELETE https://{endpoint}/v2/{project_id}/design/compound-metrics

{
  "ids" : [ "1227990857618227200" ]
}

Example Responses

Status code: 200

The operation succeeds, and the number of deleted compound metrics is returned.

{
  "value" : 1
}

Status code: 400

BadRequest

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user request is illegal."
}

Status code: 401

Unauthorized

{
  "error_code" : "DS.60xx",
  "error_msg" : "User authentication failed."
}

Status code: 403

Forbidden

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user does not have permission to call this API."
}

Status Codes

Status Code

Description

200

The operation succeeds, and the number of deleted compound metrics is returned.

400

BadRequest

401

Unauthorized

403

Forbidden
Parent Topic: Compound Metrics