Domain name for API request: monitor.tencentcloudapi.com.
This API is used to create a Prometheus scrape configuration in TKE.
Note: The prerequisite is that the corresponding TKE service has been integrated through the Prometheus console.
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: CreateServiceDiscovery. |
Version | Yes | String | Common Params. The value used for this API: 2018-07-24. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley. |
InstanceId | Yes | String | Prometheus instance ID |
KubeClusterId | Yes | String | |
KubeType | Yes | Integer | Kubernetes cluster type: |
Type | Yes | Integer | Scrape configuration type. Valid values: |
Yaml | Yes | String | Scrape configuration information |
Parameter Name | Type | Description |
---|---|---|
ServiceDiscovery | ServiceDiscoveryItem | The scrape configuration information returned after successful creation |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://monitor.tencentcloudapi.com/?Action=CreateServiceDiscovery
&InstanceId=prom-sdfk2342a
&KubeClusterId=cls-pwerf3k3
&KubeType=1
&Type=1
&Yaml=yaml
&<Common request parameters>
{
"Response": {
"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\":\"\"}}]"
},
"RequestId": "nrtlca1qmunlpf51noe13qp5vyvg7mq5"
}
}
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 |
---|---|
FailedOperation | Operation failed. |
FailedOperation.AccessSTSFail | Failed to access STS. |
FailedOperation.AccessTKEFail | Failed to access the TKE cluster. |
FailedOperation.AgentVersionNotSupported | The agent version does not support this operation. Upgrade the agent. |
FailedOperation.BadYamlFormat | The YAML format is incorrect. |
FailedOperation.ResourceNotFound | The resource does not exist. |
FailedOperation.TKEClientAuthFail | There is no access to TKE. |
FailedOperation.TKEEndpointStatusError | The TKE endpoint is inaccessible. |
FailedOperation.TKEResourceConflict | A conflict occurred while updating the TKE resource. |
InternalError | Internal error. |
InvalidParameter | Invalid parameter. |
Was this page helpful?