文档首页/ API网关 APIG/ API参考/ 专享版API（V2）/ 专享版-API管理/ 批量删除API - BatchDeleteApisV2
更新时间：2026-04-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量删除API - BatchDeleteApisV2

功能介绍

批量删除api。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    apig:api:batchDelete

    Write

    instance *

    g:ResourceTag/<tag-key>

    apig:apis:delete
    • apig:instance:get
    • apig:apiGroup:get

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/apis/batch-delete

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID，在API网关控制台的“实例信息”中获取。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

apis

否

Array of strings

需要批量删除的api编号列表。

group_id

否

String

需要批量删除的api所属的分组编号

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

本次待批量删除的API总数

success_count

Integer

批量删除成功的API数量

failure

BatchFailure object

批量操作失败的返回结果。
表5 BatchFailure

参数

参数类型

描述

api_id

String

发布或下线失败的API ID

api_name

String

发布或下线失败的API名称

error_code

String

发布或下线失败的错误码

error_msg

String

发布或下线失败的错误信息

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

批量删除指定的API

{
  "apis" : [ "b20a5be94ded40cc8f2872ea3005cfb7", "5f918d104dc84480a75166ba99efff21" ]
}

响应示例

状态码：200

OK

{
  "total_count" : 2,
  "success_count" : 1,
  "failure" : [ {
    "error_code" : "APIG.3002",
    "error_msg" : "API b20a5be94ded40cc8f2872ea3005cfb7 does not exist",
    "api_id" : "b20a5be94ded40cc8f2872ea3005cfb7"
  } ]
}

状态码：400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value: parameter action should be \"delete\""
}

状态码：401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

状态码：404

Not Found

{
  "error_code" : "APIG.3030",
  "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
}

状态码：500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 专享版-API管理

相关文档