tccli-intl-en 3.0.1237.1__py2.py3-none-any.whl → 3.0.1282.1__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tccli/__init__.py +1 -1
- tccli/services/__init__.py +17 -1
- tccli/services/advisor/advisor_client.py +8 -2
- tccli/services/aiart/aiart_client.py +4 -1
- tccli/services/ams/ams_client.py +16 -4
- tccli/services/antiddos/antiddos_client.py +280 -70
- tccli/services/apigateway/apigateway_client.py +372 -93
- tccli/services/apm/apm_client.py +52 -13
- tccli/services/asr/asr_client.py +8 -2
- tccli/services/autoscaling/autoscaling_client.py +232 -58
- tccli/services/autoscaling/v20180419/api.json +1 -1
- tccli/services/batch/batch_client.py +112 -28
- tccli/services/bi/bi_client.py +1242 -4
- tccli/services/bi/v20220105/api.json +5340 -107
- tccli/services/bi/v20220105/examples.json +196 -1
- tccli/services/billing/billing_client.py +168 -42
- tccli/services/cam/cam_client.py +324 -81
- tccli/services/captcha/captcha_client.py +4 -1
- tccli/services/car/car_client.py +132 -33
- tccli/services/cbs/cbs_client.py +152 -38
- tccli/services/ccc/ccc_client.py +732 -98
- tccli/services/ccc/v20200210/api.json +1727 -196
- tccli/services/ccc/v20200210/examples.json +64 -0
- tccli/services/cdb/cdb_client.py +532 -133
- tccli/services/cdc/cdc_client.py +80 -20
- tccli/services/cdc/v20201214/api.json +2 -2
- tccli/services/cdc/v20201214/examples.json +4 -4
- tccli/services/cdn/cdn_client.py +176 -44
- tccli/services/cdwdoris/cdwdoris_client.py +308 -77
- tccli/services/cdwpg/cdwpg_client.py +96 -24
- tccli/services/cdz/__init__.py +4 -0
- tccli/services/cdz/cdz_client.py +210 -0
- tccli/services/cdz/v20221123/api.json +233 -0
- tccli/services/cdz/v20221123/examples.json +12 -0
- tccli/services/cfg/cfg_client.py +64 -16
- tccli/services/cfs/cfs_client.py +156 -39
- tccli/services/cfw/cfw_client.py +264 -66
- tccli/services/chdfs/chdfs_client.py +116 -29
- tccli/services/ciam/ciam_client.py +64 -16
- tccli/services/ckafka/ckafka_client.py +575 -77
- tccli/services/ckafka/v20190819/api.json +2749 -1470
- tccli/services/ckafka/v20190819/examples.json +209 -155
- tccli/services/clb/clb_client.py +332 -83
- tccli/services/clb/v20180317/api.json +29 -14
- tccli/services/cloudaudit/cloudaudit_client.py +72 -18
- tccli/services/cls/cls_client.py +348 -87
- tccli/services/cmq/cmq_client.py +12 -801
- tccli/services/cmq/v20190304/api.json +173 -1367
- tccli/services/cmq/v20190304/examples.json +0 -120
- tccli/services/config/config_client.py +24 -6
- tccli/services/controlcenter/controlcenter_client.py +4 -1
- tccli/services/csip/csip_client.py +136 -34
- tccli/services/ctsdb/ctsdb_client.py +8 -2
- tccli/services/cvm/cvm_client.py +627 -110
- tccli/services/cvm/v20170312/api.json +750 -340
- tccli/services/cvm/v20170312/examples.json +105 -59
- tccli/services/cwp/cwp_client.py +1860 -465
- tccli/services/cynosdb/cynosdb_client.py +1749 -439
- tccli/services/cynosdb/v20190107/api.json +11763 -7697
- tccli/services/cynosdb/v20190107/examples.json +132 -4
- tccli/services/dataintegration/dataintegration_client.py +4 -1
- tccli/services/dayu/dayu_client.py +412 -103
- tccli/services/dbbrain/dbbrain_client.py +168 -42
- tccli/services/dc/dc_client.py +72 -18
- tccli/services/dcdb/dcdb_client.py +248 -62
- tccli/services/dlc/dlc_client.py +756 -111
- tccli/services/dlc/v20210125/api.json +637 -13
- tccli/services/dlc/v20210125/examples.json +48 -0
- tccli/services/dms/dms_client.py +8 -2
- tccli/services/dnspod/dnspod_client.py +353 -74
- tccli/services/dnspod/v20210323/api.json +196 -0
- tccli/services/dnspod/v20210323/examples.json +24 -0
- tccli/services/domain/domain_client.py +96 -24
- tccli/services/dts/dts_client.py +332 -83
- tccli/services/eb/eb_client.py +104 -26
- tccli/services/ecdn/ecdn_client.py +60 -15
- tccli/services/ecm/ecm_client.py +496 -124
- tccli/services/eiam/eiam_client.py +160 -40
- tccli/services/emr/emr_client.py +2784 -115
- tccli/services/emr/v20190103/api.json +14647 -4756
- tccli/services/emr/v20190103/examples.json +408 -40
- tccli/services/es/es_client.py +84 -21
- tccli/services/facefusion/facefusion_client.py +12 -3
- tccli/services/faceid/faceid_client.py +76 -19
- tccli/services/faceid/v20180301/api.json +79 -14
- tccli/services/faceid/v20180301/examples.json +3 -3
- tccli/services/gaap/gaap_client.py +352 -88
- tccli/services/gme/gme_client.py +40 -10
- tccli/services/gpm/gpm_client.py +72 -18
- tccli/services/gse/gse_client.py +88 -22
- tccli/services/gwlb/gwlb_client.py +72 -18
- tccli/services/iai/iai_client.py +116 -29
- tccli/services/iap/iap_client.py +24 -6
- tccli/services/ims/ims_client.py +4 -1
- tccli/services/intlpartnersmgt/intlpartnersmgt_client.py +168 -42
- tccli/services/intlpartnersmgt/v20220928/api.json +11 -11
- tccli/services/iotcloud/iotcloud_client.py +80 -20
- tccli/services/ip/ip_client.py +24 -6
- tccli/services/kms/kms_client.py +272 -68
- tccli/services/lcic/lcic_client.py +212 -53
- tccli/services/lighthouse/lighthouse_client.py +296 -74
- tccli/services/lighthouse/v20200324/api.json +14 -14
- tccli/services/lighthouse/v20200324/examples.json +5 -5
- tccli/services/live/live_client.py +480 -120
- tccli/services/lke/lke_client.py +360 -90
- tccli/services/lke/v20231130/api.json +182 -39
- tccli/services/lkeap/__init__.py +4 -0
- tccli/services/lkeap/lkeap_client.py +546 -0
- tccli/services/lkeap/v20240522/api.json +855 -0
- tccli/services/lkeap/v20240522/examples.json +72 -0
- tccli/services/mariadb/mariadb_client.py +200 -50
- tccli/services/mdc/mdc_client.py +72 -18
- tccli/services/mdl/mdl_client.py +132 -33
- tccli/services/mdl/v20200326/api.json +186 -12
- tccli/services/mdl/v20200326/examples.json +16 -16
- tccli/services/mdp/mdp_client.py +680 -70
- tccli/services/mdp/v20200527/api.json +748 -23
- tccli/services/mdp/v20200527/examples.json +143 -79
- tccli/services/message/__init__.py +4 -0
- tccli/services/message/message_client.py +210 -0
- tccli/services/message/v20181225/api.json +72 -0
- tccli/services/message/v20181225/examples.json +13 -0
- tccli/services/mongodb/mongodb_client.py +340 -29
- tccli/services/mongodb/v20190725/api.json +811 -226
- tccli/services/mongodb/v20190725/examples.json +54 -22
- tccli/services/monitor/monitor_client.py +864 -152
- tccli/services/monitor/v20180724/api.json +657 -8
- tccli/services/monitor/v20180724/examples.json +152 -4
- tccli/services/mps/mps_client.py +592 -92
- tccli/services/mps/v20190612/api.json +2931 -399
- tccli/services/mps/v20190612/examples.json +64 -14
- tccli/services/msp/msp_client.py +28 -7
- tccli/services/ocr/ocr_client.py +212 -45
- tccli/services/ocr/v20181119/api.json +872 -112
- tccli/services/ocr/v20181119/examples.json +12 -4
- tccli/services/omics/omics_client.py +80 -20
- tccli/services/organization/organization_client.py +464 -116
- tccli/services/postgres/postgres_client.py +364 -91
- tccli/services/postgres/v20170312/api.json +134 -109
- tccli/services/postgres/v20170312/examples.json +14 -14
- tccli/services/privatedns/privatedns_client.py +124 -31
- tccli/services/pts/pts_client.py +192 -48
- tccli/services/quota/__init__.py +4 -0
- tccli/services/quota/quota_client.py +434 -0
- tccli/services/quota/v20241204/api.json +548 -0
- tccli/services/quota/v20241204/examples.json +51 -0
- tccli/services/rce/rce_client.py +4 -1
- tccli/services/redis/redis_client.py +592 -106
- tccli/services/redis/v20180412/api.json +636 -240
- tccli/services/redis/v20180412/examples.json +98 -56
- tccli/services/region/region_client.py +12 -3
- tccli/services/rum/rum_client.py +240 -60
- tccli/services/scf/scf_client.py +168 -42
- tccli/services/ses/ses_client.py +116 -29
- tccli/services/sms/sms_client.py +72 -18
- tccli/services/sqlserver/sqlserver_client.py +3772 -387
- tccli/services/sqlserver/v20180328/api.json +9760 -3380
- tccli/services/sqlserver/v20180328/examples.json +478 -18
- tccli/services/ssl/ssl_client.py +152 -38
- tccli/services/ssm/ssm_client.py +96 -24
- tccli/services/sts/sts_client.py +20 -5
- tccli/services/tag/tag_client.py +120 -30
- tccli/services/tat/tat_client.py +76 -19
- tccli/services/tbaas/tbaas_client.py +16 -4
- tccli/services/tcaplusdb/tcaplusdb_client.py +208 -52
- tccli/services/tcaplusdb/v20190823/api.json +836 -760
- tccli/services/tcaplusdb/v20190823/examples.json +3 -3
- tccli/services/tchd/tchd_client.py +4 -1
- tccli/services/tcmpp/tcmpp_client.py +416 -104
- tccli/services/tcr/tcr_client.py +304 -76
- tccli/services/tcsas/tcsas_client.py +236 -59
- tccli/services/tcsas/v20250106/api.json +155 -79
- tccli/services/tcsas/v20250106/examples.json +3 -3
- tccli/services/tcss/tcss_client.py +1320 -330
- tccli/services/tdid/tdid_client.py +192 -48
- tccli/services/tdmq/tdmq_client.py +376 -94
- tccli/services/tem/tem_client.py +224 -56
- tccli/services/teo/teo_client.py +1127 -245
- tccli/services/teo/v20220901/api.json +382 -58
- tccli/services/teo/v20220901/examples.json +24 -0
- tccli/services/tione/__init__.py +4 -0
- tccli/services/tione/tione_client.py +210 -0
- tccli/services/tione/v20211111/api.json +3074 -0
- tccli/services/tione/v20211111/examples.json +12 -0
- tccli/services/tiw/tiw_client.py +204 -51
- tccli/services/tke/tke_client.py +552 -138
- tccli/services/tms/tms_client.py +4 -1
- tccli/services/tmt/tmt_client.py +4 -1
- tccli/services/trabbit/trabbit_client.py +116 -29
- tccli/services/trro/trro_client.py +76 -19
- tccli/services/trtc/trtc_client.py +420 -55
- tccli/services/trtc/v20190722/api.json +685 -23
- tccli/services/trtc/v20190722/examples.json +39 -7
- tccli/services/tts/tts_client.py +4 -1
- tccli/services/vclm/vclm_client.py +8 -2
- tccli/services/vm/vm_client.py +16 -4
- tccli/services/vod/v20180717/examples.json +1 -1
- tccli/services/vod/vod_client.py +716 -179
- tccli/services/vpc/v20170312/api.json +970 -75
- tccli/services/vpc/v20170312/examples.json +106 -10
- tccli/services/vpc/vpc_client.py +1876 -361
- tccli/services/waf/v20180125/api.json +1372 -194
- tccli/services/waf/v20180125/examples.json +89 -1
- tccli/services/waf/waf_client.py +1051 -147
- tccli/services/wedata/v20250806/api.json +13644 -0
- tccli/services/wedata/v20250806/examples.json +621 -0
- tccli/services/wedata/wedata_client.py +5830 -1026
- tccli/services/yunjing/yunjing_client.py +284 -71
- {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/METADATA +4 -7
- {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/RECORD +214 -192
- {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/WHEEL +1 -1
- {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/entry_points.txt +0 -1
- {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/LICENSE +0 -0
- {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/top_level.txt +0 -0
|
@@ -58,10 +58,118 @@
|
|
|
58
58
|
],
|
|
59
59
|
"CreateExporterIntegration": [
|
|
60
60
|
{
|
|
61
|
-
"document": " ",
|
|
62
|
-
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"
|
|
63
|
-
"output": "{\n \"Response\": {\n \"Names\": [\n \"
|
|
64
|
-
"title": "Creating an
|
|
61
|
+
"document": "The parameter descriptions are as follows:<br> 1. The InstanceId parameter is the Prometheus Instance ID and is required.<br> 2. The Kind parameter is fixed as `emr-exporter` and is required.<br> 3. The parameter format of Content is as shown in the example. The details are as follows:<br> 3.1. kind is the integration type, required and fixed as `emr-exporter` here<br> 3.2. spec.job is the scrape configuration, required in yaml format. For details, see the EMR integration documentation (https://www.tencentcloud.com/document/product/248/65343)",
|
|
62
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"emr-exporter\",\n \"Content\": \"{\\\"kind\\\":\\\"emr-exporter\\\",\\\"spec\\\":{\\\"job\\\":\\\"job_name: emr-example-job\\\\nmetrics_path: /metrics\\\\nemr_sd_configs:\\\\n- region: ap-guangzhou\\\\n instance_ids: \\\\n - emr-test\\\\nrelabel_configs:\\\\n- regex: __meta_emr_(.*)\\\\n replacement: $1\\\\n action: labelmap\\\"}}\"\n}",
|
|
63
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"emr-example-job\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
64
|
+
"title": "Creating an EMR Integration"
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"document": "The parameter descriptions are as follows:<br> 1. The InstanceId parameter is the Prometheus Instance ID and is required.<br> 2. The Kind parameter is fixed as `cdwch-exporter` and is required.<br> 3. The parameter format of Content is as shown in the example. The details are as follows:<br> 3.1. kind is the integration type, required and fixed as `cdwch-exporter` here<br> 3.2. spec.job is the scrape configuration, required in yaml format. It is recommended to refer to the reference input example and only modify the job_name and instance_ids.",
|
|
68
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"cdwch-exporter\",\n \"Content\": \"{\\\"kind\\\":\\\"cdwch-exporter\\\",\\\"spec\\\":{\\\"job\\\":\\\"job_name: cdwch-example-job\\\\nmetrics_path: /metrics\\\\ncdwch_sd_configs:\\\\n- region: ap-guangzhou\\\\n instance_ids: \\\\n - cdwch-test\\\\nrelabel_configs:\\\\n- regex: __meta_cdwch_(.*)\\\\n replacement: $1\\\\n action: labelmap\\\"}}\"\n}",
|
|
69
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"cdwch-example-job\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
70
|
+
"title": "Creating a Cdwch Integration"
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"document": " Install a no-auth agent to access the Prometheus native API over the private network without authentication.<br> Once created, you can call the DescribeExporterIntegrations API to obtain the integrated private IP:Port address through the InstanceDesc parameter. This address can replace the Prometheus instance address to achieve authentication-free access.<br> The parameter descriptions are as follows:<br> 1. The InstanceId parameter is the Prometheus Instance ID and is required.<br> 2. The Kind parameter is fixed as `raw-job` and is required.<br> 3. The parameter format of Content is as shown in the example. The details are as follows:<br> 3.1. kind is the integration type, required and fixed as `raw-job` here<br> 3.2. spec.job is the scrape configuration, required in yaml format. For details, see the documentation (https://www.tencentcloud.com/document/product/248/62393#native-job-configuration)",
|
|
74
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"raw-job\",\n \"Content\": \"{\\\"kind\\\":\\\"raw-job\\\",\\\"spec\\\":{\\\"job\\\":\\\"job_name: test-job\\\\nscrape_interval: 30s\\\\nstatic_configs:\\\\n- targets:\\\\n - 127.0.0.1:9090\\\"}}\"\n}",
|
|
75
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"test-job\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
76
|
+
"title": "Creating a Scrape Job"
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"document": "The parameter descriptions are as follows:<br> 1. The InstanceId parameter is the Prometheus Instance ID and is required.<br> 2. The Kind parameter is fixed as `kafka-exporter` and is required.<br> 3. The parameter format of Content is as shown in the example. The details are as follows:<br> 3.1. name is the integration name, required and globally unique, and must match the regex `^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`<br> 3.2. kind is the integration type, required and fixed as `kafka-exporter`<br> 3.3. spec.instanceSpec.servers is the address of the Kafka instance, required. You can fill in more than one. We recommend one instance per integration.<br> 3.4. spec.instanceSpec.version is the Kafka instance version, which is optional. An error will be reported if not filled in for some versions, such as 0.10.2.0.<br> 3.5. spec.instanceSpec.labels is used to add custom tags to metrics, in key-value pair format, optional<br> 3.6. spec.exporterSpec.topicFilter is used for filtering topics. It is optional and collects all by default. After filling in a regular expression, only eligible topics are collected.<br> 3.7. spec.exporterSpec.groupFilter is used for filtering groups. It is optional and defaults to collecting all. After filling in regular expression, only eligible groups will be collected.",
|
|
80
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"kafka-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"kafka-test\\\",\\\"kind\\\":\\\"kafka-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"servers\\\":[\\\"127.0.0.1:8080\\\"],\\\"version\\\":\\\"0.10.2.0\\\",\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}},\\\"exporterSpec\\\":{\\\"topicFilter\\\":\\\"topic.*\\\",\\\"groupFilter\\\":\\\"group.*\\\"}}}\"\n}",
|
|
81
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"kafka-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
82
|
+
"title": "Creating a Kafka Integration"
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"document": "The parameter descriptions are as follows:<br> 1. The InstanceId parameter is the Prometheus Instance ID and is required.<br> 2. The Kind parameter is fixed as `mysql-exporter` and is required.<br> 3. The parameter format of Content is as shown in the example. The details are as follows:<br> 3.1. name is the integration name, required and globally unique, and must match the regex `^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`<br> 3.2. kind is the integration type, required and fixed as `mysql-exporter`<br> 3.3. spec.instanceSpec.user is the username of the MySQL instance, required.<br> 3.4. spec.instanceSpec.password is the password for the MySQL instance, required<br> 3.5. spec.instanceSpec.address is the connection address of the MySQL instance, required<br> 3.6. spec.instanceSpec.labels is used to add custom tags to metrics, with key-value pair type, optional",
|
|
86
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"mysql-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"mysql-test\\\",\\\"kind\\\":\\\"mysql-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"user\\\":\\\"root\\\",\\\"password\\\":\\\"password\\\",\\\"address\\\":\\\"127.0.0.1:8080\\\",\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}}}}\"\n}",
|
|
87
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"mysql-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
88
|
+
"title": "Creating a MySQL Integration"
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
"document": " The parameter descriptions are as follows:<br> 1. The InstanceId parameter is the Prometheus Instance ID and is required.<br> 2. The Kind parameter is fixed as `redis-exporter` and is required.<br> 3. The parameter format of Content is as shown in the example. The details are as follows:<br> 3.1. name is the integration name, required and globally unique, and must match the regex `^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`<br> 3.2. kind is the integration type, required and fixed as `redis-exporter`<br> 3.3. spec.instanceSpec.address is the connection address of the Redis instance, required.<br> 3.4. spec.instanceSpec.password is the password for the Redis instance, required<br> 3.5. spec.instanceSpec.labels Used to add custom tags to metrics, key-value pair type, optional",
|
|
92
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"redis-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"redis-test\\\",\\\"kind\\\":\\\"redis-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"address\\\":\\\"127.0.0.1:8080\\\",\\\"password\\\":\\\"password\\\",\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}}}}\"\n}",
|
|
93
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"redis-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
94
|
+
"title": "Creating a Redis Integration"
|
|
95
|
+
},
|
|
96
|
+
{
|
|
97
|
+
"document": "The parameter descriptions are as follows:<br> 1. The InstanceId parameter is the Prometheus Instance ID and is required.<br> 2. The Kind parameter is fixed as `consul-exporter` and is required.<br> 3. The parameter format of Content is as shown in the example. The details are as follows:<br> 3.1. name is the integration name, required and globally unique, and must match the regex `^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`<br> 3.2. kind is the integration type, required and fixed as `consul-exporter`<br> 3.3. spec.instanceSpec.server is the address of the Consul instance, required.<br> 3.4. spec.instanceSpec.labels Use custom tags for metrics, key-value pair type, optional",
|
|
98
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"consul-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"consul-test\\\",\\\"kind\\\":\\\"consul-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"server\\\":\\\"1.1.1.1:8080\\\",\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}}}}\"\n}",
|
|
99
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"consul-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
100
|
+
"title": "Creating a Consul Integration"
|
|
101
|
+
},
|
|
102
|
+
{
|
|
103
|
+
"document": " The parameter descriptions are as follows:<br> 1. The InstanceId parameter is the Prometheus Instance ID and is required.<br> 2. The Kind parameter is fixed as `mongodb-exporter` and is required.<br> 3. The parameter format of Content is as shown in the example. The details are as follows:<br> 3.1. name is the integration name, required and globally unique, and must match the regex `^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`<br> 3.2. kind is the integration type, required and fixed as `mongodb-exporter`<br> 3.3. spec.instanceSpec.user is the username of the MongoDB instance, required<br> 3.4. spec.instanceSpec.password is the password of the MongoDB instance, required<br> 3.5. spec.instanceSpec.servers is the connection address of the MongoDB instance, required, you can fill in more than one, separate with commas<br> 3.6. spec.instanceSpec.labels is used to add custom tags to metrics, with key-value pair type, optional<br> 3.7. spec.exporterSpec.collectors is the collection configuration of the exporter, fillable, an array of strings. This example shows you how to fill in all values. Among them, `database` means enabling the collection of database metrics, `collection` means enabling the collection of collection metrics, `topmetrics` means enabling the collection of header metric information, `indexusage` means enabling the collection of index usage statistics, `connpoolstats` means enabling the collection of connection pool statistics.",
|
|
104
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"mongodb-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"mongodb-test\\\",\\\"kind\\\":\\\"mongodb-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"user\\\":\\\"root\\\",\\\"password\\\":\\\"password\\\",\\\"servers\\\":[\\\"127.0.0.1:8080\\\",\\\"127.0.0.2:8080\\\"],\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}},\\\"exporterSpec\\\":{\\\"collectors\\\":[\\\"database\\\",\\\"collection\\\",\\\"topmetrics\\\",\\\"indexusage\\\",\\\"connpoolstats\\\"]}}}\"\n}",
|
|
105
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"mongodb-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
106
|
+
"title": "Creating MongoDB Integration"
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
"document": "The parameter descriptions are as follows: <br> 1. The InstanceId parameter is the Prometheus Instance ID and is required. <br> 2. The Kind parameter is fixed as `rocketmq-exporter` and is required. <br> 3. The parameter format of Content is as shown in the example. The details are as follows: <br> 3.1. name is the integration name, required and globally unique, and must match the regex `^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$` <br> 3.2. kind is the integration type, required and fixed as `rocketmq-exporter` here <br> 3.3. spec.instanceSpec.address is the address of the RocketMQ instance, required. You can fill in more than one, separate them with a semicolon. <br> 3.4. spec.instanceSpec.version is the version of the RocketMQ instance, required, such as V4_9_4 <br> 3.5. spec.instanceSpec.labels Used to add custom tags to metrics, key-value pair type, optional<br>",
|
|
110
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"rocketmq-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"rocketmq-test\\\",\\\"kind\\\":\\\"rocketmq-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"address\\\":\\\"127.0.0.1:8080;127.0.0.2:8080\\\",\\\"version\\\":\\\"V4_9_4\\\",\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}}}}\"\n}",
|
|
111
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"rocketmq-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
112
|
+
"title": "Creating a RocketMQ Integration"
|
|
113
|
+
},
|
|
114
|
+
{
|
|
115
|
+
"document": "Installing the Graphite Exporter enables the conversion of Graphite metrics into Prometheus metrics.<br> After creation, you can call the DescribeExporterIntegrations API to get the private IP address:Port of the integration through the InstanceDesc parameter.<br> The parameter descriptions are as follows: <br> 1. The InstanceId parameter is the Prometheus Instance ID and is required. <br> 2. The Kind parameter is fixed as `graphite-exporter` and is required. <br> 3. The parameter format of Content is as shown in the example. The details are as follows: <br> 3.1. name is the integration name, required and globally unique, and must match the regex `^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`<br> 3.2. kind is the integration type, required and fixed as `graphite-exporter`<br> 3.3. spec.instanceSpec.isStrictMatch indicates whether to perform strict matching with mappingConfig. This field is optional and defaults to false.<br> 3.4. spec.instanceSpec.mappingConfig is the mapping configuration, which can define the name and label of Prometheus metrics. For details, see the official documentation (https://github.com/prometheus/graphite_exporter#yaml-config)",
|
|
116
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"graphite-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"graphite-test\\\",\\\"kind\\\":\\\"graphite-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"isStrictMatch\\\":true,\\\"mappingConfig\\\":\\\"mappings:\\\\n- match: test.dispatcher.*.*.*\\\\n name: dispatcher_events_total\\\\n labels:\\\\n action: $2\\\\n job: test_dispatcher\\\\n outcome: $3\\\\n processor: $1\\\\n- match: \\\\\\\"*.signup.*.*\\\\\\\"\\\\n name: signup_events_total\\\\n labels:\\\\n job: ${1}_server\\\\n outcome: $3\\\\n provider: $2\\\\n- match: \\\\\\\"servers.(.*).networking.subnetworks.transmissions.([a-z0-9-]+).(.*)\\\\\\\"\\\\n match_type: regex\\\\n name: \\\\\\\"servers_networking_transmissions_${3}\\\\\\\"\\\\n labels: \\\\n hostname: ${1}\\\\n device: ${2}\\\"}}}\"\n}",
|
|
117
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"graphite-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
118
|
+
"title": "Creating a Graphite Integration"
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
"document": "The parameter descriptions are as follows: <br> 1. The InstanceId parameter is the Prometheus Instance ID and is required. <br> 2. The Kind parameter is fixed as `qcloud-exporter` and is required. <br> 3. The parameter format of Content is as shown in the example. The details are as follows: <br> 3.1. name is the integration name, required and globally unique, and must match the regex `^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`<br> 3.2. kind is the integration type, required and fixed as `qcloud-exporter`<br> 3.3. spec.instanceSpec.region indicates the region where the cloud product is located. This parameter is required. For example, to collect Cloud products in the Guangzhou region, you can set to `Guangzhou` or `ap-guangzhou`. The parameter will be converted to the label of the object, named `instance-region`.<br> 3.4. spec.instanceSpec.delaySeconds indicates data collection delay, an integer in seconds (optional, default is 0). When the value is 0, the timestamp of the original data point will be ignored and replaced with the time when the data point is pulled during integration. When the value is greater than 0, the data point will retain its original timestamp, and the data will inevitably be delayed by the set time.<br> 3.5. spec.instanceSpec.reload_interval_minutes indicates the instance refresh interval, an integer in minutes, required and must be greater than or equal to 10. New additions of cloud product instances or modifications to cloud tags will be reflected in metrics after instance refresh, with up to one instance refresh interval to wait.<br> 3.6. spec.instanceSpec.useRole indicates whether to use a service role. It is a boolean type and required. The current logic always uses a service role, so it must be set to `true`.<br> 3.7. spec.instanceSpec.labels is used to add custom tags to metrics, with key-value pair type, optional<br> 3.8. spec.exporterSpec.[Cloud Product] indicates whether to collect the corresponding cloud service. Boolean type, `true` means collecting this cloud service. Cloud service codes and their meanings: `cvm`: Cloud Virtual Machine, `cbs`: Cloud Block Storage, `lb_public`: Cloud Load Balancer (public network), `lb_private`: Cloud Load Balancer (private network), `tgw_set`: Cloud Load Balancer (exclusive cluster), `cmongo`: MongoDB Database, `cdb`: MySQL Database (CDB), `redis`: Redis Database (CKV edition), `redis_mem`: Redis Database (in-memory edition), `tendis`: Tendis, `xstor`: CTSDB (InfluxDB edition), `mariadb`: MariaDB Database, `postgres`: PostgreSQL Database, `tdmysql`: TDSQL MySQL edition, `cynosdb_mysql`: TDSQL-C MySQL, `sqlserver`: SQL Server Database, `nat_gateway`: NAT Gateway, `ckafka`: CKafka, `rocketmq`: RocketMQ (new metric), `lb`: Elastic IP, `vpngw`: VPN Gateway, `vpnx`: VPN Tunnel, `vpc_net_detect`: Network Probe, `cdn`: CDN, `ov_cdn`: CDN (overseas), `cos`: COS, `dc`: Direct Connect - Physical Connection, `dcx`: Direct Connect - Dedicated Tunnel, `dcg`: Direct Connect - Direct Connect Gateway, `lighthouse`: Tencent Cloud Lighthouse, `nacos`: Nacos, `zookeeper`: Zookeeper, `ces`: Elasticsearch, `dts`: Data Transfer Service, `vbc`: Cloud Connect Network, `gaap`: Global Application Acceleration Platform, `waf`: Web Application Firewall, `cfs`: Cloud File Storage, `bwp`: Bandwidth Package, `scf_v2`: Serverless Cloud Function (alias), `vod`: Video on Demand (VOD), `cls`: Cloud Log Service (CLS) - Log Topic, `apigateway`: API Gateway, `ti_traintask`: TI-ONE (task-based modeling), `ti_notebook`: TI-ONE (Notebook), `ti_model`: TI-ONE (online service), `self`: Collector self-monitoring.<br> 3.9. spec.scrapeSpec.relabelConfigs is used to add the `metric_relabel_configs` configuration, which is optional. See the configuration example (https://www.tencentcloud.com/document/product/248/63002#29fe272b-ac9e-4932-b6dc-972c2b1ef9dc).",
|
|
122
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"qcloud-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"test-qcloud\\\",\\\"kind\\\":\\\"qcloud-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"region\\\":\\\"Guangzhou\\\",\\\"delaySeconds\\\":0,\\\"reload_interval_minutes\\\":10,\\\"useRole\\\":true,\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}},\\\"exporterSpec\\\":{\\\"cvm\\\":true,\\\"cbs\\\":true},\\\"scrapeSpec\\\":{\\\"relabelConfigs\\\":\\\"metric_relabel_configs:\\\\n- action: labeldrop\\\\n regex: tmp_test_label\\\\n\\\"}}}\"\n}",
|
|
123
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"test-qcloud\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
124
|
+
"title": "Creating Cloud Monitoring Integration"
|
|
125
|
+
},
|
|
126
|
+
{
|
|
127
|
+
"document": "The parameter descriptions are as follows: <br> 1. The InstanceId parameter is the Prometheus Instance ID and is required. <br> 2. The Kind parameter is fixed as `memcached-exporter` and is required. <br> 3. The parameter format of Content is as shown in the example. The details are as follows: <br> 3.1. name is the integration name, required and globally unique, and must match the regex `^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`<br> 3.2. kind is the integration type, required and fixed as `memcached-exporter`<br> 3.3. spec.instanceSpec.address is the domain name or IP address of the Memcached instance, required.<br> 3.4. spec.instanceSpec.labels Use custom tags for metrics, key-value pair type, optional<br>",
|
|
128
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"memcached-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"memcached-test\\\",\\\"kind\\\":\\\"memcached-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"address\\\":\\\"127.0.0.1:8080\\\",\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}}}}\"\n}",
|
|
129
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"memcached-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
130
|
+
"title": "Creating a Memcached Integration"
|
|
131
|
+
},
|
|
132
|
+
{
|
|
133
|
+
"document": "The parameter descriptions are as follows: <br> 1. The InstanceId parameter is the Prometheus Instance ID and is required. <br> 2. The Kind parameter is fixed as `postgres-exporter` and is required. <br> 3. The parameter format of Content is as shown in the example. The details are as follows: <br> 3.1. name is the integration name, required and globally unique, and must match the regex `^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`<br> 3.2. kind is the integration type, required and fixed as `postgres-exporter`<br> 3.3. spec.instanceSpec.user is the username of the PostgreSQL instance, required<br> 3.4. spec.instanceSpec.password is the password of the PostgreSQL instance, required<br> 3.5. spec.instanceSpec.address is the connection address of the PostgreSQL instance, required<br> 3.6. spec.instanceSpec.labels is used to add custom tags to metrics, with key-value pair type, optional<br>",
|
|
134
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"postgres-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"postgresql-test\\\",\\\"kind\\\":\\\"postgres-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"user\\\":\\\"user\\\",\\\"password\\\":\\\"password\\\",\\\"address\\\":\\\"127.0.0.1:8080\\\",\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}}}}\"\n}",
|
|
135
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"postgresql-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
136
|
+
"title": "Creating PostgreSQL Integration"
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
"document": "The parameter descriptions are as follows: <br> 1. The InstanceId parameter is the Prometheus Instance ID and is required. <br> 2. The Kind parameter is fixed as `blackbox-exporter` and is required. <br> 3. The parameter format of Content is as shown in the example. The details are as follows: <br> 3.1. name is the integration name, required and globally unique, and must match the regex `^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`<br> 3.2. kind is the integration type, required and fixed as `blackbox-exporter`<br> 3.3. spec.instanceSpec.module is the detection method, required. Optional values: `http_get`, `http_post`, `tcp`, `ssh`, `ping`.<br> 3.4. spec.instanceSpec.urls is the detection target, a string array, required. The target format can be host:port, http://abc, or https://abc.<br> 3.5. spec.instanceSpec.noAllowRedirect controls whether to forbid redirection. It is a boolean type, optional, and only applicable to the detection methods `http_get` and `http_post`. If true, it means redirection is forbidden. You can leave it blank, and it defaults to false.<br> 3.6. spec.instanceSpec.insecureSkipVerify controls whether to disable target certificate authentication. It is a boolean type and optional, only applicable to the detection methods `http_get` and `http_post`. true indicates that it is disabled. You can leave it blank, and it defaults to false.<br> 3.7. spec.instanceSpec.headers adds headers when probing the target. It uses key-value pairs, is optional, and only applicable to the `http_get` and `http_post` detection methods.<br> 3.8. spec.instanceSpec.labels is used to add custom tags to metrics, key-value pair type, optional<br> 3.9. spec.scrapeSpec.interval is used for custom check interval, optional, 15s is selected by default<br>",
|
|
140
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"blackbox-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"test-blackbox\\\",\\\"kind\\\":\\\"blackbox-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"module\\\":\\\"http_get\\\",\\\"urls\\\":[\\\"host:port\\\",\\\"http://abc\\\",\\\"https://abc\\\"],\\\"noAllowRedirect\\\":false,\\\"insecureSkipVerify\\\":true,\\\"headers\\\":{\\\"Authorization\\\":\\\"Basic <Credentials>\\\",\\\"test\\\":\\\"test\\\"},\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}},\\\"scrapeSpec\\\":{\\\"interval\\\":\\\"15s\\\"}}}\"\n}",
|
|
141
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"test-blackbox\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
142
|
+
"title": "Creating a Health Check Integration"
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
"document": "The parameter descriptions are as follows: <br> 1. The InstanceId parameter is the Prometheus Instance ID and is required. <br> 2. The Kind parameter is fixed as `es-exporter` and is required. <br> 3. The parameter format of Content is as shown in the example. The details are as follows: <br> 3.1. name is the integration name, required and globally unique, and must match the regex `^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`<br> 3.2. kind is the integration type, required and fixed as `es-exporter` here<br> 3.3. spec.instanceSpec.user is the username of ElasticSearch, required<br> 3.4. spec.instanceSpec.password is the ElasticSearch password, required<br> 3.5. spec.instanceSpec.url is the ElasticSearch connection address, required<br> 3.6. spec.instanceSpec.labels is used to add custom tags to metrics, with key-value pair type, optional<br> 3.7. spec.exporterSpec.all indicates whether to query statistical information of all nodes in a cluster. It is a boolean type, optional, and the default value is false. If false, it only queries statistical information of connected nodes.<br> 3.8. spec.exporterSpec.indices indicates whether to query index statistics for all in a cluster, boolean type, optional, default value is false<br> 3.9. spec.exporterSpec.indicesSettings indicates whether to query statistical information of all index configurations in a cluster, boolean type, optional, default value is false<br> 3.10. spec.exporterSpec.shards indicates whether to query index statistics of all in a cluster, including shard level statistical information. Boolean type, optional, default value is false.<br> 3.11. spec.exporterSpec.snapshots indicates whether to query cluster snapshot statistical information. It is a boolean type, optional, and the default value is false.<br> 3.12. spec.exporterSpec.clusterSettings indicates whether to query cluster configuration statistical information, boolean type, optional, default value is false",
|
|
146
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"es-exporter\",\n \"Content\": \"{\\\"name\\\":\\\"es-test\\\",\\\"kind\\\":\\\"es-exporter\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"user\\\":\\\"root\\\",\\\"password\\\":\\\"password\\\",\\\"url\\\":\\\"http://127.0.0.1:8080\\\",\\\"labels\\\":{\\\"labelKey\\\":\\\"labelValue\\\",\\\"test\\\":\\\"test\\\"}},\\\"exporterSpec\\\":{\\\"all\\\":true,\\\"indices\\\":true,\\\"indicesSettings\\\":true,\\\"shards\\\":true,\\\"snapshots\\\":true,\\\"clusterSettings\\\":true}}}\"\n}",
|
|
147
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"es-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
148
|
+
"title": "Creating an ElasticSearch Integration"
|
|
149
|
+
},
|
|
150
|
+
{
|
|
151
|
+
"document": "Install a no-auth agent to access the Prometheus native API over the private network without authentication.<br> Once created, you can call the DescribeExporterIntegrations API to obtain the integrated private IP:Port address through the InstanceDesc parameter. This address can replace the Prometheus instance address to achieve authentication-free access.<br> The parameter descriptions are as follows: <br> 1. The InstanceId parameter is the Prometheus Instance ID and is required. <br> 2. The Kind parameter is fixed as `auth-proxy` and is required. <br> 3. The parameter format of Content is as shown in the example. The details are as follows: <br> 3.1. name is the integration name, required and globally unique, and must match the regex `^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`<br> 3.2. kind is the integration type, required and fixed as `auth-proxy`<br> 3.3. spec.instanceSpec.enableSelfMonitor indicates whether to collect self-monitoring metrics. This field is optional and the default is false. The self-monitoring metric is auth_proxy_http_requests_total{result=~\"success|error\"}, which counts request quantity for success or failure.",
|
|
152
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"auth-proxy\",\n \"Content\": \"{\\\"name\\\":\\\"auth-test\\\",\\\"kind\\\":\\\"auth-proxy\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"enableSelfMonitor\\\":true}}}\"\n}",
|
|
153
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"auth-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
154
|
+
"title": "Creating a No-Auth Proxy Integration"
|
|
155
|
+
},
|
|
156
|
+
{
|
|
157
|
+
"document": "The parameter descriptions are as follows: <br> 1. The InstanceId parameter is the Prometheus Instance ID and is required. <br> 2. The Kind parameter is fixed as `cvm-http-sd-exporter` and is required. <br> 3. The parameter format of Content is as shown in the example. The details are as follows: <br> 3.1. kind is the integration type, required and fixed as `cvm-http-sd-exporter`<br> 3.2. spec.job is the scrape configuration, required in yaml format. For specific configuration, see the scraping configuration instructions (https://www.tencentcloud.com/document/product/248/62393#.60cvm_sd_config.60-configuration)",
|
|
158
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"cvm-http-sd-exporter\",\n \"Content\": \"{\\\"kind\\\":\\\"cvm-http-sd-exporter\\\",\\\"spec\\\":{\\\"job\\\":\\\"job_name: example-job-name\\\\nmetrics_path: /metrics\\\\ncvm_sd_configs:\\\\n- region: ap-singapore\\\\n ports:\\\\n - 9100\\\\n filters: \\\\n - name: tag:example_tag_key\\\\n values: \\\\n - example_tag_value\\\\nrelabel_configs: \\\\n- source_labels: [__meta_cvm_instance_state]\\\\n regex: RUNNING\\\\n action: keep\\\\n- regex: __meta_cvm_tag_(.*)\\\\n replacement: $1\\\\n action: labelmap\\\\n- source_labels: [__meta_cvm_region]\\\\n target_label: region\\\\n action: replace\\\"}}\"\n}",
|
|
159
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"example-job-name\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
160
|
+
"title": "Creating a CVM Scrape Job Integration"
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
"document": "To ensure the CVM instance and Prometheus instance are connected via private network (for example, under the same VPC) and the CVM instance has Tencent Cloud Automation Tools (TAT) installed (https://www.tencentcloud.com/document/product/1147/46042).<br> The parameter descriptions are as follows: <br> 1. The InstanceId parameter is the Prometheus Instance ID and is required. <br> 2. The Kind parameter is fixed as `cvm-node-exporter-sd` and is required. <br> 3. The parameter format of Content is as shown in the example. The details are as follows: <br> 3.1. kind is the integration type, required and fixed as `cvm-node-exporter-sd` here<br> 3.2. spec.job is the scrape configuration, required in yaml format. You can refer to the input example, where instance_ids can contain multiple CVM instance ids.",
|
|
164
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"Kind\": \"cvm-node-exporter-sd\",\n \"Content\": \"{\\\"kind\\\":\\\"cvm-node-exporter-sd\\\",\\\"spec\\\":{\\\"job\\\":\\\"job_name: node-test\\\\ninstance:\\\\n - region: ap-chengdu\\\\n instance_ids:\\\\n - ins-a\\\\n - ins-b\\\\n\\\"}}\"\n}",
|
|
165
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"node-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
166
|
+
"title": "Creating CVM Node Exporter Integration"
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
"document": "The parameter descriptions are as follows: <br> 1. The InstanceId parameter is the Prometheus Instance ID and is required. <br> 2. The Kind parameter is fixed as `nginx-ingress` and is required. <br> 3. ClusterId is the cluster ID associated with the Prometheus instance where Ingress NGINX Controller is deployed, required<br> 4. KubeType is the cluster type corresponding to ClusterId, required. 1 means tke cluster, 2 or 3 means eks cluster.<br> 5. The parameter format of Content is as shown in the example. The details are as follows: <br> 5.1. kind is the integration type, required and fixed as `nginx-ingress`<br> 5.2. name is the integration name, required and globally unique, must match the regex `^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`<br> 5.3. spec.instanceSpec.namespace is the namespace where Ingress NGINX Controller resides, required<br> 5.4. spec.instanceSpec.name is the name of the Ingress NGINX Controller, required. Use the name of the Deployment or DaemonSet.<br> 5.5. spec.instanceSpec.workload is the cluster object type for Ingress NGINX Controller, required, such as deployment or daemonset.<br>",
|
|
170
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateExporterIntegration\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-1\",\n \"ClusterId\": \"cls-test\",\n \"KubeType\": 1,\n \"Kind\": \"nginx-ingress\",\n \"Content\": \"{\\\"kind\\\":\\\"nginx-ingress\\\",\\\"name\\\":\\\"ingress-test\\\",\\\"spec\\\":{\\\"instanceSpec\\\":{\\\"namespace\\\":\\\"namespace\\\",\\\"name\\\":\\\"controller-name\\\",\\\"workLoad\\\":\\\"deployment\\\"}}}\"\n}",
|
|
171
|
+
"output": "{\n \"Response\": {\n \"Names\": [\n \"ingress-test\"\n ],\n \"RequestId\": \"xyz\"\n }\n}",
|
|
172
|
+
"title": "Creating Ingress NGINX Controller Integration"
|
|
65
173
|
}
|
|
66
174
|
],
|
|
67
175
|
"CreateGrafanaInstance": [
|
|
@@ -104,6 +212,14 @@
|
|
|
104
212
|
"title": "Creating a Prometheus agent"
|
|
105
213
|
}
|
|
106
214
|
],
|
|
215
|
+
"CreatePrometheusAlertGroup": [
|
|
216
|
+
{
|
|
217
|
+
"document": "This example shows you how to create an alert rule using a notification template.",
|
|
218
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreatePrometheusAlertGroup\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-7vp71mk0\",\n\"GroupName\": \"Alarm Grouping Test\"\n \"AMPReceivers\": [\n \"notice-xxxxxx\"\n ],\n \"Rules\": [\n {\n\"RuleName\": \"Rule-1\",\n \"Labels\": [\n {\n \"Key\": \"k1\",\n \"Value\": \"v1\"\n }\n ],\n \"Annotations\": [\n {\n \"Key\": \"summary\",\n \"Value\": \"{{$value}}\"\n },\n {\n \"Key\": \"describe\",\n\"Value\": \"Rule 1 Alarm\"\n }\n ],\n \"Expr\": \"expr1\"\n }\n ]\n}",
|
|
219
|
+
"output": "{\n \"Response\": {\n \"GroupId\": \"alert-2zvqof1a\",\n \"RequestId\": \"02c92b99-abc9-431b-8b08-42b9977d51cf\"\n }\n}",
|
|
220
|
+
"title": "Creating an Alert Rule Using a Notification Template"
|
|
221
|
+
}
|
|
222
|
+
],
|
|
107
223
|
"CreatePrometheusAlertPolicy": [
|
|
108
224
|
{
|
|
109
225
|
"document": "This example shows you how to create an alerting rule.",
|
|
@@ -268,6 +384,14 @@
|
|
|
268
384
|
"title": "Deleting alarm policy group"
|
|
269
385
|
}
|
|
270
386
|
],
|
|
387
|
+
"DeletePrometheusAlertGroups": [
|
|
388
|
+
{
|
|
389
|
+
"document": "This example shows you how to delete an Alert group",
|
|
390
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeletePrometheusAlertGroups\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-7vp71mk0\",\n \"GroupIds\": [\n \"alert-ol72w8vy\"\n ]\n}",
|
|
391
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"09cffdc9-047e-45c5-b0eb-6d7cbfee5048\"\n }\n}",
|
|
392
|
+
"title": "Deleting an Alert Group"
|
|
393
|
+
}
|
|
394
|
+
],
|
|
271
395
|
"DeletePrometheusAlertPolicy": [
|
|
272
396
|
{
|
|
273
397
|
"document": "This example shows you how to delete a Prometheus alerting rule.",
|
|
@@ -622,6 +746,14 @@
|
|
|
622
746
|
"title": "Listing Prometheus agents"
|
|
623
747
|
}
|
|
624
748
|
],
|
|
749
|
+
"DescribePrometheusAlertGroups": [
|
|
750
|
+
{
|
|
751
|
+
"document": "This example shows you how to list ALL alert groups under an instance, including enabled and disabled ones.",
|
|
752
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribePrometheusAlertGroups\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-xxxxxxxx\"\n}",
|
|
753
|
+
"output": "{\n \"Response\": {\n \"AlertGroupSet\": [\n {\n \"AMPReceivers\": [],\n \"CreatedAt\": \"2023-08-01T20:29:56+08:00\",\n \"CustomReceiver\": {\n \"Type\": \"\",\n \"Url\": \"\"\n },\n \"GroupId\": \"alert-xxxxxxxx\",\n\"GroupName\": \"Query Alerts Group Trial-1\"\n \"Rules\": [\n {\n \"Annotations\": [\n {\n \"Key\": \"summary\",\n \"Value\": \"{{$value}}\"\n }\n ],\n \"Duration\": \"\",\n \"Expr\": \"expr1\",\n \"Labels\": [\n {\n \"Key\": \"_interval_\",\n \"Value\": \"10m\"\n }\n ],\n\"RuleName\": \"Rule -1\",\n \"State\": 2\n }\n ],\n \"TemplateId\": \"\",\n \"UpdatedAt\": \"2023-08-01T20:29:56+08:00\"\n }\n ],\n \"RequestId\": \"bc70036f-db50-4b46-abbc-bd41eeb06f7a\",\n \"TotalCount\": 1\n }\n}",
|
|
754
|
+
"title": "List All Alert Groups under an Instance"
|
|
755
|
+
}
|
|
756
|
+
],
|
|
625
757
|
"DescribePrometheusAlertPolicy": [
|
|
626
758
|
{
|
|
627
759
|
"document": "describe prometheus instance alert policy list",
|
|
@@ -1160,6 +1292,22 @@
|
|
|
1160
1292
|
"title": "Updating the status of a Prometheus agent"
|
|
1161
1293
|
}
|
|
1162
1294
|
],
|
|
1295
|
+
"UpdatePrometheusAlertGroup": [
|
|
1296
|
+
{
|
|
1297
|
+
"document": "",
|
|
1298
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdatePrometheusAlertGroup\n<Common request parameters>\n\n{\n \"GroupId\": \"alert-34xae12s\",\n \"InstanceId\": \"prom-7vp71mk0\",\n\"GroupName\": \"Update alarm group test\"\n \"AMPReceivers\": [\n \"notice-xxxxxx\"\n ],\n \"Rules\": [\n {\n\"RuleName\": \"Rule-1\",\n \"Labels\": [\n {\n \"Key\": \"k1\",\n \"Value\": \"v1\"\n }\n ],\n \"Annotations\": [\n {\n \"Key\": \"summary\",\n \"Value\": \"{{$value}}\"\n },\n {\n \"Key\": \"describe\",\n\"Value\": \"Rule 1 Alarm\"\n }\n ],\n \"Expr\": \"expr1\"\n }\n ]\n}",
|
|
1299
|
+
"output": "{\n \"Response\": {\n \"GroupId\": \"alert-34xae12s\",\n \"RequestId\": \"02c92b99-abc9-431b-8b08-42b9977d51cf\"\n }\n}",
|
|
1300
|
+
"title": "Updating Alert Group"
|
|
1301
|
+
}
|
|
1302
|
+
],
|
|
1303
|
+
"UpdatePrometheusAlertGroupState": [
|
|
1304
|
+
{
|
|
1305
|
+
"document": "This example shows you how to disable alarm grouping in settings.",
|
|
1306
|
+
"input": "POST / HTTP/1.1\nHost: monitor.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdatePrometheusAlertGroupState\n<Common request parameters>\n\n{\n \"InstanceId\": \"prom-7vp71mk0\",\n \"GroupIds\": [\n \"alert-ol72w8vy\"\n ],\n \"GroupState\": 3\n}",
|
|
1307
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"a4797141-a4f9-43d4-b4ca-09d72bb48f8d\"\n }\n}",
|
|
1308
|
+
"title": "Setting Alarm Group Disabling"
|
|
1309
|
+
}
|
|
1310
|
+
],
|
|
1163
1311
|
"UpdatePrometheusScrapeJob": [
|
|
1164
1312
|
{
|
|
1165
1313
|
"document": " ",
|