DescribeDashboards
最近更新时间: 2025-10-20 17:05:56
1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
本接口用于获取仪表盘
默认接口请求频率限制：20次/秒。
接口更新时间：2022-10-31 11:10:35。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeDashboards |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Offset | 否 | 否 | Int64 | 分页的偏移量，默认值为0。 |
| Limit | 否 | 否 | Int64 | 分页单页限制数目，默认值为20，最大值100。 |
| Filters | 否 | 否 | Array of Filter | <br><li> dashboardId<br><br>按照【仪表盘id】进行过滤。<br>类型：String<br><br>必选：否<br><br><br><li> dashboardName<br><br>按照【仪表盘名字】进行模糊搜索过滤。<br>类型：String<br><br>必选：否<br><br><br><li> dashboardRegion<br><br>按照【仪表盘地域】进行过滤，为了兼容老的仪表盘，通过云API创建的仪表盘没有地域属性<br>类型：String<br><br>必选：否<br><br><br><li> tagKey<br><br>按照【标签键】进行过滤。<br><br>类型：String<br><br>必选：否<br><br><br><li> tag:tagKey<br><br>按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例2。<br><br>类型：String<br><br>必选：否<br><br>每次请求的Filters的上限为10，Filter.Values的上限为100。 |
| TopicIdRegionFilter | 否 | 否 | Array of TopicIdAndRegion | 按照topicId和regionId过滤。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 此参数对外不可见。 仪表盘的数量 |
| DashboardInfos | DashboardInfo | 此参数对外不可见。 仪表盘详细明细 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| InternalError | 内部错误。 |
| LimitExceeded | 超过配额限制。 |
| FailedOperation | 操作失败。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.ACLFailed | ACL校验失败。 |
| LimitExceeded.Tag | tag超过限制。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountNotExists | 账户不存在。 |