Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to create metric collection configurations.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ModifyMetricConfig. |
| Version | Yes | String | Common Params. The value used for this API: 2020-10-16. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| TopicId | Yes | String | Metric Topic id - Get the log topic Id through Get Log Topic List. Note: BizType 0: log topic (default value), 1: metric topic. - Obtain the log topic Id through Create Log Topic. Note that BizType 0: log topic (default value), 1: metric topic. |
| ConfigId | Yes | String | Metric collection configuration ID. |
| Source | No | Integer | Collection configuration source. Support: 0, 1.-Self-built k8s - 1:TKE |
| GroupIds.N | No | Array of String | Machine group ID. |
| Operate | No | Integer | Operation status. Valid values: 0: applied; 1: paused. |
| Spec | No | MetricSpec | Collection object. This parameter is valid only when Flag is 0. |
| MetricRelabels.N | No | Array of Relabeling | Label processing. This parameter is valid only when Flag is 0. |
| MetricLabel | No | MetricConfigLabel | Custom metadata. This parameter is valid only when Flag is 0. |
| Scheme | No | String | Communication protocol. Valid values: HTTP and HTTPS. This parameter is valid only when Flag is 0. |
| ScrapeInterval | No | String | Collection frequency. This parameter is valid only when Flag=0. -Check format: ^(((\d+)y)?((\d+)w)?((\d+)d)?((\d+)h)?((\d+)m)?((\d+)s)?((\d+)ms)?|0)$-Default: 60s |
| ScrapeTimeout | No | String | Collection timeout. This parameter is valid only when Flag=0. -Check format: ^(((\d+)y)?((\d+)w)?((\d+)d)?((\d+)h)?((\d+)m)?((\d+)s)?((\d+)ms)?|0)$ |
| HonorLabels | No | Boolean | How Prometheus handles tag conflicts. This parameter is valid only when Flag=0 && Type=1 and supports true, false.- false: Rename conflicting tags in configuration data- true: Ignore server-side tag conflicts |
| YamlSpec | No | MetricYamlSpec | Collection configuration, which is a string in YAML format. It is required when Flag is 1. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to modify the configuration of a basic metric collection.
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyMetricConfig
<Common request parameters>
{
"TopicId": "d7adf66d-88a7-4321-8b4b-6f2c7a9773b8",
"ConfigId": "b8c24595-6fce-489c-8488-9d2db440fd9d",
"YamlSpec": {
"Type": "ScrapeConfig-prometheus",
"Spec": "scrape_configs:\n- job_name: cadvisor\n honor_timestamps: false\n metrics_path: /metrics\n scheme: https\n kubernetes_sd_configs:\n - role: node\n bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token\n tls_config:\n ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt\n relabel_configs:\n - source_labels: [__meta_kubernetes_node_name]\n separator: ;\n regex: (.*)\n target_label: __address__\n replacement: kubernetes.default.svc:443\n action: replace\n - source_labels: [__meta_kubernetes_node_name]\n separator: ;\n regex: (.+)\n target_label: __metrics_path__\n replacement: /api/v1/nodes/${1}/proxy/metrics/cadvisor\n action: replace\n - separator: ;\n regex: __meta_kubernetes_node_label_(.+)\n replacement: $1\n action: labelmap\n - separator: ;\n regex: eks_tke_cloud_tencent_com_(.+)\n replacement: $1\n action: labeldrop\n metric_relabel_configs:\n - source_labels: [container_name]\n separator: ;\n regex: (.+)\n target_label: container\n replacement: $1\n action: replace\n - source_labels: [pod_name]\n separator: ;\n regex: (.+)\n target_label: pod\n replacement: $1\n action: replace\n - source_labels: [container]\n separator: ;\n regex: (.*)\n replacement: $1\n action: keep\n---\nscrape_configs:\n- job_name: kube-state-metric\n honor_timestamps: true\n metrics_path: /metrics\n scheme: http\n kubernetes_sd_configs:\n - role: endpoints\n namespaces:\n names:\n - kube-system\n selectors:\n - label: \"app.kubernetes.io/name==kube-state-metrics\"\n role: endpoints\n bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token\n tls_config:\n insecure_skip_verify: true\n metric_relabel_configs:\n - source_labels: [__name__, resource, unit]\n separator: ;\n regex: kube_pod_container_resource_requests;cpu;core\n target_label: __name__\n replacement: kube_pod_container_resource_requests_cpu_cores\n action: replace\n - source_labels: [__name__, resource, unit]\n separator: ;\n regex: kube_pod_container_resource_limits;cpu;core\n target_label: __name__\n replacement: kube_pod_container_resource_limits_cpu_cores\n action: replace\n - source_labels: [__name__, resource, unit]\n separator: ;\n regex: kube_pod_container_resource_requests;memory;byte\n target_label: __name__\n replacement: kube_pod_container_resource_requests_memory_bytes\n action: replace\n - source_labels: [__name__, resource, unit]\n separator: ;\n regex: kube_pod_container_resource_limits;memory;byte\n target_label: __name__\n replacement: kube_pod_container_resource_limits_memory_bytes\n action: replace\n - source_labels: [__name__, resource, unit]\n separator: ;\n regex: kube_node_status_capacity;cpu;core\n target_label: __name__\n replacement: kube_node_status_capacity_cpu_cores\n action: replace\n - source_labels: [__name__, resource, unit]\n separator: ;\n regex: kube_node_status_capacity;memory;byte\n target_label: __name__\n replacement: kube_node_status_capacity_memory_bytes\n action: replace\n - source_labels: [__name__, resource, unit]\n separator: ;\n regex: kube_node_status_allocatable;cpu;core\n target_label: __name__\n replacement: kube_node_status_allocatable_cpu_cores\n action: replace\n - source_labels: [__name__, resource, unit]\n separator: ;\n regex: kube_node_status_allocatable;memory;byte\n target_label: __name__\n replacement: kube_node_status_allocatable_memory_bytes\n action: replace\n---\nscrape_configs:\n- job_name: node-exporter\n honor_timestamps: true\n metrics_path: /metrics\n scheme: http\n kubernetes_sd_configs:\n - role: endpoints\n namespaces:\n names:\n - kube-system\n selectors:\n - label: \"app.kubernetes.io/name==node-exporter\"\n role: endpoints\n bearer_token_file: /var/run/secrets/kubernetes.io/serviceaccount/token\n tls_config:\n insecure_skip_verify: true\n relabel_configs:\n - separator: ;\n action: replace\n regex: (.*)\n replacement: $1\n source_labels: [__meta_kubernetes_pod_node_name]\n target_label: instance"
}
}
{
"Response": {
"RequestId": "e163af1b-fd31-4cef-b820-cb897e4644cf"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| AuthFailure.UnauthorizedOperation | Request unauthorized. |
| FailedOperation | Operation failed. |
| FailedOperation.Timeout | Operation timed out |
| InternalError | Internal error. |
| InternalError.DbError | DB Error. |
| InternalError.IllegalRole | Illegal role. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameter.DbDuplication | The unique key of database conflicts. |
| InvalidParameter.ParamError | Parameter error. |
| InvalidParameterValue | Incorrect parameter value. |
| LimitExceeded.RecordOutOfLimit | Record exceeds limit |
| MissingParameter | Missing parameter. |
| UnauthorizedOperation | Unauthorized operation. |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation | Unsupported operation. |
文档反馈