文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 仪表板/ 更新仪表板
更新时间：2024-07-31 GMT+08:00
查看PDF
分享

更新仪表板

功能介绍

更新仪表板。

URI

POST /v1/{project_id}/dashboards/update

表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参数

参数

是否必选

参数类型

描述

id

是

String

仪表板ID。

最小长度：0

最大长度：128

name

是

String

仪表板名称。

最小长度：1

最大长度：32

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

id

String

仪表板ID。

最小长度：0

最大长度：128

name

String

仪表板名称。

最小长度：1

最大长度：32

create_user_name

String

创建者。

最小长度：0

最大长度：128

create_date

Long

创建时间戳。

最小值：0

最大值：9007199254740991

update_user_name

String

更新者。

最小长度：0

最大长度：128

update_date

Long

更新时间戳。

最小值：0

最大值：9007199254740991

status

Integer

仪表板状态：

  • 0：未发布。
  • 1：已发布。
  • 2：已下线。

枚举值：

  • 0
  • 1
  • 2

请求示例

更新仪表板。

https://{endpoint}/v1/{project_id}/dashboards/update
{
  "id" : "009b3d3e-xxxx-4cc3-xxxx-dc54cd42424d",
  "name" : "更新仪表板"
}

响应示例

状态码： 200

更新仪表板成功。

{
  "id" : "009b3d3e-xxxx-4cc3-xxxx-dc54cd42424d",
  "name" : "更新仪表板",
  "create_user_name" : "xxxx",
  "create_date" : 1706062051243,
  "update_user_name" : "xxxx",
  "update_date" : 1706062051243,
  "status" : 0
}

状态码

状态码

描述

200

更新仪表板成功。

错误码

请参见错误码。

父主题： 仪表板

相关文档