更新时间:2025-10-31 GMT+08:00
分享

更新仪表板 - UpdateDashboard

功能介绍

更新仪表板。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v1/{project_id}/dashboards/update

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

参数

是否必选

参数类型

描述

id

String

仪表板ID。

name

String

仪表板名称。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

id

String

仪表板ID。

name

String

仪表板名称。

create_user_name

String

创建者。

create_date

Long

创建时间戳。

update_user_name

String

更新者。

update_date

Long

更新时间戳。

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

更新仪表板成功。

错误码

请参见错误码

相关文档