Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to obtain metric subscription 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: DescribeTopicBaseMetricConfigs. |
| 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 log topic id. - Obtain the log topic Id through Get Log Topic List. Note that 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. |
| Filters.N | No | Array of Filter | groupId is filtered by [Bound machine group id]. Type: String. Required: No. The maximum number of Filters per request is 10, and the total upper limit for ALL Filter.Values is 100. |
| Offset | No | Integer | Page offset. Default value: 0 |
| Limit | No | Integer | Maximum number of entries per page. Default value: 20. Maximum value: 100. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number |
| Datas | Array of BaseMetricCollectConfig | List of metric collection configurations. Note: This field may return null, indicating that no valid values can be obtained. |
| 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. |
Obtaining Basic Monitoring Configuration Information for Metric Collection
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopicBaseMetricConfigs
<Common request parameters>
{
"TopicId": "d7adf66d-88a7-4321-8b4b-6f2c7a9773b8",
"Offset": 0,
"Limit": 10
}
{
"Response": {
"Datas": [
{
"Configs": [
{
"ConfigId": "6886a667-77eb-4363-ad5a-906d1481fe04",
"CreateTime": 1724244707,
"Flag": 1,
"GroupIds": [
"43948ea4-f286-4636-adfd-92aa0fc8344e"
],
"HonorLabels": false,
"Name": "node-exporter",
"Operate": 0,
"Scheme": "",
"ScrapeInterval": "",
"ScrapeTimeout": "",
"Source": 0,
"TopicIds": [
"d7adf66d-88a7-4321-8b4b-6f2c7a9773b8"
],
"Type": 0,
"UpdateTime": 1724244707,
"YamlSpec": {
"Spec": "job_name: node-exporter\nhonor_timestamps: true\ntrack_timestamps_staleness: false\nmetrics_path: /metrics\nscheme: http\nenable_compression: true\nauthorization:\n type: Bearer\n credentials_file: /var/run/secrets/kubernetes.io/serviceaccount/token\ntls_config:\n insecure_skip_verify: true\nfollow_redirects: true\nenable_http2: true\nhttp_headers: null\nrelabel_configs:\n- source_labels: [__meta_kubernetes_pod_node_name]\n separator: ;\n regex: (.*)\n target_label: instance\n replacement: $1\n action: replace\n",
"Type": "ScrapeConfig-prometheus"
}
},
{
"ConfigId": "853fd8d1-77ec-4815-8696-5e2e029fba21",
"CreateTime": 1724244707,
"Flag": 1,
"GroupIds": [
"43948ea4-f286-4636-adfd-92aa0fc8344e"
],
"HonorLabels": false,
"Name": "kube-state-metric",
"Operate": 0,
"Scheme": "",
"ScrapeInterval": "",
"ScrapeTimeout": "",
"Source": 0,
"TopicIds": [
"d7adf66d-88a7-4321-8b4b-6f2c7a9773b8"
],
"Type": 0,
"UpdateTime": 1724244707,
"YamlSpec": {
"Spec": "job_name: kube-state-metric\nhonor_timestamps: true\ntrack_timestamps_staleness: false\nmetrics_path: /metrics\nscheme: http\nenable_compression: true\nauthorization:\n type: Bearer\n credentials_file: /var/run/secrets/kubernetes.io/serviceaccount/token\ntls_config:\n insecure_skip_verify: true\nfollow_redirects: true\nenable_http2: true\nhttp_headers: null\nmetric_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",
"Type": "ScrapeConfig-prometheus"
}
},
{
"ConfigId": "1bac0b5b-7bbe-4612-8831-5d445da9553d",
"CreateTime": 1724244707,
"Flag": 1,
"GroupIds": [
"43948ea4-f286-4636-adfd-92aa0fc8344e"
],
"HonorLabels": false,
"Name": "cadvisor",
"Operate": 0,
"Scheme": "",
"ScrapeInterval": "",
"ScrapeTimeout": "",
"Source": 0,
"TopicIds": [
"d7adf66d-88a7-4321-8b4b-6f2c7a9773b8"
],
"Type": 0,
"UpdateTime": 1724244707,
"YamlSpec": {
"Spec": "job_name: cadvisor\nhonor_timestamps: false\ntrack_timestamps_staleness: false\nmetrics_path: /metrics\nscheme: https\nenable_compression: true\nauthorization:\n type: Bearer\n credentials_file: /var/run/secrets/kubernetes.io/serviceaccount/token\ntls_config:\n ca_file: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt\n insecure_skip_verify: false\nfollow_redirects: true\nenable_http2: true\nhttp_headers: null\nrelabel_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\nmetric_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",
"Type": "ScrapeConfig-prometheus"
}
}
],
"GroupId": "43948ea4-f286-4636-adfd-92aa0fc8344e"
}
],
"RequestId": "c8db920f-a681-44a6-a22b-c8d5d40a09fe",
"TotalCount": 1
}
}
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. |
| InternalError | Internal error. |
| InternalError.DbError | DB Error. |
| InternalError.IllegalRole | Illegal role. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameter.ParamError | Parameter error. |
| InvalidParameterValue | Incorrect parameter value. |
| LimitExceeded.RecordOutOfLimit | Record exceeds limit |
| MissingParameter | Missing parameter. |
| OperationDenied.AccountNotExists | The account does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation | Unsupported operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback