# 查询监控看板列表 - ListDashboardInfos #### 功能介绍 查询监控看板列表 #### 接口约束 目前华东-青岛、拉美-墨西哥城一、土耳其-伊斯坦布尔、亚太-雅加达、中东-利雅得、亚太-马尼拉6个局点不支持该接口 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CES/doc?api=ListDashboardInfos&version=v2)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ces/ces_03_0045.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | ces:dashboards:list | List | dashboard \* | - | - | - | | ces:dashboards:list | List | - | g:EnterpriseProjectId | - | - | #### URI GET /v2/{project_id}/dashboards 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-ces/ces_03_0057.html)。 **约束限制**: 不涉及。 **取值范围**: 字符串的长度必须在 1 到 64个字符之间。 **默认取值**: 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_id | 否 | String | **参数解释**： 企业项目ID。如何查询企业项目ID，请参考[获取企业项目ID](https://support.huaweicloud.com/api-ces/ces_03_0061.html)。 **约束限制**： 不涉及。 **取值范围**： 只能包含小写字母、数字、"-"、"_"，可以自定义企业项目ID，长度为36个字符。也可以为0（代表默认企业项目ID），all_granted_eps（代表所有企业项目ID）。 **默认取值**： 不涉及。 | | is_favorite | 否 | Boolean | **参数解释**： 指定企业项目下监控看板是否收藏。 **约束限制**： 填此参数时，enterprise_id必填。 **取值范围**： - true:收藏 - false:未收藏 **默认取值**： 不涉及。 | | dashboard_name | 否 | String | **参数解释**： 监控看板名称。 **约束限制**： 不涉及。 **取值范围**： 长度为\[1,128\]个字符，只允许中文、英文、数字0-9、_和- **默认取值**： 不涉及。 | | dashboard_id | 否 | String | **参数解释**： 监控看板ID，通过[查询监控看板列表](https://support.huaweicloud.com/api-ces/ListDashboardInfos.html)接口获取监控看板ID。 **约束限制**： 不涉及。 **取值范围**： 以db开头，包含22个字母和数字，长度为24个字符 **默认取值**： 不涉及。 | | dashboard_type | 否 | String | **参数解释**： 监控看板类型。 **约束限制**： 不涉及。 **取值范围**： - monitor_dashboard:表示监控大盘 - other:表示自定义看板 **默认取值**： 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | **参数解释**: 用户Token。Token认证，具体操作请参考[认证鉴权](https://support.huaweicloud.com/api-ces/ces_03_0011.html)。 **约束限制**: 不涉及。 **取值范围**: 最小字符数量为1，最大为16384。 **默认取值**: 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | dashboards | Array of [DashBoardInfo] objects | **参数解释**： 监控看板列表 | 表5DashBoardInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | dashboard_id | String | **参数解释**： 监控看板id **取值范围** 以db开头，包含22个字母和数字，长度为24个字符 | | dashboard_name | String | **参数解释** 自定义监控看板名称 **取值范围** 长度为\[1,128\]个字符，只允许中文、英文、数字0-9、_和- | | enterprise_id | String | **参数解释** 企业项目ID **取值范围** 只能包含小写字母、数字、"-"、"_"，可以自定义企业项目ID，长度为36个字符。也可以为0（代表默认企业项目ID）。 | | creator_name | String | **参数解释** 监控看板的创建用户名 **取值范围** 长度为\[1,128\]个字符，只允许中文、英文、数字0-9、_和- | | create_time | Long | **参数解释** 监控看板创建时间 **取值范围** 最小值为1111111111111，最大值为9999999999999 | | widget_num | Integer | **参数解释** 看板下的视图总数 **取值范围** 最小值为0，最大值为50 | | extend_info | [ExtendInfoResp] object | **参数解释** 看板相关拓展信息 | | namespace | String | **参数解释** 查询服务的命名空间，各服务命名空间请参阅[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)**取值范围** 格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。 | | sub_product | String | **参数解释** 子产品标识 **取值范围** 长度为\[1,128\]个字符 | | dashboard_template_id | String | **参数解释** 监控大盘模板id **取值范围** 以mb开头，包含22个字母和数字，长度为24个字符 | | row_widget_num | Integer | **参数解释** 每行展示视图数量 **取值范围** - 0:表示自定义坐标 - 1:代表每行1个视图 - 2:代表每行2个视图 - 3:代表每行3个视图 - 4:代表每行4个视图 | | is_favorite | Boolean | **参数解释** 监控看板是否标记收藏 **取值范围** - true: 收藏, - false: 未收藏 | 表6ExtendInfoResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | filter | String | **参数解释** 表示指标聚合方式 **取值范围** 枚举值： - average 平均值 - min 最小值 - max 最大值 - sum 求和值 | | period | String | **参数解释** 表示指标聚合周期 **取值范围** - 1 原始值 - 60 一分钟 - 300 5分钟 - 1200 20分钟 - 3600 1小时 - 14400 4小时 - 86400 1天 | | display_time | Integer | **参数解释** 展示时间 **取值范围** 枚举值： - 0 自定义时间 - 5 5分钟 - 15 15分钟 - 30 30分钟 - 60 1小时 - 120 2小时 - 180 3小时 - 720 12小时 - 1440 24小时 - 10080 7天 - 43200 30天 | | refresh_time | Integer | **参数解释** 刷新时间 **取值范围** 枚举值： - 0 不刷新 - 10 10秒 - 60 1分钟 - 300 5分钟 - 1200 20分钟 | | from | Long | **参数解释** 开始时间 **取值范围** 时间戳取值为\[0,9999999999999\] | | to | Long | **参数解释** 结束时间 **取值范围** 时间戳取值为\[0,9999999999999\] | | screen_color | String | **参数解释** 监控大屏背景颜色 **取值范围** 背景颜色长度最长为100个字符 | | enable_screen_auto_play | Boolean | **参数解释** 监控大屏是否自动切换 **取值范围** - true 是 - false 否 | | time_interval | Integer | **参数解释** 监控大屏自动切换时间间隔 **取值范围** 枚举值： - 10000 10秒 - 30000 30秒 - 60000 1分钟 | | enable_legend | Boolean | **参数解释** 是否开启图例 **取值范围** - true 是 - false 否 | | full_screen_widget_num | Integer | **参数解释** 大屏展示视图数量 **取值范围** 视图数量为\[0,65535\] | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | **状态码：401** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | **状态码：500** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 用于标识请求异常的具体原因。 **取值范围**： 字符串长度为0到256个字符。 | | error_msg | String | **参数解释**： 用于描述请求异常的具体信息。 **取值范围**： 字符串长度为0到256个字符。 | | request_id | String | **参数解释**： 用于唯一标识一次请求，便于问题追踪。 **取值范围**： 字符串长度为0到256个字符。 | #### 请求示例 查询监控看板名称为test1，看板ID为dbtest123，默认企业项目，已收藏，看板类型是监控大盘的看板 ``` /v2/{project_id}/dashboards?enterprise_id=0&is_favorite=true&dashboard_name=test1&dashboard_id=dbtest123&dashboard_type=monitor_dashboard ``` #### 响应示例 **状态码：200** OK ``` { "dashboards" : [ { "dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx", "dashboard_name" : "dashboard_name", "enterprise_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "creator_name" : "creator_name", "create_time" : 1111111111111, "widget_num" : 1, "row_widget_num" : 3, "is_favorite" : false } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request, 请求错误 | | 401 | Unauthorized, 未提供认证信息，或认证信息错误 | | 500 | Internal Server Error, 请求未完成, 服务异常 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ces/ErrorCode.html)。