DescribePrometheusRecordRules

Last updated: 2023-04-27 11:11:31

1. API Description

Domain name for API request: monitor.tencentcloudapi.com.

This API is used to get the list of recording rules, including those created by CRD resources in the associated cluster.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: DescribePrometheusRecordRules.
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
Offset	No	Integer	Page offset
Limit	No	Integer	Number of results per page
Filters.N	No	Array of Filter	Filter

3. Output Parameters

Parameter Name	Type	Description
Records	Array of PrometheusRecordRuleYamlItem	Recording rule
Total	Integer	Total number
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Pulling recording rules

This example shows you how to pull recording rules.

Input Example

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrometheusRecordRules
<Common request parameters>

{
    "InstanceId": "xxx"
}

Output Example

{
    "Response": {
        "Records": [
            {
                "Content": "xdx",
                "UpdateTime": "xdx",
                "ClusterId": "xdx",
                "Name": "xdx",
                "TemplateId": "xdx",
                "Id": "de",
                "Status": 1,
                "Count": 1
            }
        ],
        "Total": 1,
        "RequestId": "xxx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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.ComponentClientCommon	FailedOperation.ComponentClientCommon
FailedOperation.ComponentClientHttp	FailedOperation.ComponentClientHttp
FailedOperation.ComponentClientUnpack	FailedOperation.ComponentClientUnpack
FailedOperation.KubeClientConf	FailedOperation.KubeClientConf
FailedOperation.KubeCommon	FailedOperation.KubeCommon
InternalError	Internal error.
InternalError.DbRecordNotFound	InternalError.DbRecordNotFound
InternalError.Param	InternalError.Param
InternalError.UnexpectedInternal	InternalError.UnexpectedInternal
InvalidParameter	Invalid parameter.
InvalidParameter.PromClusterNotFound	InvalidParameter.PromClusterNotFound
InvalidParameter.PromInstanceNotFound	InvalidParameter.PromInstanceNotFound

tencent cloud

Recent Pages