tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Cloud Observability Platform
    Documentation
    Download PDF

    API Category

    Last updated: 2023-08-11 16:08:59
    Download PDF

    Monitoring data query APIs

    API Name Feature Frequency Limit (maximum requests per second)
    DescribeBaseMetrics Gets the attributes of basic metrics 20
    DescribeStatisticData Queries monitoring data by dimension conditions 20
    GetMonitorData Pulls metric monitoring data 50

    Alarm APIs

    API Name Feature Frequency Limit (maximum requests per second)
    DescribeAlarmHistories Queries alarm records 20
    DeleteAlarmPolicy Deletes alarm policy 20
    DescribeAlarmPolicies Queries the list of alarm policies (by instance, etc.) 20
    DescribeAlarmPolicy Gets the details of single alarm policy 60
    ModifyAlarmPolicyStatus Enables/Disables alarm policy 20
    SetDefaultAlarmPolicy Sets default alarm policy 20
    BindingPolicyObject Binds a policy object. 20
    UnBindingPolicyObject Deletes an object that is bound to a policy. 20
    UnBindingAllPolicyObject Deletes all bound objects. 20
    DescribeBindingPolicyObjectList Gets the bound object list. 20
    ModifyAlarmPolicyInfo Modifies the basic information of an alarm policy 20
    ModifyAlarmPolicyCondition Modifies the trigger condition of an alarm policy 20
    DescribeAllNamespaces Queries all namespaces 20
    DescribeAlarmMetrics Queries alarm metric list 20
    DescribeAlarmEvents Queries alarm event list 20
    DescribeConditionsTemplateList Gets the trigger condition template 20
    CreateAlarmPolicy Creates an alarm policy 20
    DescribeMonitorTypes Queries monitor types 20
    ModifyAlarmPolicyNotice Modifies alarm notification template bound to alarm policy 20
    ModifyAlarmPolicyTasks Modifies task triggered by alarm policy 20
    SendCustomAlarmMsg Sends a custom alarm notification. 20

    Legacy Alert APIs

    API Name Feature Frequency Limit (maximum requests per second)
    CreatePolicyGroup Adds a policy group. 20
    DeletePolicyGroup Deletes an alarm policy group. 20
    DescribeBasicAlarmList Gets the basic alarm list. 20
    DescribePolicyConditionList Gets basic alarm policy conditions. 20
    DescribePolicyGroupInfo Gets details of a basic policy group. 20
    DescribePolicyGroupList Gets the list of basic policy alarm groups. 20
    ModifyAlarmReceivers Modifies alarm recipients. 20
    ModifyPolicyGroup Updates policy group 20

    Notification template APIs

    API Name Feature Frequency Limit (maximum requests per second)
    CreateAlarmNotice Creates notification template 20
    DescribeAlarmNotices Queries notification template list 20
    DescribeAlarmNotice Queries the details of single notification template 20
    DeleteAlarmNotices Deletes alarm notification templates in batches 20
    DescribeAlarmNoticeCallbacks Gets the list of all callback URLs under account 20
    ModifyAlarmNotice Modifies notification template 20

    Prometheus Service APIs

    API Name Feature Frequency Limit (maximum requests per second)
    BindPrometheusManagedGrafana Binds a TencentCloud Managed Service for Grafana (TCMG) instance 20
    CreateAlertRule Creates an alerting rule 20
    CreateExporterIntegration Creates an exporter integration 20
    CreatePrometheusAgent Creates a Prometheus CVM agent 20
    CreatePrometheusMultiTenantInstancePostPayMode Creates a pay-as-you-go Prometheus instance 20
    CreatePrometheusScrapeJob Creates a Prometheus scrape task 20
    CreateRecordingRule Creates a recording rule 20
    CreateServiceDiscovery Creates a scrape configuration 20
    DeleteAlertRules Deletes alerting rules 20
    DeleteExporterIntegration Deletes an exporter integration 20
    DeletePrometheusScrapeJobs Deletes a Prometheus scrape task 20
    DeleteRecordingRules Deletes recording rules 20
    DescribeAlertRules Queries an alerting rule 20
    DescribeExporterIntegrations Queries the list of exporter integrations 20
    DescribePrometheusAgents Lists Prometheus CVM agents 20
    DescribePrometheusInstanceUsage Queries the usage of a pay-as-you-go TMP instance 20
    DescribePrometheusInstances Queries the list of Prometheus instances 20
    DescribePrometheusScrapeJobs Lists Prometheus scrape tasks 20
    DescribeRecordingRules Queries recording rules 20
    DescribeServiceDiscovery Lists scrape configurations 20
    DestroyPrometheusInstance Forcibly releases a Prometheus instance 20
    GetPrometheusAgentManagementCommand Gets the command line for Prometheus agent management 20
    ModifyPrometheusInstanceAttributes Modifies the attributes of a Prometheus instance 20
    TerminatePrometheusInstances Terminates a pay-as-you-go Prometheus instance 20
    UnbindPrometheusManagedGrafana Unbinds a Grafana instance from an instance 20
    UninstallGrafanaDashboard Deletes a Grafana dashboard 20
    UpdateAlertRule Updates an alerting rule 20
    UpdateAlertRuleState Updates the status of an alerting rule 20
    UpdateExporterIntegration Updates the exporter integration configuration 20
    UpdatePrometheusAgentStatus Updates the status of a Prometheus CVM agent 20
    UpdatePrometheusScrapeJob Updates a Prometheus scrape task 20
    UpdateRecordingRule Updates a recording rule 20
    UpgradeGrafanaDashboard Updates a Grafana dashboard 20
    DescribePrometheusZones Lists TMP AZs 20

    Grafana Service APIs

    API Name Feature Frequency Limit (maximum requests per second)
    CreateGrafanaIntegration Creates a Grafana integration configuration 20
    CreateSSOAccount Authorizes another Tencent Cloud user 20
    DeleteGrafanaInstance Deletes a Grafana instance 20
    DeleteGrafanaIntegration Deletes a Grafana integration configuration 20
    DeleteSSOAccount Deletes an authorized user 20
    DescribeGrafanaChannels Lists all Grafana alert channels 20
    DescribeGrafanaConfig Lists Grafana settings 20
    DescribeGrafanaInstances Lists all Grafana instances under a user account 20
    DescribeGrafanaIntegrations Lists installed Grafana integrations 20
    DescribeInstalledPlugins Lists the plugins installed in an instance 20
    DescribeSSOAccount Lists authorized accounts 20
    EnableGrafanaInternet Sets the Grafana public network access 20
    EnableGrafanaSSO Sets the Grafana SSO 20
    EnableSSOCamCheck Sets whether to enable authentication during SSO 20
    InstallPlugins Installs a Grafana plugin 20
    ModifyGrafanaInstance Modifies the attributes of a Grafana instance 20
    UninstallGrafanaPlugins Deletes installed plugins 20
    UpdateGrafanaConfig Updates the Grafana configuration 20
    UpdateGrafanaIntegration Updates the Grafana integration configuration 20
    UpdateSSOAccount Updates the account information 20
    CleanGrafanaInstance Forcibly terminates a Grafana instance 20
    CreateGrafanaNotificationChannel Creates a Grafana notification channel 20
    DeleteGrafanaNotificationChannel Deletes a Grafana notification channel 20
    DescribeDNSConfig Lists Grafana DNS configurations 20
    DescribeGrafanaEnvironments Lists Grafana environment variables 20
    DescribeGrafanaNotificationChannels Lists Grafana notification channels 20
    DescribeGrafanaWhiteList Lists the Grafana allowlist 20
    ResumeGrafanaInstance Restores a Grafana instance 20
    UpdateDNSConfig Updates the Grafana DNS configuration 20
    UpdateGrafanaEnvironments Updates Grafana environment variables 20
    UpdateGrafanaNotificationChannel Updates the Grafana notification channel 20
    UpdateGrafanaWhiteList Updates the Grafana allowlist 20
    UpgradeGrafanaInstance Upgrades a Grafana instance 20
    CreateGrafanaInstance Creates a Grafana instance 20

    Event center APIs

    API Name Feature Frequency Limit (maximum requests per second)
    DescribeProductEventList Gets the list of product events. 20
    DescribeAccidentEventList Gets the platform event list. 20

    TencentCloud Managed Service for Prometheus APIs

    API Name Feature Frequency Limit (maximum requests per second)
    CheckIsPrometheusNewUser Determines whether the user is new to TMP 20
    CreatePrometheusAlertPolicy Creates an alerting rule 20
    CreatePrometheusGlobalNotification Creates a global alert notification channel 20
    CreatePrometheusTemp Creates a template 20
    DeletePrometheusAlertPolicy Deletes a TMP 2.0 instance alerting rule 20
    DeletePrometheusClusterAgent Disassociates a TMP instance from a cluster 20
    DeletePrometheusTemp Deletes a template 20
    DeletePrometheusTempSync Unsyncs a template 20
    DescribeClusterAgentCreatingProgress Obtains the cluster binding progress 20
    DescribePrometheusAgentInstances Gets the list of instances associated with the target cluster 20
    DescribePrometheusGlobalNotification Queries the global alert notification channel 20
    DescribePrometheusInstanceDetail Gets the details of a TMP instance 20
    DescribePrometheusInstanceInitStatus Gets the initialization task status of a v2.0 instance 20
    DescribePrometheusTargetsTMP Gets the targets information 20
    DescribePrometheusTempSync Gets the information of instances associated with a template 20
    ModifyPrometheusAgentExternalLabels Modifies the external labels of the associated cluster 20
    ModifyPrometheusAlertPolicy Modifies a TMP 2.0 instance alerting rule 20
    ModifyPrometheusGlobalNotification Modifies the global alert notification channel 20
    ModifyPrometheusTemp Modifies a template 20
    RunPrometheusInstance Initializes a TMP instance 20
    SyncPrometheusTemp Syncs a template 20
    CreatePrometheusClusterAgent Associates a TMP 2.0 instance with a cluster 20
    DescribePrometheusClusterAgents Gets the list of clusters associated with the TMP instance 20
    DescribePrometheusGlobalConfig Gets the instance-level scrape configurations 20
    DescribePrometheusRecordRules Gets the list of recording rules, including resources in the associated cluster 20
    DescribePrometheusAlertPolicy Gets the list of v2.0 instance alerting rules 20
    DescribePrometheusInstancesOverview Gets the list of v2.0 instances 20
    DescribePrometheusTemp Gets the list of templates 20

    Monitoring APIs

    API Name Feature Frequency Limit (maximum requests per second)
    CreatePrometheusConfig Creates Prometheus configurations 20
    DeletePrometheusConfig Deletes Prometheus configurations 20
    DeletePrometheusRecordRuleYaml Deletes a recording instance 20
    DescribePrometheusRecordRuleYaml Gets the YAML list of Prometheus recording rules 20
    ModifyPrometheusConfig Modifies the Prometheus configuration 20
    ModifyPrometheusRecordRuleYaml Modifies a Prometheus recording instance through YAML 20
    DescribePrometheusConfig Gets the Prometheus configuration 20
    CreatePrometheusRecordRuleYaml Creates a recording rule in the YAML way 20
    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