创建/复制监控看板 - CreateOneDashboard
功能介绍
创建/复制监控看板
接口约束
目前华东-青岛、拉美-墨西哥城一、土耳其-伊斯坦布尔、亚太-雅加达、中东-利雅得、亚太-马尼拉6个局点不支持该接口
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
ces:dashboards:create
Write
dashboard *
-
-
-
-
g:EnterpriseProjectId
URI
POST /v2/{project_id}/dashboards
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见“获取项目ID”。 约束限制: 不涉及。 取值范围: 字符串的长度必须在 1 到 64个字符之间。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
否 |
String |
参数解释: 发送的实体的MIME类型。 约束限制: 不涉及。 取值范围: 最小字符数量为1，最大为64。 默认取值: 默认使用application/json; charset=UTF-8。 |
|
X-Auth-Token |
否 |
String |
参数解释: 用户Token。 约束限制: 不涉及。 取值范围: 最小字符数量为1，最大为16384。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
dashboard_name |
是 |
String |
参数描述： 自定义监控看板名称 约束限制 不涉及 取值范围 长度为[1,128]个字符，只允许中文、英文、数字0-9、_和- 默认取值 不涉及 |
|
enterprise_id |
否 |
String |
参数解释 企业项目ID 约束限制 不涉及 取值范围 只能包含小写字母、数字、“-”、“_”，可以自定义企业项目ID，长度为36个字符。也可以为0（代表默认企业项目ID）。 默认取值 不涉及 |
|
dashboard_id |
否 |
String |
参数描述： 监控看板id 约束限制 不涉及 取值范围 以db开头，包含22个字母和数字，长度为24个字符 默认取值 不涉及 |
|
row_widget_num |
否 |
Integer |
参数描述： 监控视图展示模式 约束限制 不涉及 取值范围
默认取值 3 |
响应参数
状态码：201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
dashboard_id |
String |
参数描述： 监控看板id 取值范围 以db开头，包含22个字母和数字，长度为24个字符 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 |
|
error_msg |
String |
请求异常信息 |
|
request_id |
String |
请求ID |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 |
|
error_msg |
String |
请求异常信息 |
|
request_id |
String |
请求ID |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 |
|
error_msg |
String |
请求异常信息 |
|
request_id |
String |
请求ID |
请求示例
{
"dashboard_name" : "dashboard_name",
"enterprise_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx",
"row_widget_num" : 3
}
响应示例
状态码：201
OK
{
"dashboard_id" : "dbxxxxxxxxx"
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
OK |
|
400 |
Bad Request, 请求错误 |
|
401 |
Unauthorized, 未提供认证信息，或认证信息错误 |
|
500 |
Internal Server Error, 请求未完成, 服务异常 |
错误码
请参见错误码。
