1. 接口描述
接口请求域名： monitor.api3.fincloud.tencent.cn。
查询监控产品列表
默认接口请求频率限制：20次/秒。
接口更新时间：2022-08-25 14:20:38。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeMonitorProducts |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-07-24 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Module | 是 | 否 | String | 固定值，为"monitor" 示例值： monitor |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ProductList | String | 云产品列表，json 字符串 示例值： {"avaliableRegions":[],"id":"dcchannel","isShowInDashboard":true,"meta":{"alarms":[{"dimensions":{"directconnectconnid":"directConnectTunnelId"},"policyViewName":"dcchannel"}],"columns":[{"enName":"Channel ID/Name","isShowInMonitorList":true,"keys":["directConnectTunnelId","directConnectTunnelName"],"name":"\u901a\u9053ID/\u540d\u79f0","required":true},{"enName":"Status","isShowInMonitorList":true,"isShowInSelector":false,"name":"\u72b6\u6001","renderConditions":{"key":"status","switch":[[0,{"enShow":"Connected","show":"\u5df2\u8fde\u63a5"},"success"],[1,{"enShow":"Applying","show":"\u7533\u8bf7\u4e2d"}],[2,{"enShow":"Configuring","show":"\u914d\u7f6e\u4e2d"}],[20,{"enShow":"Waiting for connection","show":"\u7b49\u5f85\u8fde\u63a5"}],[21,{"enShow":"Reject","show":"\u62d2\u7edd"},"danger"]]}},{"enName":"Physical Dedicated Line","isShowInMonitorList":false,"key":"directConnectId","name":"\u7269\u7406\u4e13\u7ebf"},{"enName":"Associated dedicated line gateway","isShowInMonitorList":false,"isShowInSelector":false,"key":"directConnectGatewayId","name":"\u5173\u8054\u4e13\u7ebf\u7f51\u5173"},{"enName":"Virtual Private Cloud","isShowInMonitorList":true,"keys":["vpcId","vpcName"],"name":"\u79c1\u6709\u7f51\u7edc"}],"enName":"VPC - Direct Connect tunnel","enProductName":"VPC - Direct Connect tunnel","enSearchPlaceHolder":"Direct Connect Channel ID","id":"dcchannel","idKey":["directConnectTunnelId","directConnectConnId"],"instanceLoader":{"cmd":"DescribeDirectConnectTunnels","fieldsMapping":{"directConnectConnId":"directConnectTunnelId"},"fieldsToInstances":{"isArray":false,"reqParams":{"directConnectTunnelId":"<%=obj.directconnectconnid |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | 无效的参数值。 |
| InternalError | 内部错误。 |
| InvalidParameter.InvalidParameterParam | 参数错误。 |
| InvalidParameter.InvalidParameter | 参数错误。 |
| InvalidParameter | 参数错误。 |
| InternalError.ExeTimeout | 执行超时。 |
| FailedOperation | 操作失败。 |
| MissingParameter | 缺少参数错误。 |
| UnknownParameter | 未知参数错误。 |
| UnauthorizedOperation | 未授权操作。 |
| UnsupportedOperation | 操作不支持。 |
| ResourceNotFound | 资源不存在。 |
| LimitExceeded | 超过配额限制。 |
| ResourceUnavailable | 资源不可用。 |
| ResourceInsufficient | 资源不足。 |
| FailedOperation | 操作失败。 |
| ResourceInUse | 资源被占用。 |
| DryRunOperation | DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。 |
| ResourcesSoldOut | 资源售罄。 |
| LimitExceeded.MetricQuotaExceeded | 指标数量达到配额限制，禁止含有未注册指标的请求。 |
| FailedOperation.ServiceNotEnabled | 服务未启用，开通服务后方可使用。 |
| FailedOperation.AlertPolicyCreateFailed | 创建告警策略失败。 |
| FailedOperation.DbRecordCreateFailed | 创建数据库记录失败。 |
| FailedOperation.DbTransactionBeginFailed | 数据库事务开始失败。 |
| FailedOperation.DbRecordDeleteFailed | 数据库记录删除失败。 |
| FailedOperation.DbQueryFailed | 数据库查询失败。 |
| FailedOperation.DbTransactionCommitFailed | 数据库事务提交失败。 |
| FailedOperation.DbRecordUpdateFailed | 数据库记录更新失败。 |
| AuthFailure.UnauthorizedOperation | 请求未授权。请参考 CAM 文档对鉴权的说明。 |
| FailedOperation.DuplicateName | 名字重复。 |
| FailedOperation.DruidQueryFailed | 查询分析数据失败。 |
| FailedOperation.DimQueryRequestFailed | 请求维度查询服务失败。 |
| FailedOperation.AlertPolicyDescribeFailed | 告警策略查询失败。 |
| FailedOperation.AlertPolicyDeleteFailed | 告警策略删除失败。 |
| FailedOperation.AlertPolicyModifyFailed | 告警策略修改失败。 |
| FailedOperation.AlertTriggerRuleDeleteFailed | 删除触发条件失败。 |
| FailedOperation.AlertFilterRuleDeleteFailed | 删除过滤条件失败。 |
5. 示例
示例1 查询监控产品列表
输入示例
https://monitor.api3.fincloud.tencent.cn/?Action=DescribeMonitorProducts
&Module=monitor
&<公共请求参数>
输出示例
{
"Response":{
"ProductList":"[{\"avaliableRegions\":[],\"id\":\"dcchannel\",\"isShowInDashboard\":true,\"meta\":{\"alarms\":[{\"dimensions\":{\"directconnectconnid\":\"directConnectTunnelId\"},\"policyViewName\":\"dcchannel\"}],\"columns\":[{\"enName\":\"Channel ID/Name\",\"isShowInMonitorList\":true,\"keys\":[\"directConnectTunnelId\",\"directConnectTunnelName\"],\"name\":\"\\u901a\\u9053ID/\\u540d\\u79f0\",\"required\":true},{\"enName\":\"Status\",\"isShowInMonitorList\":true,\"isShowInSelector\":false,\"name\":\"\\u72b6\\u6001\",\"renderConditions\":{\"key\":\"status\",\"switch\":[[0,{\"enShow\":\"Connected\",\"show\":\"\\u5df2\\u8fde\\u63a5\"},\"success\"],[1,{\"enShow\":\"Applying\",\"show\":\"\\u7533\\u8bf7\\u4e2d\"}],[2,{\"enShow\":\"Configuring\",\"show\":\"\\u914d\\u7f6e\\u4e2d\"}],[20,{\"enShow\":\"Waiting for connection\",\"show\":\"\\u7b49\\u5f85\\u8fde\\u63a5\"}],[21,{\"enShow\":\"Reject\",\"show\":\"\\u62d2\\u7edd\"},\"danger\"]]}},{\"enName\":\"Physical Dedicated Line\",\"isShowInMonitorList\":false,\"key\":\"directConnectId\",\"name\":\"\\u7269\\u7406\\u4e13\\u7ebf\"},{\"enName\":\"Associated dedicated line gateway\",\"isShowInMonitorList\":false,\"isShowInSelector\":false,\"key\":\"directConnectGatewayId\",\"name\":\"\\u5173\\u8054\\u4e13\\u7ebf\\u7f51\\u5173\"},{\"enName\":\"Virtual Private Cloud\",\"isShowInMonitorList\":true,\"keys\":[\"vpcId\",\"vpcName\"],\"name\":\"\\u79c1\\u6709\\u7f51\\u7edc\"}],\"enName\":\"VPC - Direct Connect tunnel\",\"enProductName\":\"VPC - Direct Connect tunnel\",\"enSearchPlaceHolder\":\"Direct Connect Channel ID\",\"id\":\"dcchannel\",\"idKey\":[\"directConnectTunnelId\",\"directConnectConnId\"],\"instanceLoader\":{\"cmd\":\"DescribeDirectConnectTunnels\",\"fieldsMapping\":{\"directConnectConnId\":\"directConnectTunnelId\"},\"fieldsToInstances\":{\"isArray\":false,\"reqParams\":{\"directConnectTunnelId\":\"<%=obj.directconnectconnid || directConnectTunnelId %>\"}},\"labels\":[\"directConnectTunnelId\",\"directConnectTunnelName\"],\"resFields\":{\"list\":\"data\",\"total\":\"totalCount\"},\"serviceType\":\"dc\"},\"isShowAlarmPolicyColumn\":true,\"isShowAlarmPolicyTab\":true,\"metrics\":[{\"dimensions\":[\"directConnectConnId\"],\"enMetricCName\":\"Network Outbound Bandwidth\",\"metricCName\":\"\\u7f51\\u7edc\\u51fa\\u5e26\\u5bbd\",\"metricName\":\"outbandwidth\",\"unit\":\"Mbps\",\"unitCname\":\"Mbps\"},{\"dimensions\":[\"directConnectConnId\"],\"enMetricCName\":\"Network Inbound Bandwidth\",\"metricCName\":\"\\u7f51\\u7edc\\u5165\\u5e26\\u5bbd\",\"metricName\":\"inbandwidth\",\"unit\":\"Mbps\",\"unitCname\":\"Mbps\"},{\"dimensions\":[\"directConnectConnId\"],\"enMetricCName\":\"Outbound Packets\",\"enUnit\":\"/sec\",\"enUnitCname\":\"/sec\",\"metricCName\":\"\\u51fa\\u5305\\u91cf\",\"metricName\":\"outpkg\",\"unit\":\"\\u4e2a/s\",\"unitCname\":\"\\u4e2a/s\"},{\"dimensions\":[\"directConnectConnId\"],\"enMetricCName\":\"Inbound Packets\",\"enUnit\":\"/sec\",\"enUnitCname\":\"/sec\",\"metricCName\":\"\\u5165\\u5305\\u91cf\",\"metricName\":\"inpkg\",\"unit\":\"\\u4e2a/s\",\"unitCname\":\"\\u4e2a/s\"}],\"name\":\"\\u4e13\\u7ebf\\u63a5\\u5165-\\u4e13\\u7528\\u901a\\u9053\",\"namespace\":\"qce/dcx\",\"productName\":\"\\u4e13\\u7ebf\\u63a5\\u5165-\\u4e13\\u7528\\u901a\\u9053\",\"regions\":[],\"searchConfig\":{\"attributes\":[{\"enName\":\"Channel ID\",\"key\":\"directConnectTunnelId\",\"name\":\"\\u901a\\u9053ID\",\"type\":\"input\"}]},\"searchPlaceHolder\":\"\\u4e13\\u7528\\u901a\\u9053ID\"},\"namespace\":\"qce/dcx\",\"policyViewName\":\"dcchannel\",\"productName\":\"\\u4e13\\u7ebf\\u63a5\\u5165-\\u4e13\\u7528\\u901a\\u9053\"}]",
"RequestId":"11111111-1111-1111-1111-111111111111"
}
}