tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Cloud Observability Platform
    Documentation
    Download PDF

    DescribeRecordingRules

    Last updated: 2024-11-26 16:52:14
    Download PDF

      1. API Description

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

      This API is used to query Prometheus recording rules by filter.

      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: DescribeRecordingRules.
      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.
      InstanceId Yes String Prometheus instance ID
      Limit No Integer Number of returned results. Default value: 20. Maximum value: 100.
      Offset No Integer Offset. Default value: 0.
      RuleId No String Rule ID
      RuleState No Integer Rule status code. Valid values:
    • 1=RuleDeleted
    • 2=RuleEnabled
    • 3=RuleDisabled
      		•
      Name No String Rule name

      3. Output Parameters

      Parameter Name Type Description
      TotalCount Integer Number of rule groups
      RecordingRuleSet Array of RecordingRuleSet Rule group details
      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.

      4. Example

      Example1 Querying recording rules

      Input Example

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

{
    "InstanceId": "prom-sdf342",
    "RuleState": "2",
    "Limit": "10"
}

      Output Example

      {
    "Response": {
        "RecordingRuleSet": [
            {
                "RuleId": "rrule-45hkgiyc",
                "RuleState": 2,
                "Name": "example6",
                "Group": "LS0tDQpuYW1lOiBleGFtcGxlDQpydWxlczoNCiAgLSByZWNvcmQ6IGpvYjpodHRwX2lucHJvZ3Jlc3NfcmVxdWVzdHM6c3VtDQogICAgZXhwcjogc3VtIGJ5IChqb2IpIChodHRwX2lucHJvZ3Jlc3NfcmVxdWVzdHMp",
                "Total": 1,
                "UpdatedAt": "2020-08-10T17:50:06Z",
                "CreatedAt": "2020-08-10T09:32:51Z"
            }
        ],
        "RequestId": "-1y24pm54antkuiziyii7hxwv2974riq",
        "TotalCount": 1
    }
}

      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

      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
      AuthFailure Error with CAM signature/authentication.
      FailedOperation Operation failed.
      FailedOperation.BadYamlFormat The YAML format is incorrect.
      FailedOperation.DbQueryFailed Failed to query the database.
      FailedOperation.DbRecordCreateFailed Failed to create the database record.
      FailedOperation.DbRecordUpdateFailed Failed to update the database record.
      FailedOperation.GenerateInstanceIDFailed An error occurred while generating the resource ID.
      FailedOperation.ResourceExist The resource already exists.
      FailedOperation.ResourceNotFound The resource does not exist.
      InternalError Internal error.
      InvalidParameter Invalid parameter.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy