文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 仪表板/ 批量下线仪表板 - BatchOfflineDashboard
更新时间:2025-11-25 GMT+08:00
分享

批量下线仪表板 - BatchOfflineDashboard

功能介绍

批量下线仪表板。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

String

参数解释:

工作空间ID。获取方法请参见获取工作空间ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

ids

Array of strings

参数解释:

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

取值范围:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

Boolean

参数解释:

执行结果。

取值范围:

  • true:成功

  • false:失败

请求示例

批量下线仪表板。

https://{endpoint}/v1/{project_id}/dashboards/batch-offline

{
  "ids" : [ "00xxxx3e-45e5-4cc3-847c-dcxxxx42424d" ]
}

响应示例

状态码:200

仪表板下线成功。

{
  "data" : true
}

状态码

状态码

描述

200

仪表板下线成功。

错误码

请参见错误码

相关文档