文档首页/ 应用与数据集成平台 ROMA Connect/ API参考/ 历史API/ 服务集成API（V1）/ API管理（V1）/ 批量删除API
更新时间：2023-06-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量删除API

功能介绍

批量删除指定的多个API，或指定分组下的所有API。

URI

PUT /v1/{project_id}/apic/instances/{instance_id}/apis

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

instance_id

是

String

实例ID
表2 Query参数

参数

是否必选

参数类型

描述

action

是

String

需要进行的操作：

  • delete

当前只支持删除操作

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

参数

是否必选

参数类型

描述

group_id

否

String

需要删除的分组ID

apis

否

Array of strings

需要删除的API ID列表

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

failure

Array of BatchFailure objects

删除失败的API及错误信息

success_count

Long

删除成功的API数量
表6 BatchFailure

参数

参数类型

描述

api_id

String

操作失败的API ID

api_name

String

操作失败的APi名称

error_code

String

操作失败的错误码

error_msg

String

操作失败的错误信息

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

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

响应示例

状态码： 200

OK

{
  "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管理（V1）