Job创建--增长分析 DataFinder-火山引擎

文档中心

立即注册

导航

Job创建

最近更新时间：2024.06.30 18:36:03首次发布时间：2024.06.30 18:36:03

使用说明

该接口用于创建删除Job，可以混合传递user_unique_id和ssid，单次删除请求最多支持删除100个用户的数据，同一个应用在同一时间最多只能有一个Job在执行。

请求说明

Path: /datafinder/openapi/v1/{app_id}/data-deletions
Method: POST
Content-type: application/json

请求参数

Path-parameters:

参数	类型	是否必选	示例值	描述
app_id	int	是	123456	应用ID

Body:

{
    "uuids": ["uuid-1"， "uuid-2"],
    "ssids": ["ssid-3", "ssid-4"]
}

参数	类型	是否必选	示例值	描述
uuids	List	否	见下文请求示例	待删除的user_unique_id列表
ssids	List	分批	见下文请求示例	待删除的ssid列表

注：如果uuids和ssids都指定，那么将会根据uuid查询出ssid，合并后的结果作为待删除列表

返回参数

Response：

{
    "code": 200,
    "message": "success",
    "data": {
            "app_id": 1234,
            "job_id": "job_id",
            "status": "STARTED",
            "uuids": ["uuid-1", "uuid-2"],
            "ssids": ["ssid-3", "ssid-4"],
            "creator": "user_1",
            "updater": "user_1",
            "created_at": "2022-08-15",
            "updated_at": "2022-08-15",
            "started_at": "2022-08-15"
    }
}

返回状态码说明：

code	description
200	任务创建成功
400	任务创建失败，错误信息以具体的message为准
429	任务创建失败，存在未结束的数据删除任务。

DeletionJob

Field	Type	Description
app_id	int	应用id
job_id	string	Job创建后生成的唯一id
status	string	Job当前的状态
uuids	List	待删除的uuid列表
ssids	List	待删除的ssid列表
creator	string	Job创建人
updater	string	Job的最近更新人
created_at	string	Job创建时间
updated_at	string	Job更新时间
started_at	string	Job开始执行的时间

请求示例

rc 为创建的 RangersClient, 其初始化请参考使用说明，各语言的 SDK 都提供了类似的接口
调用(Python)：

ak = 'xxx' # ak
sk = 'xxx' # sk

# 需要指定url地址
url = '{使用Finder服务域名替换}'
rc = RangersClient(ak, sk, url=url)

body = {
   "uuids": ["uuid-1", "uuid-2"]
}

resp = rc.request(
    "/datafinder/openapi/v1/{app_id}/data-deletions",
     method="POST",
     body=body
 )
print(resp.json())

返回示例

{
    "code": 200,
    "message": "success",
    "data": {
            "app_id": 1234,
            "job_id": "job_id",
            "status": "STARTED",
            "uuids": ["uuid-1", "uuid-2"],
            "ssids": ["ssid-3", "ssid-4"],
            "creator": "user_1",
            "updater": "user_1",
            "created_at": "2022-08-15",
            "updated_at": "2022-08-15",
            "started_at": "2022-08-15"
    }
}