删除数据清洗任务
更新时间:2024-07-18
功能介绍
本接口用于删除数据清洗任务。
SDK调用
使用说明
调用本文API,需使用安全认证AK/SK鉴权,调用流程及鉴权介绍详见SDK安装及使用流程。
调用示例
import os
from qianfan.resources import Data
# 使用安全认证AK/SK鉴权,通过环境变量方式初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
resp = Data.delete_dataset_etl_task(["ds-9tff1q3h7ngdmgh4"])
返回示例
QfResponse(
code=200,
headers={...},
body={
"log_id": "nghhxtiaz8qqhiej",
"result": True,
"status": 200,
"success": True
},
)
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
etl_ids | List[string] | 是 | 将要删除的清洗任务的任务序号列表,说明: (1)通过以下方式获取该字段值: · 方式一,通过调用查看清洗任务列表接口,返回的字段etlStrId获取 · 方式二,在千帆控制台-数据处理-数据清洗页面,查看任务序号,如下图所示: ![]() (2)该字段新增支持string[]类型,如果之前使用的是int[]类型,建议变更为string[]类型,后续可能将逐步废弃int[]类型;例如之前是通过调用查看清洗任务列表接口,返回的etlId字段获取,请替换为接口返回的etlStrId字段获取 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
log_id | string | 操作记录id |
result | bool | 返回结果 |
status | int | 状态码 |
success | bool | 是否操作成功,说明: · true:成功 · false:失败 |
HTTP调用
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址:https://qianfan.baidubce.com/wenxinworkshop/etl/delete
请求方式:POST
- Header参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | string | 是 | 固定值:application/json |
x-bce-date | string | 否 | 当前时间,遵循ISO8601规范,格式如2016-04-06T08:23:49Z |
Authorization | string | 是 | 用于验证请求合法性的认证信息,更多内容请参考鉴权认证机制,签名工具可参考IAM签名工具 |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
etlIds | string[] | 是 | 将要删除的清洗任务的任务序号列表,说明: (1)通过以下方式获取该字段值: · 方式一,通过调用查看清洗任务列表接口,返回的字段etlStrId获取 · 方式二,在千帆控制台-数据处理-数据清洗页面,查看任务序号,如下图所示: ![]() (2)该字段新增支持string[]类型,如果之前使用的是int[]类型,建议变更为string[]类型,后续可能将逐步废弃int[]类型;例如之前是通过调用查看清洗任务列表接口,返回的etlId字段获取,请替换为接口返回的etlStrId字段获取 |
响应说明
名称 | 类型 | 描述 |
---|---|---|
log_id | string | 操作记录id |
result | bool | 返回结果 |
status | int | 状态码 |
success | bool | 是否操作成功,说明: · true:成功 · false:失败 |
请求示例
# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/wenxinworkshop/etl/delete' \
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21a52640015de61bc55ca2e6d8cc23d080016e374525543' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
"etlIds": ["ds-9tff1q3h7ngdmgh4"]
}'
响应示例
{
"log_id": "v6fkzy51it3fp9t8",
"result": true,
"status": 200,
"success": true
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
code | 错误码 |
message | 错误描述信息,帮助理解和解决发生的错误 |
例如参数错误返回:
{
"code": 500001,
"message": "param invalid"
}
更多千帆大模型平台错误码,请查看错误码说明。