更新时间:2024-07-31 GMT+08:00
分享

批量下线仪表板

功能介绍

批量下线仪表板。

URI

POST /v1/{project_id}/dashboards/batch-offline

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参考获取项目ID

最小长度:0

最大长度:128

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

String

工作空间ID,即控制台的项目ID。

最小长度:0

最大长度:128

X-Auth-Token

String

用户Token。通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。

最小长度:0

最大长度:8192

表3 请求Body参数

参数

是否必选

参数类型

描述

ids

Array of strings

执行批量操作仪表板id列表。

最小长度:0

最大长度:120

数组长度:1 - 128

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

data

Boolean

是否成功。 true,false。

请求示例

批量下线仪表板。

https://{endpoint}/v1/{project_id}/dashboards/batch-offline
{
  "ids" : [ "009b3d3e-xxxx-4cc3-xxxx-dc54cd42xxxx" ]
}

响应示例

状态码: 200

仪表板下线成功。

{
  "data" : true
}

状态码

状态码

描述

200

仪表板下线成功。

错误码

请参见错误码

相关文档