Domain name for API request: monitor.tencentcloudapi.com.
This API is used to get the Prometheus configuration.
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: DescribePrometheusConfig. |
Version | Yes | String | Common Params. The value used for this API: 2018-07-24. |
Region | No | String | Common Params. This parameter is not required for this API. |
InstanceId | Yes | String | Instance ID |
ClusterId | Yes | String | Cluster ID |
ClusterType | Yes | String | Cluster type |
Parameter Name | Type | Description |
---|---|---|
Config | String | Global configuration |
ServiceMonitors | Array of PrometheusConfigItem | ServiceMonitor configuration |
PodMonitors | Array of PrometheusConfigItem | PodMonitor configuration |
RawJobs | Array of PrometheusConfigItem | Raw jobs |
Probes | Array of PrometheusConfigItem | Probes |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to pull the Prometheus configuration.
https://monitor.tencentcloudapi.com/?Action=DescribePrometheusConfig
&InstanceId=prom-xxx
&ClusterType=tke
&ClusterId=cls-xxx
&<Common request parameters>
{
"Response": {
"RequestId": "eac6b301-a322-493a-8e36-83b295459397",
"Config": "xdfdfd",
"ServiceMonitors": [
{
"Name": "sm1",
"Config": "dfd"
}
],
"PodMonitors": [
{
"Name": "pm1",
"Config": "fdfd"
}
],
"RawJobs": [
{
"Name": "job1",
"Config": "fd"
}
],
"Probes": [
{
"Name": "job1",
"Config": "fd"
}
]
}
}
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.ComponentClientHttp | FailedOperation.ComponentClientHttp |
FailedOperation.ComponentClientUnpack | FailedOperation.ComponentClientUnpack |
FailedOperation.Db | FailedOperation.Db |
FailedOperation.DoTRPCTransferFailed | DoTRPCTransferFailed |
FailedOperation.KubeClientConf | FailedOperation.KubeClientConf |
FailedOperation.KubeCommon | FailedOperation.KubeCommon |
InternalError | Internal error. |
InternalError.Db | InternalError.Db |
InternalError.DbRecordNotFound | InternalError.DbRecordNotFound |
InternalError.Param | InternalError.Param |
InternalError.UnexpectedInternal | InternalError.UnexpectedInternal |
InvalidParameter.ClusterNotFound | InvalidParameter.ClusterNotFound |
InvalidParameter.Param | InvalidParameter.Param |
InvalidParameter.PromClusterNotFound | InvalidParameter.PromClusterNotFound |
InvalidParameter.PromInstanceNotFound | InvalidParameter.PromInstanceNotFound |
Was this page helpful?