tccli 3.0.1391.1__py2.py3-none-any.whl → 3.0.1414.1__py2.py3-none-any.whl

tccli/services/monitor/v20180724/api.json

@@ -728,6 +728,13 @@
       "output": "DescribePrometheusScrapeJobsResponse",
       "status": "online"
     },
+    "DescribePrometheusScrapeStatistics": {
+      "document": "获取实例采集速率信息",
+      "input": "DescribePrometheusScrapeStatisticsRequest",
+      "name": "获取实例采集速率信息",
+      "output": "DescribePrometheusScrapeStatisticsResponse",
+      "status": "online"
+    },
     "DescribePrometheusTargetsTMP": {
       "document": "获取targets信息，在过滤条件中指定job名称时返回targets详情，否则仅返回数量",
       "input": "DescribePrometheusTargetsTMPRequest",
@@ -770,6 +777,13 @@
       "output": "DescribeRemoteURLsResponse",
       "status": "online"
     },
+    "DescribeRemoteWrites": {
+      "document": "查询安装的 Agent 列表",
+      "input": "DescribeRemoteWritesRequest",
+      "name": "查询数据多写",
+      "output": "DescribeRemoteWritesResponse",
+      "status": "online"
+    },
     "DescribeSSOAccount": {
       "document": "列出当前grafana实例的所有授权账号",
       "input": "DescribeSSOAccountRequest",
@@ -6931,7 +6945,7 @@
         {
           "disabled": false,
           "document": "固定值，为\"monitor\"",
-          "example": "",
+          "example": "monitor",
           "member": "string",
           "name": "Module",
           "required": true,
@@ -6940,7 +6954,7 @@
         {
           "disabled": false,
           "document": "监控类型过滤 \"MT_QCE\"=云产品监控",
-          "example": "",
+          "example": "MT_QCE",
           "member": "string",
           "name": "MonitorType",
           "required": true,
@@ -6949,7 +6963,7 @@
         {
           "disabled": false,
           "document": "告警策略类型，由 DescribeAllNamespaces 获得，例如 cvm_device",
-          "example": "",
+          "example": "cvm_device",
           "member": "string",
           "name": "Namespace",
           "required": true,
@@ -6964,9 +6978,10 @@
         {
           "disabled": false,
           "document": "告警指标列表",
-          "example": "",
+          "example": "无",
           "member": "Metric",
           "name": "Metrics",
+          "output_required": true,
           "type": "list",
           "value_allowed_null": false
         },
@@ -13256,6 +13271,80 @@
       ],
       "type": "object"
     },
+    "DescribePrometheusScrapeStatisticsRequest": {
+      "document": "DescribePrometheusScrapeStatistics请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "实例ID列表",
+          "example": "[\"prom-osje\"]",
+          "member": "string",
+          "name": "InstanceIds",
+          "required": true,
+          "type": "list"
+        },
+        {
+          "disabled": false,
+          "document": "集群ID",
+          "example": "cls-xxx",
+          "member": "string",
+          "name": "ClusterId",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "job 类型",
+          "example": "podMonitor",
+          "member": "string",
+          "name": "JobType",
+          "required": false,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "job 过滤，不写就是全部 job",
+          "example": "cadvisor",
+          "member": "string",
+          "name": "Job",
+          "required": false,
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribePrometheusScrapeStatisticsResponse": {
+      "document": "DescribePrometheusScrapeStatistics返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "总个数\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "1",
+          "member": "int64",
+          "name": "Total",
+          "output_required": true,
+          "type": "int",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "实例指标抓取速率详情\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "无",
+          "member": "PrometheusInstanceScrapeStatistics",
+          "name": "InstanceResults",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribePrometheusTargetsTMPRequest": {
       "document": "DescribePrometheusTargetsTMP请求参数结构体",
       "members": [
@@ -13624,6 +13713,71 @@
       ],
       "type": "object"
     },
+    "DescribeRemoteWritesRequest": {
+      "document": "DescribeRemoteWrites请求参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "实例 ID",
+          "example": "prom-abc",
+          "member": "string",
+          "name": "InstanceId",
+          "required": true,
+          "type": "string"
+        },
+        {
+          "disabled": false,
+          "document": "列表 offset",
+          "example": "0",
+          "member": "int64",
+          "name": "Offset",
+          "required": false,
+          "type": "int"
+        },
+        {
+          "disabled": false,
+          "document": "返回 limit",
+          "example": "100",
+          "member": "int64",
+          "name": "Limit",
+          "required": false,
+          "type": "int"
+        }
+      ],
+      "type": "object"
+    },
+    "DescribeRemoteWritesResponse": {
+      "document": "DescribeRemoteWrites返回参数结构体",
+      "members": [
+        {
+          "disabled": false,
+          "document": "存储数据",
+          "example": "3",
+          "member": "int64",
+          "name": "Count",
+          "output_required": false,
+          "type": "int",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "多写信息",
+          "example": "无",
+          "member": "WriteDestination",
+          "name": "RemoteWrites",
+          "output_required": false,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
+          "member": "string",
+          "name": "RequestId",
+          "type": "string"
+        }
+      ],
+      "type": "object"
+    },
     "DescribeSSOAccountRequest": {
       "document": "DescribeSSOAccount请求参数结构体",
       "members": [
@@ -14318,7 +14472,7 @@
         {
           "disabled": false,
           "document": "实例对象的维度组合，格式为key-value键值对形式的集合。不同类型的实例字段完全不同，如CVM为[{\"Name\":\"InstanceId\",\"Value\":\"ins-j0hk02zo\"}]，Ckafka为[{\"Name\":\"instanceId\",\"Value\":\"ckafka-l49k54dd\"}]，COS为[{\"Name\":\"appid\",\"Value\":\"1258344699\"},{\"Name\":\"bucket\",\"Value\":\"rig-1258344699\"}]。各个云产品的维度请参阅各个产品[监控指标](https://cloud.tencent.com/document/product/248/6140)文档，对应的维度列即为维度组合的key，value为key对应的值。单请求最多支持批量拉取10个实例的监控数据。",
-          "example": "[{\"Dimensions\":[{\"Name\":\"uuid\",\"Value\":\"9f25c238-4e82-46e4-a0fe-76443480c8db\"}]}]",
+          "example": "无",
           "member": "Instance",
           "name": "Instances",
           "required": true,
@@ -14353,7 +14507,7 @@
         },
         {
           "disabled": false,
-          "document": "返回多种统计方式数据。avg, max, min (1,2,4)可以自由组合。注意: 仅支持对API配置文档中展示的统计方式返回对应的统计数据。如所需的统计方式不满足您的查询需求，请提工单反馈。",
+          "document": "返回多种统计方式数据。avg, max, min (1,2,4)可以自由组合。特别说明：建议查询时严格参考API配置文档中提供的统计方式。如选择其他未提供的统计方式，可能有数据统计误差。",
           "example": "1",
           "member": "int64",
           "name": "SpecifyStatistics",
@@ -14389,7 +14543,7 @@
         {
           "disabled": false,
           "document": "数据点数组",
-          "example": "[{\"Dimensions\":[{\"Name\":\"uuid\",\"Value\":\"9f25c238-4e82-46e4-a0fe-76443480c8db\"}],\"Timestamps\":[1535079000],\"Values\":[2.5]}]",
+          "example": "无",
           "member": "DataPoint",
           "name": "DataPoints",
           "output_required": true,
@@ -18354,9 +18508,10 @@
         {
           "disabled": false,
           "document": "策略名称",
-          "example": "无",
+          "example": "test-alert",
           "member": "string",
           "name": "Name",
+          "output_required": true,
           "required": true,
           "type": "string",
           "value_allowed_null": false
@@ -18367,6 +18522,7 @@
           "example": "无",
           "member": "PrometheusAlertRule",
           "name": "Rules",
+          "output_required": true,
           "required": true,
           "type": "list",
           "value_allowed_null": false
@@ -18374,9 +18530,10 @@
         {
           "disabled": false,
           "document": "告警策略 id\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "无",
+          "example": "alert-xa2asdxz",
           "member": "string",
           "name": "Id",
+          "output_required": true,
           "required": false,
           "type": "string",
           "value_allowed_null": true
@@ -18384,9 +18541,10 @@
         {
           "disabled": false,
           "document": "如果该告警来自模板下发，则TemplateId为模板id\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "无",
+          "example": "temp-xs1sd24",
           "member": "string",
           "name": "TemplateId",
+          "output_required": true,
           "required": false,
           "type": "string",
           "value_allowed_null": true
@@ -18397,6 +18555,7 @@
           "example": "无",
           "member": "PrometheusNotificationItem",
           "name": "Notification",
+          "output_required": true,
           "required": false,
           "type": "object",
           "value_allowed_null": true
@@ -18404,9 +18563,10 @@
         {
           "disabled": false,
           "document": "最后修改时间\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "无",
+          "example": "2025-10-24 20:15:39",
           "member": "string",
           "name": "UpdatedAt",
+          "output_required": true,
           "required": false,
           "type": "string",
           "value_allowed_null": true
@@ -18414,9 +18574,10 @@
         {
           "disabled": false,
           "document": "如果告警策略来源于用户集群CRD资源定义，则ClusterId为所属集群ID\n注意：此字段可能返回 null，表示取不到有效值。",
-          "example": "无",
+          "example": "cls-23as23sdf2",
           "member": "string",
           "name": "ClusterId",
+          "output_required": true,
           "required": false,
           "type": "string",
           "value_allowed_null": true
@@ -18642,6 +18803,52 @@
       ],
       "usage": "in"
     },
+    "PrometheusClusterScrapeStatistics": {
+      "document": "集群指标抓取统计",
+      "members": [
+        {
+          "disabled": false,
+          "document": "集群ID",
+          "example": "cls-asd",
+          "member": "string",
+          "name": "ClusterID",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "被采集的点数\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "0.8",
+          "member": "float",
+          "name": "ScrapedRate",
+          "output_required": true,
+          "type": "float",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "Job列表\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "[               {                \"JobName\": \"cadvisor\",                 \"MaxLabel\": 24,                 \"Metrics\": [],                 \"SamplesRate\": 271.66666,                 \"ScrapedRate\": 0               }]",
+          "member": "PrometheusJobScrapeStatistics",
+          "name": "Jobs",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "过滤前的指标采集速率\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "0.8",
+          "member": "float",
+          "name": "SamplesRate",
+          "output_required": true,
+          "type": "float",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
+    },
     "PrometheusConfigItem": {
       "document": "prometheus配置",
       "members": [
@@ -18754,6 +18961,62 @@
       ],
       "usage": "out"
     },
+    "PrometheusInstanceScrapeStatistics": {
+      "document": "实例抓取指标统计",
+      "members": [
+        {
+          "disabled": false,
+          "document": "实例ID",
+          "example": "prom-abc",
+          "member": "string",
+          "name": "InstanceId",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "被采集的点数",
+          "example": "0.8",
+          "member": "float",
+          "name": "ScrapedRate",
+          "output_required": true,
+          "type": "float",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "集群指标列表",
+          "example": "[           {             \"ClusterID\": \"cls-pvnpfz7d\",             \"FreeScrapedRate\": 121.625,             \"Jobs\": [               {                 \"FreeScrapedRate\": 33.333332,                 \"JobName\": \"cadvisor\",                 \"MaxLabel\": 24,                 \"Metrics\": [],                 \"SamplesRate\": 271.66666,                 \"ScrapedRate\": 0               }]}]",
+          "member": "PrometheusClusterScrapeStatistics",
+          "name": "Clusters",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "非容器指标列表\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "[{\"ClusterID\":\"non-cluster\",\"ScrapedRate\":5.65,\"SamplesRate\":5.65,\"FreeScrapedRate\":0,\"Jobs\":[{\"FreeScrapedRate\":0,\"Metrics\":[{\"ScrapedRate\":0.03333333333333333,\"IsRecommended\":false,\"MaxLabel\":5,\"MetricName\":\"promhttp_metric_handler_errors_total\",\"SamplesRate\":0.03333333333333333}],\"MaxLabel\":9,\"JobName\":\"prom-7f46vb1k/cvm-qcloud-exporter\",\"SamplesRate\":5.65,\"ScrapedRate\":5.65}]}]",
+          "member": "PrometheusClusterScrapeStatistics",
+          "name": "Global",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "过滤前的指标采集速率",
+          "example": "0.8",
+          "member": "float",
+          "name": "SamplesRate",
+          "output_required": true,
+          "type": "float",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    },
     "PrometheusInstanceTenantUsage": {
       "document": "Prometheus用量信息",
       "members": [
@@ -19292,6 +19555,52 @@
       ],
       "usage": "out"
     },
+    "PrometheusJobScrapeStatistics": {
+      "document": "Job抓取统计",
+      "members": [
+        {
+          "disabled": false,
+          "document": "Job 名",
+          "example": "cadvisor",
+          "member": "string",
+          "name": "JobName",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "被采集的点数",
+          "example": "0.8",
+          "member": "float",
+          "name": "ScrapedRate",
+          "output_required": true,
+          "type": "float",
+          "value_allowed_null": false
+        },
+        {
+          "disabled": false,
+          "document": "指标列表\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "[   {     \"MetricName\": \"cadvisor_version_info\",     \"SamplesRate\": 0.26666666666666666,     \"ScrapedRate\": 0,     \"IsRecommended\": false,     \"MaxLabel\": 0   } ]",
+          "member": "PrometheusMetricScrapeStatistics",
+          "name": "Metrics",
+          "output_required": true,
+          "type": "list",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "Job 类型",
+          "example": "podMonitor",
+          "member": "string",
+          "name": "JobType",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
+    },
     "PrometheusJobTargets": {
       "document": "prometheus一个job的targets",
       "members": [
@@ -19338,6 +19647,52 @@
       ],
       "usage": "out"
     },
+    "PrometheusMetricScrapeStatistics": {
+      "document": "指标抓取统计",
+      "members": [
+        {
+          "disabled": false,
+          "document": "指标名\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "cadvisor",
+          "member": "string",
+          "name": "MetricName",
+          "output_required": true,
+          "type": "string",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "原始数据中的点数\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "0.8",
+          "member": "float",
+          "name": "SamplesRate",
+          "output_required": true,
+          "type": "float",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "被采集的点数\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "0.9",
+          "member": "float",
+          "name": "ScrapedRate",
+          "output_required": true,
+          "type": "float",
+          "value_allowed_null": true
+        },
+        {
+          "disabled": false,
+          "document": "是否推荐采集\n注意：此字段可能返回 null，表示取不到有效值。",
+          "example": "true",
+          "member": "bool",
+          "name": "IsRecommended",
+          "output_required": true,
+          "type": "bool",
+          "value_allowed_null": true
+        }
+      ],
+      "usage": "out"
+    },
     "PrometheusNotificationItem": {
       "document": "告警通知渠道配置",
       "members": [
@@ -22810,6 +23165,22 @@
         }
       ],
       "usage": "both"
+    },
+    "WriteDestination": {
+      "document": "数据写向目标",
+      "members": [
+        {
+          "disabled": false,
+          "document": "存储标识",
+          "example": "multiple-1",
+          "member": "string",
+          "name": "Destination",
+          "output_required": false,
+          "type": "string",
+          "value_allowed_null": false
+        }
+      ],
+      "usage": "out"
     }
   },
   "version": "1.0"