更新仪表盘分组名称
功能介绍
该接口用于更新仪表盘分组名称。
调用方法
请参见如何调用API。
URI
PUT /v2/{project_id}/aom/dashboards-folder/{folder_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，可以从控制台获取，也可以从调用API处获取。获取方式请参见：获取项目ID。 |
|
folder_id |
是 |
String |
仪表盘分组id。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。获取方式请参见：获取Token。 |
|
Content-Type |
否 |
String |
消息体的类型（格式）。指定类型为“application/json”。 |
|
Enterprise-Project-Id |
否 |
String |
企业项目id。获取方式请参见：获取企业项目ID。
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
folder_title |
是 |
String |
仪表盘分组新名称。 |
|
old_title |
是 |
String |
仪表盘分组当前名称。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
created |
Long |
仪表盘分组创建时间。 |
|
updated |
Long |
仪表盘分组更新时间。 |
|
display |
Boolean |
是否展示仪表盘分组。 |
|
folder_id |
String |
仪表盘分组id。 |
|
folder_title |
String |
仪表盘分组名称。 |
|
is_template |
Boolean |
是否为默认仪表盘分组。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 最小长度：12 最大长度：12 |
|
error_msg |
String |
错误信息。 最小长度：0 最大长度：1024 |
|
error_type |
String |
错误类型。 最小长度：0 最大长度：128 |
|
trace_id |
String |
请求id。 最小长度：32 最大长度：32 |
请求示例
更新仪表盘分组名称。
https://{Endpoint}/v2/{project_id}/aom/dashboards-folder/{folder_id}
{
"folder_title" : "aomtestnew",
"old_title" : "aomtest"
}
响应示例
状态码：200
OK 请求响应成功。
{
"created" : 0,
"updated" : 0,
"display" : true,
"folder_id" : "703d9c41-***-***-***-08df****0f8e",
"folder_title" : "aomtestnew",
"is_template" : false
}
状态码：400
BadRequest 非法请求。建议直接修改该请求，不要重试该请求。
{
"error_code" : "AOM.05008002",
"error_msg" : "dashboard folder title or id is empty",
"error_type" : "BAD_REQUEST",
"trace_id" : ""
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK 请求响应成功。 |
|
400 |
BadRequest 非法请求。建议直接修改该请求，不要重试该请求。 |
错误码
请参见错误码。
