本文导读

功能介绍
接口约束
调试
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 云监控服务 CES/ API参考/ API V2/ 监控看板/ 批量删除监控看板

批量删除监控看板

更新时间：2024-12-26 GMT+08:00

查看PDF

功能介绍

批量删除监控看板

接口约束

目前华东-青岛、拉美-墨西哥城一、土耳其-伊斯坦布尔、亚太-雅加达、中东-利雅得5个局点不支持该接口

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/dashboards/batch-delete

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户id 最小长度：1 最大长度：64

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	发送的实体的MIME类型。推荐用户默认使用application/json 缺省值：application/json;charset=UTF-8 最小长度：1 最大长度：64
X-Auth-Token	是	String	用户Token。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。最小长度：1 最大长度：16000

表3 请求Body参数
参数	是否必选	参数类型	描述
dashboard_ids	否	Array of strings	监控看板id列表数组长度：1 - 30

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
dashboards	Array of BatchDeleteDashboardRespInfo objects	批量删除监控看板返回结果数组长度：1 - 100

表5 BatchDeleteDashboardRespInfo
参数	参数类型	描述
dashboard_id	String	监控看板id 正则匹配：^db([a-z]\|[A-Z]\|[0-9]){22}
ret_status	String	处理结果, successful: 成功, error: 失败枚举值： successful error
error_msg	String	错误信息最小长度：0 最大长度：128

状态码： 400

表6 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码最小长度：0 最大长度：256
error_msg	String	请求异常信息最小长度：0 最大长度：256
request_id	String	请求ID 最小长度：0 最大长度：256

状态码： 401

表7 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码最小长度：0 最大长度：256
error_msg	String	请求异常信息最小长度：0 最大长度：256
request_id	String	请求ID 最小长度：0 最大长度：256

状态码： 500

表8 响应Body参数
参数	参数类型	描述
error_code	String	请求异常内部业务状态码最小长度：0 最大长度：256
error_msg	String	请求异常信息最小长度：0 最大长度：256
request_id	String	请求ID 最小长度：0 最大长度：256

请求示例

{
  "dashboard_ids" : [ "dbxxxxxxxxxxxxxxxxxxxxxx", "dbXXXXXXXXXXXXXXXXXXXXXX" ]
}

响应示例

状态码： 200

{
  "dashboards" : [ {
    "dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx",
    "ret_status" : "successful"
  }, {
    "dashboard_id" : "dbXXXXXXXXXXXXXXXXXXXXXX",
    "ret_status" : "error",
    "error_msg" : "record not found"
  } ]
}

状态码

状态码	描述
200	OK
400	Bad Request, 请求错误
401	Unauthorized, 未提供认证信息，或认证信息错误
500	Internal Server Error, 请求未完成, 服务异常

错误码

请参见错误码。

父主题： 监控看板

上一篇：修改监控看板

下一篇：监控视图

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

批量删除监控看板

功能介绍

接口约束

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

意见反馈

文档内容是否对您有帮助？

文档反馈