tccli 3.0.1151.1__py2.py3-none-any.whl → 3.0.1152.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
@@ -3601,7 +3601,7 @@
3601
3601
  "example": "arule-f2vx2owo",
3602
3602
  "member": "string",
3603
3603
  "name": "RuleId",
3604
- "required": true,
3604
+ "output_required": true,
3605
3605
  "type": "string",
3606
3606
  "value_allowed_null": true
3607
3607
  },
@@ -4882,7 +4882,7 @@
4882
4882
  {
4883
4883
  "disabled": false,
4884
4884
  "document": "Prometheus 实例 ID",
4885
- "example": "",
4885
+ "example": "prom-sdfk2342a",
4886
4886
  "member": "string",
4887
4887
  "name": "InstanceId",
4888
4888
  "required": true,
@@ -4891,7 +4891,7 @@
4891
4891
  {
4892
4892
  "disabled": false,
4893
4893
  "document": "<li>类型为TKE:对应集成的腾讯云容器服务集群 ID</li>",
4894
- "example": "",
4894
+ "example": "cls-pwerf3k3",
4895
4895
  "member": "string",
4896
4896
  "name": "KubeClusterId",
4897
4897
  "required": true,
@@ -4900,7 +4900,7 @@
4900
4900
  {
4901
4901
  "disabled": false,
4902
4902
  "document": "用户 Kubernetes 集群类型:\n<li> 1 = 容器服务集群(TKE) </li>",
4903
- "example": "",
4903
+ "example": "1",
4904
4904
  "member": "int64",
4905
4905
  "name": "KubeType",
4906
4906
  "required": true,
@@ -4909,7 +4909,7 @@
4909
4909
  {
4910
4910
  "disabled": false,
4911
4911
  "document": "服务发现类型,取值如下:\n<li> 1 = ServiceMonitor</li>\n<li> 2 = PodMonitor</li>\n<li> 3 = JobMonitor</li>",
4912
- "example": "",
4912
+ "example": "1",
4913
4913
  "member": "int64",
4914
4914
  "name": "Type",
4915
4915
  "required": true,
@@ -4917,8 +4917,8 @@
4917
4917
  },
4918
4918
  {
4919
4919
  "disabled": false,
4920
- "document": "服务发现配置信息",
4921
- "example": "",
4920
+ "document": "服务发现配置信息,YAML 格式\n\n示例值:\n\n```\napiVersion: monitoring.coreos.com/v1\nkind: ServiceMonitor\nmetadata:\n name: go-demo # 填写一个唯一名称\n namespace: cm-prometheus # namespace固定,不要修改\nspec:\n endpoints:\n - interval: 30s\n # 填写service yaml中Prometheus Exporter对应的Port的Name\n port: 2112\n # 填写Prometheus Exporter对应的Path的值,不填默认/metrics\n path: /metrics\n relabelings:\n # ** 必须要有一个 label 为 application,这里假设 k8s 有一个 label 为 app,\n # 我们通过 relabel 的 replace 动作把它替换成了 application\n - action: replace\n sourceLabels: [__meta_kubernetes_pod_label_app]\n targetLabel: application\n # 选择要监控service所在的namespace\n namespaceSelector:\n matchNames:\n - golang-demo\n # 填写要监控service的Label值,以定位目标service\n selector:\n matchLabels:\n app: golang-app-demo\n```",
4921
+ "example": "yaml",
4922
4922
  "member": "string",
4923
4923
  "name": "Yaml",
4924
4924
  "required": true,
@@ -4933,9 +4933,10 @@
4933
4933
  {
4934
4934
  "disabled": false,
4935
4935
  "document": "创建成功之后,返回对应服务发现信息",
4936
- "example": "",
4936
+ "example": "",
4937
4937
  "member": "ServiceDiscoveryItem",
4938
4938
  "name": "ServiceDiscovery",
4939
+ "output_required": true,
4939
4940
  "type": "object",
4940
4941
  "value_allowed_null": false
4941
4942
  },
@@ -5641,7 +5642,7 @@
5641
5642
  {
5642
5643
  "disabled": false,
5643
5644
  "document": "模板id",
5644
- "example": "",
5645
+ "example": "temp-abc",
5645
5646
  "member": "string",
5646
5647
  "name": "TemplateId",
5647
5648
  "required": true,
@@ -5650,7 +5651,7 @@
5650
5651
  {
5651
5652
  "disabled": false,
5652
5653
  "document": "取消同步的对象列表",
5653
- "example": "",
5654
+ "example": "{\"Region\":\"abc\",\"InstanceId\":\"abc\",\"ClusterId\":\"abc\",\"SyncTime\":\"abc\",\"Version\":\"abc\",\"ClusterType\":\"abc\",\"InstanceName\":\"abc\",\"ClusterName\":\"abc\"}",
5654
5655
  "member": "PrometheusTemplateSyncTarget",
5655
5656
  "name": "Targets",
5656
5657
  "required": true,
@@ -5784,7 +5785,7 @@
5784
5785
  },
5785
5786
  {
5786
5787
  "disabled": false,
5787
- "document": "服务发现配置信息",
5788
+ "document": "服务发现配置信息,YAML 格式\n\n示例值:\n\n```\napiVersion: monitoring.coreos.com/v1\nkind: ServiceMonitor\nmetadata:\n name: go-demo # 填写一个唯一名称\n namespace: cm-prometheus # namespace固定,不要修改\nspec:\n endpoints:\n - interval: 30s\n # 填写service yaml中Prometheus Exporter对应的Port的Name\n port: 2112\n # 填写Prometheus Exporter对应的Path的值,不填默认/metrics\n path: /metrics\n relabelings:\n # ** 必须要有一个 label 为 application,这里假设 k8s 有一个 label 为 app,\n # 我们通过 relabel 的 replace 动作把它替换成了 application\n - action: replace\n sourceLabels: [__meta_kubernetes_pod_label_app]\n targetLabel: application\n # 选择要监控service所在的namespace\n namespaceSelector:\n matchNames:\n - golang-demo\n # 填写要监控service的Label值,以定位目标service\n selector:\n matchLabels:\n app: golang-app-demo\n```",
5788
5789
  "example": "yaml",
5789
5790
  "member": "string",
5790
5791
  "name": "Yaml",
@@ -11584,7 +11585,7 @@
11584
11585
  {
11585
11586
  "disabled": false,
11586
11587
  "document": "全局配置",
11587
- "example": "",
11588
+ "example": "\"scrape_configs:\\n- job_name: job1\\n scrape_interval: 15s\\n static_configs:\\n - targets:\\n - \\\"\\\"\\n\"",
11588
11589
  "member": "string",
11589
11590
  "name": "Config",
11590
11591
  "output_required": true,
@@ -11594,7 +11595,7 @@
11594
11595
  {
11595
11596
  "disabled": false,
11596
11597
  "document": "ServiceMonitor配置",
11597
- "example": "",
11598
+ "example": "[{\"Name\":\"abc\",\"Config\":\"abc\",\"TemplateId\":\"abc\",\"Targets\":{\"Total\":1,\"Up\":1,\"Down\":1,\"Unknown\":1}}]",
11598
11599
  "member": "PrometheusConfigItem",
11599
11600
  "name": "ServiceMonitors",
11600
11601
  "output_required": true,
@@ -11604,7 +11605,7 @@
11604
11605
  {
11605
11606
  "disabled": false,
11606
11607
  "document": "PodMonitor配置",
11607
- "example": "",
11608
+ "example": "[{\"Name\":\"abc\",\"Config\":\"abc\",\"TemplateId\":\"abc\",\"Targets\":{\"Total\":1,\"Up\":1,\"Down\":1,\"Unknown\":1}}]",
11608
11609
  "member": "PrometheusConfigItem",
11609
11610
  "name": "PodMonitors",
11610
11611
  "output_required": true,
@@ -11614,7 +11615,7 @@
11614
11615
  {
11615
11616
  "disabled": false,
11616
11617
  "document": "原生Job",
11617
- "example": "",
11618
+ "example": "[{\"Name\":\"abc\",\"Config\":\"abc\",\"TemplateId\":\"abc\",\"Targets\":{\"Total\":1,\"Up\":1,\"Down\":1,\"Unknown\":1}}]",
11618
11619
  "member": "PrometheusConfigItem",
11619
11620
  "name": "RawJobs",
11620
11621
  "output_required": true,
@@ -11624,7 +11625,7 @@
11624
11625
  {
11625
11626
  "disabled": false,
11626
11627
  "document": "Probes",
11627
- "example": "",
11628
+ "example": "[{\"Name\":\"abc\",\"Config\":\"abc\",\"TemplateId\":\"abc\",\"Targets\":{\"Total\":1,\"Up\":1,\"Down\":1,\"Unknown\":1}}]",
11628
11629
  "member": "PrometheusConfigItem",
11629
11630
  "name": "Probes",
11630
11631
  "output_required": true,
@@ -11634,7 +11635,7 @@
11634
11635
  {
11635
11636
  "disabled": false,
11636
11637
  "document": "实例组件是否需要升级",
11637
- "example": "",
11638
+ "example": "false",
11638
11639
  "member": "bool",
11639
11640
  "name": "ImageNeedUpdate",
11640
11641
  "output_required": true,
@@ -11779,7 +11780,7 @@
11779
11780
  {
11780
11781
  "disabled": false,
11781
11782
  "document": "实例ID",
11782
- "example": "prom-xxx",
11783
+ "example": "prom-abc",
11783
11784
  "member": "string",
11784
11785
  "name": "InstanceId",
11785
11786
  "required": true,
@@ -11794,7 +11795,7 @@
11794
11795
  {
11795
11796
  "disabled": false,
11796
11797
  "document": "实例ID",
11797
- "example": "",
11798
+ "example": "prom-abc",
11798
11799
  "member": "string",
11799
11800
  "name": "InstanceId",
11800
11801
  "output_required": true,
@@ -11804,7 +11805,7 @@
11804
11805
  {
11805
11806
  "disabled": false,
11806
11807
  "document": "实例名称",
11807
- "example": "",
11808
+ "example": "test-Prometheus",
11808
11809
  "member": "string",
11809
11810
  "name": "InstanceName",
11810
11811
  "output_required": true,
@@ -11814,7 +11815,7 @@
11814
11815
  {
11815
11816
  "disabled": false,
11816
11817
  "document": "VPC ID",
11817
- "example": "",
11818
+ "example": "vpc-abc",
11818
11819
  "member": "string",
11819
11820
  "name": "VpcId",
11820
11821
  "output_required": true,
@@ -11824,7 +11825,7 @@
11824
11825
  {
11825
11826
  "disabled": false,
11826
11827
  "document": "子网 ID",
11827
- "example": "",
11828
+ "example": "subnet-abc",
11828
11829
  "member": "string",
11829
11830
  "name": "SubnetId",
11830
11831
  "output_required": true,
@@ -11834,7 +11835,7 @@
11834
11835
  {
11835
11836
  "disabled": false,
11836
11837
  "document": "实例业务状态。取值范围:\n\n1:正在创建\n2:运行中\n3:异常\n4:重建中\n5:销毁中\n6:已停服\n8:欠费停服中\n9:欠费已停服",
11837
- "example": "",
11838
+ "example": "3",
11838
11839
  "member": "int64",
11839
11840
  "name": "InstanceStatus",
11840
11841
  "output_required": true,
@@ -11844,7 +11845,7 @@
11844
11845
  {
11845
11846
  "disabled": false,
11846
11847
  "document": "计费状态\n\n1:正常\n2:过期\n3:销毁\n4:分配中\n5:分配失败\n注意:此字段可能返回 null,表示取不到有效值。",
11847
- "example": "",
11848
+ "example": "1",
11848
11849
  "member": "int64",
11849
11850
  "name": "ChargeStatus",
11850
11851
  "output_required": true,
@@ -11854,7 +11855,7 @@
11854
11855
  {
11855
11856
  "disabled": false,
11856
11857
  "document": "是否开启 Grafana\n0:不开启\n1:开启",
11857
- "example": "",
11858
+ "example": "1",
11858
11859
  "member": "int64",
11859
11860
  "name": "EnableGrafana",
11860
11861
  "output_required": true,
@@ -11864,7 +11865,7 @@
11864
11865
  {
11865
11866
  "disabled": false,
11866
11867
  "document": "Grafana 面板 URL\n注意:此字段可能返回 null,表示取不到有效值。",
11867
- "example": "",
11868
+ "example": "http://10.0.0.1:3000",
11868
11869
  "member": "string",
11869
11870
  "name": "GrafanaURL",
11870
11871
  "output_required": true,
@@ -11874,7 +11875,7 @@
11874
11875
  {
11875
11876
  "disabled": false,
11876
11877
  "document": "实例计费模式。取值范围:\n\n2:包年包月\n3:按量",
11877
- "example": "",
11878
+ "example": "3",
11878
11879
  "member": "int64",
11879
11880
  "name": "InstanceChargeType",
11880
11881
  "output_required": true,
@@ -11884,7 +11885,7 @@
11884
11885
  {
11885
11886
  "disabled": false,
11886
11887
  "document": "规格名称\n注意:此字段可能返回 null,表示取不到有效值。",
11887
- "example": "",
11888
+ "example": "abc",
11888
11889
  "member": "string",
11889
11890
  "name": "SpecName",
11890
11891
  "output_required": true,
@@ -11894,7 +11895,7 @@
11894
11895
  {
11895
11896
  "disabled": false,
11896
11897
  "document": "存储周期\n注意:此字段可能返回 null,表示取不到有效值。",
11897
- "example": "",
11898
+ "example": "15",
11898
11899
  "member": "int64",
11899
11900
  "name": "DataRetentionTime",
11900
11901
  "output_required": true,
@@ -11904,7 +11905,7 @@
11904
11905
  {
11905
11906
  "disabled": false,
11906
11907
  "document": "购买的实例过期时间\n注意:此字段可能返回 null,表示取不到有效值。",
11907
- "example": "",
11908
+ "example": "2024/07/16 16:06:31",
11908
11909
  "member": "string",
11909
11910
  "name": "ExpireTime",
11910
11911
  "output_required": true,
@@ -11914,7 +11915,7 @@
11914
11915
  {
11915
11916
  "disabled": false,
11916
11917
  "document": "自动续费标记\n\n0:不自动续费\n1:开启自动续费\n2:禁止自动续费\n-1:无效\n注意:此字段可能返回 null,表示取不到有效值。",
11917
- "example": "",
11918
+ "example": "0",
11918
11919
  "member": "int64",
11919
11920
  "name": "AutoRenewFlag",
11920
11921
  "output_required": true,
@@ -11951,7 +11952,7 @@
11951
11952
  {
11952
11953
  "disabled": false,
11953
11954
  "document": "实例初始化状态,取值:\nuninitialized 未初始化 \ninitializing 初始化中\nrunning 初始化完成,运行中\n注意:此字段可能返回 null,表示取不到有效值。",
11954
- "example": "",
11955
+ "example": "running",
11955
11956
  "member": "string",
11956
11957
  "name": "Status",
11957
11958
  "output_required": true,
@@ -11961,7 +11962,7 @@
11961
11962
  {
11962
11963
  "disabled": false,
11963
11964
  "document": "初始化任务步骤\n注意:此字段可能返回 null,表示取不到有效值。",
11964
- "example": "",
11965
+ "example": "{\"Step\":\"abc\",\"LifeState\":\"abc\",\"StartAt\":\"abc\",\"EndAt\":\"abc\",\"FailedMsg\":\"abc\"}",
11965
11966
  "member": "TaskStepInfo",
11966
11967
  "name": "Steps",
11967
11968
  "output_required": true,
@@ -11971,7 +11972,7 @@
11971
11972
  {
11972
11973
  "disabled": false,
11973
11974
  "document": "实例eks集群ID\n注意:此字段可能返回 null,表示取不到有效值。",
11974
- "example": "",
11975
+ "example": "cls-abc",
11975
11976
  "member": "string",
11976
11977
  "name": "EksClusterId",
11977
11978
  "output_required": true,
@@ -11981,7 +11982,7 @@
11981
11982
  {
11982
11983
  "disabled": false,
11983
11984
  "document": "eks集群内pod的安全组\n注意:此字段可能返回 null,表示取不到有效值。",
11984
- "example": "",
11985
+ "example": "sg-abc",
11985
11986
  "member": "string",
11986
11987
  "name": "SecurityGroupId",
11987
11988
  "output_required": false,
@@ -12002,7 +12003,7 @@
12002
12003
  "members": [
12003
12004
  {
12004
12005
  "disabled": false,
12005
- "document": "按照一个或者多个实例ID查询。实例ID形如:prom-xxxxxxxx。请求的实例的上限为100。",
12006
+ "document": "按照一个或者多个实例ID查询。实例ID形如:prom-xxxxxxxx。",
12006
12007
  "example": "[\"prom-xxxxxxxx\"]",
12007
12008
  "member": "string",
12008
12009
  "name": "InstanceIds",
@@ -12581,7 +12582,7 @@
12581
12582
  {
12582
12583
  "disabled": false,
12583
12584
  "document": "模糊过滤条件,支持\nLevel 按模板级别过滤\nName 按名称过滤\nDescribe 按描述过滤\nID 按templateId过滤",
12584
- "example": "",
12585
+ "example": " [{\"Name\": \"Name\",\"Values\": [\"test\"]}]",
12585
12586
  "member": "Filter",
12586
12587
  "name": "Filters",
12587
12588
  "required": false,
@@ -12590,7 +12591,7 @@
12590
12591
  {
12591
12592
  "disabled": false,
12592
12593
  "document": "分页偏移",
12593
- "example": "",
12594
+ "example": "0",
12594
12595
  "member": "uint64",
12595
12596
  "name": "Offset",
12596
12597
  "required": false,
@@ -12599,7 +12600,7 @@
12599
12600
  {
12600
12601
  "disabled": false,
12601
12602
  "document": "总数限制",
12602
- "example": "",
12603
+ "example": "10",
12603
12604
  "member": "uint64",
12604
12605
  "name": "Limit",
12605
12606
  "required": false,
@@ -12614,7 +12615,7 @@
12614
12615
  {
12615
12616
  "disabled": false,
12616
12617
  "document": "模板列表",
12617
- "example": "",
12618
+ "example": "[{\"Name\":\"abc\",\"Describe\":\"abc\",\"Level\":\"abc\",\"RecordRules\":[{\"Name\":\"abc\",\"Config\":\"abc\",\"TemplateId\":\"abc\",\"Targets\":{\"Total\":1,\"Up\":1,\"Down\":1,\"Unknown\":1}}],\"RawJobs\":[{\"Name\":\"abc\",\"Config\":\"abc\",\"TemplateId\":\"abc\",\"Targets\":{\"Total\":1,\"Up\":1,\"Down\":1,\"Unknown\":1}}],\"ServiceMonitors\":[{\"Name\":\"abc\",\"Config\":\"abc\",\"TemplateId\":\"abc\",\"Targets\":{\"Total\":1,\"Up\":1,\"Down\":1,\"Unknown\":1}}],\"PodMonitors\":[{\"Name\":\"abc\",\"Config\":\"abc\",\"TemplateId\":\"abc\",\"Targets\":{\"Total\":1,\"Up\":1,\"Down\":1,\"Unknown\":1}}],\"TemplateId\":\"abc\",\"UpdateTime\":\"abc\",\"Version\":\"abc\",\"IsDefault\":true,\"AlertDetailRules\":[{\"Id\":\"abc\",\"Name\":\"abc\",\"TemplateId\":\"abc\",\"Notification\":{\"Enabled\":true,\"Type\":\"abc\",\"WebHook\":\"abc\",\"AlertManager\":{\"ClusterType\":\"abc\",\"ClusterId\":\"abc\",\"Url\":\"abc\"},\"RepeatInterval\":\"abc\",\"TimeRangeStart\":\"abc\",\"TimeRangeEnd\":\"abc\",\"NotifyWay\":[\"abc\"],\"ReceiverGroups\":[\"abc\"],\"PhoneNotifyOrder\":[1],\"PhoneCircleTimes\":0,\"PhoneInnerInterval\":0,\"PhoneCircleInterval\":0,\"PhoneArriveNotice\":true},\"Rules\":[{\"Name\":\"abc\",\"Rule\":\"abc\",\"Labels\":[{\"Name\":\"abc\",\"Value\":\"abc\"}],\"Template\":\"abc\",\"For\":\"abc\",\"Describe\":\"abc\",\"Annotations\":[{\"Name\":\"abc\",\"Value\":\"abc\"}],\"RuleState\":0}],\"UpdatedAt\":\"abc\",\"ClusterId\":\"abc\",\"Interval\":\"abc\"}],\"TargetsTotal\": 0}]",
12618
12619
  "member": "PrometheusTemp",
12619
12620
  "name": "Templates",
12620
12621
  "output_required": true,
@@ -12624,7 +12625,7 @@
12624
12625
  {
12625
12626
  "disabled": false,
12626
12627
  "document": "总数",
12627
- "example": "",
12628
+ "example": "10",
12628
12629
  "member": "uint64",
12629
12630
  "name": "Total",
12630
12631
  "output_required": true,
@@ -12646,7 +12647,7 @@
12646
12647
  {
12647
12648
  "disabled": false,
12648
12649
  "document": "模板ID",
12649
- "example": "",
12650
+ "example": "temp-abc",
12650
12651
  "member": "string",
12651
12652
  "name": "TemplateId",
12652
12653
  "required": true,
@@ -12661,7 +12662,7 @@
12661
12662
  {
12662
12663
  "disabled": false,
12663
12664
  "document": "同步目标详情\n注意:此字段可能返回 null,表示取不到有效值。",
12664
- "example": "",
12665
+ "example": "{\"Region\":\"abc\",\"InstanceId\":\"abc\",\"ClusterId\":\"abc\",\"SyncTime\":\"abc\",\"Version\":\"abc\",\"ClusterType\":\"abc\",\"InstanceName\":\"abc\",\"ClusterName\":\"abc\"}",
12665
12666
  "member": "PrometheusTemplateSyncTarget",
12666
12667
  "name": "Targets",
12667
12668
  "output_required": true,
@@ -15915,7 +15916,7 @@
15915
15916
  },
15916
15917
  {
15917
15918
  "disabled": false,
15918
- "document": "存储时长(取值为 15、3045。此参数不适用于包年包月实例)",
15919
+ "document": "数据存储时间(单位天),限制值为15, 30, 45, 90, 180, 365, 730之一",
15919
15920
  "example": "15",
15920
15921
  "member": "int64",
15921
15922
  "name": "DataRetentionTime",
@@ -16683,7 +16684,7 @@
16683
16684
  {
16684
16685
  "disabled": false,
16685
16686
  "document": "集群id",
16686
- "example": "cls-xxx",
16687
+ "example": "cls-abc",
16687
16688
  "member": "string",
16688
16689
  "name": "ClusterId",
16689
16690
  "output_required": true,
@@ -16733,7 +16734,7 @@
16733
16734
  {
16734
16735
  "disabled": false,
16735
16736
  "document": "集群所在VPC ID\n注意:此字段可能返回 null,表示取不到有效值。",
16736
- "example": "xxx",
16737
+ "example": "vpc-abc",
16737
16738
  "member": "string",
16738
16739
  "name": "VpcId",
16739
16740
  "output_required": true,
@@ -16743,7 +16744,7 @@
16743
16744
  {
16744
16745
  "disabled": false,
16745
16746
  "document": "记录关联等操作的失败信息\n注意:此字段可能返回 null,表示取不到有效值。",
16746
- "example": "xxx",
16747
+ "example": "abc",
16747
16748
  "member": "string",
16748
16749
  "name": "FailedReason",
16749
16750
  "output_required": true,
@@ -16753,7 +16754,7 @@
16753
16754
  {
16754
16755
  "disabled": false,
16755
16756
  "document": "agent名称\n注意:此字段可能返回 null,表示取不到有效值。",
16756
- "example": "xxx",
16757
+ "example": "abc",
16757
16758
  "member": "string",
16758
16759
  "name": "Name",
16759
16760
  "output_required": true,
@@ -17253,8 +17254,8 @@
17253
17254
  "members": [
17254
17255
  {
17255
17256
  "disabled": false,
17256
- "document": "集群ID",
17257
- "example": "xx-xxx",
17257
+ "document": "地域",
17258
+ "example": "ap-beijing",
17258
17259
  "member": "string",
17259
17260
  "name": "Region",
17260
17261
  "required": true,
@@ -17272,7 +17273,7 @@
17272
17273
  {
17273
17274
  "disabled": false,
17274
17275
  "document": "集群ID",
17275
- "example": "cls-xxx",
17276
+ "example": "cls-abc",
17276
17277
  "member": "string",
17277
17278
  "name": "ClusterId",
17278
17279
  "required": true,
@@ -17308,7 +17309,7 @@
17308
17309
  {
17309
17310
  "disabled": false,
17310
17311
  "document": "是否安装默认采集配置",
17311
- "example": "",
17312
+ "example": "false",
17312
17313
  "member": "bool",
17313
17314
  "name": "NotInstallBasicScrape",
17314
17315
  "required": false,
@@ -17317,7 +17318,7 @@
17317
17318
  {
17318
17319
  "disabled": false,
17319
17320
  "document": "是否采集指标,true代表drop所有指标,false代表采集默认指标",
17320
- "example": "",
17321
+ "example": "false",
17321
17322
  "member": "bool",
17322
17323
  "name": "NotScrape",
17323
17324
  "required": false,
@@ -17326,7 +17327,7 @@
17326
17327
  {
17327
17328
  "disabled": false,
17328
17329
  "document": "是否开启默认预聚合规则",
17329
- "example": "",
17330
+ "example": "true",
17330
17331
  "member": "bool",
17331
17332
  "name": "OpenDefaultRecord",
17332
17333
  "required": false,
@@ -18219,80 +18220,80 @@
18219
18220
  {
18220
18221
  "disabled": false,
18221
18222
  "document": "实例名称",
18222
- "example": "",
18223
+ "example": "test-record",
18223
18224
  "member": "string",
18224
18225
  "name": "Name",
18225
- "required": true,
18226
+ "output_required": true,
18226
18227
  "type": "string",
18227
18228
  "value_allowed_null": false
18228
18229
  },
18229
18230
  {
18230
18231
  "disabled": false,
18231
18232
  "document": "最近更新时间",
18232
- "example": "",
18233
+ "example": "2024-06-19 16:22:26",
18233
18234
  "member": "string",
18234
18235
  "name": "UpdateTime",
18235
- "required": true,
18236
+ "output_required": true,
18236
18237
  "type": "string",
18237
18238
  "value_allowed_null": false
18238
18239
  },
18239
18240
  {
18240
18241
  "disabled": false,
18241
18242
  "document": "Yaml内容",
18242
- "example": "",
18243
+ "example": "temp-abc",
18243
18244
  "member": "string",
18244
18245
  "name": "TemplateId",
18245
- "required": true,
18246
+ "output_required": true,
18246
18247
  "type": "string",
18247
18248
  "value_allowed_null": false
18248
18249
  },
18249
18250
  {
18250
18251
  "disabled": false,
18251
18252
  "document": "如果该聚合规则来至模板,则TemplateId为模板id\n注意:此字段可能返回 null,表示取不到有效值。",
18252
- "example": "",
18253
+ "example": "abc",
18253
18254
  "member": "string",
18254
18255
  "name": "Content",
18255
- "required": true,
18256
+ "output_required": true,
18256
18257
  "type": "string",
18257
18258
  "value_allowed_null": true
18258
18259
  },
18259
18260
  {
18260
18261
  "disabled": false,
18261
18262
  "document": "该聚合规则如果来源于用户集群crd资源定义,则ClusterId为所属集群ID\n注意:此字段可能返回 null,表示取不到有效值。",
18262
- "example": "",
18263
+ "example": "cls-abc",
18263
18264
  "member": "string",
18264
18265
  "name": "ClusterId",
18265
- "required": true,
18266
+ "output_required": true,
18266
18267
  "type": "string",
18267
18268
  "value_allowed_null": true
18268
18269
  },
18269
18270
  {
18270
18271
  "disabled": false,
18271
18272
  "document": "状态\n注意:此字段可能返回 null,表示取不到有效值。",
18272
- "example": "",
18273
+ "example": "1",
18273
18274
  "member": "int64",
18274
18275
  "name": "Status",
18275
- "required": false,
18276
+ "output_required": true,
18276
18277
  "type": "int",
18277
18278
  "value_allowed_null": true
18278
18279
  },
18279
18280
  {
18280
18281
  "disabled": false,
18281
18282
  "document": "id\n注意:此字段可能返回 null,表示取不到有效值。",
18282
- "example": "",
18283
+ "example": "abc",
18283
18284
  "member": "string",
18284
18285
  "name": "Id",
18285
- "required": false,
18286
+ "output_required": true,
18286
18287
  "type": "string",
18287
18288
  "value_allowed_null": true
18288
18289
  },
18289
18290
  {
18290
18291
  "disabled": false,
18291
18292
  "document": "规则数量\n注意:此字段可能返回 null,表示取不到有效值。",
18292
- "example": "",
18293
+ "example": "1",
18293
18294
  "member": "int64",
18294
18295
  "name": "Count",
18295
- "required": false,
18296
+ "output_required": true,
18296
18297
  "type": "int",
18297
18298
  "value_allowed_null": true
18298
18299
  }
@@ -18610,9 +18611,10 @@
18610
18611
  {
18611
18612
  "disabled": false,
18612
18613
  "document": "模板名称",
18613
- "example": "",
18614
+ "example": "test-a",
18614
18615
  "member": "string",
18615
18616
  "name": "Name",
18617
+ "output_required": true,
18616
18618
  "required": true,
18617
18619
  "type": "string",
18618
18620
  "value_allowed_null": false
@@ -18620,9 +18622,10 @@
18620
18622
  {
18621
18623
  "disabled": false,
18622
18624
  "document": "模板维度,支持以下类型\ninstance 实例级别\ncluster 集群级别",
18623
- "example": "",
18625
+ "example": "instance",
18624
18626
  "member": "string",
18625
18627
  "name": "Level",
18628
+ "output_required": true,
18626
18629
  "required": true,
18627
18630
  "type": "string",
18628
18631
  "value_allowed_null": false
@@ -18630,9 +18633,10 @@
18630
18633
  {
18631
18634
  "disabled": false,
18632
18635
  "document": "模板描述\n注意:此字段可能返回 null,表示取不到有效值。",
18633
- "example": "",
18636
+ "example": "test template",
18634
18637
  "member": "string",
18635
18638
  "name": "Describe",
18639
+ "output_required": true,
18636
18640
  "required": false,
18637
18641
  "type": "string",
18638
18642
  "value_allowed_null": true
@@ -18640,9 +18644,10 @@
18640
18644
  {
18641
18645
  "disabled": false,
18642
18646
  "document": "当Level为instance时有效,\n模板中的聚合规则列表\n注意:此字段可能返回 null,表示取不到有效值。",
18643
- "example": "",
18647
+ "example": "[{\"Name\":\"abc\",\"Config\":\"abc\",\"TemplateId\":\"abc\",\"Targets\":{\"Total\":1,\"Up\":1,\"Down\":1,\"Unknown\":1}}]",
18644
18648
  "member": "PrometheusConfigItem",
18645
18649
  "name": "RecordRules",
18650
+ "output_required": true,
18646
18651
  "required": false,
18647
18652
  "type": "list",
18648
18653
  "value_allowed_null": true
@@ -18650,9 +18655,10 @@
18650
18655
  {
18651
18656
  "disabled": false,
18652
18657
  "document": "当Level为cluster时有效,\n模板中的ServiceMonitor规则列表\n注意:此字段可能返回 null,表示取不到有效值。",
18653
- "example": "",
18658
+ "example": "[{\"Name\":\"abc\",\"Config\":\"abc\",\"TemplateId\":\"abc\",\"Targets\":{\"Total\":1,\"Up\":1,\"Down\":1,\"Unknown\":1}}]",
18654
18659
  "member": "PrometheusConfigItem",
18655
18660
  "name": "ServiceMonitors",
18661
+ "output_required": true,
18656
18662
  "required": false,
18657
18663
  "type": "list",
18658
18664
  "value_allowed_null": true
@@ -18660,9 +18666,10 @@
18660
18666
  {
18661
18667
  "disabled": false,
18662
18668
  "document": "当Level为cluster时有效,\n模板中的PodMonitors规则列表\n注意:此字段可能返回 null,表示取不到有效值。",
18663
- "example": "",
18669
+ "example": "[{\"Name\":\"abc\",\"Config\":\"abc\",\"TemplateId\":\"abc\",\"Targets\":{\"Total\":1,\"Up\":1,\"Down\":1,\"Unknown\":1}}]",
18664
18670
  "member": "PrometheusConfigItem",
18665
18671
  "name": "PodMonitors",
18672
+ "output_required": true,
18666
18673
  "required": false,
18667
18674
  "type": "list",
18668
18675
  "value_allowed_null": true
@@ -18670,9 +18677,10 @@
18670
18677
  {
18671
18678
  "disabled": false,
18672
18679
  "document": "当Level为cluster时有效,\n模板中的RawJobs规则列表\n注意:此字段可能返回 null,表示取不到有效值。",
18673
- "example": "",
18680
+ "example": "[{\"Name\":\"abc\",\"Config\":\"abc\",\"TemplateId\":\"abc\",\"Targets\":{\"Total\":1,\"Up\":1,\"Down\":1,\"Unknown\":1}}]",
18674
18681
  "member": "PrometheusConfigItem",
18675
18682
  "name": "RawJobs",
18683
+ "output_required": true,
18676
18684
  "required": false,
18677
18685
  "type": "list",
18678
18686
  "value_allowed_null": true
@@ -18680,9 +18688,10 @@
18680
18688
  {
18681
18689
  "disabled": false,
18682
18690
  "document": "模板的ID, 用于出参\n注意:此字段可能返回 null,表示取不到有效值。",
18683
- "example": "",
18691
+ "example": "temp-abc",
18684
18692
  "member": "string",
18685
18693
  "name": "TemplateId",
18694
+ "output_required": true,
18686
18695
  "required": false,
18687
18696
  "type": "string",
18688
18697
  "value_allowed_null": true
@@ -18690,9 +18699,10 @@
18690
18699
  {
18691
18700
  "disabled": false,
18692
18701
  "document": "最近更新时间,用于出参\n注意:此字段可能返回 null,表示取不到有效值。",
18693
- "example": "",
18702
+ "example": "2024-07-16 16:28:54",
18694
18703
  "member": "string",
18695
18704
  "name": "UpdateTime",
18705
+ "output_required": true,
18696
18706
  "required": false,
18697
18707
  "type": "string",
18698
18708
  "value_allowed_null": true
@@ -18700,9 +18710,10 @@
18700
18710
  {
18701
18711
  "disabled": false,
18702
18712
  "document": "当前版本,用于出参\n注意:此字段可能返回 null,表示取不到有效值。",
18703
- "example": "",
18713
+ "example": "v1",
18704
18714
  "member": "string",
18705
18715
  "name": "Version",
18716
+ "output_required": true,
18706
18717
  "required": false,
18707
18718
  "type": "string",
18708
18719
  "value_allowed_null": true
@@ -18710,9 +18721,10 @@
18710
18721
  {
18711
18722
  "disabled": false,
18712
18723
  "document": "是否系统提供的默认模板,用于出参\n注意:此字段可能返回 null,表示取不到有效值。",
18713
- "example": "",
18724
+ "example": "false",
18714
18725
  "member": "bool",
18715
18726
  "name": "IsDefault",
18727
+ "output_required": true,
18716
18728
  "required": false,
18717
18729
  "type": "bool",
18718
18730
  "value_allowed_null": true
@@ -18720,9 +18732,10 @@
18720
18732
  {
18721
18733
  "disabled": false,
18722
18734
  "document": "当Level为instance时有效,\n模板中的告警配置列表\n注意:此字段可能返回 null,表示取不到有效值。",
18723
- "example": "",
18735
+ "example": "[{\"Id\":\"abc\",\"Name\":\"abc\",\"TemplateId\":\"abc\",\"Notification\":{\"Enabled\":true,\"Type\":\"abc\",\"WebHook\":\"abc\",\"AlertManager\":{\"ClusterType\":\"abc\",\"ClusterId\":\"abc\",\"Url\":\"abc\"},\"RepeatInterval\":\"abc\",\"TimeRangeStart\":\"abc\",\"TimeRangeEnd\":\"abc\",\"NotifyWay\":[\"abc\"],\"ReceiverGroups\":[\"abc\"],\"PhoneNotifyOrder\":[1],\"PhoneCircleTimes\":0,\"PhoneInnerInterval\":0,\"PhoneCircleInterval\":0,\"PhoneArriveNotice\":true},\"Rules\":[{\"Name\":\"abc\",\"Rule\":\"abc\",\"Labels\":[{\"Name\":\"abc\",\"Value\":\"abc\"}],\"Template\":\"abc\",\"For\":\"abc\",\"Describe\":\"abc\",\"Annotations\":[{\"Name\":\"abc\",\"Value\":\"abc\"}],\"RuleState\":0}],\"UpdatedAt\":\"abc\",\"ClusterId\":\"abc\",\"Interval\":\"abc\"}]",
18724
18736
  "member": "PrometheusAlertPolicyItem",
18725
18737
  "name": "AlertDetailRules",
18738
+ "output_required": true,
18726
18739
  "required": false,
18727
18740
  "type": "list",
18728
18741
  "value_allowed_null": true
@@ -18730,9 +18743,10 @@
18730
18743
  {
18731
18744
  "disabled": false,
18732
18745
  "document": "关联实例数目\n注意:此字段可能返回 null,表示取不到有效值。",
18733
- "example": "",
18746
+ "example": "1",
18734
18747
  "member": "int64",
18735
18748
  "name": "TargetsTotal",
18749
+ "output_required": true,
18736
18750
  "required": false,
18737
18751
  "type": "int",
18738
18752
  "value_allowed_null": true
@@ -19391,7 +19405,7 @@
19391
19405
  {
19392
19406
  "disabled": false,
19393
19407
  "document": "实例id",
19394
- "example": "",
19408
+ "example": "temp-abc",
19395
19409
  "member": "string",
19396
19410
  "name": "TemplateId",
19397
19411
  "required": true,
@@ -19400,7 +19414,7 @@
19400
19414
  {
19401
19415
  "disabled": false,
19402
19416
  "document": "同步目标",
19403
- "example": "",
19417
+ "example": "{\"Region\":\"abc\",\"InstanceId\":\"abc\",\"ClusterId\":\"abc\",\"SyncTime\":\"abc\",\"Version\":\"abc\",\"ClusterType\":\"abc\",\"InstanceName\":\"abc\",\"ClusterName\":\"abc\"}",
19404
19418
  "member": "PrometheusTemplateSyncTarget",
19405
19419
  "name": "Targets",
19406
19420
  "required": true,
@@ -20632,7 +20646,7 @@
20632
20646
  },
20633
20647
  {
20634
20648
  "disabled": false,
20635
- "document": "Agent ID 列表,例如:agent-abcd1234,可在控制台 Agent 管理中获取",
20649
+ "document": "Agent ID 列表,例如:agent-abcd1234,可在控制台 Agent 管理中获取\n\n示例值:[\"agent-abcd1234\"]",
20636
20650
  "example": "[\"xx\"]",
20637
20651
  "member": "string",
20638
20652
  "name": "AgentIds",
@@ -20995,7 +21009,7 @@
20995
21009
  {
20996
21010
  "disabled": false,
20997
21011
  "document": "Prometheus 实例 ID",
20998
- "example": "",
21012
+ "example": "prom-sdfk2342a",
20999
21013
  "member": "string",
21000
21014
  "name": "InstanceId",
21001
21015
  "required": true,
@@ -21004,7 +21018,7 @@
21004
21018
  {
21005
21019
  "disabled": false,
21006
21020
  "document": "<li>类型是 TKE,为对应的腾讯云容器服务集群 ID</li>",
21007
- "example": "",
21021
+ "example": "cls-pwerf3k3",
21008
21022
  "member": "string",
21009
21023
  "name": "KubeClusterId",
21010
21024
  "required": true,
@@ -21013,7 +21027,7 @@
21013
21027
  {
21014
21028
  "disabled": false,
21015
21029
  "document": "用户 Kubernetes 集群类型:\n<li> 1 = 容器服务集群(TKE) </li>",
21016
- "example": "",
21030
+ "example": "1",
21017
21031
  "member": "int64",
21018
21032
  "name": "KubeType",
21019
21033
  "required": true,
@@ -21022,7 +21036,7 @@
21022
21036
  {
21023
21037
  "disabled": false,
21024
21038
  "document": "服务发现类型,取值如下:\n<li> 1 = ServiceMonitor</li>\n<li> 2 = PodMonitor</li>\n<li> 3 = JobMonitor</li>",
21025
- "example": "",
21039
+ "example": "1",
21026
21040
  "member": "int64",
21027
21041
  "name": "Type",
21028
21042
  "required": true,
@@ -21030,8 +21044,8 @@
21030
21044
  },
21031
21045
  {
21032
21046
  "disabled": false,
21033
- "document": "服务发现配置信息",
21034
- "example": "",
21047
+ "document": "服务发现配置信息,YAML 格式\n\n示例值:\n\n```\napiVersion: monitoring.coreos.com/v1\nkind: ServiceMonitor\nmetadata:\n name: go-demo # 填写一个唯一名称\n namespace: cm-prometheus # namespace固定,不要修改\nspec:\n endpoints:\n - interval: 30s\n # 填写service yaml中Prometheus Exporter对应的Port的Name\n port: 2112\n # 填写Prometheus Exporter对应的Path的值,不填默认/metrics\n path: /metrics\n relabelings:\n # ** 必须要有一个 label 为 application,这里假设 k8s 有一个 label 为 app,\n # 我们通过 relabel 的 replace 动作把它替换成了 application\n - action: replace\n sourceLabels: [__meta_kubernetes_pod_label_app]\n targetLabel: application\n # 选择要监控service所在的namespace\n namespaceSelector:\n matchNames:\n - golang-demo\n # 填写要监控service的Label值,以定位目标service\n selector:\n matchLabels:\n app: golang-app-demo\n```",
21048
+ "example": "yaml",
21035
21049
  "member": "string",
21036
21050
  "name": "Yaml",
21037
21051
  "required": true,
@@ -21046,9 +21060,10 @@
21046
21060
  {
21047
21061
  "disabled": false,
21048
21062
  "document": "更新成功之后,返回对应服务发现的信息",
21049
- "example": "",
21063
+ "example": " \"ServiceDiscovery\": { \"Kind\": \"ServiceMonitor\", \"Name\": \"name\", \"Namespace\": \"namespace\", \"Selector\": \"{\\\"matchLabels\\\":{\\\"k8sapp\\\":\\\"mysql-exporter\\\"}}\", \"Yaml\": \"apiVersion: monitoring.coreos.com...\", \"NamespaceSelector\": \"{\\\"matchNames\\\":[\\\"demo-ns\\\"]}\", \"Endpoints\": \"[{\\\"port\\\":\\\"tcp-port\\\",\\\"path\\\":\\\"/metrics\\\",\\\"interval\\\":\\\"30s\\\",\\\"bearerTokenSecret\\\":{\\\"key\\\":\\\"\\\"}}]\" }",
21050
21064
  "member": "ServiceDiscoveryItem",
21051
21065
  "name": "ServiceDiscovery",
21066
+ "output_required": true,
21052
21067
  "type": "object",
21053
21068
  "value_allowed_null": false
21054
21069
  },
@@ -21075,7 +21090,7 @@
21075
21090
  },
21076
21091
  {
21077
21092
  "disabled": false,
21078
- "document": "Prometheus 集成项 Code,升级对应的 Dashboard,取值如下:\n<li>qcloud</li>\n<li>cvm_process_exporter</li>\n<li>cvm_node_exporter</li>\n<li>cvm</li>\n<li>kubernetes</li>\n<li>cdwch</li>\n<li>rocketmq</li>\n<li>spring_mvc</li>\n<li>mysql</li>\n<li>go</li>\n<li>redis</li>\n<li>jvm</li>\n<li>pgsql</li>\n<li>mongo</li>\n<li>kafka</li>\n<li>es</li>\n<li>flink</li>\n<li>blackbox</li>\n<li>consule</li>\n<li>memcached</li>\n<li>zk</li>\n<li>tps</li>\n<li>istio</li>\n<li>etcd</li>\n<li>pts</li>\n<li>kong</li>",
21093
+ "document": "Prometheus 集成项 Code,升级对应的 Dashboard,取值如下:<li>qcloud</li><li>cvm_process_exporter</li><li>cvm_node_exporter</li><li>cvm</li><li>tps</li><li>nginx-ingress</li><li>nvidia-gpu</li><li>cdwch</li><li>emr</li><li>apache</li><li>rocketmq</li><li>rabbitmq</li><li>spring_mvc</li><li>mysql</li><li>mssql</li><li>go</li><li>redis</li><li>jvm</li><li>pgsql</li><li>ceph</li><li>docker</li><li>nginx</li><li>oracledb</li><li>mongo</li><li>kafka</li><li>es</li><li>flink</li><li>blackbox</li><li>consule</li><li>memcached</li><li>zk</li><li>tps</li><li>istio</li><li>etcd</li><li>pts</li><li>kong</li>",
21079
21094
  "example": "[\"spring-mvc\"]",
21080
21095
  "member": "string",
21081
21096
  "name": "IntegrationCodes",