本文档为用户数据删除相关openapi接口的说明文档。使用提供的OpenAPI可以删除一组已知user_unique_id或ssid用户的数据。(私有化版本4.1(含)后开始支持)
一个数据删除请求对应一个Job,Job创建成功后,处于PENDING状态,将会有24小时的等待时间。在24小时内如果想要取消删除操作,可以调用对应的OpenAPI执行取消操作。在不进行取消操作的情况下,24小时后Job变为STARTED状态,处于该状态的Job无法取消。Job的状态可以通过提供的OpenAPI查询获得。
状态 | 含义 |
---|---|
PENDING | Job创建后,24小时内处于该状态。处于该状态的Job支持取消 |
STARTED | Job创建超过24小时后更新为该状态。处于该状态的Job不支持取消 |
REVOKED | 取消状态。处于该状态的Job不会被调度 |
SUCCESS | 执行成功 |
FAILURE | 执行失败 |
任务状态变更时请求方会收到站内信通知,具体可以收到四种类型的站内信。
Job状态 | 站内信 |
---|---|
PENDING | 调用Job创建API创建成功后,Job处于该状态。收到的站内信内容为: |
STARETED | Job创建24小时后,Job处于该状态。收到的站内信内容为: |
REVOKED | 调用Job取消API取消成功后,Job处于该状态。收到的站内信内容为: |
SUCCESS | Job执行成功之后,Job处于该状态。收到的站内信内容为: 尊敬的用户 {username},您好: 您提交的删除数据的请求已执行成功。 任务ID:{job_id} 应用:{app_name}({app_id}) 集团:{org_name}({org_id}) |
API | 说明 |
---|---|
Job创建 | |
Job查询 | |
Job取消 |