抖音开放平台Logo
控制台

删除索引

更新时间 2024-07-24 02:58:49
收藏
我的收藏

接口说明

开发者可通过接口向抖音提交需要删除的已索引资源，包括死链、低质及不希望在抖音搜索中展现的内容，提交内容将在抖音搜索结果中屏蔽，生效时间为 30 分钟。 注意事项：

  • 删除的索引无法再恢复
  • 提交的文件格式类似sitemap文件格式

基本信息

名称描述
HTTP URL
https://open.douyin.com/api/apps/v1/search/delete_index/
HTTP Method
POST
Scope
ma.search

请求头

名称字段类型是否必填示例描述
access-tokenString是clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
调用https://open.douyin.com/oauth/client_token/生成的token
content-typeString是application/json
固定值"application/json"

请求参数

Body

名称字段类型是否必填示例描述
app_idString是tt5daf2b12c285xxxx
小程序id
nameString是index

在控制台显示的文件名称

请求示例

curl --location 'https://open.douyin.com/api/apps/v1/search/delete_index/' \
--header 'access-token: clt.78743ab256619da1fde8efabfb7c50da1jJz6mjqx0xwukNHcIdhIKWaAbOU_lq' \
--header 'Content-Type: application/json' \
--data '{
    "app_id": "tt5daf2b12c285xxxx",
    "name":"index",
    "path_list": [
        "pages/index/1?t=1",
        "pages/index/2?t=2",
        "pages/index/3?t=3"
    ]
}'

响应参数

Body

名称字段类型是否必填示例描述
err_msgString是success

错误信息

err_noInt32是0

错误码

log_idString是20240515223931DF96BE0F06804B27F36D

日志ID，用于向内部开发人员进行反馈

响应示例

正常响应示例

{
  "err_no": 0,
  "err_msg": "success",
  "log_id": "20240515223931DF96BE0F06804B27F36D"
}

异常响应示例

{
  "err_no": -1,
  "err_msg": "系统错误",
  "log_id": "20240515223931DF96BE0F06804B27F36D"
}

错误码

http状态码错误码错误码描述排查建议
20028001003

access-token 无效

重新获取access-token；或检查请求头拼写"access-token"

20028005007

参数校验异常

检查入参非空字段是否正确填写

20029003003

系统异常

重试