文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据架构API/ 衍生指标接口/ 删除衍生指标
更新时间：2024-12-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

删除衍生指标

功能介绍

根据衍生指标ID，删除衍生指标。

调用方法

请参见如何调用API。

URI

DELETE /v2/{project_id}/design/derivative-indexs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参见项目ID和账号ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

IAM Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

使用Token认证时必选。

workspace

是

String

工作空间ID，获取方法请参见实例ID和工作空间ID。

X-Project-Id

否

String

项目ID，获取方法请参见项目ID和账号ID。

多project场景采用AK/SK认证的接口请求，则该字段必选。

Content-Type

否

String

默认值：application/json;charset=UTF-8

可选，有Body体的情况下必选，没有Body体则无需填写和校验。
表3 请求Body参数

参数

是否必选

参数类型

描述

ids

是

Array of strings

ID列表，ID字符串。

del_types

否

String

删除类型。

枚举值：

  • PHYSICAL_TABLE: 是否删除数据库物理表，只针对能物化的表生效（配置此值则表示删除）

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

data

data object

删除的最终返回结果，返回成功删除的对象个数。
表5 data

参数

参数类型

描述

value

Integer

成功删除的对象个数

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码，如DS.6000，请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，如DS.6000，请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，如DS.6000，请求处理失败。

error_msg

String

错误信息。

data

Object

返回的数据信息。

请求示例

根据传入的参数，删除衍生指标，只支持删除状态为草稿、已下线、已驳回的衍生指标。

DELETE https://{endpoint}/v2/{project_id}/design/derivative-indexs

{
  "ids" : [ "1227990857618227200" ]
}

响应示例

状态码： 200

Success，返回data数据是删除个数。

{
  "value" : 1
}

状态码： 400

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

状态码： 401

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

状态码： 403

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

状态码

状态码

描述

200

Success，返回data数据是删除个数。

400

BadRequest

401

Unauthorized

403

Forbidden
父主题： 衍生指标接口

相关文档