From e9265fb6b01fe013ef5861d96ad4bf8156626381 Mon Sep 17 00:00:00 2001 From: qiujiandong1 Date: Fri, 5 Dec 2025 10:48:24 +0000 Subject: [PATCH] CES API Update -20250521 version Reviewed-by: Ziuzko, Alevtina Co-authored-by: qiujiandong1 Co-committed-by: qiujiandong1 --- docs/ces/api-ref/ALL_META.TXT.json | 1126 +++- docs/ces/api-ref/AddAlarmRuleResources.html | 315 ++ docs/ces/api-ref/BatchCreateResources.html | 365 ++ docs/ces/api-ref/BatchDeleteAlarmRules.html | 244 + .../api-ref/BatchDeleteAlarmTemplates.html | 332 ++ .../api-ref/BatchDeleteOneClickAlarms.html | 340 ++ .../api-ref/BatchDeleteResourceGroups.html | 322 ++ docs/ces/api-ref/BatchDeleteResources.html | 365 ++ docs/ces/api-ref/BatchEnableAlarmRules.html | 254 + ...dateOneClickAlarmPoliciesEnabledState.html | 416 ++ ...BatchUpdateOneClickAlarmsEnabledState.html | 403 ++ docs/ces/api-ref/CLASS.TXT.json | 633 ++- docs/ces/api-ref/CreateAlarmRules.html | 675 +++ docs/ces/api-ref/CreateAlarmTemplate.html | 541 ++ docs/ces/api-ref/CreateOneClickAlarm.html | 486 ++ docs/ces/api-ref/CreateOneDashboard.html | 337 ++ docs/ces/api-ref/CreateResourceGroup.html | 408 ++ .../ces/api-ref/DeleteAlarmRuleResources.html | 315 ++ docs/ces/api-ref/DeleteDashboards.html | 335 ++ docs/ces/api-ref/ListAgentDimensionInfo.html | 406 ++ docs/ces/api-ref/ListAlarmHistories.html | 826 +++ docs/ces/api-ref/ListAlarmRulePolicies.html | 509 ++ docs/ces/api-ref/ListAlarmRuleResources.html | 312 ++ docs/ces/api-ref/ListAlarmRules.html | 705 +++ .../ListAlarmTemplateAssociationAlarms.html | 396 ++ docs/ces/api-ref/ListAlarmTemplates.html | 454 ++ docs/ces/api-ref/ListDashboardInfos.html | 377 ++ docs/ces/api-ref/ListOneClickAlarmRules.html | 670 +++ docs/ces/api-ref/ListOneClickAlarms.html | 358 ++ docs/ces/api-ref/ListResourceGroups.html | 463 ++ .../ListResourceGroupsServicesResources.html | 527 ++ docs/ces/api-ref/ShowAlarmTemplate.html | 531 ++ docs/ces/api-ref/ShowResourceGroup.html | 447 ++ docs/ces/api-ref/UpdateAlarmRulePolicies.html | 521 ++ docs/ces/api-ref/UpdateAlarmTemplate.html | 545 ++ docs/ces/api-ref/UpdateDashboard.html | 299 ++ .../UpdateOneClickAlarmNotifications.html | 451 ++ docs/ces/api-ref/UpdateResourceGroup.html | 406 ++ docs/ces/api-ref/ces_01_0054.html | 4720 +++++++++++------ docs/ces/api-ref/ces_03_0001.html | 2 +- docs/ces/api-ref/ces_03_0018.html | 4 +- docs/ces/api-ref/ces_03_0019.html | 2 +- docs/ces/api-ref/ces_03_0021.html | 2 +- docs/ces/api-ref/ces_03_0022.html | 2 +- docs/ces/api-ref/ces_03_0023.html | 21 +- docs/ces/api-ref/ces_03_0026.html | 12 +- docs/ces/api-ref/ces_03_0027.html | 50 +- docs/ces/api-ref/ces_03_0028.html | 48 +- docs/ces/api-ref/ces_03_0029.html | 11 +- docs/ces/api-ref/ces_03_0030.html | 9 +- docs/ces/api-ref/ces_03_0031.html | 53 +- docs/ces/api-ref/ces_03_0032.html | 2 +- docs/ces/api-ref/ces_03_0033.html | 43 +- docs/ces/api-ref/ces_03_0034.html | 111 +- docs/ces/api-ref/ces_03_0035.html | 17 +- docs/ces/api-ref/ces_03_0036.html | 2 +- docs/ces/api-ref/ces_03_0037.html | 11 +- docs/ces/api-ref/ces_03_0038.html | 5 +- docs/ces/api-ref/ces_03_0042.html | 32 + docs/ces/api-ref/ces_03_0057.html | 2 +- docs/ces/api-ref/ces_03_0059.html | 223 +- docs/ces/api-ref/ces_03_0060.html | 13 +- docs/ces/api-ref/ces_03_0062.html | 351 ++ docs/ces/api-ref/ces_03_0063.html | 101 + docs/ces/api-ref/ces_03_0064.html | 894 ++++ docs/ces/api-ref/ces_03_0066.html | 335 ++ docs/ces/api-ref/ces_03_0067.html | 24 + docs/ces/api-ref/ces_03_0068.html | 342 ++ docs/ces/api-ref/ces_03_0069.html | 373 ++ docs/ces/api-ref/ces_03_0070.html | 237 + docs/ces/api-ref/ces_03_0071.html | 237 + docs/ces/api-ref/ces_03_0072.html | 106 + docs/ces/api-ref/ces_03_0073.html | 432 ++ docs/ces/api-ref/ces_03_0074.html | 27 +- docs/ces/api-ref/ces_03_0075.html | 25 +- ...1.png => en-us_image_0000002446115165.png} | Bin docs/ces/api-ref/en-us_topic_0032831274.html | 30 +- docs/ces/api-ref/en-us_topic_0109034020.html | 51 +- docs/ces/api-ref/topic_300000000.html | 22 + docs/ces/api-ref/topic_300000001.html | 20 + docs/ces/api-ref/topic_300000002.html | 18 + docs/ces/api-ref/topic_300000004.html | 16 + docs/ces/api-ref/topic_300000005.html | 24 + docs/ces/api-ref/topic_300000006.html | 16 + docs/ces/api-ref/topic_300000007.html | 24 + docs/ces/api-ref/topic_300000008.html | 20 + docs/ces/api-ref/topic_300000009.html | 28 + docs/ces/api-ref/topic_300000011.html | 22 + docs/ces/api-ref/topic_300000014.html | 16 + 89 files changed, 24597 insertions(+), 2006 deletions(-) create mode 100644 docs/ces/api-ref/AddAlarmRuleResources.html create mode 100644 docs/ces/api-ref/BatchCreateResources.html create mode 100644 docs/ces/api-ref/BatchDeleteAlarmRules.html create mode 100644 docs/ces/api-ref/BatchDeleteAlarmTemplates.html create mode 100644 docs/ces/api-ref/BatchDeleteOneClickAlarms.html create mode 100644 docs/ces/api-ref/BatchDeleteResourceGroups.html create mode 100644 docs/ces/api-ref/BatchDeleteResources.html create mode 100644 docs/ces/api-ref/BatchEnableAlarmRules.html create mode 100644 docs/ces/api-ref/BatchUpdateOneClickAlarmPoliciesEnabledState.html create mode 100644 docs/ces/api-ref/BatchUpdateOneClickAlarmsEnabledState.html create mode 100644 docs/ces/api-ref/CreateAlarmRules.html create mode 100644 docs/ces/api-ref/CreateAlarmTemplate.html create mode 100644 docs/ces/api-ref/CreateOneClickAlarm.html create mode 100644 docs/ces/api-ref/CreateOneDashboard.html create mode 100644 docs/ces/api-ref/CreateResourceGroup.html create mode 100644 docs/ces/api-ref/DeleteAlarmRuleResources.html create mode 100644 docs/ces/api-ref/DeleteDashboards.html create mode 100644 docs/ces/api-ref/ListAgentDimensionInfo.html create mode 100644 docs/ces/api-ref/ListAlarmHistories.html create mode 100644 docs/ces/api-ref/ListAlarmRulePolicies.html create mode 100644 docs/ces/api-ref/ListAlarmRuleResources.html create mode 100644 docs/ces/api-ref/ListAlarmRules.html create mode 100644 docs/ces/api-ref/ListAlarmTemplateAssociationAlarms.html create mode 100644 docs/ces/api-ref/ListAlarmTemplates.html create mode 100644 docs/ces/api-ref/ListDashboardInfos.html create mode 100644 docs/ces/api-ref/ListOneClickAlarmRules.html create mode 100644 docs/ces/api-ref/ListOneClickAlarms.html create mode 100644 docs/ces/api-ref/ListResourceGroups.html create mode 100644 docs/ces/api-ref/ListResourceGroupsServicesResources.html create mode 100644 docs/ces/api-ref/ShowAlarmTemplate.html create mode 100644 docs/ces/api-ref/ShowResourceGroup.html create mode 100644 docs/ces/api-ref/UpdateAlarmRulePolicies.html create mode 100644 docs/ces/api-ref/UpdateAlarmTemplate.html create mode 100644 docs/ces/api-ref/UpdateDashboard.html create mode 100644 docs/ces/api-ref/UpdateOneClickAlarmNotifications.html create mode 100644 docs/ces/api-ref/UpdateResourceGroup.html create mode 100644 docs/ces/api-ref/ces_03_0042.html create mode 100644 docs/ces/api-ref/ces_03_0062.html create mode 100644 docs/ces/api-ref/ces_03_0063.html create mode 100644 docs/ces/api-ref/ces_03_0064.html create mode 100644 docs/ces/api-ref/ces_03_0066.html create mode 100644 docs/ces/api-ref/ces_03_0067.html create mode 100644 docs/ces/api-ref/ces_03_0068.html create mode 100644 docs/ces/api-ref/ces_03_0069.html create mode 100644 docs/ces/api-ref/ces_03_0070.html create mode 100644 docs/ces/api-ref/ces_03_0071.html create mode 100644 docs/ces/api-ref/ces_03_0072.html create mode 100644 docs/ces/api-ref/ces_03_0073.html rename docs/ces/api-ref/{en-us_image_0000001508295281.png => en-us_image_0000002446115165.png} (100%) create mode 100644 docs/ces/api-ref/topic_300000000.html create mode 100644 docs/ces/api-ref/topic_300000001.html create mode 100644 docs/ces/api-ref/topic_300000002.html create mode 100644 docs/ces/api-ref/topic_300000004.html create mode 100644 docs/ces/api-ref/topic_300000005.html create mode 100644 docs/ces/api-ref/topic_300000006.html create mode 100644 docs/ces/api-ref/topic_300000007.html create mode 100644 docs/ces/api-ref/topic_300000008.html create mode 100644 docs/ces/api-ref/topic_300000009.html create mode 100644 docs/ces/api-ref/topic_300000011.html create mode 100644 docs/ces/api-ref/topic_300000014.html diff --git a/docs/ces/api-ref/ALL_META.TXT.json b/docs/ces/api-ref/ALL_META.TXT.json index 1dc6e25b6..3d1059831 100644 --- a/docs/ces/api-ref/ALL_META.TXT.json +++ b/docs/ces/api-ref/ALL_META.TXT.json @@ -27,7 +27,7 @@ "code":"2", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", - "kw":"API Description", + "kw":"API V1", "search_title":"", "metedata":[ { @@ -35,7 +35,7 @@ "prodname":"ces" } ], - "title":"API Description", + "title":"API V1", "githuburl":"" }, { @@ -236,11 +236,101 @@ "title":"Creating an Alarm Rule", "githuburl":"" }, + { + "uri":"ces_03_0062.html", + "node_id":"ces_03_0062.xml", + "product_code":"ces", + "code":"14", + "des":"This API is used to create a custom alarm template to add alarm rules for one or more metrics.POST /V1.0/{project_id}/alarm-templateParameter descriptionParameter descrip", + "doc_type":"api", + "kw":"Creating a Custom Alarm Template,Alarm Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Creating a Custom Alarm Template", + "githuburl":"" + }, + { + "uri":"ces_03_0063.html", + "node_id":"ces_03_0063.xml", + "product_code":"ces", + "code":"15", + "des":"This API is used to delete a custom alarm template.DELETE /V1.0/{project_id}/alarm-template/{template_id}Parameter descriptionParameter descriptionParameterMandatoryDescr", + "doc_type":"api", + "kw":"Deleting a Custom Alarm Template,Alarm Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Deleting a Custom Alarm Template", + "githuburl":"" + }, + { + "uri":"ces_03_0064.html", + "node_id":"ces_03_0064.xml", + "product_code":"ces", + "code":"16", + "des":"This API is used to query the alarm history of an alarm rule based on the alarm rule ID.GET /V1.0/{project_id}/alarm-historiesQuerying parameter descriptionQuerying param", + "doc_type":"api", + "kw":"Querying the Alarm History of an Alarm Rule,Alarm Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Querying the Alarm History of an Alarm Rule", + "githuburl":"" + }, + { + "uri":"ces_03_0066.html", + "node_id":"ces_03_0066.xml", + "product_code":"ces", + "code":"17", + "des":"This API is used to update a custom alarm template.PUT /V1.0/{project_id}/alarm-template/{template_id}Parameter descriptionParameter descriptionParameterMandatoryDescript", + "doc_type":"api", + "kw":"Updating a Custom Alarm Template,Alarm Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Updating a Custom Alarm Template", + "githuburl":"" + }, + { + "uri":"ces_03_0069.html", + "node_id":"ces_03_0069.xml", + "product_code":"ces", + "code":"18", + "des":"This API is used to modify an alarm rule.PUT /V1.0/{project_id}/alarms/{alarm_id}Parameter descriptionParameter descriptionParameterMandatoryDescriptionproject_idYesSpeci", + "doc_type":"api", + "kw":"Modifying an Alarm Rule,Alarm Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Modifying an Alarm Rule", + "githuburl":"" + }, { "uri":"ces_03_0032.html", "node_id":"ces_03_0032.xml", "product_code":"ces", - "code":"14", + "code":"19", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Monitoring Data", @@ -258,7 +348,7 @@ "uri":"ces_03_0033.html", "node_id":"ces_03_0033.xml", "product_code":"ces", - "code":"15", + "code":"20", "des":"This API is used to query the monitoring data of a specified metric at a specified granularity in a specified time range. You can specify the dimension of data to be quer", "doc_type":"api", "kw":"Querying Monitoring Data of a Metric,Monitoring Data,API Reference", @@ -276,7 +366,7 @@ "uri":"en-us_topic_0032831274.html", "node_id":"en-us_topic_0032831274.xml", "product_code":"ces", - "code":"16", + "code":"21", "des":"This API is used to add one or more pieces of custom metric monitoring data to solve the problem that the system metrics cannot meet specific service requirements.For det", "doc_type":"api", "kw":"Adding Monitoring Data,Monitoring Data,API Reference", @@ -294,8 +384,8 @@ "uri":"ces_03_0034.html", "node_id":"ces_03_0034.xml", "product_code":"ces", - "code":"17", - "des":"You can query the monitoring data of specified metrics within a specified time range and at a specified granularity. You can query the monitoring data of up to 10 metrics", + "code":"22", + "des":"You can query the data of specified metrics within a specified time range and at a specified granularity. You can query the monitoring data of up to 10 metrics in one bat", "doc_type":"api", "kw":"Querying Monitoring Data of Multiple Metrics,Monitoring Data,API Reference", "search_title":"", @@ -312,7 +402,7 @@ "uri":"ces_03_0035.html", "node_id":"ces_03_0035.xml", "product_code":"ces", - "code":"18", + "code":"23", "des":"This API is used to query the host configuration for a specified event type in a specified time range. You can specify the dimension of data to be queried.This API is pro", "doc_type":"api", "kw":"Querying the Host Configuration,Monitoring Data,API Reference", @@ -330,7 +420,7 @@ "uri":"ces_03_0036.html", "node_id":"ces_03_0036.xml", "product_code":"ces", - "code":"19", + "code":"24", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Quotas", @@ -348,7 +438,7 @@ "uri":"ces_03_0037.html", "node_id":"ces_03_0037.xml", "product_code":"ces", - "code":"20", + "code":"25", "des":"This API is used to query the alarm rule quota and the number of alarm rules that have been created.GET /V1.0/{project_id}/quotasParameter descriptionParameter descriptio", "doc_type":"api", "kw":"Querying Quotas,Quotas,API Reference", @@ -362,11 +452,119 @@ "title":"Querying Quotas", "githuburl":"" }, + { + "uri":"ces_03_0067.html", + "node_id":"ces_03_0067.xml", + "product_code":"ces", + "code":"26", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Resource Groups", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Resource Groups", + "githuburl":"" + }, + { + "uri":"ces_03_0068.html", + "node_id":"ces_03_0068.xml", + "product_code":"ces", + "code":"27", + "des":"This API is used to query resources in a resource group based on the resource group ID.GET /V1.0/{project_id}/resource-groups/{group_id}Parameter descriptionParameter de", + "doc_type":"api", + "kw":"Querying Resources in a Resource Group,Resource Groups,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Querying Resources in a Resource Group", + "githuburl":"" + }, + { + "uri":"ces_03_0070.html", + "node_id":"ces_03_0070.xml", + "product_code":"ces", + "code":"28", + "des":"This API is used to create a resource group. You can use resource groups to manage resources by service, and view monitoring and alarm information by group to ease O&M.PO", + "doc_type":"api", + "kw":"Creating a Resource Group,Resource Groups,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Creating a Resource Group", + "githuburl":"" + }, + { + "uri":"ces_03_0071.html", + "node_id":"ces_03_0071.xml", + "product_code":"ces", + "code":"29", + "des":"This API is used to update a resource group. You can use resource groups to manage resources by service, and view monitoring and alarm information by group to ease O&M.PU", + "doc_type":"api", + "kw":"Updating a Resource Group,Resource Groups,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Updating a Resource Group", + "githuburl":"" + }, + { + "uri":"ces_03_0072.html", + "node_id":"ces_03_0072.xml", + "product_code":"ces", + "code":"30", + "des":"This API is used to delete a resource group.DELETE /V1.0/{project_id}/resource-groups/{group_id}Parameter descriptionParameter descriptionParameterTypeMandatoryDescripti", + "doc_type":"api", + "kw":"Deleting a Resource Group,Resource Groups,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Deleting a Resource Group", + "githuburl":"" + }, + { + "uri":"ces_03_0073.html", + "node_id":"ces_03_0073.xml", + "product_code":"ces", + "code":"31", + "des":"This API is used to query all resource groups you created.GET /V1.0/{project_id}/resource-groupsParameter descriptionParameter descriptionParameterTypeMandatoryDescripti", + "doc_type":"api", + "kw":"Query Resource Groups,Resource Groups,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Query Resource Groups", + "githuburl":"" + }, { "uri":"ces_03_0038.html", "node_id":"ces_03_0038.xml", "product_code":"ces", - "code":"21", + "code":"32", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Event Monitoring", @@ -384,7 +582,7 @@ "uri":"en-us_topic_0109034020.html", "node_id":"en-us_topic_0109034020.xml", "product_code":"ces", - "code":"22", + "code":"33", "des":"An API for reporting custom events is provided, which helps you collect and report abnormal events or important change events to Cloud Eye.POST /V1.0/{project_id}/eventsP", "doc_type":"api", "kw":"Reporting Events,Event Monitoring,API Reference", @@ -402,7 +600,7 @@ "uri":"ces_03_0074.html", "node_id":"ces_03_0074.xml", "product_code":"ces", - "code":"23", + "code":"34", "des":"This API is used to query events, including system events and custom events.GET /V1.0/{project_id}/eventsParameter descriptionParameter descriptionParameterTypeMandatoryD", "doc_type":"api", "kw":"Querying Events,Event Monitoring,API Reference", @@ -420,7 +618,7 @@ "uri":"ces_03_0075.html", "node_id":"ces_03_0075.xml", "product_code":"ces", - "code":"24", + "code":"35", "des":"This API is used to query details of an event based on the event name.GET /V1.0/{project_id}/event/{event_name}Parameter descriptionParameter descriptionParameterTypeMand", "doc_type":"api", "kw":"Querying Details of an Event,Event Monitoring,API Reference", @@ -434,11 +632,875 @@ "title":"Querying Details of an Event", "githuburl":"" }, + { + "uri":"ces_03_0042.html", + "node_id":"ces_03_0042.xml", + "product_code":"ces", + "code":"36", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"API V2", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"API V2", + "githuburl":"" + }, + { + "uri":"topic_300000000.html", + "node_id":"topic_300000000.xml", + "product_code":"ces", + "code":"37", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Alarm Rules", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Alarm Rules", + "githuburl":"" + }, + { + "uri":"CreateAlarmRules.html", + "node_id":"createalarmrules.xml", + "product_code":"ces", + "code":"38", + "des":"This API is used to create an alarm rule (recommended).POST /v2/{project_id}/alarmsStatus code: 201Status code: 400Status code: 500Create an alarm rule whose name is alar", + "doc_type":"api", + "kw":"Creating an Alarm Rule (Recommended),Alarm Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Creating an Alarm Rule (Recommended)", + "githuburl":"" + }, + { + "uri":"BatchDeleteAlarmRules.html", + "node_id":"batchdeletealarmrules.xml", + "product_code":"ces", + "code":"39", + "des":"This API (V2) is used to batch delete alarm rules.POST /v2/{project_id}/alarms/batch-deleteStatus code: 200Status code: 400Status code: 500Batch deleting alarm rulesStatu", + "doc_type":"api", + "kw":"Deleting Alarm Rules in Batches,Alarm Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Deleting Alarm Rules in Batches", + "githuburl":"" + }, + { + "uri":"BatchEnableAlarmRules.html", + "node_id":"batchenablealarmrules.xml", + "product_code":"ces", + "code":"40", + "des":"This API is used to enable or disable alarm rules in batches.POST /v2/{project_id}/alarms/actionStatus code: 200Status code: 400Status code: 500Enable or disable alarm ru", + "doc_type":"api", + "kw":"Enabling or Disabling Alarm Rules in Batches,Alarm Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Enabling or Disabling Alarm Rules in Batches", + "githuburl":"" + }, + { + "uri":"ListAlarmRules.html", + "node_id":"listalarmrules.xml", + "product_code":"ces", + "code":"41", + "des":"This API is used to query alarm rules.GET /v2/{project_id}/alarmsStatus code: 200Status code: 400Status code: 500Querying alarm rulesStatus code: 200Query succeeded.See E", + "doc_type":"api", + "kw":"Querying Alarm Rules (Recommended),Alarm Rules,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Querying Alarm Rules (Recommended)", + "githuburl":"" + }, + { + "uri":"topic_300000001.html", + "node_id":"topic_300000001.xml", + "product_code":"ces", + "code":"42", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Resources in an Alarm Rule", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Resources in an Alarm Rule", + "githuburl":"" + }, + { + "uri":"AddAlarmRuleResources.html", + "node_id":"addalarmruleresources.xml", + "product_code":"ces", + "code":"43", + "des":"This API is used to batch add resources to an alarm rule. This API does not support alarm rules with Monitoring Scope set to Resource groups or All resources. To modify r", + "doc_type":"api", + "kw":"Batch Adding Resources to an Alarm Rule,Resources in an Alarm Rule,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Batch Adding Resources to an Alarm Rule", + "githuburl":"" + }, + { + "uri":"DeleteAlarmRuleResources.html", + "node_id":"deletealarmruleresources.xml", + "product_code":"ces", + "code":"44", + "des":"This API is used to batch delete resources to an alarm rule. This API does not support alarm rules with Monitoring Scope set to Resource groups. To modify resources in su", + "doc_type":"api", + "kw":"Deleting Resources from an Alarm Rule,Resources in an Alarm Rule,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Deleting Resources from an Alarm Rule", + "githuburl":"" + }, + { + "uri":"ListAlarmRuleResources.html", + "node_id":"listalarmruleresources.xml", + "product_code":"ces", + "code":"45", + "des":"This API is used to query resources in an alarm rule by its ID.GET /v2/{project_id}/alarms/{alarm_id}/resourcesStatus code: 200Status code: 400Status code: 500Querying re", + "doc_type":"api", + "kw":"Querying Resources in an Alarm Rule,Resources in an Alarm Rule,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Querying Resources in an Alarm Rule", + "githuburl":"" + }, + { + "uri":"topic_300000002.html", + "node_id":"topic_300000002.xml", + "product_code":"ces", + "code":"46", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Alarm Policies", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Alarm Policies", + "githuburl":"" + }, + { + "uri":"UpdateAlarmRulePolicies.html", + "node_id":"updatealarmrulepolicies.xml", + "product_code":"ces", + "code":"47", + "des":"This API is used to modify alarm policies in an alarm rule.PUT /v2/{project_id}/alarms/{alarm_id}/policiesStatus code: 200Status code: 400Status code: 500Modifying an ala", + "doc_type":"api", + "kw":"Modifying Policies in an Alarm Rule,Alarm Policies,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Modifying Policies in an Alarm Rule", + "githuburl":"" + }, + { + "uri":"ListAlarmRulePolicies.html", + "node_id":"listalarmrulepolicies.xml", + "product_code":"ces", + "code":"48", + "des":"This API is used to query alarm policies by alarm rule ID.GET /v2/{project_id}/alarms/{alarm_id}/policiesStatus code: 200Status code: 400Status code: 404Status code: 500Q", + "doc_type":"api", + "kw":"Querying Alarm Policies in an Alarm Rule,Alarm Policies,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Querying Alarm Policies in an Alarm Rule", + "githuburl":"" + }, + { + "uri":"topic_300000004.html", + "node_id":"topic_300000004.xml", + "product_code":"ces", + "code":"49", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Alarm Records", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Alarm Records", + "githuburl":"" + }, + { + "uri":"ListAlarmHistories.html", + "node_id":"listalarmhistories.xml", + "product_code":"ces", + "code":"50", + "des":"This API is used to query alarm records.GET /v2/{project_id}/alarm-historiesStatus code: 200Status code: 400Status code: 500Querying alarm records whose alarm_name is ala", + "doc_type":"api", + "kw":"Querying Alarm Records,Alarm Records,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Querying Alarm Records", + "githuburl":"" + }, + { + "uri":"topic_300000005.html", + "node_id":"topic_300000005.xml", + "product_code":"ces", + "code":"51", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Alarm Templates", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Alarm Templates", + "githuburl":"" + }, + { + "uri":"CreateAlarmTemplate.html", + "node_id":"createalarmtemplate.xml", + "product_code":"ces", + "code":"52", + "des":"This API is used to create a custom alarm template.POST /v2/{project_id}/alarm-templatesStatus code: 201Status code: 400Status code: 401Status code: 403Status code: 500Cr", + "doc_type":"api", + "kw":"Creating a Custom Alarm Template,Alarm Templates,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Creating a Custom Alarm Template", + "githuburl":"" + }, + { + "uri":"BatchDeleteAlarmTemplates.html", + "node_id":"batchdeletealarmtemplates.xml", + "product_code":"ces", + "code":"53", + "des":"This API is used to delete custom alarm templates in batches.POST /v2/{project_id}/alarm-templates/batch-deleteStatus code: 200Status code: 400Status code: 401Status code", + "doc_type":"api", + "kw":"Batch Deleting Custom Alarm Templates,Alarm Templates,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Batch Deleting Custom Alarm Templates", + "githuburl":"" + }, + { + "uri":"UpdateAlarmTemplate.html", + "node_id":"updatealarmtemplate.xml", + "product_code":"ces", + "code":"54", + "des":"This API is used to modify a custom alarm template.PUT /v2/{project_id}/alarm-templates/{template_id}Status code: 400Status code: 401Status code: 403Status code: 404Statu", + "doc_type":"api", + "kw":"Modifying a Custom Alarm Template,Alarm Templates,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Modifying a Custom Alarm Template", + "githuburl":"" + }, + { + "uri":"ListAlarmTemplates.html", + "node_id":"listalarmtemplates.xml", + "product_code":"ces", + "code":"55", + "des":"This API is used to query alarm templates.GET /v2/{project_id}/alarm-templatesStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 500Querying ala", + "doc_type":"api", + "kw":"Querying Alarm Templates,Alarm Templates,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Querying Alarm Templates", + "githuburl":"" + }, + { + "uri":"ShowAlarmTemplate.html", + "node_id":"showalarmtemplate.xml", + "product_code":"ces", + "code":"56", + "des":"This API is used to query details of an alarm template.GET /v2/{project_id}/alarm-templates/{template_id}Status code: 200Status code: 400Status code: 401Status code: 403S", + "doc_type":"api", + "kw":"Querying Details of an Alarm Template,Alarm Templates,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Querying Details of an Alarm Template", + "githuburl":"" + }, + { + "uri":"topic_300000006.html", + "node_id":"topic_300000006.xml", + "product_code":"ces", + "code":"57", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Alarm Rules Associated with an Alarm Template", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Alarm Rules Associated with an Alarm Template", + "githuburl":"" + }, + { + "uri":"ListAlarmTemplateAssociationAlarms.html", + "node_id":"listalarmtemplateassociationalarms.xml", + "product_code":"ces", + "code":"58", + "des":"This API is used to query alarm rules associated with an alarm template.GET /v2/{project_id}/alarm-templates/{template_id}/association-alarmsStatus code: 200Status code: ", + "doc_type":"api", + "kw":"Querying Alarm Rules Associated with an Alarm Template,Alarm Rules Associated with an Alarm Template", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Querying Alarm Rules Associated with an Alarm Template", + "githuburl":"" + }, + { + "uri":"topic_300000007.html", + "node_id":"topic_300000007.xml", + "product_code":"ces", + "code":"59", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Resource Groups", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Resource Groups", + "githuburl":"" + }, + { + "uri":"CreateResourceGroup.html", + "node_id":"createresourcegroup.xml", + "product_code":"ces", + "code":"60", + "des":"This API is used to create a resource group (recommended).POST /v2/{project_id}/resource-groupsStatus code: 200Status code: 400Status code: 401Status code: 403Status code", + "doc_type":"api", + "kw":"Creating a Resource Group (Recommended),Resource Groups,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Creating a Resource Group (Recommended)", + "githuburl":"" + }, + { + "uri":"BatchDeleteResourceGroups.html", + "node_id":"batchdeleteresourcegroups.xml", + "product_code":"ces", + "code":"61", + "des":"This API is used to delete resource groups in batches.POST /v2/{project_id}/resource-groups/batch-deleteStatus code: 200Status code: 400Status code: 401Status code: 403St", + "doc_type":"api", + "kw":"Batch Deleting Resource Groups,Resource Groups,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Batch Deleting Resource Groups", + "githuburl":"" + }, + { + "uri":"UpdateResourceGroup.html", + "node_id":"updateresourcegroup.xml", + "product_code":"ces", + "code":"62", + "des":"This API is used to modify a resource group.PUT /v2/{project_id}/resource-groups/{group_id}Status code: 400Status code: 401Status code: 403Status code: 404Status code: 50", + "doc_type":"api", + "kw":"Modifying a Resource Group,Resource Groups,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Modifying a Resource Group", + "githuburl":"" + }, + { + "uri":"ShowResourceGroup.html", + "node_id":"showresourcegroup.xml", + "product_code":"ces", + "code":"63", + "des":"This API is used to query details of a resource group.GET /v2/{project_id}/resource-groups/{group_id}Status code: 200Status code: 400Status code: 401Status code: 403Statu", + "doc_type":"api", + "kw":"Querying Details of a Resource Group,Resource Groups,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Querying Details of a Resource Group", + "githuburl":"" + }, + { + "uri":"ListResourceGroups.html", + "node_id":"listresourcegroups.xml", + "product_code":"ces", + "code":"64", + "des":"This API is used to query resource groups.GET /v2/{project_id}/resource-groupsStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 500Querying res", + "doc_type":"api", + "kw":"Querying Resource Groups,Resource Groups,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Querying Resource Groups", + "githuburl":"" + }, + { + "uri":"topic_300000008.html", + "node_id":"topic_300000008.xml", + "product_code":"ces", + "code":"65", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Resources in a Resource Group", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Resources in a Resource Group", + "githuburl":"" + }, + { + "uri":"BatchCreateResources.html", + "node_id":"batchcreateresources.xml", + "product_code":"ces", + "code":"66", + "des":"This API is used to batch add associated resources to a custom resource group whose type is Manual.POST /v2/{project_id}/resource-groups/{group_id}/resources/batch-create", + "doc_type":"api", + "kw":"Batch Adding Associated Resources to a Custom Resource Group,Resources in a Resource Group,API Refer", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Batch Adding Associated Resources to a Custom Resource Group", + "githuburl":"" + }, + { + "uri":"BatchDeleteResources.html", + "node_id":"batchdeleteresources.xml", + "product_code":"ces", + "code":"67", + "des":"This API is used to batch delete associated resources from a custom resource group whose type is Manual.POST /v2/{project_id}/resource-groups/{group_id}/resources/batch-d", + "doc_type":"api", + "kw":"Batch Deleting Associated Resources from a Custom Resource Group,Resources in a Resource Group,API R", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Batch Deleting Associated Resources from a Custom Resource Group", + "githuburl":"" + }, + { + "uri":"ListResourceGroupsServicesResources.html", + "node_id":"listresourcegroupsservicesresources.xml", + "product_code":"ces", + "code":"68", + "des":"This API is used to query resources of a specified dimension for a specified resource type in a resource group.GET /v2/{project_id}/resource-groups/{group_id}/services/{s", + "doc_type":"api", + "kw":"Querying Resources of a Specified Dimension for a Specified Service Type in a Resource Group,Resourc", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Querying Resources of a Specified Dimension for a Specified Service Type in a Resource Group", + "githuburl":"" + }, + { + "uri":"topic_300000009.html", + "node_id":"topic_300000009.xml", + "product_code":"ces", + "code":"69", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"One-Click Monitoring", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"One-Click Monitoring", + "githuburl":"" + }, + { + "uri":"CreateOneClickAlarm.html", + "node_id":"createoneclickalarm.xml", + "product_code":"ces", + "code":"70", + "des":"This API is used to enable one-click monitoring.POST /v2/{project_id}/one-click-alarmsStatus code: 201Status code: 400Status code: 401Status code: 403Status code: 500Stat", + "doc_type":"api", + "kw":"Enabling One-Click Monitoring,One-Click Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Enabling One-Click Monitoring", + "githuburl":"" + }, + { + "uri":"ListOneClickAlarms.html", + "node_id":"listoneclickalarms.xml", + "product_code":"ces", + "code":"71", + "des":"This API is used to query services and resources in one-click monitoring.GET /v2/{project_id}/one-click-alarmsStatus code: 200Status code: 400Status code: 401Status code:", + "doc_type":"api", + "kw":"Querying Services and Resources in One-Click Monitoring,One-Click Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Querying Services and Resources in One-Click Monitoring", + "githuburl":"" + }, + { + "uri":"ListOneClickAlarmRules.html", + "node_id":"listoneclickalarmrules.xml", + "product_code":"ces", + "code":"72", + "des":"This API is used to query alarm rules for one service in one-click monitoring.GET /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/alarmsStatus code: 200Status code", + "doc_type":"api", + "kw":"Querying Alarm Rules for One Service in One-Click Monitoring,One-Click Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Querying Alarm Rules for One Service in One-Click Monitoring", + "githuburl":"" + }, + { + "uri":"BatchUpdateOneClickAlarmsEnabledState.html", + "node_id":"batchupdateoneclickalarmsenabledstate.xml", + "product_code":"ces", + "code":"73", + "des":"This API is used to batch enable or disable alarm rules for one service that has one-click monitoring enabled.PUT /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/a", + "doc_type":"api", + "kw":"Batch Enabling or Disabling Alarm Rules of One Service in One-Click Monitoring,One-Click Monitoring,", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Batch Enabling or Disabling Alarm Rules of One Service in One-Click Monitoring", + "githuburl":"" + }, + { + "uri":"BatchDeleteOneClickAlarms.html", + "node_id":"batchdeleteoneclickalarms.xml", + "product_code":"ces", + "code":"74", + "des":"This API is used to batch disable one-click monitoring.POST /v2/{project_id}/one-click-alarms/batch-deleteStatus code: 200Status code: 400Status code: 401Status code: 403", + "doc_type":"api", + "kw":"Batch Disabling One-Click Monitoring,One-Click Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Batch Disabling One-Click Monitoring", + "githuburl":"" + }, + { + "uri":"UpdateOneClickAlarmNotifications.html", + "node_id":"updateoneclickalarmnotifications.xml", + "product_code":"ces", + "code":"75", + "des":"This API is used to batch modify alarm notifications in alarm rules for one service with one-click monitoring enabled.PUT /v2/{project_id}/one-click-alarms/{one_click_ala", + "doc_type":"api", + "kw":"Batch Modifying Alarm Notifications in Alarm Rules for One Service with One-Click Monitoring Enabled", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Batch Modifying Alarm Notifications in Alarm Rules for One Service with One-Click Monitoring Enabled", + "githuburl":"" + }, + { + "uri":"BatchUpdateOneClickAlarmPoliciesEnabledState.html", + "node_id":"batchupdateoneclickalarmpoliciesenabledstate.xml", + "product_code":"ces", + "code":"76", + "des":"This API is used to batch enable or disable alarm policies in alarm rules for one service with one-click monitoring enabled.PUT /v2/{project_id}/one-click-alarms/{one_cli", + "doc_type":"api", + "kw":"Batch Enabling or Disabling Alarm Policies in Alarm Rules for One Service with One-Click Monitoring ", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Batch Enabling or Disabling Alarm Policies in Alarm Rules for One Service with One-Click Monitoring Enabled", + "githuburl":"" + }, + { + "uri":"topic_300000011.html", + "node_id":"topic_300000011.xml", + "product_code":"ces", + "code":"77", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Dashboards", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Dashboards", + "githuburl":"" + }, + { + "uri":"CreateOneDashboard.html", + "node_id":"createonedashboard.xml", + "product_code":"ces", + "code":"78", + "des":"This API is used to create or copy a dashboard.POST /v2/{project_id}/dashboardsStatus code: 201Status code: 400Status code: 401Status code: 500Create a dashboard.Copy a d", + "doc_type":"api", + "kw":"Creating or Copying a Dashboard,Dashboards,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Creating or Copying a Dashboard", + "githuburl":"" + }, + { + "uri":"ListDashboardInfos.html", + "node_id":"listdashboardinfos.xml", + "product_code":"ces", + "code":"79", + "des":"This API is used to query dashboards.GET /v2/{project_id}/dashboardsStatus code: 200Status code: 400Status code: 401Status code: 500NoneStatus code: 200OKSee Error Codes.", + "doc_type":"api", + "kw":"Querying Dashboards,Dashboards,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Querying Dashboards", + "githuburl":"" + }, + { + "uri":"UpdateDashboard.html", + "node_id":"updatedashboard.xml", + "product_code":"ces", + "code":"80", + "des":"This API is used to modify a dashboard.PUT /v2/{project_id}/dashboards/{dashboard_id}Status code: 400Status code: 401Status code: 500NoneSee Error Codes.", + "doc_type":"api", + "kw":"Modifying a Dashboard,Dashboards,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Modifying a Dashboard", + "githuburl":"" + }, + { + "uri":"DeleteDashboards.html", + "node_id":"deletedashboards.xml", + "product_code":"ces", + "code":"81", + "des":"This API is used to delete dashboards in batches.POST /v2/{project_id}/dashboards/batch-deleteStatus code: 200Status code: 400Status code: 401Status code: 500Status code:", + "doc_type":"api", + "kw":"Batch Deleting Dashboards,Dashboards,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Batch Deleting Dashboards", + "githuburl":"" + }, + { + "uri":"topic_300000014.html", + "node_id":"topic_300000014.xml", + "product_code":"ces", + "code":"82", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Metric Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Metric Management", + "githuburl":"" + }, + { + "uri":"ListAgentDimensionInfo.html", + "node_id":"listagentdimensioninfo.xml", + "product_code":"ces", + "code":"83", + "des":"This API is used to query metrics based on the ECS or BMS ID and from the following dimensions: disk, mount point, process, graphics card, and RAID controller. The NPU di", + "doc_type":"api", + "kw":"Querying Server Monitoring Metrics,Metric Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ces" + } + ], + "title":"Querying Server Monitoring Metrics", + "githuburl":"" + }, { "uri":"ces_03_0045.html", "node_id":"ces_03_0045.xml", "product_code":"ces", - "code":"25", + "code":"84", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Permissions Policies and Supported Actions", @@ -456,7 +1518,7 @@ "uri":"ces_03_0046.html", "node_id":"ces_03_0046.xml", "product_code":"ces", - "code":"26", + "code":"85", "des":"This chapter describes fine-grained permissions management for your Cloud Eye. If your account does not need individual IAM users, then you may skip over this chapter.Po", "doc_type":"api", "kw":"Introduction,Permissions Policies and Supported Actions,API Reference", @@ -474,7 +1536,7 @@ "uri":"ces_03_0047.html", "node_id":"ces_03_0047.xml", "product_code":"ces", - "code":"27", + "code":"86", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Supported Actions of the API Version Management APIs,Permissions Policies and Supported Actions,API ", @@ -492,7 +1554,7 @@ "uri":"ces_03_0048.html", "node_id":"ces_03_0048.xml", "product_code":"ces", - "code":"28", + "code":"87", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Supported Actions of the Metric Management API,Permissions Policies and Supported Actions,API Refere", @@ -510,7 +1572,7 @@ "uri":"ces_03_0049.html", "node_id":"ces_03_0049.xml", "product_code":"ces", - "code":"29", + "code":"88", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Supported Actions of the Alarm Rule Management APIs,Permissions Policies and Supported Actions,API R", @@ -528,7 +1590,7 @@ "uri":"ces_03_0050.html", "node_id":"ces_03_0050.xml", "product_code":"ces", - "code":"30", + "code":"89", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Supported Actions of the Monitoring Data Management APIs,Permissions Policies and Supported Actions,", @@ -546,7 +1608,7 @@ "uri":"ces_03_0051.html", "node_id":"ces_03_0051.xml", "product_code":"ces", - "code":"31", + "code":"90", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Supported Actions of the Quota Management API,Permissions Policies and Supported Actions,API Referen", @@ -564,7 +1626,7 @@ "uri":"ces_03_0052.html", "node_id":"ces_03_0052.xml", "product_code":"ces", - "code":"32", + "code":"91", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Supported Actions of the Event Monitoring API,Permissions Policies and Supported Actions,API Referen", @@ -582,7 +1644,7 @@ "uri":"ces_03_0053.html", "node_id":"ces_03_0053.xml", "product_code":"ces", - "code":"33", + "code":"92", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Common Parameters", @@ -600,7 +1662,7 @@ "uri":"ces_03_0055.html", "node_id":"ces_03_0055.xml", "product_code":"ces", - "code":"34", + "code":"93", "des":"NormalReturned ValueDescription200 OKThe results of GET and PUT operations are returned as expected.201 CreatedThe results of the POST operation are returned as expected.", "doc_type":"api", "kw":"Status Codes,Common Parameters,API Reference", @@ -618,7 +1680,7 @@ "uri":"ErrorCode.html", "node_id":"errorcode.xml", "product_code":"ces", - "code":"35", + "code":"94", "des":"If an error occurs during API calling, the system returns error information. This section describes the error codes contained in the error information for Cloud Eye APIs.", "doc_type":"api", "kw":"Error Codes,Common Parameters,API Reference", @@ -636,7 +1698,7 @@ "uri":"ces_03_0057.html", "node_id":"ces_03_0057.xml", "product_code":"ces", - "code":"36", + "code":"95", "des":"A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:Obtain the Project ID by Ca", "doc_type":"api", "kw":"Obtaining a Project ID,Common Parameters,API Reference", @@ -654,7 +1716,7 @@ "uri":"ces_03_0058.html", "node_id":"ces_03_0058.xml", "product_code":"ces", - "code":"37", + "code":"96", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Appendix", @@ -672,8 +1734,8 @@ "uri":"ces_03_0059.html", "node_id":"ces_03_0059.xml", "product_code":"ces", - "code":"38", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "code":"97", + "des":"In addition to the preceding cloud services, the following cloud services also support event monitoring. For details about monitored events, see Events Supported by Event", "doc_type":"api", "kw":"Services Interconnected with Cloud Eye,Appendix,API Reference", "search_title":"", @@ -690,8 +1752,8 @@ "uri":"ces_01_0054.html", "node_id":"ces_01_0054.xml", "product_code":"ces", - "code":"39", - "des":"Events in Event Monitoring come from operations on cloud service resources and are not collected by the Agent in Server Monitoring.Once a physical host running ECSs break", + "code":"98", + "des":"Events in Event Monitoring come from operations on cloud service resources and are not collected by the Agent in Server Monitoring.The name of a resource that supports ev", "doc_type":"api", "kw":"Events Supported by Event Monitoring,Appendix,API Reference", "search_title":"", @@ -708,7 +1770,7 @@ "uri":"ces_03_0060.html", "node_id":"ces_03_0060.xml", "product_code":"ces", - "code":"40", + "code":"99", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Change History,API Reference", diff --git a/docs/ces/api-ref/AddAlarmRuleResources.html b/docs/ces/api-ref/AddAlarmRuleResources.html new file mode 100644 index 000000000..108f7775e --- /dev/null +++ b/docs/ces/api-ref/AddAlarmRuleResources.html @@ -0,0 +1,315 @@ + + +

Batch Adding Resources to an Alarm Rule

+

Function

This API is used to batch add resources to an alarm rule. This API does not support alarm rules with Monitoring Scope set to Resource groups or All resources. To modify resources in such alarm rules, use the resource group management APIs.

+
+

URI

POST /v2/{project_id}/alarms/{alarm_id}/resources/batch-create

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

alarm_id

+

Yes

+

String

+

Alarm rule ID.

+

Regular expression matching: al([a-z]|[A-Z]|[0-9]){22}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

No

+

String

+

MIME type of the request body. The default value is application/json; charset=UTF-8.

+

Default: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

No

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

resources

+

Yes

+

Array of arrays of Dimension objects

+

Resource information.

+

Array length: 0 to 1000

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 Dimension

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Dimension of a resource. For example, the dimension of an ECS can be instance_id. A maximum of four dimensions are supported. For the metric dimension of each resource, see Service Metric Dimensions.

+

Regular expression matching: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$

+

value

+

No

+

String

+

Resource dimension value, that is, the instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755.

+

Regular expression matching:

+
^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$
+
+
NOTE:

To add a resource, you need to specify the value. If no value is specified, the API skips the addition without returning an error.

+
+
+
+
+

Response Parameters

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Adding resources to an alarm rule

+
{
+  "resources" : [ [ {
+    "name" : "rds_cluster_id",
+    "value" : "rds000000000001"
+  } ] ]
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Resources added.

+

400

+

Parameter verification failed.

+

404

+

Resources not found.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resources in an Alarm Rule
+
+
+ diff --git a/docs/ces/api-ref/BatchCreateResources.html b/docs/ces/api-ref/BatchCreateResources.html new file mode 100644 index 000000000..1a0948fb2 --- /dev/null +++ b/docs/ces/api-ref/BatchCreateResources.html @@ -0,0 +1,365 @@ + + +

Batch Adding Associated Resources to a Custom Resource Group

+

Function

This API is used to batch add associated resources to a custom resource group whose type is Manual.

+
+

URI

POST /v2/{project_id}/resource-groups/{group_id}/resources/batch-create

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

group_id

+

Yes

+

String

+

Resource group ID. The value starts with rg and is followed by 22 characters of letters, digits, or a combination of both.

+

Minimum: 24

+

Maximum: 24

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

resources

+

Yes

+

Array of Resource objects

+

Resource information.

+

Array length: 1 to 1000

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 Resource

Parameter

+

Mandatory

+

Type

+

Description

+

namespace

+

Yes

+

String

+

Namespace of a service. For details about the namespace of each service, see Service Namespaces. The namespace must be in the service.item format and contain 3 to 32 characters. service and item must start with a letter and can contain only letters, digits, and underscores (_).

+

Minimum: 3

+

Maximum: 32

+

dimensions

+

Yes

+

Array of Dimension objects

+

Resource dimension information.

+

Array length: 1 to 4

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 Dimension

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Dimension of a resource. For example, the dimension of an ECS can be instance_id. A maximum of four dimensions are supported. For the metric dimension of each resource, see Service Metric Dimensions.

+

Regular expression matching: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$

+

value

+

Yes

+

String

+

Resource dimension value, which is an instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755.

+

Regular expression matching:

+
^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$
+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

succeed_count

+

Integer

+

Number of resources that were added.

+

Minimum: 0

+

Maximum: 1000

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Batch adding associated resources to a custom resource group

+
{
+  "resources" : [ {
+    "namespace" : "SYS.ECS",
+    "dimensions" : [ {
+      "name" : "instance_id",
+      "value" : "4270ff17-aba3-4138-89fa-820594c39755"
+    } ]
+  } ]
+}
+
+

Example Responses

Status code: 200

+

Resources added.

+
{
+  "succeed_count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Resources added.

+

400

+

Parameter verification failed.

+

404

+

Resources not found.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resources in a Resource Group
+
+
+ diff --git a/docs/ces/api-ref/BatchDeleteAlarmRules.html b/docs/ces/api-ref/BatchDeleteAlarmRules.html new file mode 100644 index 000000000..607ca7ff3 --- /dev/null +++ b/docs/ces/api-ref/BatchDeleteAlarmRules.html @@ -0,0 +1,244 @@ + + +

Deleting Alarm Rules in Batches

+

Function

This API (V2) is used to batch delete alarm rules.

+
+

URI

POST /v2/{project_id}/alarms/batch-delete

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

No

+

String

+

MIME type of the request body.

+

Default: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

No

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

alarm_ids

+

Yes

+

Array of strings

+

IDs of the alarm rules to be deleted in batches.

+

Array length: 1 to 10

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

alarm_ids

+

Array of strings

+

IDs of the alarm rules that are deleted.

+

Array length: 1 to 10

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Batch deleting alarm rules

+
{
+  "alarm_ids" : [ "al12345678901234567890" ]
+}
+
+

Example Responses

Status code: 200

+

Alarm rule deleted.

+
{
+  "alarm_ids" : [ "alCzk8o9dtSQHtiDgb44Eepw" ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Alarm rule deleted.

+

400

+

Parameter verification failed.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm Rules
+
+
+ diff --git a/docs/ces/api-ref/BatchDeleteAlarmTemplates.html b/docs/ces/api-ref/BatchDeleteAlarmTemplates.html new file mode 100644 index 000000000..f2835e664 --- /dev/null +++ b/docs/ces/api-ref/BatchDeleteAlarmTemplates.html @@ -0,0 +1,332 @@ + + +

Batch Deleting Custom Alarm Templates

+

Function

This API is used to delete custom alarm templates in batches.

+
+

URI

POST /v2/{project_id}/alarm-templates/batch-delete

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

template_ids

+

Yes

+

Array of strings

+

IDs of the alarm templates to be deleted in batches. Alarm templates that are not associated with alarm rules can be deleted in batches. For alarm templates that are associated with alarm rules, you can delete only one alarm template at a time. If you delete multiple ones, an exception will be returned.

+

Array length: 1 to 100

+

delete_associate_alarm

+

Yes

+

Boolean

+

Whether alarm rules associated with an alarm template will be deleted when you delete the alarm template. true indicates that the alarm rules will be deleted. false indicates that only the alarm template will be deleted.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

template_ids

+

Array of strings

+

IDs of alarm templates that were deleted.

+

Array length: 1 to 100

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Deleting custom alarm templates in batches

+
{
+  "template_ids" : [ "at1628592157541dB1klWgY6" ],
+  "delete_associate_alarm" : false
+}
+
+

Example Responses

Status code: 200

+

IDs of the templates deleted.

+
{
+  "template_ids" : [ "at1628592157541dB1klWgY6" ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

IDs of the templates deleted.

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm Templates
+
+
+ diff --git a/docs/ces/api-ref/BatchDeleteOneClickAlarms.html b/docs/ces/api-ref/BatchDeleteOneClickAlarms.html new file mode 100644 index 000000000..86adf5a34 --- /dev/null +++ b/docs/ces/api-ref/BatchDeleteOneClickAlarms.html @@ -0,0 +1,340 @@ + + +

Batch Disabling One-Click Monitoring

+

Function

This API is used to batch disable one-click monitoring.

+
+

URI

POST /v2/{project_id}/one-click-alarms/batch-delete

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

MIME type of the request body.

+

Default: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

one_click_alarm_ids

+

Yes

+

Array of strings

+

IDs of services that need to disable one-click monitoring.

+

Array length: 1 to 100

+

Range: 1 to 64 characters

+

Regular expression matching: ^([a-z]|[A-Z]|[0-9]){1,64}$

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

one_click_alarm_ids

+

Array of strings

+

IDs of services for which one-click monitoring was disabled.

+

Array length: 1 to 100

+

Range: 1 to 64 characters

+

Regular expression matching: ^([a-z]|[A-Z]|[0-9]){1,64}$

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Batch disable one-click motoring.

+
POST /v2/{project_id}/one-click-alarms/batch-delete
+

Request body:

+
{
+  "one_click_alarm_ids" : [ "o1619578505263QkW3b66yo" ]
+}
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "one_click_alarm_ids" : [ "o1619578505263QkW3b66yo" ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: One-Click Monitoring
+
+
+ diff --git a/docs/ces/api-ref/BatchDeleteResourceGroups.html b/docs/ces/api-ref/BatchDeleteResourceGroups.html new file mode 100644 index 000000000..0e7283e0c --- /dev/null +++ b/docs/ces/api-ref/BatchDeleteResourceGroups.html @@ -0,0 +1,322 @@ + + +

Batch Deleting Resource Groups

+

Function

This API is used to delete resource groups in batches.

+
+

URI

POST /v2/{project_id}/resource-groups/batch-delete

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

group_ids

+

Yes

+

Array of strings

+

IDs of resource groups to be deleted in batches.

+

Array length: 1 to 100

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

group_ids

+

Array of strings

+

IDs of resource groups that were deleted.

+

Array length: 1 to 100

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Batch deleting resource groups

+
{
+  "group_ids" : [ "rg1761380163308Dxxxxxxxx" ]
+}
+
+

Example Responses

Status code: 200

+

IDs of resource groups that were deleted

+
{
+  "group_ids" : [ "rg1761380163308Dxxxxxxxx" ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

IDs of resource groups that were successfully deleted.

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Groups
+
+
+ diff --git a/docs/ces/api-ref/BatchDeleteResources.html b/docs/ces/api-ref/BatchDeleteResources.html new file mode 100644 index 000000000..362c94d47 --- /dev/null +++ b/docs/ces/api-ref/BatchDeleteResources.html @@ -0,0 +1,365 @@ + + +

Batch Deleting Associated Resources from a Custom Resource Group

+

Function

This API is used to batch delete associated resources from a custom resource group whose type is Manual.

+
+

URI

POST /v2/{project_id}/resource-groups/{group_id}/resources/batch-delete

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

group_id

+

Yes

+

String

+

Resource group ID. The value starts with rg and is followed by 22 characters of letters, digits, or a combination of both.

+

Minimum: 24

+

Maximum: 24

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

resources

+

Yes

+

Array of Resource objects

+

Resource information.

+

Array length: 1 to 1000

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 Resource

Parameter

+

Mandatory

+

Type

+

Description

+

namespace

+

Yes

+

String

+

Namespace of a service. For details about the namespace of each service, see Service Namespaces. The namespace must be in the service.item format and contain 3 to 32 characters. service and item must start with a letter and can contain only letters, digits, and underscores (_).

+

Minimum: 3

+

Maximum: 32

+

dimensions

+

Yes

+

Array of Dimension objects

+

Resource dimension information.

+

Array length: 1 to 4

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 Dimension

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Dimension of a resource. For example, the dimension of an ECS can be instance_id. A maximum of four dimensions are supported. For the metric dimension of each resource, see Service Metric Dimensions.

+

Regular expression matching: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$

+

value

+

Yes

+

String

+

Resource dimension value, which is an instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755.

+

Regular expression matching:

+
^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$
+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

succeed_count

+

Integer

+

Number of resources that were deleted.

+

Minimum: 0

+

Maximum: 1000

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Batch deleting associated resources from a custom resource group

+
{
+  "resources" : [ {
+    "namespace" : "SYS.ECS",
+    "dimensions" : [ {
+      "name" : "instance_id",
+      "value" : "4270ff17-aba3-4138-89fa-820594c39755"
+    } ]
+  } ]
+}
+
+

Example Responses

Status code: 200

+

Resources deleted.

+
{
+  "succeed_count" : 1
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Resources deleted.

+

400

+

Parameter verification failed.

+

404

+

Resources not found.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resources in a Resource Group
+
+
+ diff --git a/docs/ces/api-ref/BatchEnableAlarmRules.html b/docs/ces/api-ref/BatchEnableAlarmRules.html new file mode 100644 index 000000000..df0e5c35e --- /dev/null +++ b/docs/ces/api-ref/BatchEnableAlarmRules.html @@ -0,0 +1,254 @@ + + +

Enabling or Disabling Alarm Rules in Batches

+

Function

This API is used to enable or disable alarm rules in batches.

+
+

URI

POST /v2/{project_id}/alarms/action

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

No

+

String

+

MIME type of the request body. The default value is application/json; charset=UTF-8.

+

Default: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

No

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

alarm_ids

+

Yes

+

Array of strings

+

IDs of alarm rules to be enabled or disabled in batches.

+

Array length: 1 to 100

+

alarm_enabled

+

Yes

+

Boolean

+

Whether to generate alarms when the alarm triggering conditions are met.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

alarm_ids

+

Array of strings

+

IDs of alarm rules that were enabled or disabled.

+

Array length: 1 to 100

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Enable or disable alarm rules in batches.

+
{
+  "alarm_ids" : [ "al12345678901234567890" ],
+  "alarm_enabled" : true
+}
+
+

Example Responses

Status code: 200

+

Alarm rules enabled or disabled.

+
{
+  "alarm_ids" : [ "alCzk8o9dtSQHtiDgb44Eepw" ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Alarm rules enabled or disabled.

+

400

+

Parameter verification failed.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm Rules
+
+
+ diff --git a/docs/ces/api-ref/BatchUpdateOneClickAlarmPoliciesEnabledState.html b/docs/ces/api-ref/BatchUpdateOneClickAlarmPoliciesEnabledState.html new file mode 100644 index 000000000..e368f939f --- /dev/null +++ b/docs/ces/api-ref/BatchUpdateOneClickAlarmPoliciesEnabledState.html @@ -0,0 +1,416 @@ + + +

Batch Enabling or Disabling Alarm Policies in Alarm Rules for One Service with One-Click Monitoring Enabled

+

Function

This API is used to batch enable or disable alarm policies in alarm rules for one service with one-click monitoring enabled.

+
+

URI

PUT /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/alarms/{alarm_id}/policies/action

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

one_click_alarm_id

+

Yes

+

String

+

One-click monitoring ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^([a-z]|[A-Z]|[0-9]){1,64}$

+

alarm_id

+

Yes

+

String

+

Alarm rule ID.

+

Minimum: 24

+

Maximum: 24

+

Regular expression matching: ^al([0-9A-Za-z]){22}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. The default value is application/json; charset=UTF-8.

+

Default: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

alarm_policy_ids

+

Yes

+

Array of strings

+

IDs of alarm policies to be enabled or disabled in batches in an alarm rule.

+

Array length: 1 to 100

+

Regular expression matching: ^([a-z]|[A-Z]|[0-9]|-)+$

+

enabled

+

Yes

+

Boolean

+

Whether to enable the function. The value can be true (enable) or false (disable).

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

alarm_policy_ids

+

Array of strings

+

IDs of alarm policies that were enabled or disabled in batches in an alarm rule.

+

Array length: 1 to 100

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Batch enable or disable alarm policies in alarm rules for one service that has one-click monitoring enabled.

+
POST /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/alarms/{alarm_id}/policies/action
+

Request body:

+
{
+  "alarm_policy_ids" : [ "alxdxxxdsw12321321" ],
+  "enabled" : true
+}
+
+

Example Responses

Status code: 200

+

Alarm policies enabled or disabled.

+
{
+  "alarm_policy_ids" : [ "alxdxxxdsw12321321" ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Alarm policies enabled or disabled.

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

404

+

Resources not found.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: One-Click Monitoring
+
+
+ diff --git a/docs/ces/api-ref/BatchUpdateOneClickAlarmsEnabledState.html b/docs/ces/api-ref/BatchUpdateOneClickAlarmsEnabledState.html new file mode 100644 index 000000000..cba9999d5 --- /dev/null +++ b/docs/ces/api-ref/BatchUpdateOneClickAlarmsEnabledState.html @@ -0,0 +1,403 @@ + + +

Batch Enabling or Disabling Alarm Rules of One Service in One-Click Monitoring

+

Function

This API is used to batch enable or disable alarm rules for one service that has one-click monitoring enabled.

+
+

URI

PUT /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/alarm-rules/action

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

one_click_alarm_id

+

Yes

+

String

+

One-click monitoring ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^([a-z]|[A-Z]|[0-9]){1,64}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. The default value is application/json; charset=UTF-8.

+

Default: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

alarm_ids

+

Yes

+

Array of strings

+

IDs of alarm rules to be enabled or disabled in batches.

+

Array length: 1 to 100

+

alarm_enabled

+

Yes

+

Boolean

+

Whether to generate alarms when the alarm triggering conditions are met. The value can be true (enable) or false (disable).

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

alarm_ids

+

Array of strings

+

IDs of alarm rules that were enabled or disabled.

+

Array length: 1 to 100

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Batch enable or disable alarm rules for a service in one-click monitoring.

+
PUT /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/alarm-rules/action
+

Request body:

+
{
+  "alarm_ids" : [ "al1759030688878rovaxxxxx" ],
+  "alarm_enabled" : true
+}
+
+

Example Responses

Status code: 200

+

Alarm rules enabled or disabled.

+
{
+  "alarm_ids" : [ "al1759030688878rovaxxxxx" ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Alarm rules enabled or disabled.

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

404

+

Resources not found.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: One-Click Monitoring
+
+
+ diff --git a/docs/ces/api-ref/CLASS.TXT.json b/docs/ces/api-ref/CLASS.TXT.json index 5908c2fa7..6aa44817f 100644 --- a/docs/ces/api-ref/CLASS.TXT.json +++ b/docs/ces/api-ref/CLASS.TXT.json @@ -11,7 +11,7 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ces", - "title":"API Description", + "title":"API V1", "uri":"ces_03_0018.html", "doc_type":"api", "p_code":"", @@ -116,6 +116,51 @@ "p_code":"8", "code":"13" }, + { + "desc":"This API is used to create a custom alarm template to add alarm rules for one or more metrics.POST /V1.0/{project_id}/alarm-templateParameter descriptionParameter descrip", + "product_code":"ces", + "title":"Creating a Custom Alarm Template", + "uri":"ces_03_0062.html", + "doc_type":"api", + "p_code":"8", + "code":"14" + }, + { + "desc":"This API is used to delete a custom alarm template.DELETE /V1.0/{project_id}/alarm-template/{template_id}Parameter descriptionParameter descriptionParameterMandatoryDescr", + "product_code":"ces", + "title":"Deleting a Custom Alarm Template", + "uri":"ces_03_0063.html", + "doc_type":"api", + "p_code":"8", + "code":"15" + }, + { + "desc":"This API is used to query the alarm history of an alarm rule based on the alarm rule ID.GET /V1.0/{project_id}/alarm-historiesQuerying parameter descriptionQuerying param", + "product_code":"ces", + "title":"Querying the Alarm History of an Alarm Rule", + "uri":"ces_03_0064.html", + "doc_type":"api", + "p_code":"8", + "code":"16" + }, + { + "desc":"This API is used to update a custom alarm template.PUT /V1.0/{project_id}/alarm-template/{template_id}Parameter descriptionParameter descriptionParameterMandatoryDescript", + "product_code":"ces", + "title":"Updating a Custom Alarm Template", + "uri":"ces_03_0066.html", + "doc_type":"api", + "p_code":"8", + "code":"17" + }, + { + "desc":"This API is used to modify an alarm rule.PUT /V1.0/{project_id}/alarms/{alarm_id}Parameter descriptionParameter descriptionParameterMandatoryDescriptionproject_idYesSpeci", + "product_code":"ces", + "title":"Modifying an Alarm Rule", + "uri":"ces_03_0069.html", + "doc_type":"api", + "p_code":"8", + "code":"18" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"ces", @@ -123,7 +168,7 @@ "uri":"ces_03_0032.html", "doc_type":"api", "p_code":"2", - "code":"14" + "code":"19" }, { "desc":"This API is used to query the monitoring data of a specified metric at a specified granularity in a specified time range. You can specify the dimension of data to be quer", @@ -131,8 +176,8 @@ "title":"Querying Monitoring Data of a Metric", "uri":"ces_03_0033.html", "doc_type":"api", - "p_code":"14", - "code":"15" + "p_code":"19", + "code":"20" }, { "desc":"This API is used to add one or more pieces of custom metric monitoring data to solve the problem that the system metrics cannot meet specific service requirements.For det", @@ -140,17 +185,17 @@ "title":"Adding Monitoring Data", "uri":"en-us_topic_0032831274.html", "doc_type":"api", - "p_code":"14", - "code":"16" + "p_code":"19", + "code":"21" }, { - "desc":"You can query the monitoring data of specified metrics within a specified time range and at a specified granularity. You can query the monitoring data of up to 10 metrics", + "desc":"You can query the data of specified metrics within a specified time range and at a specified granularity. You can query the monitoring data of up to 10 metrics in one bat", "product_code":"ces", "title":"Querying Monitoring Data of Multiple Metrics", "uri":"ces_03_0034.html", "doc_type":"api", - "p_code":"14", - "code":"17" + "p_code":"19", + "code":"22" }, { "desc":"This API is used to query the host configuration for a specified event type in a specified time range. You can specify the dimension of data to be queried.This API is pro", @@ -158,8 +203,8 @@ "title":"Querying the Host Configuration", "uri":"ces_03_0035.html", "doc_type":"api", - "p_code":"14", - "code":"18" + "p_code":"19", + "code":"23" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -168,7 +213,7 @@ "uri":"ces_03_0036.html", "doc_type":"api", "p_code":"2", - "code":"19" + "code":"24" }, { "desc":"This API is used to query the alarm rule quota and the number of alarm rules that have been created.GET /V1.0/{project_id}/quotasParameter descriptionParameter descriptio", @@ -176,8 +221,62 @@ "title":"Querying Quotas", "uri":"ces_03_0037.html", "doc_type":"api", - "p_code":"19", - "code":"20" + "p_code":"24", + "code":"25" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"ces", + "title":"Resource Groups", + "uri":"ces_03_0067.html", + "doc_type":"api", + "p_code":"2", + "code":"26" + }, + { + "desc":"This API is used to query resources in a resource group based on the resource group ID.GET /V1.0/{project_id}/resource-groups/{group_id}Parameter descriptionParameter de", + "product_code":"ces", + "title":"Querying Resources in a Resource Group", + "uri":"ces_03_0068.html", + "doc_type":"api", + "p_code":"26", + "code":"27" + }, + { + "desc":"This API is used to create a resource group. You can use resource groups to manage resources by service, and view monitoring and alarm information by group to ease O&M.PO", + "product_code":"ces", + "title":"Creating a Resource Group", + "uri":"ces_03_0070.html", + "doc_type":"api", + "p_code":"26", + "code":"28" + }, + { + "desc":"This API is used to update a resource group. You can use resource groups to manage resources by service, and view monitoring and alarm information by group to ease O&M.PU", + "product_code":"ces", + "title":"Updating a Resource Group", + "uri":"ces_03_0071.html", + "doc_type":"api", + "p_code":"26", + "code":"29" + }, + { + "desc":"This API is used to delete a resource group.DELETE /V1.0/{project_id}/resource-groups/{group_id}Parameter descriptionParameter descriptionParameterTypeMandatoryDescripti", + "product_code":"ces", + "title":"Deleting a Resource Group", + "uri":"ces_03_0072.html", + "doc_type":"api", + "p_code":"26", + "code":"30" + }, + { + "desc":"This API is used to query all resource groups you created.GET /V1.0/{project_id}/resource-groupsParameter descriptionParameter descriptionParameterTypeMandatoryDescripti", + "product_code":"ces", + "title":"Query Resource Groups", + "uri":"ces_03_0073.html", + "doc_type":"api", + "p_code":"26", + "code":"31" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -186,7 +285,7 @@ "uri":"ces_03_0038.html", "doc_type":"api", "p_code":"2", - "code":"21" + "code":"32" }, { "desc":"An API for reporting custom events is provided, which helps you collect and report abnormal events or important change events to Cloud Eye.POST /V1.0/{project_id}/eventsP", @@ -194,8 +293,8 @@ "title":"Reporting Events", "uri":"en-us_topic_0109034020.html", "doc_type":"api", - "p_code":"21", - "code":"22" + "p_code":"32", + "code":"33" }, { "desc":"This API is used to query events, including system events and custom events.GET /V1.0/{project_id}/eventsParameter descriptionParameter descriptionParameterTypeMandatoryD", @@ -203,8 +302,8 @@ "title":"Querying Events", "uri":"ces_03_0074.html", "doc_type":"api", - "p_code":"21", - "code":"23" + "p_code":"32", + "code":"34" }, { "desc":"This API is used to query details of an event based on the event name.GET /V1.0/{project_id}/event/{event_name}Parameter descriptionParameter descriptionParameterTypeMand", @@ -212,8 +311,440 @@ "title":"Querying Details of an Event", "uri":"ces_03_0075.html", "doc_type":"api", - "p_code":"21", - "code":"24" + "p_code":"32", + "code":"35" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"ces", + "title":"API V2", + "uri":"ces_03_0042.html", + "doc_type":"api", + "p_code":"", + "code":"36" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"ces", + "title":"Alarm Rules", + "uri":"topic_300000000.html", + "doc_type":"api", + "p_code":"36", + "code":"37" + }, + { + "desc":"This API is used to create an alarm rule (recommended).POST /v2/{project_id}/alarmsStatus code: 201Status code: 400Status code: 500Create an alarm rule whose name is alar", + "product_code":"ces", + "title":"Creating an Alarm Rule (Recommended)", + "uri":"CreateAlarmRules.html", + "doc_type":"api", + "p_code":"37", + "code":"38" + }, + { + "desc":"This API (V2) is used to batch delete alarm rules.POST /v2/{project_id}/alarms/batch-deleteStatus code: 200Status code: 400Status code: 500Batch deleting alarm rulesStatu", + "product_code":"ces", + "title":"Deleting Alarm Rules in Batches", + "uri":"BatchDeleteAlarmRules.html", + "doc_type":"api", + "p_code":"37", + "code":"39" + }, + { + "desc":"This API is used to enable or disable alarm rules in batches.POST /v2/{project_id}/alarms/actionStatus code: 200Status code: 400Status code: 500Enable or disable alarm ru", + "product_code":"ces", + "title":"Enabling or Disabling Alarm Rules in Batches", + "uri":"BatchEnableAlarmRules.html", + "doc_type":"api", + "p_code":"37", + "code":"40" + }, + { + "desc":"This API is used to query alarm rules.GET /v2/{project_id}/alarmsStatus code: 200Status code: 400Status code: 500Querying alarm rulesStatus code: 200Query succeeded.See E", + "product_code":"ces", + "title":"Querying Alarm Rules (Recommended)", + "uri":"ListAlarmRules.html", + "doc_type":"api", + "p_code":"37", + "code":"41" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"ces", + "title":"Resources in an Alarm Rule", + "uri":"topic_300000001.html", + "doc_type":"api", + "p_code":"36", + "code":"42" + }, + { + "desc":"This API is used to batch add resources to an alarm rule. This API does not support alarm rules with Monitoring Scope set to Resource groups or All resources. To modify r", + "product_code":"ces", + "title":"Batch Adding Resources to an Alarm Rule", + "uri":"AddAlarmRuleResources.html", + "doc_type":"api", + "p_code":"42", + "code":"43" + }, + { + "desc":"This API is used to batch delete resources to an alarm rule. This API does not support alarm rules with Monitoring Scope set to Resource groups. To modify resources in su", + "product_code":"ces", + "title":"Deleting Resources from an Alarm Rule", + "uri":"DeleteAlarmRuleResources.html", + "doc_type":"api", + "p_code":"42", + "code":"44" + }, + { + "desc":"This API is used to query resources in an alarm rule by its ID.GET /v2/{project_id}/alarms/{alarm_id}/resourcesStatus code: 200Status code: 400Status code: 500Querying re", + "product_code":"ces", + "title":"Querying Resources in an Alarm Rule", + "uri":"ListAlarmRuleResources.html", + "doc_type":"api", + "p_code":"42", + "code":"45" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"ces", + "title":"Alarm Policies", + "uri":"topic_300000002.html", + "doc_type":"api", + "p_code":"36", + "code":"46" + }, + { + "desc":"This API is used to modify alarm policies in an alarm rule.PUT /v2/{project_id}/alarms/{alarm_id}/policiesStatus code: 200Status code: 400Status code: 500Modifying an ala", + "product_code":"ces", + "title":"Modifying Policies in an Alarm Rule", + "uri":"UpdateAlarmRulePolicies.html", + "doc_type":"api", + "p_code":"46", + "code":"47" + }, + { + "desc":"This API is used to query alarm policies by alarm rule ID.GET /v2/{project_id}/alarms/{alarm_id}/policiesStatus code: 200Status code: 400Status code: 404Status code: 500Q", + "product_code":"ces", + "title":"Querying Alarm Policies in an Alarm Rule", + "uri":"ListAlarmRulePolicies.html", + "doc_type":"api", + "p_code":"46", + "code":"48" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"ces", + "title":"Alarm Records", + "uri":"topic_300000004.html", + "doc_type":"api", + "p_code":"36", + "code":"49" + }, + { + "desc":"This API is used to query alarm records.GET /v2/{project_id}/alarm-historiesStatus code: 200Status code: 400Status code: 500Querying alarm records whose alarm_name is ala", + "product_code":"ces", + "title":"Querying Alarm Records", + "uri":"ListAlarmHistories.html", + "doc_type":"api", + "p_code":"49", + "code":"50" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"ces", + "title":"Alarm Templates", + "uri":"topic_300000005.html", + "doc_type":"api", + "p_code":"36", + "code":"51" + }, + { + "desc":"This API is used to create a custom alarm template.POST /v2/{project_id}/alarm-templatesStatus code: 201Status code: 400Status code: 401Status code: 403Status code: 500Cr", + "product_code":"ces", + "title":"Creating a Custom Alarm Template", + "uri":"CreateAlarmTemplate.html", + "doc_type":"api", + "p_code":"51", + "code":"52" + }, + { + "desc":"This API is used to delete custom alarm templates in batches.POST /v2/{project_id}/alarm-templates/batch-deleteStatus code: 200Status code: 400Status code: 401Status code", + "product_code":"ces", + "title":"Batch Deleting Custom Alarm Templates", + "uri":"BatchDeleteAlarmTemplates.html", + "doc_type":"api", + "p_code":"51", + "code":"53" + }, + { + "desc":"This API is used to modify a custom alarm template.PUT /v2/{project_id}/alarm-templates/{template_id}Status code: 400Status code: 401Status code: 403Status code: 404Statu", + "product_code":"ces", + "title":"Modifying a Custom Alarm Template", + "uri":"UpdateAlarmTemplate.html", + "doc_type":"api", + "p_code":"51", + "code":"54" + }, + { + "desc":"This API is used to query alarm templates.GET /v2/{project_id}/alarm-templatesStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 500Querying ala", + "product_code":"ces", + "title":"Querying Alarm Templates", + "uri":"ListAlarmTemplates.html", + "doc_type":"api", + "p_code":"51", + "code":"55" + }, + { + "desc":"This API is used to query details of an alarm template.GET /v2/{project_id}/alarm-templates/{template_id}Status code: 200Status code: 400Status code: 401Status code: 403S", + "product_code":"ces", + "title":"Querying Details of an Alarm Template", + "uri":"ShowAlarmTemplate.html", + "doc_type":"api", + "p_code":"51", + "code":"56" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"ces", + "title":"Alarm Rules Associated with an Alarm Template", + "uri":"topic_300000006.html", + "doc_type":"api", + "p_code":"36", + "code":"57" + }, + { + "desc":"This API is used to query alarm rules associated with an alarm template.GET /v2/{project_id}/alarm-templates/{template_id}/association-alarmsStatus code: 200Status code: ", + "product_code":"ces", + "title":"Querying Alarm Rules Associated with an Alarm Template", + "uri":"ListAlarmTemplateAssociationAlarms.html", + "doc_type":"api", + "p_code":"57", + "code":"58" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"ces", + "title":"Resource Groups", + "uri":"topic_300000007.html", + "doc_type":"api", + "p_code":"36", + "code":"59" + }, + { + "desc":"This API is used to create a resource group (recommended).POST /v2/{project_id}/resource-groupsStatus code: 200Status code: 400Status code: 401Status code: 403Status code", + "product_code":"ces", + "title":"Creating a Resource Group (Recommended)", + "uri":"CreateResourceGroup.html", + "doc_type":"api", + "p_code":"59", + "code":"60" + }, + { + "desc":"This API is used to delete resource groups in batches.POST /v2/{project_id}/resource-groups/batch-deleteStatus code: 200Status code: 400Status code: 401Status code: 403St", + "product_code":"ces", + "title":"Batch Deleting Resource Groups", + "uri":"BatchDeleteResourceGroups.html", + "doc_type":"api", + "p_code":"59", + "code":"61" + }, + { + "desc":"This API is used to modify a resource group.PUT /v2/{project_id}/resource-groups/{group_id}Status code: 400Status code: 401Status code: 403Status code: 404Status code: 50", + "product_code":"ces", + "title":"Modifying a Resource Group", + "uri":"UpdateResourceGroup.html", + "doc_type":"api", + "p_code":"59", + "code":"62" + }, + { + "desc":"This API is used to query details of a resource group.GET /v2/{project_id}/resource-groups/{group_id}Status code: 200Status code: 400Status code: 401Status code: 403Statu", + "product_code":"ces", + "title":"Querying Details of a Resource Group", + "uri":"ShowResourceGroup.html", + "doc_type":"api", + "p_code":"59", + "code":"63" + }, + { + "desc":"This API is used to query resource groups.GET /v2/{project_id}/resource-groupsStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 500Querying res", + "product_code":"ces", + "title":"Querying Resource Groups", + "uri":"ListResourceGroups.html", + "doc_type":"api", + "p_code":"59", + "code":"64" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"ces", + "title":"Resources in a Resource Group", + "uri":"topic_300000008.html", + "doc_type":"api", + "p_code":"36", + "code":"65" + }, + { + "desc":"This API is used to batch add associated resources to a custom resource group whose type is Manual.POST /v2/{project_id}/resource-groups/{group_id}/resources/batch-create", + "product_code":"ces", + "title":"Batch Adding Associated Resources to a Custom Resource Group", + "uri":"BatchCreateResources.html", + "doc_type":"api", + "p_code":"65", + "code":"66" + }, + { + "desc":"This API is used to batch delete associated resources from a custom resource group whose type is Manual.POST /v2/{project_id}/resource-groups/{group_id}/resources/batch-d", + "product_code":"ces", + "title":"Batch Deleting Associated Resources from a Custom Resource Group", + "uri":"BatchDeleteResources.html", + "doc_type":"api", + "p_code":"65", + "code":"67" + }, + { + "desc":"This API is used to query resources of a specified dimension for a specified resource type in a resource group.GET /v2/{project_id}/resource-groups/{group_id}/services/{s", + "product_code":"ces", + "title":"Querying Resources of a Specified Dimension for a Specified Service Type in a Resource Group", + "uri":"ListResourceGroupsServicesResources.html", + "doc_type":"api", + "p_code":"65", + "code":"68" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"ces", + "title":"One-Click Monitoring", + "uri":"topic_300000009.html", + "doc_type":"api", + "p_code":"36", + "code":"69" + }, + { + "desc":"This API is used to enable one-click monitoring.POST /v2/{project_id}/one-click-alarmsStatus code: 201Status code: 400Status code: 401Status code: 403Status code: 500Stat", + "product_code":"ces", + "title":"Enabling One-Click Monitoring", + "uri":"CreateOneClickAlarm.html", + "doc_type":"api", + "p_code":"69", + "code":"70" + }, + { + "desc":"This API is used to query services and resources in one-click monitoring.GET /v2/{project_id}/one-click-alarmsStatus code: 200Status code: 400Status code: 401Status code:", + "product_code":"ces", + "title":"Querying Services and Resources in One-Click Monitoring", + "uri":"ListOneClickAlarms.html", + "doc_type":"api", + "p_code":"69", + "code":"71" + }, + { + "desc":"This API is used to query alarm rules for one service in one-click monitoring.GET /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/alarmsStatus code: 200Status code", + "product_code":"ces", + "title":"Querying Alarm Rules for One Service in One-Click Monitoring", + "uri":"ListOneClickAlarmRules.html", + "doc_type":"api", + "p_code":"69", + "code":"72" + }, + { + "desc":"This API is used to batch enable or disable alarm rules for one service that has one-click monitoring enabled.PUT /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/a", + "product_code":"ces", + "title":"Batch Enabling or Disabling Alarm Rules of One Service in One-Click Monitoring", + "uri":"BatchUpdateOneClickAlarmsEnabledState.html", + "doc_type":"api", + "p_code":"69", + "code":"73" + }, + { + "desc":"This API is used to batch disable one-click monitoring.POST /v2/{project_id}/one-click-alarms/batch-deleteStatus code: 200Status code: 400Status code: 401Status code: 403", + "product_code":"ces", + "title":"Batch Disabling One-Click Monitoring", + "uri":"BatchDeleteOneClickAlarms.html", + "doc_type":"api", + "p_code":"69", + "code":"74" + }, + { + "desc":"This API is used to batch modify alarm notifications in alarm rules for one service with one-click monitoring enabled.PUT /v2/{project_id}/one-click-alarms/{one_click_ala", + "product_code":"ces", + "title":"Batch Modifying Alarm Notifications in Alarm Rules for One Service with One-Click Monitoring Enabled", + "uri":"UpdateOneClickAlarmNotifications.html", + "doc_type":"api", + "p_code":"69", + "code":"75" + }, + { + "desc":"This API is used to batch enable or disable alarm policies in alarm rules for one service with one-click monitoring enabled.PUT /v2/{project_id}/one-click-alarms/{one_cli", + "product_code":"ces", + "title":"Batch Enabling or Disabling Alarm Policies in Alarm Rules for One Service with One-Click Monitoring Enabled", + "uri":"BatchUpdateOneClickAlarmPoliciesEnabledState.html", + "doc_type":"api", + "p_code":"69", + "code":"76" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"ces", + "title":"Dashboards", + "uri":"topic_300000011.html", + "doc_type":"api", + "p_code":"36", + "code":"77" + }, + { + "desc":"This API is used to create or copy a dashboard.POST /v2/{project_id}/dashboardsStatus code: 201Status code: 400Status code: 401Status code: 500Create a dashboard.Copy a d", + "product_code":"ces", + "title":"Creating or Copying a Dashboard", + "uri":"CreateOneDashboard.html", + "doc_type":"api", + "p_code":"77", + "code":"78" + }, + { + "desc":"This API is used to query dashboards.GET /v2/{project_id}/dashboardsStatus code: 200Status code: 400Status code: 401Status code: 500NoneStatus code: 200OKSee Error Codes.", + "product_code":"ces", + "title":"Querying Dashboards", + "uri":"ListDashboardInfos.html", + "doc_type":"api", + "p_code":"77", + "code":"79" + }, + { + "desc":"This API is used to modify a dashboard.PUT /v2/{project_id}/dashboards/{dashboard_id}Status code: 400Status code: 401Status code: 500NoneSee Error Codes.", + "product_code":"ces", + "title":"Modifying a Dashboard", + "uri":"UpdateDashboard.html", + "doc_type":"api", + "p_code":"77", + "code":"80" + }, + { + "desc":"This API is used to delete dashboards in batches.POST /v2/{project_id}/dashboards/batch-deleteStatus code: 200Status code: 400Status code: 401Status code: 500Status code:", + "product_code":"ces", + "title":"Batch Deleting Dashboards", + "uri":"DeleteDashboards.html", + "doc_type":"api", + "p_code":"77", + "code":"81" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"ces", + "title":"Metric Management", + "uri":"topic_300000014.html", + "doc_type":"api", + "p_code":"36", + "code":"82" + }, + { + "desc":"This API is used to query metrics based on the ECS or BMS ID and from the following dimensions: disk, mount point, process, graphics card, and RAID controller. The NPU di", + "product_code":"ces", + "title":"Querying Server Monitoring Metrics", + "uri":"ListAgentDimensionInfo.html", + "doc_type":"api", + "p_code":"82", + "code":"83" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -222,7 +753,7 @@ "uri":"ces_03_0045.html", "doc_type":"api", "p_code":"", - "code":"25" + "code":"84" }, { "desc":"This chapter describes fine-grained permissions management for your Cloud Eye. If your account does not need individual IAM users, then you may skip over this chapter.Po", @@ -230,8 +761,8 @@ "title":"Introduction", "uri":"ces_03_0046.html", "doc_type":"api", - "p_code":"25", - "code":"26" + "p_code":"84", + "code":"85" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -239,8 +770,8 @@ "title":"Supported Actions of the API Version Management APIs", "uri":"ces_03_0047.html", "doc_type":"api", - "p_code":"25", - "code":"27" + "p_code":"84", + "code":"86" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -248,8 +779,8 @@ "title":"Supported Actions of the Metric Management API", "uri":"ces_03_0048.html", "doc_type":"api", - "p_code":"25", - "code":"28" + "p_code":"84", + "code":"87" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -257,8 +788,8 @@ "title":"Supported Actions of the Alarm Rule Management APIs", "uri":"ces_03_0049.html", "doc_type":"api", - "p_code":"25", - "code":"29" + "p_code":"84", + "code":"88" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -266,8 +797,8 @@ "title":"Supported Actions of the Monitoring Data Management APIs", "uri":"ces_03_0050.html", "doc_type":"api", - "p_code":"25", - "code":"30" + "p_code":"84", + "code":"89" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -275,8 +806,8 @@ "title":"Supported Actions of the Quota Management API", "uri":"ces_03_0051.html", "doc_type":"api", - "p_code":"25", - "code":"31" + "p_code":"84", + "code":"90" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -284,8 +815,8 @@ "title":"Supported Actions of the Event Monitoring API", "uri":"ces_03_0052.html", "doc_type":"api", - "p_code":"25", - "code":"32" + "p_code":"84", + "code":"91" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -294,7 +825,7 @@ "uri":"ces_03_0053.html", "doc_type":"api", "p_code":"", - "code":"33" + "code":"92" }, { "desc":"NormalReturned ValueDescription200 OKThe results of GET and PUT operations are returned as expected.201 CreatedThe results of the POST operation are returned as expected.", @@ -302,8 +833,8 @@ "title":"Status Codes", "uri":"ces_03_0055.html", "doc_type":"api", - "p_code":"33", - "code":"34" + "p_code":"92", + "code":"93" }, { "desc":"If an error occurs during API calling, the system returns error information. This section describes the error codes contained in the error information for Cloud Eye APIs.", @@ -311,8 +842,8 @@ "title":"Error Codes", "uri":"ErrorCode.html", "doc_type":"api", - "p_code":"33", - "code":"35" + "p_code":"92", + "code":"94" }, { "desc":"A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:Obtain the Project ID by Ca", @@ -320,8 +851,8 @@ "title":"Obtaining a Project ID", "uri":"ces_03_0057.html", "doc_type":"api", - "p_code":"33", - "code":"36" + "p_code":"92", + "code":"95" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -330,25 +861,25 @@ "uri":"ces_03_0058.html", "doc_type":"api", "p_code":"", - "code":"37" + "code":"96" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"In addition to the preceding cloud services, the following cloud services also support event monitoring. For details about monitored events, see Events Supported by Event", "product_code":"ces", "title":"Services Interconnected with Cloud Eye", "uri":"ces_03_0059.html", "doc_type":"api", - "p_code":"37", - "code":"38" + "p_code":"96", + "code":"97" }, { - "desc":"Events in Event Monitoring come from operations on cloud service resources and are not collected by the Agent in Server Monitoring.Once a physical host running ECSs break", + "desc":"Events in Event Monitoring come from operations on cloud service resources and are not collected by the Agent in Server Monitoring.The name of a resource that supports ev", "product_code":"ces", "title":"Events Supported by Event Monitoring", "uri":"ces_01_0054.html", "doc_type":"api", - "p_code":"37", - "code":"39" + "p_code":"96", + "code":"98" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -357,6 +888,6 @@ "uri":"ces_03_0060.html", "doc_type":"api", "p_code":"", - "code":"40" + "code":"99" } ] \ No newline at end of file diff --git a/docs/ces/api-ref/CreateAlarmRules.html b/docs/ces/api-ref/CreateAlarmRules.html new file mode 100644 index 000000000..d3087cb0f --- /dev/null +++ b/docs/ces/api-ref/CreateAlarmRules.html @@ -0,0 +1,675 @@ + + +

Creating an Alarm Rule (Recommended)

+

Function

This API is used to create an alarm rule (recommended).

+
+

URI

POST /v2/{project_id}/alarms

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

MIME type of the request body.

+

Default: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

No

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Name of an alarm rule. The name allows 1 to 128 characters and can only contain letters, digits, underscores (_), and hyphens (-).

+

description

+

No

+

String

+

Alarm rule description. The value can contain 0 to 256 characters.

+

namespace

+

Yes

+

String

+

Namespace of a service. For details about the namespace of each service, see Service Namespaces. The namespace must be in the service.item format and contain 3 to 32 characters. The values of service and item must start with a letter and can only contain letters, digits, and underscores (_).

+

Minimum: 3

+

Maximum: 32

+

resource_group_id

+

No

+

String

+

Resource group ID. This parameter is mandatory when the monitoring scope is set to Resource groups.

+

resources

+

Yes

+

Array of arrays of Dimension objects

+

Resource list. If an alarm rule is created for all resources or resources in a resource group, leave the resource dimension blank. If the alarm rule is created for specified resources, the resource dimension value is mandatory, and you can specify multiple resources to be monitored at a time.

+

Array length: 0 to 1000

+

policies

+

No

+

Array of Policy objects

+

Alarm policies.

+

Array length: 1 to 50

+
NOTE:

Either policies or alarm_template_id must be set. If both are specified, the policy in the alarm template is used.

+
+

type

+

Yes

+

String

+

Alarm rule type.

+

The value can be:

+
  • ALL_INSTANCE: alarms for all resources
  • RESOURCE_GROUP: alarms for resource groups
  • MULTI_INSTANCE: alarms for specified resources
  • EVENT.SYS: system event alarms
  • EVENT.CUSTOM: custom event alarms
+

alarm_notifications

+

No

+

Array of Notification objects

+

Action to be triggered by the alarm. Array length: 0 to 10

+

ok_notifications

+

No

+

Array of Notification objects

+

Action to be triggered after an alarm is cleared. Array length: 0 to 10

+

notification_begin_time

+

No

+

String

+

Time when the alarm notification was enabled. Example: 12:00

+

Regular expression matching: ^([01][0-9]|2[0-3]):([0-5][0-9])$

+

notification_end_time

+

No

+

String

+

Time when the alarm notification was disabled. Example: 12:00

+

Regular expression matching: ^([1][0-9]|2[0-3]):([0-5][0-9])$

+

enterprise_project_id

+

No

+

String

+

Enterprise project ID. The value allows 36 characters. It can only contain lowercase letters, hyphens (-), and underscores (_). You can customize an enterprise project ID. The value can also be 0 (default enterprise project ID).

+

Regular expression matching: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$

+

enabled

+

Yes

+

Boolean

+

Whether to generate alarms when the alarm triggering conditions are met.

+

notification_enabled

+

Yes

+

Boolean

+

Whether to enable alarm notification.

+

alarm_template_id

+

No

+

String

+

ID of an alarm template associated with an alarm rule. If this parameter is specified, the policy associated with the alarm rule changes accordingly with the alarm template policy.

+

Minimum: 0

+

Maximum: 64

+

Regular expression matching: ^at([0-9A-Za-z]){0,62}$

+
NOTE:

Either policies or alarm_template_id must be set. If both are specified, the policy in the alarm template is used.

+
+

tags

+

No

+

Array of ResourceTag objects

+

Tenant tags.

+

Array length: 0 to 20

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 Dimension

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Dimension of a resource. For example, the dimension of an ECS can be instance_id. A maximum of four dimensions are supported. For the metric dimension of each resource, see Service Metric Dimensions.

+

Regular expression matching: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$

+

value

+

No

+

String

+

Resource dimension value, which is an instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755.

+

Regular expression matching:

+
^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Policy

Parameter

+

Mandatory

+

Type

+

Description

+

metric_name

+

Yes

+

String

+

Metric name of a resource. The name must start with a letter and contain only digits, letters, and underscores (_). The length ranges from 1 to 64 characters. For example, cpu_util of an ECS indicates the CPU usage of the ECS. mongo001_command_ps in DDS indicates the command execution frequency. For details about the metric name of each service, see Service Metric Names.

+

Regular expression matching: ^([A-Za-z]){1}([0-9A-Za-z]|_|-)*$

+

period

+

Yes

+

Integer

+

Monitoring period of a metric, in seconds. The default value is 0. For an event alarm, set this parameter to 0. 1 indicates the original aggregation period of a metric. For example, if the original aggregation period of an RDS metric is 60s, its data point is calculated every 60 seconds. For details about the original aggregation period of each cloud service metric, see Services Interconnected with Cloud Eye. 300 indicates that the metric aggregation period is 5 minutes.

+

Minimum: 0

+

Maximum: 86400

+

The value can be:

+

  • 0

    +

  • 1

    +

  • 300

    +

  • 1200

    +

  • 3600

    +

  • 14400

    +

  • 86400

    +
+

filter

+

Yes

+

String

+

Data aggregation method. The value can be:

+
  • average: average value of metric data within an aggregation period.
  • max: maximum value of metric data within an aggregation period.
  • min: minimum value of metric data within an aggregation period.
  • sum: sum of metric data within an aggregation period.
  • variance: variance value of metric data within an aggregation period.
+

comparison_operator

+

Yes

+

String

+

Operator of an alarm threshold.

+

Regular expression matching: ^(>|<|>=|<=|=|!=)$

+

value

+

No

+

Number

+

Alarm threshold. Supported range: 0 to Number.MAX_VALUE (1.7976931348623157e+108) For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS cpu_util to 80.

+

Minimum: 0

+

Maximum: 1.7976931348623157e+108

+

unit

+

No

+

String

+

Data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

+

Minimum: 0

+

Maximum: 32

+

count

+

Yes

+

Integer

+

Number of times that the alarm triggering conditions are met. For event alarms, the value ranges from 1 to 180. For metric and website alarms, the value can be 1, 2, 3, 4, 5, 10, 15, 30, 60, 90, 120, or 180.

+

suppress_duration

+

No

+

Integer

+

Alarm suppression time, in seconds. This parameter corresponds to the last field in the alarm policy when an alarm rule is created on the Cloud Eye console. This field is used to avoid frequent alarms. 0 indicates that the alarm is not suppressed and alarms are generated as long as the conditions are met. 300 indicates that an alarm is generated every 5 minutes as long as the alarm triggering conditions are met.

+

Minimum: 0

+

Maximum: 86400

+

The value can be:

+

  • 0

    +

  • 300

    +

  • 600

    +

  • 900

    +

  • 1800

    +

  • 3600

    +

  • 10800

    +

  • 21600

    +

  • 43200

    +

  • 86400

    +
+

level

+

No

+

Integer

+

Alarm severity, which can be 1 (critical), 2 (major), 3 (minor), or 4 (informational). The default value is 2.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 Notification

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

Yes

+

String

+

Notification type.

+

The value can be:

+

notification: topic subscriptions. Notifications are sent using SMN topics.

+

contact: cloud account contact. Notifications are sent to the mobile number and email address registered for your account.

+

notification_list

+

Yes

+

Array of strings

+

List of objects to be notified of alarm status changes. The value of topicUrn can be obtained from SMN. For details, see section "Querying Topics." When type is set to notification, notification_list cannot be left blank. If you set alarm_action_enabled to true, you must specify either alarm_actions or ok_actions. If alarm_actions and ok_actions coexist, their notification_list must be the same.

+

Array length: 0 to 20

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 7 ResourceTag

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Tag key. A tag key can contain a maximum of 128 Unicode characters.

+

Minimum: 1

+

Maximum: 128

+

Regular expression matching: ^((?!\s)(?!_sys_)[\p{L}\p{Z}\p{N}_.:=+\-@]*)(?<!\s)$

+

value

+

Yes

+

String

+

Tag value. Each tag value can contain a maximum of 255 Unicode characters.

+

Minimum: 0

+

Maximum: 255

+

Regular expression matching: ^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$

+
+
+
+

Response Parameters

Status code: 201

+ +
+ + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

alarm_id

+

String

+

ID of an alarm rule, which starts with al and is followed by 22 characters of letters, digits, or a combination of both.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Create an alarm rule whose name is alarm-lxy-rg-RDS, type is RESOURCE_GROUP, suppress_duration is 86400, and level is 2.

+
{
+  "name" : "alarm-lxy-rg-RDS",
+  "description" : "",
+  "namespace" : "SYS.RDS",
+  "type" : "RESOURCE_GROUP",
+  "resources" : [ [ {
+    "name" : "rds_cluster_id",
+    "value" : "rdsxxx"
+  } ] ],
+  "policies" : [ {
+    "metric_name" : "rds001_cpu_util",
+    "period" : 1,
+    "filter" : "average",
+    "comparison_operator" : ">=",
+    "value" : 0,
+    "unit" : "%",
+    "count" : 1,
+    "suppress_duration" : 86400,
+    "level" : 2
+  } ],
+  "enabled" : true,
+  "notification_enabled" : false,
+  "resource_group_id" : "rg1623429506587NbRweoa3J",
+  "enterprise_project_id" : "a9d919b7-0456-4bb8-b470-6a23b64f4f7e",
+  "alarm_template_id" : "at1628592157541dB1klWgY6"
+}
+
Create an alarm rule whose name is alarm-event-tes-05, type is EVENT.SYS, suppress_duration is 0, and level is 2.
{
+  "name" : "alarm-event-test-05",
+  "namespace" : "SYS.ECS",
+  "resources" : [ [ {
+    "name" : "resource_id",
+    "value" : "2ffxxx"
+  } ] ],
+  "policies" : [ {
+    "metric_name" : "instance_resize_executing",
+    "period" : 0,
+    "filter" : "average",
+    "comparison_operator" : ">=",
+    "unit" : "count",
+    "count" : 1,
+    "suppress_duration" : 0,
+    "level" : 2
+  } ],
+  "type" : "EVENT.SYS",
+  "enabled" : true,
+  "notification_enabled" : false
+}
+
+
+

Example Responses

Status code: 201

+

Alarm rule created.

+
{
+  "alarm_id" : "alCzk8o9dtSQHtiDgb44Eepw"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + +

Status Code

+

Description

+

201

+

Alarm rule created.

+

400

+

Parameter verification failed.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm Rules
+
+
+ diff --git a/docs/ces/api-ref/CreateAlarmTemplate.html b/docs/ces/api-ref/CreateAlarmTemplate.html new file mode 100644 index 000000000..49d0da553 --- /dev/null +++ b/docs/ces/api-ref/CreateAlarmTemplate.html @@ -0,0 +1,541 @@ + + +

Creating a Custom Alarm Template

+

Function

This API is used to create a custom alarm template.

+
+

URI

POST /v2/{project_id}/alarm-templates

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

template_name

+

Yes

+

String

+

Alarm template name. It must start with a letter and can contain letters, digits, underscores (_), hyphens (-), parentheses, and periods (.). Fuzzy match is supported.

+

Minimum: 1

+

Maximum: 128

+

Regular expression matching:

+
^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-|\(|\)|\.|\s)+$
+

template_type

+

No

+

Integer

+

Type of a custom alarm template.

+

The value can be:

+

  • 0: metric template

    +

  • 2: event template

    +
+

template_description

+

No

+

String

+

Supplementary information about an alarm template. The description can contain 0 to 256 characters and is left blank by default.

+

policies

+

Yes

+

Array of Policies objects

+

Alarm policies in an alarm template.

+

Array length: 1 to 50

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Policies

Parameter

+

Mandatory

+

Type

+

Description

+

namespace

+

Yes

+

String

+

Namespace.

+

Namespace of a service. For details about the namespace of each service, see Service Namespaces. The namespace must be in the service.item format and contain 3 to 32 characters. service and item must start with a letter and can contain only letters, digits, and underscores (_).

+

Minimum: 3

+

Maximum: 32

+

dimension_name

+

No

+

String

+

Resource dimension, which must start with a letter. A dimension allows a maximum of 32 characters can only contain digits, letters, underscores (_), and hyphens (-). If there are multiple dimensions, use commas (,) to separate them. DimensionName in event alarm templates must be left blank.

+

metric_name

+

Yes

+

String

+

Metric name of a resource. For details about the metrics of each service, see Service Metric Names. The value must start with a letter and can only contain digits, letters, underscores (_), and hyphens (-). It allows 1 to 96 characters. For example, the ECS metric cpu_util indicates the CPU usage of an ECS. The DDS metric mongo001_command_ps indicates the command execution frequency.

+

Regular expression matching: ^([A-Za-z]){1}([0-9A-Za-z]|_|-)*$

+

period

+

Yes

+

Integer

+

Interval (seconds) for checking whether the alarm rule conditions are met.

+

0: default value. For example, this value can be used for event alarms.

+

1: original aggregation period of a metric. For example, if the original aggregation period of an RDS metric is 60s, its data point is calculated every 60 seconds. For details about the original aggregation period of each cloud service metric, see Services Interconnected with Cloud Eye.

+

300: The metric data is collected and calculated every 5 minutes.

+

1200: The metric data is collected and calculated every 20 minutes.

+

3600: The metric data is collected and calculated every 1 hour.

+

14400: The metric data is collected and calculated every 4 hours.

+

86400: The metric data is collected and calculated every day.

+

The value can be:

+

  • 0

    +

  • 1

    +

  • 300

    +

  • 1200

    +

  • 3600

    +

  • 14400

    +

  • 86400

    +
+

filter

+

Yes

+

String

+

Data aggregation method. The value can be:

+
  • average: average value of metric data within an aggregation period.
  • max: maximum value of metric data in an aggregation period.
  • min: minimum value of metric data within an aggregation period.
  • sum: sum of metric data within an aggregation period.
  • variance: variance value of metric data within an aggregation period.
+

comparison_operator

+

Yes

+

String

+

Operator of an alarm threshold.

+

Regular expression matching: ^(>|<|>=|<=|=|!=)$

+

value

+

No

+

Number

+

Alarm threshold.

+

Minimum: 0

+

Maximum: Number.MAX_VALUE (1.7976931348623156E108)

+

unit

+

No

+

String

+

Data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

+

Minimum: 0

+

Maximum: 32

+

count

+

Yes

+

Integer

+

Number of consecutive alarm triggering times. For event alarms, the value ranges from 1 to 180. For metric and website alarms, the value can be 1, 2, 3, 4, 5, 10, 15, 30, 60, 90, 120, or 180.

+

alarm_level

+

No

+

Integer

+

Alarm severity, which can be 1 (critical), 2 (major), 3 (minor), or 4 (warning). The default value is 2.

+

suppress_duration

+

Yes

+

Integer

+

Alarm suppression period, in seconds. When the period is 0, only one alarm is generated.

+

The value can be:

+

  • 0

    +

  • 300

    +

  • 600

    +

  • 900

    +

  • 1800

    +

  • 3600

    +

  • 10800

    +

  • 21600

    +

  • 43200

    +

  • 86400

    +
+
+
+
+

Response Parameters

Status code: 201

+ +
+ + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

template_id

+

String

+

ID of an alarm template. The ID starts with at and is followed by letters, digits, or a combination of both. The value can contain a maximum of 64 characters.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Creating a custom alarm template whose template_name is my_template, count is 2, suppress_duration is 300, and alarm_level is 2
{
+  "template_name" : "my_template",
+  "template_description" : "hello world",
+  "policies" : [ {
+    "namespace" : "SYS.ECS",
+    "dimension_name" : "instance_id",
+    "metric_name" : "cpu_util",
+    "period" : 300,
+    "filter" : "sum",
+    "comparison_operator" : ">",
+    "value" : 2,
+    "unit" : "bit/s",
+    "count" : 2,
+    "alarm_level" : 2,
+    "suppress_duration" : 300
+  } ],
+ "template_type": 0
+}
+
+

Creating an event template whose template_name is my_event_template, metric_name is rebootServer, count is 1, and alarm_level is 2

+
{
+  "template_name" : "my_event_template",
+  "template_description" : "hello world",
+  "policies" : [ {
+    "namespace" : "SYS.ECS",
+    "dimension_name" : "",
+    "metric_name" : "rebootServer",
+    "period" : 0,
+    "filter" : "average",
+    "comparison_operator" : ">=",
+    "value" : 1,
+    "unit" : "count",
+    "count" : 1,
+    "alarm_level" : 2,
+    "suppress_duration" : 0
+  } ],
+ "template_type": 2
+}
+
+

Example Responses

Status code: 201

+

Created

+
{
+  "template_id" : "at1628592157541dB1klWgY6"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

201

+

Created

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm Templates
+
+
+ diff --git a/docs/ces/api-ref/CreateOneClickAlarm.html b/docs/ces/api-ref/CreateOneClickAlarm.html new file mode 100644 index 000000000..87d059451 --- /dev/null +++ b/docs/ces/api-ref/CreateOneClickAlarm.html @@ -0,0 +1,486 @@ + + +

Enabling One-Click Monitoring

+

Function

This API is used to enable one-click monitoring.

+
+

URI

POST /v2/{project_id}/one-click-alarms

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. The default value is application/json; charset=UTF-8.

+

Default: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

one_click_alarm_id

+

Yes

+

String

+

One-click monitoring ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^([a-z]|[A-Z]|[0-9]){1,64}$

+

dimension_name

+

Yes

+

DimensionNames object

+

Dimensions in metric and event alarm rules that have one-click monitoring enabled. One-click monitoring must be enabled for at least one type of alarm rules.

+

notification_enabled

+

Yes

+

Boolean

+

Whether to enable alarm notifications. The value can be true (enabled) or false (disabled).

+

alarm_notifications

+

No

+

Array of Notification objects

+

Action to be triggered by the alarm. Array length: 0 to 10

+

ok_notifications

+

No

+

Array of Notification objects

+

Action to be triggered after an alarm is cleared. Array length: 0 to 10

+

notification_begin_time

+

No

+

String

+

Time when the alarm notification was enabled. Example: 09:00

+

Regular expression matching: ^([01][0-9]|2[0-3]):([0-5][0-9])$

+

notification_end_time

+

No

+

String

+

Time when the alarm notification was disabled. Example: 12:00

+

Regular expression matching: ^([01][0-9]|2[0-3]):([0-5][0-9])$

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 DimensionNames

Parameter

+

Mandatory

+

Type

+

Description

+

metric

+

Yes

+

Array of strings

+

Dimensions in metric alarm rules that have one-click monitoring enabled. One-click monitoring are disabled by default for unspecified dimensions.

+

You must specify either metric or event.

+

Array length: 0 to 100

+

The value is a list of character strings. Each element contains 1 to 131 characters.

+

Regular expression matching:

+
^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-|,)*$
+

event

+

Yes

+

Array of strings

+

Dimensions in event alarm rules that have one-click monitoring enabled. One-click monitoring are disabled by default for unspecified dimensions. "" indicates enable one-click monitoring for all dimensions.

+

You must specify either metric or event.

+

Array length: 0 to 100

+

The value is a list of character strings. Each element contains 0 to 131 characters.

+

Regular expression matching:

+
^([a-z]|[A-Z]|[0-9]|_|-|,)*$
+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 Notification

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

Yes

+

String

+

Notification type.

+

The value can be:

+

notification: topic subscriptions. Notifications are sent using SMN topics.

+

contact: cloud account contacts. Notifications are sent using the mobile number and email address registered for your account.

+

notification_list

+

Yes

+

Array of strings

+

List of objects to be notified of alarm status changes. The value of topicUrn can be obtained from SMN. For details, see section Querying Topics. If type is set to notification, the value of notificationList cannot be empty. If type is set to autoscaling, the value of notificationList must be empty. If you set alarm_action_enabled to true, you must specify either alarm_actions or ok_actions. If alarm_actions and ok_actions coexist, their notificationList must be the same.

+

Array length: 0 to 20

+
+
+
+

Response Parameters

Status code: 201

+ +
+ + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

one_click_alarm_id

+

String

+

One-click monitoring ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^([a-z]|[A-Z]|[0-9]){1,64}$

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

{
+  "one_click_alarm_id" : "o1234567890123456789012",
+  "dimension_names" : {
+    "metric" : [ "disk", "instance_id" ],
+    "event" : [ "resource_id" ]
+  },
+  "notification_enabled" : true,
+  "alarm_notifications" : [ {
+    "type" : "notification",
+    "notification_list" : [ "urn:smn:123" ]
+  } ],
+  "ok_notifications" : [ {
+    "type" : "notification",
+    "notification_list" : [ "urn:smn:123" ]
+  } ],
+  "notification_begin_time" : "00:00",
+  "notification_end_time" : "23:59"
+}
+
+

Example Responses

Status code: 201

+

Created

+
{
+  "one_click_alarm_id" : "o1234567890123456789012"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

201

+

Created

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: One-Click Monitoring
+
+
+ diff --git a/docs/ces/api-ref/CreateOneDashboard.html b/docs/ces/api-ref/CreateOneDashboard.html new file mode 100644 index 000000000..ecab88835 --- /dev/null +++ b/docs/ces/api-ref/CreateOneDashboard.html @@ -0,0 +1,337 @@ + + +

Creating or Copying a Dashboard

+

Function

This API is used to create or copy a dashboard.

+
+

URI

POST /v2/{project_id}/dashboards

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. application/json is recommended.

+

Default value: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dashboard_name

+

Yes

+

String

+

Custom dashboard name.

+

Minimum: 1

+

Maximum: 128

+

Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

+

enterprise_id

+

No

+

String

+

Enterprise project ID.

+

Regular expression matching: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$

+

dashboard_id

+

No

+

String

+

Dashboard ID. If a dashboard ID is specified, the dashboard will be copied.

+

Regular expression matching: ^db([a-z]|[A-Z]|[0-9]){22}

+

row_widget_num

+

No

+

Integer

+

How a graph is displayed. 0 indicates that you can customize top and left of the graph. 1 indicates one graph per row.

+

Minimum: 0

+

Maximum: 3

+

Default: 0

+
+
+
+

Response Parameters

Status code: 201

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

dashboard_id

+

String

+

Dashboard ID.

+

Regular expression matching: ^db([a-z]|[A-Z]|[0-9]){22}

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Create a dashboard.

+
{
+  "dashboard_name" : "dashboard_name",
+  "enterprise_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+  "row_widget_num" : 3
+}
+

Copy a dashboard.

+
{
+  "dashboard_name" : "dashboard_name",
+  "enterprise_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+  "dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx",
+  "row_widget_num" : 3
+}
+
+

Example Responses

Status code: 201

+

OK

+

Create a dashboard.

+
{
+  "dashboard_id" : "dbxxxxxxxxx"
+}
+

Copy a dashboard.

+
{
+  "dashboard_id" : "dbxxxxxxxxx"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

201

+

OK

+

400

+

The server failed to process the request.

+

401

+

Token authentication is required.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Dashboards
+
+
+ diff --git a/docs/ces/api-ref/CreateResourceGroup.html b/docs/ces/api-ref/CreateResourceGroup.html new file mode 100644 index 000000000..edc696ce6 --- /dev/null +++ b/docs/ces/api-ref/CreateResourceGroup.html @@ -0,0 +1,408 @@ + + +

Creating a Resource Group (Recommended)

+

Function

This API is used to create a resource group (recommended).

+
+

URI

POST /v2/{project_id}/resource-groups

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

group_name

+

Yes

+

String

+

Resource group name. The value allows a maximum of 128 characters and can only contain letters, digits, hyphens (-), and underscores (_).

+

Minimum: 1

+

Maximum: 128

+

Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

+

enterprise_project_id

+

No

+

String

+

ID of the enterprise project that a resource group belongs to.

+

Regular expression matching: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$

+

type

+

No

+

String

+

Method for adding resources to a resource group. The value can only be EPS (synchronizing resources from enterprise projects), TAG (dynamic tag matching), or Manual (manually adding resources). If this parameter is not specified, resources are manually added.

+

Regular expression matching: ^(EPS|TAG|Manual)$

+

tags

+

No

+

Array of ResourceGroupTagRelation objects

+

Associated tag during dynamic tag matching. This parameter is mandatory when type is set to TAG.

+

Array length: 1 to 10

+

association_ep_ids

+

No

+

Array of strings

+

ID of the enterprise project from which resources in the resource group come. This parameter is mandatory when type is set to EPS.

+

Array length: 1 to 10

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 ResourceGroupTagRelation

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Tag key.

+

Minimum: 1

+

Maximum: 36

+

Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

+

value

+

No

+

String

+

Tag value.

+

Minimum: 0

+

Maximum: 43

+

Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

group_id

+

String

+

Resource group ID. The value starts with rg and is followed by 22 characters of letters, digits, or a combination of both.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Creating a resource group whose group _name is rg_test and type is TAG

+
{
+  "group_name" : "rg_test",
+  "enterprise_project_id" : "0",
+  "type" : "TAG",
+  "tags" : [ {
+    "key" : "key1",
+    "value" : "value1"
+  } ],
+  "association_ep_ids" : [ "d61d4705-5658-42f5-8e0c-70eb34d17b02" ]
+}
+
+

Example Responses

Status code: 200

+

Created

+
{
+  "group_id" : "rg1761380163308Dxxxxxxxx"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Created

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Groups
+
+
+ diff --git a/docs/ces/api-ref/DeleteAlarmRuleResources.html b/docs/ces/api-ref/DeleteAlarmRuleResources.html new file mode 100644 index 000000000..14d23129d --- /dev/null +++ b/docs/ces/api-ref/DeleteAlarmRuleResources.html @@ -0,0 +1,315 @@ + + +

Deleting Resources from an Alarm Rule

+

Function

This API is used to batch delete resources to an alarm rule. This API does not support alarm rules with Monitoring Scope set to Resource groups. To modify resources in such alarm rules, use the resource group management APIs.

+
+

URI

POST /v2/{project_id}/alarms/{alarm_id}/resources/batch-delete

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

alarm_id

+

Yes

+

String

+

Alarm rule ID.

+

Regular expression matching: al([a-z]|[A-Z]|[0-9]){22}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

No

+

String

+

MIME type of the request body. The default value is application/json; charset=UTF-8.

+

Default: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

No

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

resources

+

Yes

+

Array of arrays of Dimension objects

+

Resource information.

+

Array length: 0 to 1000

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 Dimension

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Dimension of a resource. For example, the dimension of an ECS can be instance_id. A maximum of four dimensions are supported. For the metric dimension of each resource, see Service Metric Dimensions.

+

Regular expression matching: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$

+

value

+

No

+

String

+

Resource dimension value, that is, the instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755.

+

Regular expression matching:

+
^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$
+
+
NOTE:

To delete a resource, you need to specify the value. If no value is specified, the API skips the deletion without returning an error.

+
+
+
+
+

Response Parameters

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Deleting resources from an alarm rule

+
{
+  "resources" : [ [ {
+    "name" : "rds_cluster_id",
+    "value" : "rds000000000001"
+  } ] ]
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Resources deleted.

+

400

+

Parameter verification failed.

+

404

+

Resources not found.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resources in an Alarm Rule
+
+
+ diff --git a/docs/ces/api-ref/DeleteDashboards.html b/docs/ces/api-ref/DeleteDashboards.html new file mode 100644 index 000000000..0d91c477c --- /dev/null +++ b/docs/ces/api-ref/DeleteDashboards.html @@ -0,0 +1,335 @@ + + +

Batch Deleting Dashboards

+

Function

This API is used to delete dashboards in batches.

+
+

URI

POST /v2/{project_id}/dashboards/batch-delete

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. application/json is recommended.

+

Default value: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dashboard_ids

+

No

+

Array of strings

+

Dashboard ID list.

+

Array length: 1 to 30

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

dashboards

+

Array of BatchDeleteDashboardRespInfo objects

+

Response body for deleting dashboards in batches.

+

Array length: 1 to 100

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 BatchDeleteDashboardRespInfo

Parameter

+

Type

+

Description

+

dashboard_id

+

String

+

Dashboard ID.

+

Regular expression matching: ^db([a-z]|[A-Z]|[0-9]){22}

+

ret_status

+

String

+

Operation result. The value can be successful or error.

+

The value can be:

+

  • successful

    +

  • error

    +
+

error_msg

+

String

+

Error message.

+

Minimum: 0

+

Maximum: 128

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

{
+  "dashboard_ids" : [ "dbxxxxxxxxxxxxxxxxxxxxxx", "dbXXXXXXXXXXXXXXXXXXXXXX" ]
+}
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "dashboards" : [ {
+    "dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx",
+    "ret_status" : "successful"
+  }, {
+    "dashboard_id" : "dbXXXXXXXXXXXXXXXXXXXXXX",
+    "ret_status" : "error",
+    "error_msg" : "record not found"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

The server failed to process the request.

+

401

+

Token authentication is required.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Dashboards
+
+
+ diff --git a/docs/ces/api-ref/ListAgentDimensionInfo.html b/docs/ces/api-ref/ListAgentDimensionInfo.html new file mode 100644 index 000000000..e06cd89a8 --- /dev/null +++ b/docs/ces/api-ref/ListAgentDimensionInfo.html @@ -0,0 +1,406 @@ + + +

Querying Server Monitoring Metrics

+

Function

This API is used to query metrics based on the ECS or BMS ID and from the following dimensions: disk, mount point, process, graphics card, and RAID controller. The NPU dimension is the original value, so there's no need to call this API to obtain the metric information.

+
+

URI

GET /v2/{project_id}/instances/{instance_id}/agent-dimensions

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

instance_id

+

Yes

+

String

+

Resource ID, for example, 4270ff17-aba3-4138-89fa-820594c39755.

+

Minimum: 36

+

Maximum: 36

+

Regular expression matching:

+
^([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*$
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dim_name

+

Yes

+

String

+

Dimension name.

+

The value can be:

+

  • mount_point

    +

  • disk

    +

  • proc

    +

  • raid

    +
+

dim_value

+

No

+

String

+

Dimension value, which contains 32 characters, for example, 2e84018fc8b4484b94e89aae212fe615. Minimum: 32

+

Maximum: 32

+

Regular expression matching: ([a-f\d]{32}|[A-F\d]{32})

+

offset

+

No

+

Integer

+

Pagination offset.

+

Minimum: 0

+

Maximum: 2147483647

+

Default: 0

+

Regular expression matching: ^(0|[1-9][0-9]*)$

+

limit

+

No

+

Integer

+

Number of records displayed on each page.

+

Minimum: 1

+

Maximum: 1000

+

Default: 1000

+

Regular expression matching: ^([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|1000)$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. The default value is application/json; charset=UTF-8.

+

Default: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

dimensions

+

Array of AgentDimension objects

+

Dimension information.

+

Array length: 0 to 2147483647

+

count

+

Integer

+

Total number of dimensions.

+

Minimum: 0

+

Maximum: 2147483647

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 AgentDimension

Parameter

+

Type

+

Description

+

name

+

String

+

Dimension name.

+

The value can be:

+

  • mount_point

    +

  • disk

    +

  • proc

    +

  • raid

    +
+

value

+

String

+

Dimension value, which contains 32 characters, for example, 2e84018fc8b4484b94e89aae212fe615.

+

Minimum: 32

+

Maximum: 32

+

Regular expression matching: ([a-f\d]{32}|[A-F\d]{32})

+

origin_value

+

String

+

Actual dimension information. The value is a character string, for example, vda.

+

Minimum: 1

+

Maximum: 1024

+

Regular expression matching:

+
^([a-z]|[A-Z]|[0-9]|_|-|~|\\.|/|:)*$
+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Querying metrics collected by Agent from a server whose instance_id is 4270ff17-aba3-4138-89fa-820594c39755

+
/v2/{project_id}/instances/4270ff17-aba3-4138-89fa-820594c39755/agent-dimensions?offset=0&limit=10&dim_name=disk
+
+

Example Responses

Status code: 200

+

Query succeeded.

+
{
+  "dimensions" : [ {
+    "name" : "disk",
+    "value" : "2e84018fc8b4484b94e89aae212fe615",
+    "origin_value" : "vda"
+  }, {
+    "name" : "disk",
+    "value" : "6a1b2de69eeb9a037ea23de6b529394d",
+    "origin_value" : "vdc"
+  } ],
+  "count" : 10
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Query succeeded.

+

400

+

Parameter verification failed.

+

404

+

Resources not found.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Metric Management
+
+
+ diff --git a/docs/ces/api-ref/ListAlarmHistories.html b/docs/ces/api-ref/ListAlarmHistories.html new file mode 100644 index 000000000..ba4dc5904 --- /dev/null +++ b/docs/ces/api-ref/ListAlarmHistories.html @@ -0,0 +1,826 @@ + + +

Querying Alarm Records

+

Function

This API is used to query alarm records.

+
+

URI

GET /v2/{project_id}/alarm-histories

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

alarm_id

+

No

+

String

+

Alarm rule ID, which starts with al and is followed by 22 characters of letters, digits, or a combination of both.

+

Minimum: 24

+

Maximum: 24

+

name

+

No

+

String

+

Alarm rule name.

+

Minimum: 0

+

Maximum: 128

+

status

+

No

+

String

+

Alarm rule status. The value can be ok, alarm, or invalid.

+

Regular expression matching: ^(ok|alarm|invalid)$

+

level

+

No

+

Integer

+

Alarm severity, which can be 1 (critical), 2 (major), 3 (minor), or 4 (warning).

+

Minimum: 1

+

Maximum: 4

+

namespace

+

No

+

String

+

Namespace of a service. For details about the namespace of each service, see Service Namespaces. The namespace must be in the service.item format and contain 3 to 32 characters. service and item must start with a letter and can contain only letters, digits, and underscores (_).

+

Minimum: 3

+

Maximum: 32

+

resource_id

+

No

+

String

+

ID of a resource in an alarm rule. If the resource has multiple dimensions, the resource IDs are sorted in ascending alphabetical order and separated by commas (,).

+

Minimum: 0

+

Maximum: 2048

+

Regular expression matching:

+
^([a-z]|[A-Z]|[0-9]|_|-|:|,|\.|)+$
+

from

+

No

+

String

+

Start of the time window for querying alarm records based on their end time (end_time in the response body, equal to or later than from). from must be earlier than to. Example: 2022-02-10T10:05:46+08:00

+

Minimum: 0

+

Maximum: 64

+
NOTE:

If the format of the from and to parameters is incorrect, alarm records in the past week are displayed.

+
+

to

+

No

+

String

+

End of the time window for querying alarm records based on their end time (end_time in the response body, earlier than to). Example: 2022-02-10T10:05:47+08:00

+

Minimum: 0

+

Maximum: 64

+
NOTE:

If the format of the from and to parameters is incorrect, alarm records in the past week are displayed.

+
+

offset

+

No

+

Integer

+

Pagination offset.

+

Minimum: 0

+

Maximum: 999

+

Default: 0

+

Regular expression matching: ^(0|[1-9]|[1-9][0-9])$

+

limit

+

No

+

Integer

+

Number of records displayed on each page.

+

Minimum: 1

+

Maximum: 100

+

Default: 100

+

Regular expression matching: ^([1-9]|[1-9][0-9]|100)$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. The default value is application/json; charset=UTF-8.

+

Default: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

alarm_histories

+

Array of AlarmHistoryItemV2 objects

+

Alarm records.

+

Array length: 0 to 100

+

count

+

Integer

+

Total number of alarm records.

+

Minimum: 0

+

Maximum: 2147483647

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 AlarmHistoryItemV2

Parameter

+

Type

+

Description

+

record_id

+

String

+

Alarm record ID.

+

Minimum: 24

+

Maximum: 24

+

alarm_id

+

String

+

Alarm rule ID, for example, al1603131199286dzxpqK3Ez.

+

Minimum: 24

+

Maximum: 24

+

name

+

String

+

Alarm rule name, for example, alarm-test01.

+

Minimum: 1

+

Maximum: 128

+

status

+

String

+

Status of the alarm record.

+

The value can be:

+

  • ok

    +

  • alarm

    +

  • invalid

    +
+

level

+

Integer

+

Alarm severity, which can be 1 (critical), 2 (major), 3 (minor), or 4 (warning).

+

The value can be:

+

  • 1

    +

  • 2

    +

  • 3

    +

  • 4

    +
+

type

+

String

+

Alarm rule type.

+

The value can be:

+
  • ALL_INSTANCE: alarms for all resources
  • RESOURCE_GROUP: alarms for resource groups
  • MULTI_INSTANCE: alarms for specified resources
  • EVENT.SYS: system event alarms
  • EVENT.CUSTOM: custom event alarms
+

action_enabled

+

Boolean

+

Whether to send a notification. The value can be true or false.

+

begin_time

+

String

+

Alarm generation time (UTC time).

+

end_time

+

String

+

Alarm end time (UTC time).

+

first_alarm_time

+

String

+

UTC time when the alarm was generated for the first time.

+

last_alarm_time

+

String

+

UTC time when the alarm was generated for the last time.

+

alarm_recovery_time

+

String

+

UTC time when the alarm was cleared.

+

metric

+

Metric object

+

Metric information.

+

condition

+

AlarmCondition object

+

Alarm triggering condition.

+

additional_info

+

AdditionalInfo object

+

Additional field of an alarm record, which applies only to alarm records generated in event monitoring scenarios.

+

alarm_actions

+

Array of Notification objects

+

Action to be triggered by the alarm.

+

The structure is as follows:

+

{ "type": "notification", "notification_list": ["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] }

+

The value of type can be:

+
  • notification: A notification will be sent.
  • autoscaling: A scaling action will be triggered.
+

notificationList indicates list of recipients to be notified of alarm status changes.

+

Array length: 0 to 10

+

ok_actions

+

Array of Notification objects

+

Action to be triggered after an alarm is cleared. A structure example is {"type": "notification", "notification_list": ["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] }. The type value can be notification (a notification action will be triggered). notification_list indicates list of objects to be notified of alarm status changes.

+

Array length: 0 to 10

+

data_points

+

Array of DataPointInfo objects

+

Time when the resource monitoring data is reported and the monitoring data in the alarm record.

+

Array length: 0 to 2147483647

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Metric

Parameter

+

Type

+

Description

+

namespace

+

String

+

Namespace of a service. For details about the namespace of each service, see Service Namespaces. The namespace must be in the service.item format and contain 3 to 32 characters. service and item must start with a letter and can contain only letters, digits, and underscores (_).

+

Minimum: 3

+

Maximum: 32

+

metric_name

+

String

+

Metric name of a resource. The name must start with a letter and contain only digits, letters, and underscores (_). The length ranges from 1 to 64 characters. For example, cpu_util of an ECS indicates the CPU usage of the ECS. mongo001_command_ps in DDS indicates the command execution frequency. For details about the metric name of each service, see Service Metric Names.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^([A-Za-z]){1}([0-9A-Za-z]|_|-)*$

+

dimensions

+

Array of Dimension objects

+

Metric dimension. A maximum of four dimensions can be added.

+

Array length: 0 to 4

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 Dimension

Parameter

+

Type

+

Description

+

name

+

String

+

Dimension of a resource. For example, the dimension of an ECS can be instance_id. A maximum of four dimensions are supported. For the metric dimension of each resource, see Service Metric Dimensions.

+

Regular expression matching: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$

+

value

+

String

+

Resource dimension value, which is an instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755.

+

Regular expression matching:

+
^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 AlarmCondition

Parameter

+

Type

+

Description

+

period

+

Integer

+

Monitoring period of a metric, in seconds. The default value is 0. For an event alarm, set this parameter to 0. 1 indicates the original aggregation period of a metric. For example, if the original aggregation period of an RDS metric is 60s, its data point is calculated every 60 seconds. For details about the original aggregation period of each cloud service metric, see Services Interconnected with Cloud Eye. 300 indicates that the metric aggregation period is 5 minutes.

+

The value can be:

+

  • 0

    +

  • 1

    +

  • 300

    +

  • 1200

    +

  • 3600

    +

  • 14400

    +

  • 86400

    +
+

filter

+

String

+

Data aggregation method. The value can be:

+
  • average: average value of metric data within an aggregation period.
  • max: maximum value of metric data in an aggregation period.
  • min: minimum value of metric data within an aggregation period.
  • sum: sum of metric data within an aggregation period.
  • variance: variance value of metric data within an aggregation period.
+

comparison_operator

+

String

+

Operator of an alarm threshold.

+

Regular expression matching: ^(>|<|>=|<=|=|!=)$

+

value

+

Double

+

Alarm threshold. Supported range: 0 to Number. MAX_VALUE (1.7976931348623157e+108) For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS cpu_util to 80.

+

Minimum: 0

+

Maximum: 1.7976931348623157e+108

+

unit

+

String

+

Data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

+

Minimum: 0

+

Maximum: 32

+

count

+

Integer

+

Number of occurrences.

+

Minimum: 1

+

Maximum: 180

+

suppress_duration

+

Integer

+

Alarm suppression time, in seconds. This parameter corresponds to the last field in the alarm policy when an alarm rule is created on the Cloud Eye console. This field is used to avoid frequent alarms. 0 indicates that the alarm is not suppressed and alarms are generated as long as the conditions are met. 300 indicates that an alarm is generated every 5 minutes as long as the alarm triggering conditions are met.

+

The value can be:

+

  • 0

    +

  • 300

    +

  • 600

    +

  • 900

    +

  • 1800

    +

  • 3600

    +

  • 10800

    +

  • 21600

    +

  • 43200

    +
  • 86400
+

Regular expression matching: ^(0|300|600|900|1800|3600|10800|21600|43200|86400)$

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 9 AdditionalInfo

Parameter

+

Type

+

Description

+

resource_id

+

String

+

Resource ID corresponding to the alarm record, for example, 22d98f6c-16d2-4c2d-b424-50e79d82838f.

+

Minimum: 0

+

Maximum: 128

+

resource_name

+

String

+

Resource name corresponding to the alarm record, for example, ECS-Test01.

+

Minimum: 0

+

Maximum: 128

+

event_id

+

String

+

ID of the event in the alarm record, for example, ev16031292300990kKN8p17J.

+

Minimum: 24

+

Maximum: 24

+
+
+ +
+ + + + + + + + + + + + + +
Table 10 Notification

Parameter

+

Type

+

Description

+

type

+

String

+

Notification type.

+

The value can be:

+

notification: topic subscriptions. Notifications are sent using SMN topics.

+

contact: cloud account contacts. Notifications are sent to the mobile number and email address registered for your account.

+

notification_list

+

Array of strings

+

List of objects to be notified of alarm status changes. The value of topicUrn can be obtained from SMN. For details, see Querying Topics. When type is set to notification, notification_list cannot be left blank. If you set alarm_action_enabled to true, you must specify either alarm_actions or ok_actions. If alarm_actions and ok_actions coexist, their notification_list must be the same.

+

Array length: 0 to 20

+
+
+ +
+ + + + + + + + + + + + + +
Table 11 DataPointInfo

Parameter

+

Type

+

Description

+

time

+

String

+

UTC time when the resource monitoring data of the alarm record is reported.

+

Minimum: 1

+

Maximum: 64

+

value

+

Double

+

Resource monitoring data of the alarm record at the time point, for example, 7.019.

+

Minimum: 0

+

Maximum: 1.7976931348623157E308

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 12 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 13 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Querying alarm records whose alarm_name is alarm-test01, and from and to are 2022-02-10T10:05:46+08:00.

+
/v2/{project_id}/alarm-histories?limit=10&offset=0&from=2022-02-10T10:05:46+08:00&to=2022-02-10T12:05:46+08:00&name=alarm-test01
+
+

Example Responses

Status code: 200

+

Query succeeded.

+
{
+  "alarm_histories" : [ {
+    "alarm_id" : "al1604473987569z6n6nkpm1",
+    "record_id" : "ah1655717086704DEnBrJ999",
+    "name" : "TC_CES_FunctionBaseline_Alarm_008",
+    "metric" : {
+      "namespace" : "SYS.VPC",
+      "dimensions" : [ {
+        "name" : "bandwidth_id",
+        "value" : "79a9cc0c-f626-4f15-bf99-a1f184107f88"
+      } ],
+      "metric_name" : "downstream_bandwidth"
+    },
+    "condition" : {
+      "period" : 1,
+      "filter" : "average",
+      "comparison_operator" : ">=",
+      "value" : 0,
+      "count" : 3,
+      "suppress_duration" : 3600
+    },
+    "level" : 2,
+    "type" : "ALL_INSTANCE",
+    "begin_time" : "2024-02-11T05:48:08+08:00",
+    "end_time" : "2024-02-11T08:48:08+08:00",
+    "action_enabled" : false,
+    "alarm_actions" : [ ],
+    "ok_actions" : [ ],
+    "status" : "alarm",
+    "data_points" : [ {
+      "time" : "2022-06-22T16:38:02+08:00",
+      "value" : 873.1507798960139
+    }, {
+      "time" : "2022-06-22T16:28:02+08:00",
+      "value" : 883.1507798960139
+    }, {
+      "time" : "2022-06-22T16:18:02+08:00",
+      "value" : 873.4
+    } ],
+    "additional_info" : {
+      "resource_id" : "",
+      "resource_name" : "",
+      "event_id" : ""
+    }
+  } ],
+  "count" : 103
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Query succeeded.

+

400

+

Parameter verification failed.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm Records
+
+
+ diff --git a/docs/ces/api-ref/ListAlarmRulePolicies.html b/docs/ces/api-ref/ListAlarmRulePolicies.html new file mode 100644 index 000000000..8dd55a871 --- /dev/null +++ b/docs/ces/api-ref/ListAlarmRulePolicies.html @@ -0,0 +1,509 @@ + + +

Querying Alarm Policies in an Alarm Rule

+

Function

This API is used to query alarm policies by alarm rule ID.

+
+

URI

GET /v2/{project_id}/alarms/{alarm_id}/policies

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

alarm_id

+

Yes

+

String

+

Alarm rule ID.

+

Regular expression matching: ^al([0-9A-Za-z]){22}$

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Pagination offset.

+

Minimum: 0

+

Maximum: 10000

+

Default: 0

+

Regular expression matching: ^([0]|[1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9]|10000)$

+

limit

+

No

+

Integer

+

Number of records displayed on each page.

+

Minimum: 1

+

Maximum: 100

+

Default: 10

+

Regular expression matching: ^([1-9]|[1-9][0-9]|100)$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

No

+

String

+

MIME type of the request body. The default value is application/json; charset=UTF-8.

+

Default: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

No

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

policies

+

Array of ListPolicy objects

+

Policy information.

+

Array length: 0 to 100

+

count

+

Integer

+

Total number of policies in an alarm rule.

+

Minimum: 0

+

Maximum: 100

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 ListPolicy

Parameter

+

Type

+

Description

+

metric_name

+

String

+

Metric name of a resource. The name must start with a letter and contain only digits, letters, and underscores (_). The length ranges from 1 to 64 characters. For example, cpu_util of an ECS indicates the CPU usage of the ECS. mongo001_command_ps in DDS indicates the command execution frequency. For details about the metric name of each service, see Service Metric Names.

+

Regular expression matching: ^([A-Za-z]){1}([0-9A-Za-z]|_|-)*$

+

extra_info

+

MetricExtraInfo object

+

Additional information about an alarm policy. This parameter is left blank by default.

+

period

+

Integer

+

Monitoring period of a metric, in seconds. The default value is 0. For an event alarm, set this parameter to 0. 1 indicates the original aggregation period of a metric. For example, if the original aggregation period of an RDS metric is 60s, its data point is calculated every 60 seconds. For details about the original aggregation period of each cloud service metric, see Services Interconnected with Cloud Eye. 300 indicates that the metric aggregation period is 5 minutes.

+

Minimum: 0

+

Maximum: 86400

+

The value can be:

+

  • 0

    +

  • 1

    +

  • 300

    +

  • 1200

    +

  • 3600

    +

  • 14400

    +

  • 86400

    +
+

filter

+

String

+

Data aggregation method. The value can be:

+
  • average: average value of metric data within an aggregation period.
  • max: maximum value of metric data in an aggregation period.
  • min: minimum value of metric data within an aggregation period.
  • sum: sum of metric data within an aggregation period.
  • variance: variance value of metric data within an aggregation period.
+

comparison_operator

+

String

+

Operator of an alarm threshold.

+

Regular expression matching: ^(>|<|>=|<=|=|!=)$

+

value

+

Number

+

Alarm threshold. Supported range: 0 to Number.MAX_VALUE (1.7976931348623157e+108) For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS cpu_util to 80.

+

Minimum: 0

+

Maximum: 1.7976931348623157e+108

+

unit

+

String

+

Data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

+

Minimum: 0

+

Maximum: 32

+

type

+

String

+

Alarm policy type. This parameter is left blank by default.

+

The value can be:

+

  • auto: dynamic threshold.

    +
+
NOTE:

This parameter has been discarded. It has no impact on APIs. It is still retained in this document for compatibility with earlier versions.

+
+

count

+

Integer

+

Number of times that the alarm triggering conditions are met. For event alarms, the value ranges from 1 to 180. For metric and website alarms, the value can be 1, 2, 3, 4, 5, 10, 15, 30, 60, 90, 120, or 180.

+

suppress_duration

+

Integer

+

Alarm suppression time, in seconds. This parameter corresponds to the last field in the alarm policy when an alarm rule is created on the Cloud Eye console. This field is used to avoid frequent alarms. 0 indicates that the alarm is not suppressed and alarms are generated as long as the conditions are met. 300 indicates that an alarm is generated every 5 minutes as long as the alarm triggering conditions are met.

+

Minimum: 0

+

Maximum: 86400

+

The value can be:

+

  • 0

    +

  • 300

    +

  • 600

    +

  • 900

    +

  • 1800

    +

  • 3600

    +

  • 10800

    +

  • 21600

    +

  • 43200

    +

  • 86400

    +
+

level

+

Integer

+

Alarm severity, which can be 1 (critical), 2 (major), 3 (minor), or 4 (informational). The default value is 2.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 MetricExtraInfo

Parameter

+

Type

+

Description

+

origin_metric_name

+

String

+

Original metric name.

+

Minimum: 0

+

Maximum: 64

+

metric_prefix

+

String

+

Metric name prefix.

+

Minimum: 0

+

Maximum: 8

+

custom_proc_name

+

String

+

Name of a user process.

+

Minimum: 0

+

Maximum: 64

+

metric_type

+

String

+

Metric type.

+

Minimum: 0

+

Maximum: 16

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Querying alarm policies of an alarm rule whose alarm_id is alCzk8o9dtSQHtiDgb44Eepw and limit is 10

+
/v2/{project_id}/alarms/alCzk8o9dtSQHtiDgb44Eepw/policies?offset=0&limit=10
+
+

Example Responses

Status code: 200

+

Query succeeded.

+
{
+  "policies" : [ {
+    "metric_name" : "disk_device_read_bytes_rate",
+    "extra_info" : { },
+    "period" : 1,
+    "filter" : "average",
+    "comparison_operator" : ">",
+    "value" : 75,
+    "unit" : "byte/s",
+    "count" : 3,
+    "type" : "",
+    "suppress_duration" : 10800,
+    "level" : 2
+  } ],
+  "count" : 10
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Query succeeded.

+

400

+

Parameter verification failed.

+

404

+

Alarm rule not found.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm Policies
+
+
+ diff --git a/docs/ces/api-ref/ListAlarmRuleResources.html b/docs/ces/api-ref/ListAlarmRuleResources.html new file mode 100644 index 000000000..905d44d8d --- /dev/null +++ b/docs/ces/api-ref/ListAlarmRuleResources.html @@ -0,0 +1,312 @@ + + +

Querying Resources in an Alarm Rule

+

Function

This API is used to query resources in an alarm rule by its ID.

+
+

URI

GET /v2/{project_id}/alarms/{alarm_id}/resources

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

alarm_id

+

Yes

+

String

+

Alarm rule ID.

+

Regular expression matching: al([a-z]|[A-Z]|[0-9]){22}$

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Pagination offset.

+

Minimum: 0

+

Maximum: 10000

+

Default: 0

+

Regular expression matching: ^([0]|[1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9]|10000)$

+

limit

+

No

+

Integer

+

Number of records displayed on each page.

+

Minimum: 1

+

Maximum: 100

+

Default: 10

+

Regular expression matching: ^([1-9]|[1-9][0-9]|100)$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

No

+

String

+

MIME type of the request body. The default value is application/json; charset=UTF-8.

+

Default: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

No

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

resources

+

Array of arrays of Dimension objects

+

Resource information.

+

Array length: 0 to 1000

+

count

+

Integer

+

Total number of resources.

+

Minimum: 0

+

Maximum: 2147483647

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 Dimension

Parameter

+

Type

+

Description

+

name

+

String

+

Dimension of a resource. For example, the dimension of an ECS can be instance_id. A maximum of four dimensions are supported. For the metric dimension of each resource, see Service Metric Dimensions.

+

Regular expression matching: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$

+

value

+

String

+

Resource dimension value, which is an instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755.

+

Regular expression matching:

+
^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$
+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Querying resources of an alarm rule whose alarm_id is alCzk8o9dtSQHtiDgb44Eepw and limit is 10

+
/v2/{project_id}/alarms/alCzk8o9dtSQHtiDgb44Eepw/resources?offset=0&limit=10
+
+

Example Responses

Status code: 200

+

Query succeeded.

+
{
+  "resources" : [ [ {
+    "name" : "disk_name"
+    "value" : "4270ff17-aba3-4138-89fa-xxxxxxxxxxxx"
+  } ] ],
+  "count" : 10
+}
+

If the alarm rule applies to all resources types, the returned response will not include the value field.

+
+
+

Status Codes

+
+ + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Query succeeded.

+

400

+

Parameter verification failed.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resources in an Alarm Rule
+
+
+ diff --git a/docs/ces/api-ref/ListAlarmRules.html b/docs/ces/api-ref/ListAlarmRules.html new file mode 100644 index 000000000..cdfb45a64 --- /dev/null +++ b/docs/ces/api-ref/ListAlarmRules.html @@ -0,0 +1,705 @@ + + +

Querying Alarm Rules (Recommended)

+

Function

This API is used to query alarm rules.

+
+

URI

GET /v2/{project_id}/alarms

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

alarm_id

+

No

+

String

+

Alarm rule ID.

+

Regular expression matching: ^al([0-9A-Za-z]){22}$

+

name

+

No

+

String

+

Name of an alarm rule. The name allows 1 to 128 characters and can only contain letters, digits, underscores (_), and hyphens (-).

+

Minimum: 1

+

Maximum: 128

+

Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

+

namespace

+

No

+

String

+

Namespace of a service. For details about the namespace of each service, see Service Namespaces. The namespace must be in the service.item format and contain 3 to 32 characters. service and item must start with a letter and can contain only letters, digits, and underscores (_).

+

Minimum: 0

+

Maximum: 32

+

Regular expression matching: ^((([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*)|)$

+

resource_id

+

No

+

String

+

ID of a resource in an alarm rule. If the resource has multiple dimensions, the resource IDs are sorted in ascending alphabetical order and separated by commas (,).

+

Maximum: 700

+

Regular expression matching:

+
^([a-z]|[A-Z]|[0-9]|_|-|:|,|\.|)+$
+

enterprise_project_id

+

No

+

String

+

Enterprise project ID.

+

Regular expression matching: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$

+

offset

+

No

+

Integer

+

Pagination offset.

+

Minimum: 0

+

Maximum: 10000

+

Default: 0

+

Regular expression matching: ^([0]|[1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9]|10000)$

+

limit

+

No

+

Integer

+

Number of records displayed on each page.

+

Minimum: 1

+

Maximum: 100

+

Default: 10

+

Regular expression matching: ^([1-9]|[1-9][0-9]|100)$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. The default value is application/json; charset=UTF-8.

+

Default: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

No

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

alarms

+

Array of alarms objects

+

Alarm rule list.

+

Array length: 1 to 100

+

count

+

Integer

+

Total number of alarm rules.

+

Minimum: 0

+

Maximum: 10000

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 alarms

Parameter

+

Type

+

Description

+

alarm_id

+

String

+

ID of an alarm rule, which starts with al and is followed by 22 characters of letters, digits, or a combination of both.

+

name

+

String

+

Name of an alarm rule. The name allows 1 to 128 characters and can only contain letters, digits, underscores (_), and hyphens (-).

+

description

+

String

+

Alarm rule description. The value can contain 0 to 256 characters.

+

namespace

+

String

+

Namespace of a service. For details about the namespace of each service, see Service Namespaces. The namespace must be in the service.item format and contain 3 to 32 characters. service and item must start with a letter and can contain only letters, digits, and underscores (_).

+

Minimum: 0

+

Maximum: 32

+

Regular expression matching: ^((([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*)|)$

+

policies

+

Array of Policy objects

+

Alarm policies.

+

Array length: 1 to 100

+

resources

+

Array of ResourcesInListResp objects

+

Resource list. Associated resources can be obtained by calling the API for querying resources in an alarm rule.

+

Array length: 1 to 3000

+

type

+

String

+

Alarm rule type.

+

The value can be:

+
  • ALL_INSTANCE: alarms for all resources
  • RESOURCE_GROUP: alarms for resource groups
  • MULTI_INSTANCE: alarms for specified resources
  • EVENT.SYS: system event alarms
  • EVENT.CUSTOM: custom event alarms
+

enabled

+

Boolean

+

Whether to generate alarms when the alarm triggering conditions are met.

+

notification_enabled

+

Boolean

+

Whether to enable alarm notification.

+

alarm_notifications

+

Array of Notification objects

+

Action to be triggered by the alarm. Array length: 0 to 10

+

ok_notifications

+

Array of Notification objects

+

Action to be triggered after an alarm is cleared. Array length: 0 to 10

+

notification_begin_time

+

String

+

Time when the alarm notification was enabled. Example: 12:00

+

Regular expression matching: ^([01][0-9]|2[0-3]):([0-5][0-9])$

+

notification_end_time

+

String

+

Time when the alarm notification was disabled. Example: 12:00

+

Regular expression matching: ^([01][0-9]|2[0-3]):([0-5][0-9])$

+

enterprise_project_id

+

String

+

Enterprise project ID. The value allows 36 characters. It can only contain lowercase letters, hyphens (-), and underscores (_). You can customize an enterprise project ID. The value can also be 0 (default enterprise project ID).

+

Regular expression matching: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$

+

alarm_template_id

+

String

+

ID of an alarm template associated with an alarm rule. If this parameter is specified, the policy associated with the alarm rule changes accordingly with the alarm template policy.

+

Minimum: 0

+

Maximum: 64

+

Regular expression matching: ^at([0-9A-Za-z]){0,62}$

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 Policy

Parameter

+

Type

+

Description

+

metric_name

+

String

+

Metric name of a resource. The name must start with a letter and contain only digits, letters, and underscores (_). The length ranges from 1 to 64 characters. For example, cpu_util of an ECS indicates the CPU usage of the ECS. mongo001_command_ps in DDS indicates the command execution frequency. For details about the metric name of each service, see Service Metric Names.

+

Regular expression matching: ^([A-Za-z]){1}([0-9A-Za-z]|_|-)*$

+

period

+

Integer

+

Metric period, in seconds.

+

The default value is 0. For an event alarm, set this parameter to 0. 1 indicates the original aggregation period of a metric. For example, if the original aggregation period of an RDS metric is 60s, its data point is calculated every 60 seconds. For details about the original aggregation period of each cloud service metric, see Services Interconnected with Cloud Eye. 300 indicates that the metric aggregation period is 5 minutes.

+

Minimum: 0

+

Maximum: 86400

+

The value can be:

+

  • 0

    +

  • 1

    +

  • 300

    +

  • 1200

    +

  • 3600

    +

  • 14400

    +

  • 86400

    +
+

filter

+

String

+

Data aggregation method. The value can be:

+
  • average: average value of metric data within an aggregation period.
  • max: maximum value of metric data within an aggregation period.
  • min: minimum value of metric data within an aggregation period.
  • sum: sum of metric data within an aggregation period.
  • variance: variance value of metric data within an aggregation period.
+

comparison_operator

+

String

+

Operator of an alarm threshold.

+

Regular expression matching: ^(>|<|>=|<=|=|!=)$

+

value

+

Number

+

Alarm threshold. Supported range: 0 to Number.MAX_VALUE (1.7976931348623157e+108) For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS cpu_util to 80.

+

Minimum: 0

+

Maximum: 1.7976931348623157e+108

+

hierarchical_value

+

Object

+

Multi-level alarm threshold. This parameter is not required for the current version.

+

unit

+

String

+

Data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

+

Minimum: 0

+

Maximum: 32

+

count

+

Integer

+

Number of times that the alarm triggering conditions are met.

+

For event alarms, the value ranges from 1 to 180. For metric and website alarms, the value can be 1, 2, 3, 4, 5, 10, 15, 30, 60, 90, 120, or 180.

+

suppress_duration

+

Integer

+

Alarm suppression time, in seconds. This parameter corresponds to the last field in the alarm policy when an alarm rule is created on the Cloud Eye console. This field is used to avoid frequent alarms. 0 indicates that the alarm is not suppressed and alarms are generated as long as the conditions are met. 300 indicates that an alarm is generated every 5 minutes as long as the alarm triggering conditions are met.

+

Minimum: 0

+

Maximum: 86400

+

The value can be:

+

  • 0

    +

  • 300

    +

  • 600

    +

  • 900

    +

  • 1800

    +

  • 3600

    +

  • 10800

    +

  • 21600

    +

  • 43200

    +

  • 86400

    +
+

level

+

Integer

+

Alarm severity, which can be 1 (critical), 2 (major), 3 (minor), or 4 (informational). The default value is 2.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 7 ResourcesInListResp

Parameter

+

Type

+

Description

+

resource_group_id

+

String

+

Resource group ID. This parameter is available when the monitoring scope is set to Resource groups.

+

Regular expression matching: ^rg([a-z]|[A-Z]|[0-9]){22}$

+

resource_group_name

+

String

+

Resource group name. This parameter is available when the monitoring scope is set to Resource groups.

+

Minimum: 1

+

Maximum: 128

+

Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

+

dimensions

+

Array of MetricDimension objects

+

Dimension information.

+

Array length: 0 to 10000

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 MetricDimension

Parameter

+

Type

+

Description

+

name

+

String

+

Metric dimension name.

+

Minimum: 1

+

Maximum: 32

+

Regular expression matching: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$

+

value

+

String

+

Metric dimension value.

+

Minimum: 0

+

Maximum: 256

+

Regular expression matching: ^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-)*)|){0,256}$

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 Notification

Parameter

+

Type

+

Description

+

type

+

String

+

Notification type.

+

The value can be:

+

notification: topic subscriptions. Notifications are sent using SMN topics.

+

contact: cloud account contact. Notifications are sent to the mobile number and email address registered for your account.

+

notification_list

+

Array of strings

+

List of objects to be notified of alarm status changes. The value of topicUrn can be obtained from SMN. For details, see section Querying Topics. When type is set to notification, notification_list cannot be left blank. If you set alarm_action_enabled to true, you must specify either alarm_actions or ok_actions. If alarm_actions and ok_actions coexist, their notification_list must be the same.

+

Array length: 0 to 20

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 11 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Querying alarm rules

+
/v2/{project_id}/alarms?offset=0&limit=10
+
+

Example Responses

Status code: 200

+

Query succeeded.

+
{
+  "alarms" : [ {
+    "alarm_id" : "al16558829757444BVVxr999",
+    "name" : "alarm01",
+    "description" : "",
+    "namespace" : "SYS.ECS",
+    "policies" : [ {
+      "metric_name" : "disk_device_read_bytes_rate",
+      "period" : 1,
+      "filter" : "average",
+      "comparison_operator" : ">",
+      "value" : 75,
+      "hierarchical_value": {},
+      "unit" : "byte/s",
+      "count" : 3,
+      "suppress_duration" : 10800,
+      "level" : 2
+    } ],
+    "resources" : [ {
+      "dimensions" : [ {
+        "name" : "disk_name"
+      } ]
+    } ],
+    "type" : "ALL_INSTANCE",
+    "enabled" : true,
+    "notification_enabled" : true,
+    "alarm_notifications" : [ {
+      "type" : "notification",
+      "notification_list" : [ "urn:smn:xxx:xxx70e7359:topic_xxx" ]
+    } ],
+    "ok_notifications" : [ {
+      "type" : "notification",
+      "notification_list" : [ "urn:smn:xxx:xxx70e7359:topic_xxx" ]
+    } ],
+    "notification_begin_time" : "00:00",
+    "notification_end_time" : "23:59",
+    "enterprise_project_id" : 0
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Query succeeded.

+

400

+

Parameter verification failed.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm Rules
+
+
+ diff --git a/docs/ces/api-ref/ListAlarmTemplateAssociationAlarms.html b/docs/ces/api-ref/ListAlarmTemplateAssociationAlarms.html new file mode 100644 index 000000000..e8466d039 --- /dev/null +++ b/docs/ces/api-ref/ListAlarmTemplateAssociationAlarms.html @@ -0,0 +1,396 @@ + + +

Querying Alarm Rules Associated with an Alarm Template

+

Function

This API is used to query alarm rules associated with an alarm template.

+
+

URI

GET /v2/{project_id}/alarm-templates/{template_id}/association-alarms

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

template_id

+

Yes

+

String

+

ID of an alarm template. The ID starts with at and is followed by letters, digits, or a combination of both. The value can contain a maximum of 64 characters.

+

Minimum: 2

+

Maximum: 64

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Start position for pagination query, indicating the sequence number of the data record where the query starts. The default value is 0.

+

Minimum: 0

+

Maximum: 10000

+

limit

+

No

+

Integer

+

Maximum number of query results. The value ranges from 1 to 100 (default).

+

Minimum: 1

+

Maximum: 100

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

alarms

+

Array of alarms objects

+

Alarm rule list.

+

Array length: 0 to 100

+

count

+

Integer

+

Total number of alarm rules.

+

Minimum: 0

+

Maximum: 1000

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 alarms

Parameter

+

Type

+

Description

+

alarm_id

+

String

+

Alarm rule ID.

+

Regular expression matching: ^al([0-9A-Za-z]){22}$

+

name

+

String

+

Alarm rule name.

+

Minimum: 1

+

Maximum: 128

+

Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

+

description

+

String

+

Description of the alarm rule.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Querying alarm rules associated with an alarm template

+
/v2/{project_id}/alarm-templates/{template_id}/association-alarms
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "alarms" : [ {
+    "alarm_id" : "al12345678901234567890",
+    "name" : "test",
+    "description": "Alarm rule list."
+  } ],
+  "count" : 100
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm Rules Associated with an Alarm Template
+
+
+ diff --git a/docs/ces/api-ref/ListAlarmTemplates.html b/docs/ces/api-ref/ListAlarmTemplates.html new file mode 100644 index 000000000..4a69a66e7 --- /dev/null +++ b/docs/ces/api-ref/ListAlarmTemplates.html @@ -0,0 +1,454 @@ + + +

Querying Alarm Templates

+

Function

This API is used to query alarm templates.

+
+

URI

GET /v2/{project_id}/alarm-templates

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Start position for pagination query, indicating the sequence number of the data record where the query starts. The default value is 0.

+

Minimum: 0

+

Maximum: 10000

+

limit

+

No

+

Integer

+

Maximum number of query results. The value ranges from 1 to 100 (default).

+

Minimum: 1

+

Maximum: 100

+

namespace

+

No

+

String

+

Namespace of a service. For details about the namespace of each service, see Service Namespaces.

+

Minimum: 3

+

Maximum: 32

+

Regular expression matching: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*$

+

dim_name

+

No

+

String

+

Resource dimension, which must start with a letter. A dimension allows a maximum of 32 characters can only contain digits, letters, underscores (_), and hyphens (-). If there are multiple dimensions, use commas (,) to separate them.

+

Regular expression matching: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}(,([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){0,31}){0,3}$

+

template_type

+

No

+

String

+

Alarm template type. system indicates default alarm templates for metrics, custom indicates the custom alarm templates for metrics, system_event indicates default event templates, custom_event indicates the custom event templates, and system_custom_event indicates all default and custom event templates. If this parameter is not specified, all metric templates are returned.

+

The value can be:

+

  • system

    +

  • custom

    +

  • system_event

    +

  • custom_event

    +

  • system_custom_event

    +
+

template_name

+

No

+

String

+

Alarm template name. It must start with a letter and can contain letters, digits, underscores (_), hyphens (-), parentheses, and periods (.). Fuzzy match is supported.

+

Minimum: 1

+

Maximum: 128

+

Regular expression matching:

+
^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-|\(|\)|\.|\s)+$
+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

alarm_templates

+

Array of AlarmTemplates objects

+

Alarm template list.

+

Array length: 0 to 100

+

count

+

Integer

+

Total number of alarm templates.

+

Minimum: 0

+

Maximum: 9999999

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 AlarmTemplates

Parameter

+

Type

+

Description

+

template_id

+

String

+

ID of an alarm template. The ID starts with at and is followed by letters, digits, or a combination of both. The value can contain a maximum of 64 characters.

+

template_name

+

String

+

Alarm template name. It must start with a letter and can contain letters, digits, underscores (_), hyphens (-), parentheses, and periods (.). Fuzzy match is supported.

+

Minimum: 1

+

Maximum: 128

+

Regular expression matching:

+
^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-|\(|\)|\.|\s)+$
+

template_type

+

String

+

Type of an alarm template. custom indicates custom alarm templates, and system indicates default alarm templates.

+

The value can be:

+

  • system

    +

  • custom

    +
+

create_time

+

String

+

Time when an alarm template was created. The value is in the 2006-01-02T15:04:05.000Z format.

+

template_description

+

String

+

Supplementary information about an alarm template. The description can contain 0 to 256 characters and is left blank by default.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Querying alarm templates

+
/v2/{project_id}/alarm-templates?offset=0&limit=100
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "alarm_templates" : [ {
+    "template_id" : "at1628592157541dB1klWgY6",
+    "template_name" : "my_template",
+    "template_type" : "custom",
+    "create_time" : "2006-01-02T15:04:05.000Z",
+    "template_description" : "hello world"
+  } ],
+  "count" : 100
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm Templates
+
+
+ diff --git a/docs/ces/api-ref/ListDashboardInfos.html b/docs/ces/api-ref/ListDashboardInfos.html new file mode 100644 index 000000000..622d4426f --- /dev/null +++ b/docs/ces/api-ref/ListDashboardInfos.html @@ -0,0 +1,377 @@ + + +

Querying Dashboards

+

Function

This API is used to query dashboards.

+
+

URI

GET /v2/{project_id}/dashboards

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

is_favorite

+

No

+

Boolean

+

Whether a dashboard in an enterprise project is added to favorites. The value can be true (added to favorites) and false (not added to favorites). If this parameter is specified, enterprise_id is mandatory.

+

dashboard_name

+

No

+

String

+

Dashboard name.

+

Minimum: 1

+

Maximum: 128

+

Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

+

dashboard_id

+

No

+

String

+

Dashboard ID.

+

Regular expression matching: ^db([a-z]|[A-Z]|[0-9]){22}

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

dashboards

+

Array of DashBoardInfo objects

+

Dashboard list.

+

Array length: 0 to 10

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 DashBoardInfo

Parameter

+

Type

+

Description

+

dashboard_id

+

String

+

Dashboard ID.

+

Regular expression matching: ^db([a-z]|[A-Z]|[0-9]){22}

+

dashboard_name

+

String

+

Custom dashboard name.

+

Minimum: 1

+

Maximum: 128

+

Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

+

enterprise_id

+

String

+

Enterprise project ID.

+

Regular expression matching: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$

+

creator_name

+

String

+

Name of the user who created the dashboard.

+

Minimum: 1

+

Maximum: 128

+

Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

+

create_time

+

Long

+

Time when the dashboard was created. The value is a timestamp, in milliseconds.

+

Minimum: 1111111111111

+

Maximum: 9999999999999

+

row_widget_num

+

Integer

+

How a graph is displayed. 0 indicates that you can customize top and left of the graph. 1 indicates one graph per row.

+

Minimum: 0

+

Maximum: 3

+

Default: 3

+

is_favorite

+

Boolean

+

Whether a dashboard is added to favorites. The value can be true or false.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

OK

+
{
+  "dashboards" : [ {
+    "dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx",
+    "dashboard_name" : "dashboard_name",
+    "enterprise_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+    "creator_name" : "creator_name",
+    "create_time" : 1111111111111,
+    "row_widget_num" : 3,
+    "is_favorite" : false
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

The server failed to process the request.

+

401

+

Token authentication is required.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Dashboards
+
+
+ diff --git a/docs/ces/api-ref/ListOneClickAlarmRules.html b/docs/ces/api-ref/ListOneClickAlarmRules.html new file mode 100644 index 000000000..0f094845f --- /dev/null +++ b/docs/ces/api-ref/ListOneClickAlarmRules.html @@ -0,0 +1,670 @@ + + +

Querying Alarm Rules for One Service in One-Click Monitoring

+

Function

This API is used to query alarm rules for one service in one-click monitoring.

+
+

URI

GET /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/alarms

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

one_click_alarm_id

+

Yes

+

String

+

One-click monitoring ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^([a-z]|[A-Z]|[0-9]){1,64}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. The default value is application/json; charset=UTF-8.

+

Default: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

alarms

+

Array of alarms objects

+

Alarm rule list.

+

Array length: 1 to 100

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 alarms

Parameter

+

Type

+

Description

+

alarm_id

+

String

+

ID of an alarm rule, which starts with al and is followed by 22 characters of letters, digits, or a combination of both.

+

name

+

String

+

Name of an alarm rule. The name allows 1 to 128 characters and can only contain letters, digits, underscores (_), and hyphens (-).

+

description

+

String

+

Alarm rule description. The value can contain 0 to 256 characters.

+

namespace

+

String

+

Namespace of a service. For details about the namespace of each service, see Service Namespaces. The namespace must be in the service.item format and contain 3 to 32 characters. service and item must start with a letter and can contain only letters, digits, and underscores (_).

+

policies

+

Array of Policy objects

+

Alarm policies.

+

Array length: 1 to 100

+

resources

+

Array of Resources object

+

Resource list. Associated resources can be obtained by calling the API for querying resources in an alarm rule.

+

Array length: 1 to 3000

+

type

+

String

+

Alarm rule type.

+

The value can be:

+
  • ALL_INSTANCE: alarms for all resources
  • RESOURCE_GROUP: alarms for resource groups
  • MULTI_INSTANCE: alarms for specified resources
  • EVENT.SYS: system event alarms
  • EVENT.CUSTOM: custom event alarms
+

enabled

+

Boolean

+

Whether to generate alarms when the alarm triggering conditions are met.

+

notification_enabled

+

Boolean

+

Whether to enable alarm notifications.

+

alarm_notifications

+

Array of Notification objects

+

Action to be triggered by the alarm. Array length: 0 to 10

+

ok_notifications

+

Array of Notification objects

+

Action to be triggered after an alarm is cleared. Array length: 0 to 10

+

notification_begin_time

+

String

+

Time when the alarm notification was enabled. Example: 09:00

+

Regular expression matching: ^([1][0-9]|2[0-3]):([0-5][0-9])$

+

notification_end_time

+

String

+

Time when the alarm notification was disabled. Example: 12:00

+

Regular expression matching: ^([1][0-9]|2[0-3]):([0-5][0-9])$

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Policy

Parameter

+

Type

+

Description

+

alarm_policy_id

+

String

+

Alarm policy ID.

+

Regular expression matching: ^([a-z]|[A-Z]|[0-9]|-)+$

+

metric_name

+

String

+

Metric name of a resource. For details about the metrics of each service, see Service Metric Names. The value must start with a letter and can only contain digits, letters, underscores (_), and hyphens (-). It allows 1 to 96 characters. For example, the ECS metric cpu_util indicates the CPU usage of an ECS. The DDS metric mongo001_command_ps indicates the command execution frequency.

+

Regular expression matching: ^([A-Za-z]){1}([0-9A-Za-z]|_|-)*$

+

period

+

Integer

+

How often to generate an alarm, in seconds. 1 indicates that alarms are generated based on raw data. When alarm_type is EVENT.SYS or EVENT.CUSTOM, the value may be 0.

+

The value can be:

+

  • 0

    +

  • 1

    +

  • 300

    +

  • 1200

    +

  • 3600

    +

  • 14400

    +

  • 86400

    +
+

filter

+

String

+

Data aggregation method. The value can be:

+
  • average: average value of metric data within an aggregation period.
  • max: maximum value of metric data in an aggregation period.
  • min: minimum value of metric data within an aggregation period.
  • sum: sum of metric data within an aggregation period.
  • variance: variance value of metric data within an aggregation period.
+

comparison_operator

+

String

+

Operator of an alarm threshold.

+

Regular expression matching: ^(>|<|>=|<=|=|!=)$

+

value

+

Number

+

Alarm threshold. Supported range: 0 to Number. MAX_VALUE (1.7976931348623157e+108) For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS cpu_util to 80.

+

Minimum: 0

+

Maximum: 1.7976931348623157e+108

+

unit

+

String

+

Data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

+

Minimum: 0

+

Maximum: 32

+

count

+

Integer

+

Number of times that the alarm triggering conditions are met. Value range: 1 to 180

+

suppress_duration

+

Integer

+

Suppression period, in seconds. 0 indicates that only one alarm is generated.

+

The value can be:

+

  • 0

    +

  • 300

    +

  • 600

    +

  • 900

    +

  • 1800

    +

  • 3600

    +

  • 10800

    +

  • 21600

    +

  • 43200

    +

  • 86400

    +
+

level

+

Integer

+

Alarm severity, which can be 1 (critical), 2 (major), 3 (minor), or 4 (warning).

+

enabled

+

Boolean

+

Whether to enable the function.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Resources

Parameter

+

Type

+

Description

+

resource_group_id

+

String

+

Resource group ID. This parameter is available when the monitoring scope is Resource groups.

+

Regular expression matching: ^rg([a-z]|[A-Z]|[0-9]){22}$

+

resource_group_name

+

String

+

Resource group name. This parameter is available when the monitoring scope is set to Resource groups.

+

Minimum: 1

+

Maximum: 128

+

Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

+

dimensions

+

Array of Dimensions objects

+

Dimension information.

+

Array length: 0 to 10000

+
+
+ +
+ + + + + + + +
Table 7 Dimensions

Parameter

+

Description

+

name

+

Metric dimension name.

+

Minimum: 1

+

Maximum: 32

+

Regular expression matching: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 Notification

Parameter

+

Type

+

Description

+

type

+

String

+

Notification type.

+

The value can be:

+

notification: topic subscriptions. Notifications are sent using SMN topics.

+

contact: cloud account contacts. Notifications are sent using the mobile number and email address registered for your account.

+

notification_list

+

Array of strings

+

List of objects to be notified of alarm status changes. The value of topicUrn can be obtained from SMN. For details, see section Querying Topics. If type is set to notification, the value of notificationList cannot be empty. If type is set to autoscaling, the value of notificationList must be empty. If you set alarm_action_enabled to true, you must specify either alarm_actions or ok_actions. If alarm_actions and ok_actions coexist, their notificationList must be the same.

+

Array length: 0 to 20

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 11 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 12 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Query alarm rules of a service in one-click monitoring.

+
GET /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/alarms
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "alarms" : [ {
+    "alarm_id" : "al123232232341232132",
+    "name" : "alarm1",
+    "description" : "hello world",
+    "namespace" : "SYS.ECS",
+    "policies" : [ {
+      "alarm_policy_id" : "alxdxxxdsw12321321",
+      "metric_name" : "cpu_util",
+      "period" : 0,
+      "filter" : "max",
+      "comparison_operator" : "",
+      "value" : 1.7976931348623156E108,
+      "unit" : "%",
+      "count" : 100,
+      "suppress_duration" : 0,
+      "level" : 2,
+      "enabled" : true
+    } ],
+    "resources" : [ {
+      "dimensions" : [ {
+        "name" : "string",
+        "value" : "string"
+      } ]
+    } ],
+    "type" : "EVENT.SYS",
+    "enabled" : true,
+    "notification_enabled" : true,
+    "alarm_notifications" : [ {
+      "type" : "notification",
+      "notification_list" : [ "urn:smn:123" ]
+    } ],
+    "ok_notifications" : [ {
+      "type" : "notification",
+      "notification_list" : [ "urn:smn:123" ]
+    } ],
+    "notification_begin_time" : "00:00",
+    "notification_end_time" : "23:59"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: One-Click Monitoring
+
+
+ diff --git a/docs/ces/api-ref/ListOneClickAlarms.html b/docs/ces/api-ref/ListOneClickAlarms.html new file mode 100644 index 000000000..bae439445 --- /dev/null +++ b/docs/ces/api-ref/ListOneClickAlarms.html @@ -0,0 +1,358 @@ + + +

Querying Services and Resources in One-Click Monitoring

+

Function

This API is used to query services and resources in one-click monitoring.

+
+

URI

GET /v2/{project_id}/one-click-alarms

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. The default value is application/json; charset=UTF-8.

+

Default: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

one_click_alarms

+

Array of one_click_alarms objects

+

Services and resources in one-click monitoring.

+

Array length: 1 to 1000

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 one_click_alarms

Parameter

+

Type

+

Description

+

one_click_alarm_id

+

String

+

One-click monitoring ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^([a-z]|[A-Z]|[0-9]){1,64}$

+

namespace

+

String

+

Namespace of a service. For details about the namespace of each service, see Service Namespaces. The namespace must be in the service.item format and contain 3 to 32 characters. The values of service and item must start with a letter and can only contain letters, digits, and underscores (_).

+

Minimum: 3

+

Maximum: 32

+

description

+

String

+

Supplementary information about one-click monitoring. The description can contain 0 to 256 characters and is left blank by default.

+

enabled

+

Boolean

+

Whether to enable one-click monitoring.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Query services and resources that support one-click monitoring.

+
GET /v2/{project_id}/one-click-alarms
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "one_click_alarms" : [ {
+    "one_click_alarm_id" : "o1234567890123456789012",
+    "namespace" : "SYS.ECS",
+    "description" : "hello world",
+    "enabled" : true
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: One-Click Monitoring
+
+
+ diff --git a/docs/ces/api-ref/ListResourceGroups.html b/docs/ces/api-ref/ListResourceGroups.html new file mode 100644 index 000000000..c71f4951f --- /dev/null +++ b/docs/ces/api-ref/ListResourceGroups.html @@ -0,0 +1,463 @@ + + +

Querying Resource Groups

+

Function

This API is used to query resource groups.

+
+

URI

GET /v2/{project_id}/resource-groups

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

enterprise_project_id

+

No

+

String

+

ID of the enterprise project that a resource group belongs to.

+

Regular expression matching: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$

+

group_name

+

No

+

String

+

Resource group name. Fuzzy search is supported.

+

Minimum: 1

+

Maximum: 128

+

Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

+

group_id

+

No

+

String

+

Resource group ID. The value starts with rg and is followed by 22 characters of letters, digits, or a combination of both.

+

Minimum: 24

+

Maximum: 24

+

offset

+

No

+

Integer

+

Start position for pagination query, indicating the sequence number of the data record where the query starts. The default value is 0.

+

Minimum: 0

+

Maximum: 10000

+

limit

+

No

+

Integer

+

Number of items on each page during pagination query. The value ranges from 1 to 100 (default).

+

Minimum: 1

+

Maximum: 100

+

type

+

No

+

String

+

Method for adding resources to a resource group. The value can only be EPS (synchronizing resources from enterprise projects), TAG (dynamic tag matching), or Manual (manually adding resources). If this parameter is not specified, all resource groups are queried.

+

The value can be:

+

  • EPS

    +

  • TAG

    +

  • Manual

    +
+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

count

+

Integer

+

Total number of resource groups.

+

Minimum: 0

+

Maximum: 1000

+

resource_groups

+

Array of OneResourceGroupResp objects

+

Resource group list.

+

Array length: 0 to 100

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 OneResourceGroupResp

Parameter

+

Type

+

Description

+

group_name

+

String

+

Resource group name.

+

Regular expression matching: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$

+

group_id

+

String

+

Resource group ID. The value starts with rg and is followed by 22 characters of letters, digits, or a combination of both.

+

Minimum: 24

+

Maximum: 24

+

create_time

+

String

+

Time when the resource group was created. The value is in the 2006-01-02T15:04:05.000Z format.

+

enterprise_project_id

+

String

+

ID of the enterprise project that a resource group belongs to.

+

Regular expression matching: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$

+

type

+

String

+

Method for adding resources to a resource group. The value can only be EPS (synchronizing resources from enterprise projects), TAG (dynamic tag matching), or Manual (manually adding resources).

+

The value can be:

+

  • EPS

    +

  • TAG

    +

  • Manual

    +
+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Querying resource groups

+
/v2/{project_id}/resource-groups?offset=0&limit=100
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "resource_groups" : [ {
+    "group_name" : "group1",
+    "create_time" : "2006-01-02T15:04:05.000Z",
+    "group_id" : "rg1761380163308Dxxxxxxxx",
+    "enterprise_project_id" : "0",
+    "type" : "Manual"
+  }, {
+    "group_name" : "band",
+    "type" : "EPS",
+    "create_time" : "2006-01-02T15:04:05.000Z",
+    "group_id" : "rg1761380163309Dxxxxxxxx",
+    "enterprise_project_id" : "d61d4705-5658-42f5-8e0c-70eb34d17b02"
+  }, {
+    "group_name" : "group2",
+    "type" : "TAG",
+    "create_time" : "2006-01-02T15:04:05.000Z",
+    "group_id" : "rg1761380163310Dxxxxxxxx",
+    "enterprise_project_id" : "0"
+  } ],
+  "count" : 3
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Groups
+
+
+ diff --git a/docs/ces/api-ref/ListResourceGroupsServicesResources.html b/docs/ces/api-ref/ListResourceGroupsServicesResources.html new file mode 100644 index 000000000..6bda6387d --- /dev/null +++ b/docs/ces/api-ref/ListResourceGroupsServicesResources.html @@ -0,0 +1,527 @@ + + +

Querying Resources of a Specified Dimension for a Specified Service Type in a Resource Group

+

Function

This API is used to query resources of a specified dimension for a specified resource type in a resource group.

+
+

URI

GET /v2/{project_id}/resource-groups/{group_id}/services/{service}/resources

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

group_id

+

Yes

+

String

+

Resource group ID. The value starts with rg and is followed by 22 characters of letters, digits, or a combination of both.

+

Minimum: 24

+

Maximum: 24

+

service

+

Yes

+

String

+

Service type, for example, SYS.ECS.

+

Namespace of a service. For details about the namespace of each service, see Service Namespaces. The namespace must be in the service.item format and contain 3 to 32 characters. service and item must start with a letter and can contain only letters, digits, and underscores (_).

+

Minimum: 3

+

Maximum: 32

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dim_name

+

No

+

String

+

Resource dimension information. If there are multiple dimensions, they are sorted in alphabetical order and separated by commas (,). This parameter must be used together with namespace.

+

Regular expression matching:

+
^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-|,)*$
+

limit

+

No

+

String

+

Number of items on each page during pagination query. The value ranges from 1 to 1000. The default value is 100.

+

Minimum: 1

+

Maximum: 1000

+

offset

+

No

+

Integer

+

Start position for pagination query, indicating the sequence number of the data record where the query starts. The default value is 0.

+

Minimum: 0

+

Maximum: 10000

+

status

+

No

+

String

+

Resource health status.

+

The value can be:

+

  • health: An alarm rule has been created for the resource and there is no alarm triggered.

    +

  • unhealthy: An alarm rule has been created for the resource and there are alarms triggered.

    +

  • no_alarm_rule: No alarm rule has been created for the resource.

    +
+

dim_value

+

No

+

String

+

Resource dimension value. Fuzzy match is not supported. If a resource has multiple dimensions, you can specify one of them.

+

Minimum: 1

+

Maximum: 256

+

Regular expression matching:

+
^([a-z]|[A-Z]|[0-9]|\*|_){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*$
+

extend_relation_id

+

No

+

String

+

Enterprise project ID.

+

Minimum: 1

+

Maximum: 128

+

Regular expression matching: ^([a-z]|[A-Z]|[0-9]|_|-)+$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

count

+

Integer

+

Total number of resources.

+

Minimum: 0

+

Maximum: 10000

+

resources

+

Array of GetResourceGroupResources objects

+

Resources in a resource group.

+

Array length: 0 to 100

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 GetResourceGroupResources

Parameter

+

Type

+

Description

+

status

+

String

+

Resource health status.

+

The value can be:

+

  • health: An alarm rule has been created for the resource and there is no alarm triggered.

    +

  • unhealthy: An alarm rule has been created for the resource and there are alarms triggered.

    +

  • no_alarm_rule: No alarm rule has been created for the resource.

    +
+

dimensions

+

Array of Dimension objects

+

Resource dimension information.

+

Array length: 1 to 4

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 Dimension

Parameter

+

Type

+

Description

+

name

+

String

+

Dimension of a resource. For example, the dimension of an ECS can be instance_id. A maximum of four dimensions are supported. For the metric dimension of each resource, see Service Metric Dimensions.

+

Regular expression matching: ^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$

+

value

+

String

+

Resource dimension value, which is an instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755.

+

Regular expression matching:

+
^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$
+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 11 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Querying resources of a specified dimension for a specified resource type in a resource group.

+
/v2/{project_id}/resource-groups/{group_id}/services/{service}/resources
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "count" : 1000,
+  "resources" : [ {
+    "status" : "health",
+    "dimensions" : [ {
+      "name" : "instance_id",
+      "value" : "4270ff17-aba3-4138-89fa-820594c39755"
+    } ]
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

404

+

Resources not found.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resources in a Resource Group
+
+
+ diff --git a/docs/ces/api-ref/ShowAlarmTemplate.html b/docs/ces/api-ref/ShowAlarmTemplate.html new file mode 100644 index 000000000..83b0e96f3 --- /dev/null +++ b/docs/ces/api-ref/ShowAlarmTemplate.html @@ -0,0 +1,531 @@ + + +

Querying Details of an Alarm Template

+

Function

This API is used to query details of an alarm template.

+
+

URI

GET /v2/{project_id}/alarm-templates/{template_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

template_id

+

Yes

+

String

+

ID of an alarm template. The ID starts with at and is followed by letters, digits, or a combination of both. The value can contain a maximum of 64 characters.

+

Minimum: 2

+

Maximum: 64

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

template_id

+

String

+

ID of an alarm template. The ID starts with at and is followed by letters, digits, or a combination of both. The value can contain a maximum of 64 characters.

+

template_name

+

String

+

Alarm template name. It must start with a letter and can contain letters, digits, underscores (_), hyphens (-), parentheses, and periods (.). Fuzzy match is supported.

+

Minimum: 1

+

Maximum: 128

+

Regular expression matching:

+
^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-|\(|\)|\.|\s)+$
+

template_type

+

String

+

Type of an alarm template. custom indicates custom alarm templates, and system indicates default alarm templates.

+

The value can be:

+

  • system

    +

  • custom

    +
+

create_time

+

String

+

Time when an alarm template was created. The value is in the 2006-01-02T15:04:05.000Z format.

+

template_description

+

String

+

Supplementary information about an alarm template. The description can contain 0 to 256 characters and is left blank by default.

+

policies

+

Array of policies objects

+

Alarm policies in an alarm template.

+

Array length: 1 to 50

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 policies

Parameter

+

Type

+

Description

+

namespace

+

String

+

Namespace of a service. For details about the namespace of each service, see Service Namespaces. The namespace must be in the service.item format and contain 3 to 32 characters. service and item must start with a letter and can contain only letters, digits, and underscores (_).

+

Minimum: 3

+

Maximum: 32

+

dimension_name

+

String

+

Resource dimension, which must start with a letter. A dimension allows a maximum of 32 characters can only contain digits, letters, underscores (_), and hyphens (-). If there are multiple dimensions, use commas (,) to separate them. DimensionName in event alarm templates must be left blank.

+

metric_name

+

String

+

Metric name of a resource. For details about the metrics of each service, see Service Metric Names. The value must start with a letter and can only contain digits, letters, underscores (_), and hyphens (-). It allows 1 to 96 characters. For example, the ECS metric cpu_util indicates the CPU usage of an ECS. The DDS metric mongo001_command_ps indicates the command execution frequency.

+

Regular expression matching: ^([A-Za-z]){1}([0-9A-Za-z]|_|-)*$

+

period

+

Integer

+

Interval (seconds) for checking whether the alarm rule conditions are met.

+

The value can be:

+

  • 0

    +

  • 1

    +

  • 300

    +

  • 1200

    +

  • 3600

    +

  • 14400

    +

  • 86400

    +
+

filter

+

String

+

Data aggregation method. The value can be:

+
  • average: average value of metric data within an aggregation period.
  • max: maximum value of metric data in an aggregation period.
  • min: minimum value of metric data within an aggregation period.
  • sum: sum of metric data within an aggregation period.
  • variance: variance value of metric data within an aggregation period.
+

comparison_operator

+

String

+

Operator of an alarm threshold.

+

Regular expression matching: ^(>|<|>=|<=|=|!=)$

+

value

+

Number

+

Alarm threshold.

+

Minimum: 0

+

Maximum: 2.34854258277383E108

+

unit

+

String

+

Data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

+

Minimum: 0

+

Maximum: 32

+

count

+

Integer

+

Number of consecutive alarm triggering times. For event alarms, the value ranges from 1 to 180. For metric and website alarms, the value can be 1, 2, 3, 4, 5, 10, 15, 30, 60, 90, 120, or 180.

+

alarm_level

+

Integer

+

Alarm severity, which can be 1 (critical), 2 (major), 3 (minor), or 4 (warning). The default value is 2.

+

suppress_duration

+

Integer

+

Alarm suppression period, in seconds. When the period is 0, only one alarm is generated.

+

The value can be:

+

  • 0

    +

  • 300

    +

  • 600

    +

  • 900

    +

  • 1800

    +

  • 3600

    +

  • 10800

    +

  • 21600

    +

  • 43200

    +

  • 86400

    +
+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Querying details of an alarm template

+
/v2/{project_id}/alarm-templates/{template_id}
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "template_id" : "at1628592157541dB1klWgY6",
+  "template_name" : "my_template",
+  "template_type" : "custom",
+  "create_time" : "2006-01-02T15:04:05.000Z",
+  "template_description" : "hello world",
+  "policies" : [ {
+    "namespace" : "SYS.ECS",
+    "dimension_name" : "instance_id",
+    "metric_name" : "cpu_util",
+    "period" : 300,
+    "filter" : "sum",
+    "comparison_operator" : ">",
+    "value" : 2,
+    "unit" : "bit/s",
+    "count" : 2,
+    "alarm_level" : 2,
+    "suppress_duration" : 300
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

404

+

Resources not found.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm Templates
+
+
+ diff --git a/docs/ces/api-ref/ShowResourceGroup.html b/docs/ces/api-ref/ShowResourceGroup.html new file mode 100644 index 000000000..b4ee9f5d6 --- /dev/null +++ b/docs/ces/api-ref/ShowResourceGroup.html @@ -0,0 +1,447 @@ + + +

Querying Details of a Resource Group

+

Function

This API is used to query details of a resource group.

+
+

URI

GET /v2/{project_id}/resource-groups/{group_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

group_id

+

Yes

+

String

+

Resource group ID. The value starts with rg and is followed by 22 characters of letters, digits, or a combination of both.

+

Minimum: 24

+

Maximum: 24

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

group_name

+

String

+

Resource group name.

+

Regular expression matching: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$

+

group_id

+

String

+

Resource group ID. The value starts with rg and is followed by 22 characters of letters, digits, or a combination of both.

+

Minimum: 24

+

Maximum: 24

+

create_time

+

String

+

Time when the resource group was created. The value is in the 2006-01-02T15:04:05.000Z format.

+

enterprise_project_id

+

String

+

ID of the enterprise project that a resource group belongs to.

+

Regular expression matching: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$

+

type

+

String

+

Method for adding resources to a resource group. The value can only be EPS (synchronizing resources from enterprise projects), TAG (dynamic tag matching), or Manual (manually adding resources).

+

The value can be:

+

  • EPS

    +

  • TAG

    +

  • Manual

    +
+

association_ep_ids

+

Array of strings

+

ID of the enterprise project from which resources in the resource group come. This parameter is mandatory when type is set to EPS.

+

Array length: 1 to 10

+

tags

+

Array of ResourceGroupTagRelation objects

+

Associated tag during dynamic tag matching. This parameter must be specified when type is set to TAG.

+

Array length: 1 to 10

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 ResourceGroupTagRelation

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key.

+

Minimum: 1

+

Maximum: 36

+

Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

+

value

+

String

+

Tag value.

+

Minimum: 0

+

Maximum: 43

+

Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|\.|_|-)*$

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Querying details of a specified resource group

+
/v2/{project_id}/resource-groups/{group_id}
+
+

Example Responses

Status code: 200

+

OK

+
{
+  "group_name" : "band",
+  "type" : "TAG",
+  "tags" : [ {
+    "key" : "Resource",
+    "value" : "VPC"
+  }, {
+    "key" : "Usage",
+    "value" : "Tmp"
+  } ],
+  "create_time" : "2006-01-02T15:04:05.000Z",
+  "group_id" : "rg1761380163308Dxxxxxxxx",
+  "enterprise_project_id" : "0"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

OK

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

404

+

Resources not found.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Groups
+
+
+ diff --git a/docs/ces/api-ref/UpdateAlarmRulePolicies.html b/docs/ces/api-ref/UpdateAlarmRulePolicies.html new file mode 100644 index 000000000..001851444 --- /dev/null +++ b/docs/ces/api-ref/UpdateAlarmRulePolicies.html @@ -0,0 +1,521 @@ + + +

Modifying Policies in an Alarm Rule

+

Function

This API is used to modify alarm policies in an alarm rule.

+
+

URI

PUT /v2/{project_id}/alarms/{alarm_id}/policies

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

alarm_id

+

Yes

+

String

+

Alarm rule ID.

+

Regular expression matching: ^al([0-9A-Za-z]){22}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

No

+

String

+

MIME type of the request body. The default value is application/json; charset=UTF-8.

+

Default: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

No

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

policies

+

Yes

+

Array of UpdatePolicy objects

+

Policy information.

+

Array length: 1 to 50

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 UpdatePolicy

Parameter

+

Mandatory

+

Type

+

Description

+

metric_name

+

Yes

+

String

+

Metric name of a resource. The name must start with a letter and contain only digits, letters, and underscores (_). The length ranges from 1 to 64 characters. For example, cpu_util of an ECS indicates the CPU usage of the ECS. mongo001_command_ps in DDS indicates the command execution frequency. For details about the metric name of each service, see Service Metric Names.

+

Regular expression matching: ^([A-Za-z]){1}([0-9A-Za-z]|_|-)*$

+

period

+

Yes

+

Integer

+

Monitoring period of a metric, in seconds. The default value is 0. For an event alarm, set this parameter to 0. 1 indicates the original aggregation period of a metric. For example, if the original aggregation period of an RDS metric is 60s, its data point is calculated every 60 seconds. For details about the original aggregation period of each cloud service metric, see Services Interconnected with Cloud Eye. 300 indicates that the metric aggregation period is 5 minutes.

+

Minimum: 0

+

Maximum: 86400

+

The value can be:

+

  • 0

    +

  • 1

    +

  • 300

    +

  • 1200

    +

  • 3600

    +

  • 14400

    +

  • 86400

    +
+

filter

+

Yes

+

String

+

Data aggregation method. The value can be:

+
  • average: average value of metric data within an aggregation period.
  • max: maximum value of metric data in an aggregation period.
  • min: minimum value of metric data within an aggregation period.
  • sum: sum of metric data within an aggregation period.
  • variance: variance value of metric data within an aggregation period.
+

comparison_operator

+

Yes

+

String

+

Operator of an alarm threshold.

+

Regular expression matching: ^(>|<|>=|<=|=|!=)$

+

value

+

No

+

Number

+

Alarm threshold. Supported range: 0 to Number.MAX_VALUE (1.7976931348623157e+108) For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS cpu_util to 80.

+

Minimum: 0

+

Maximum: 1.7976931348623157e+108

+

unit

+

No

+

String

+

Data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

+

Minimum: 0

+

Maximum: 32

+

count

+

Yes

+

Integer

+

Number of times that the alarm triggering conditions are met. For event alarms, the value ranges from 1 to 180. For metric and website alarms, the value can be 1, 2, 3, 4, 5, 10, 15, 30, 60, 90, 120, or 180.

+

suppress_duration

+

No

+

Integer

+

Alarm suppression time, in seconds. This parameter corresponds to the last field in the alarm policy when an alarm rule is created on the Cloud Eye console. This field is used to avoid frequent alarms. 0 indicates that the alarm is not suppressed and alarms are generated as long as the conditions are met. 300 indicates that an alarm is generated every 5 minutes as long as the alarm triggering conditions are met.

+

Minimum: 0

+

Maximum: 86400

+

The value can be:

+

  • 0

    +

  • 300

    +

  • 600

    +

  • 900

    +

  • 1800

    +

  • 3600

    +

  • 10800

    +

  • 21600

    +

  • 43200

    +

  • 86400

    +
+

level

+

No

+

Integer

+

Alarm severity, which can be 1 (critical), 2 (major), 3 (minor), or 4 (informational). The default value is 2.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

policies

+

Array of UpdatePolicy objects

+

Policy information.

+

Array length: 1 to 50

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 UpdatePolicy

Parameter

+

Type

+

Description

+

metric_name

+

String

+

Metric name of a resource. The name must start with a letter and contain only digits, letters, and underscores (_). The length ranges from 1 to 64 characters. For example, cpu_util of an ECS indicates the CPU usage of the ECS. mongo001_command_ps in DDS indicates the command execution frequency. For details about the metric name of each service, see Service Metric Names.

+

Regular expression matching: ^([A-Za-z]){1}([0-9A-Za-z]|_|-)*$

+

period

+

Integer

+

Monitoring period of a metric, in seconds. The default value is 0. For an event alarm, set this parameter to 0. 1 indicates the original aggregation period of a metric. For example, if the original aggregation period of an RDS metric is 60s, its data point is calculated every 60 seconds. For details about the original aggregation period of each cloud service metric, see Services Interconnected with Cloud Eye. 300 indicates that the metric aggregation period is 5 minutes.

+

Minimum: 0

+

Maximum: 86400

+

The value can be:

+

  • 0

    +

  • 1

    +

  • 300

    +

  • 1200

    +

  • 3600

    +

  • 14400

    +

  • 86400

    +
+

filter

+

String

+

Data aggregation method. The value can be:

+
  • average: average value of metric data within an aggregation period.
  • max: maximum value of metric data in an aggregation period.
  • min: minimum value of metric data within an aggregation period.
  • sum: sum of metric data within an aggregation period.
  • variance: variance value of metric data within an aggregation period.
+

comparison_operator

+

String

+

Operator of an alarm threshold.

+

Regular expression matching: ^(>|<|>=|<=|=|!=)$

+

value

+

Number

+

Alarm threshold. Supported range: 0 to Number.MAX_VALUE (1.7976931348623157e+108) For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS cpu_util to 80.

+

Minimum: 0

+

Maximum: 1.7976931348623157e+108

+

unit

+

String

+

Data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

+

Minimum: 0

+

Maximum: 32

+

type

+

String

+

Alarm policy type. This parameter is left blank by default.

+

The value can be:

+

  • auto: dynamic threshold.

    +
+
NOTE:

This parameter has been discarded. It has no impact on APIs. It is still retained in this document for compatibility with earlier versions.

+
+

count

+

Integer

+

Number of times that the alarm triggering conditions are met. For event alarms, the value ranges from 1 to 180. For metric and website alarms, the value can be 1, 2, 3, 4, 5, 10, 15, 30, 60, 90, 120, or 180.

+

suppress_duration

+

Integer

+

Alarm suppression time, in seconds. This parameter corresponds to the last field in the alarm policy when an alarm rule is created on the Cloud Eye console. This field is used to avoid frequent alarms. 0 indicates that the alarm is not suppressed and alarms are generated as long as the conditions are met. 300 indicates that an alarm is generated every 5 minutes as long as the alarm triggering conditions are met.

+

Minimum: 0

+

Maximum: 86400

+

The value can be:

+

  • 0

    +

  • 300

    +

  • 600

    +

  • 900

    +

  • 1800

    +

  • 3600

    +

  • 10800

    +

  • 21600

    +

  • 43200

    +

  • 86400

    +
+

level

+

Integer

+

Alarm severity, which can be 1 (critical), 2 (major), 3 (minor), or 4 (informational). The default value is 2.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Modifying an alarm policy whose metric_name is disk_device_read_bytes_rate

+
{
+  "policies" : [ {
+    "metric_name" : "disk_device_read_bytes_rate",
+    "period" : 1,
+    "filter" : "average",
+    "comparison_operator" : ">",
+    "value" : 75,
+    "unit" : "byte/s",
+    "count" : 3,
+    "suppress_duration" : 10800,
+    "level" : 2
+  } ]
+}
+
+

Example Responses

Status code: 200

+

Modification succeeded.

+
{
+  "policies" : [ {
+    "metric_name" : "disk_device_read_bytes_rate",
+    "period" : 1,
+    "filter" : "average",
+    "comparison_operator" : ">",
+    "value" : 75,
+    "unit" : "byte/s",
+    "count" : 3,
+    "type" : "",
+    "suppress_duration" : 10800,
+    "level" : 2
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Modification succeeded.

+

400

+

Parameter verification failed.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm Policies
+
+
+ diff --git a/docs/ces/api-ref/UpdateAlarmTemplate.html b/docs/ces/api-ref/UpdateAlarmTemplate.html new file mode 100644 index 000000000..419d68eea --- /dev/null +++ b/docs/ces/api-ref/UpdateAlarmTemplate.html @@ -0,0 +1,545 @@ + + +

Modifying a Custom Alarm Template

+

Function

This API is used to modify a custom alarm template.

+
+

URI

PUT /v2/{project_id}/alarm-templates/{template_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

template_id

+

Yes

+

String

+

ID of an alarm template.

+

Minimum: 2

+

Maximum: 64

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

template_name

+

Yes

+

String

+

Alarm template name. It must start with a letter and can contain letters, digits, underscores (_), hyphens (-), parentheses, and periods (.). Fuzzy match is supported.

+

Minimum: 1

+

Maximum: 128

+

Regular expression matching:

+
^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-|\(|\)|\.|\s)+$
+

template_type

+

No

+

Integer

+

Type of a custom alarm template.

+

The value can be:

+

  • 0: metric template

    +

  • 2: event template

    +
+

template_description

+

No

+

String

+

Supplementary information about an alarm template. The description can contain 0 to 256 characters and is left blank by default.

+

policies

+

Yes

+

Array of Policies objects

+

Alarm policies in an alarm template.

+

Array length: 1 to 50

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Policies

Parameter

+

Mandatory

+

Type

+

Description

+

namespace

+

Yes

+

String

+

Namespace of a service. For details about the namespace of each service, see Service Namespaces. The namespace must be in the service.item format and contain 3 to 32 characters. service and item must start with a letter and can contain only letters, digits, and underscores (_).

+

Minimum: 3

+

Maximum: 32

+

dimension_name

+

No

+

String

+

Resource dimension, which must start with a letter. A dimension allows a maximum of 32 characters can only contain digits, letters, underscores (_), and hyphens (-). If there are multiple dimensions, use commas (,) to separate them. DimensionName in event alarm templates must be left blank.

+

metric_name

+

Yes

+

String

+

Metric name of a resource. For details about the metrics of each service, see Service Metric Names. The value must start with a letter and can only contain digits, letters, underscores (_), and hyphens (-). It allows 1 to 96 characters. For example, the ECS metric cpu_util indicates the CPU usage of an ECS. The DDS metric mongo001_command_ps indicates the command execution frequency.

+

Regular expression matching: ^([A-Za-z]){1}([0-9A-Za-z]|_|-)*$

+

period

+

Yes

+

Integer

+

Interval (seconds) for checking whether the alarm rule conditions are met.

+

The value can be:

+

  • 0

    +

  • 1

    +

  • 300

    +

  • 1200

    +

  • 3600

    +

  • 14400

    +

  • 86400

    +
+

filter

+

Yes

+

String

+

Data aggregation method. The value can be:

+
  • average: average value of metric data within an aggregation period.
  • max: maximum value of metric data in an aggregation period.
  • min: minimum value of metric data within an aggregation period.
  • sum: sum of metric data within an aggregation period.
  • variance: variance value of metric data within an aggregation period.
+

comparison_operator

+

Yes

+

String

+

Operator of an alarm threshold.

+

Regular expression matching: ^(>|<|>=|<=|=|!=)$

+

value

+

No

+

Number

+

Alarm threshold.

+

Minimum: 0

+

Maximum: Number.MAX_VALUE (1.7976931348623156E108)

+

unit

+

No

+

String

+

Data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

+

Minimum: 0

+

Maximum: 32

+

count

+

Yes

+

Integer

+

Number of consecutive alarm triggering times. For event alarms, the value ranges from 1 to 180. For metric and website alarms, the value can be 1, 2, 3, 4, 5, 10, 15, 30, 60, 90, 120, or 180.

+

alarm_level

+

No

+

Integer

+

Alarm severity, which can be 1 (critical), 2 (major), 3 (minor), or 4 (warning). The default value is 2.

+

suppress_duration

+

Yes

+

Integer

+

Alarm suppression period, in seconds. When the period is 0, only one alarm is generated.

+

The value can be:

+

  • 0

    +

  • 300

    +

  • 600

    +

  • 900

    +

  • 1800

    +

  • 3600

    +

  • 10800

    +

  • 21600

    +

  • 43200

    +

  • 86400

    +
+
+
+
+

Response Parameters

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Modifying a custom template whose template_name is my_template, including its metric period, aggregation method, threshold, unit, count, alarm suppression duration, and alarm severity.

+
{
+  "template_name" : "my_template",
+  "template_description" : "hello world",
+  "policies" : [ {
+    "namespace" : "SYS.ECS",
+    "dimension_name" : "instance_id",
+    "metric_name" : "cpu_util",
+    "period" : 300,
+    "filter" : "sum",
+    "comparison_operator" : ">",
+    "value" : 2,
+    "unit" : "bit/s",
+    "count" : 2,
+    "alarm_level" : 2,
+    "suppress_duration" : 300
+  } ]
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

204

+

No Content

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

404

+

Resources not found.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm Templates
+
+
+ diff --git a/docs/ces/api-ref/UpdateDashboard.html b/docs/ces/api-ref/UpdateDashboard.html new file mode 100644 index 000000000..3f645a781 --- /dev/null +++ b/docs/ces/api-ref/UpdateDashboard.html @@ -0,0 +1,299 @@ + + +

Modifying a Dashboard

+

Function

This API is used to modify a dashboard.

+
+

URI

PUT /v2/{project_id}/dashboards/{dashboard_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

dashboard_id

+

Yes

+

String

+

Dashboard ID, which starts with db and is followed by 22 characters of letters, digits, or a combination of both. Example: db16564943172807wjOmoLyn.

+

The value can contain a maximum of 24 characters.

+

Regular expression matching: ^db([a-z]|[A-Z]|[0-9]){22}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. application/json is recommended.

+

Default value: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

dashboard_name

+

No

+

String

+

Custom dashboard name.

+

Minimum: 1

+

Maximum: 128

+

Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

+

is_favorite

+

No

+

Boolean

+

Whether a dashboard is added to favorites. The value can be true or false.

+

row_widget_num

+

No

+

Integer

+

How a graph is displayed. 0 indicates that you can customize top and left of the graph. 1 indicates one graph per row.

+

Minimum: 0

+

Maximum: 3

+

Default: 3

+
+
+
+

Response Parameters

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

{
+  "dashboard_name" : "dashboard_name_new",
+  "is_favorite" : true,
+  "row_widget_num" : 0
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

204

+

No Content

+

400

+

The server failed to process the request.

+

401

+

Token authentication is required.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Dashboards
+
+
+ diff --git a/docs/ces/api-ref/UpdateOneClickAlarmNotifications.html b/docs/ces/api-ref/UpdateOneClickAlarmNotifications.html new file mode 100644 index 000000000..c6d71abbb --- /dev/null +++ b/docs/ces/api-ref/UpdateOneClickAlarmNotifications.html @@ -0,0 +1,451 @@ + + +

Batch Modifying Alarm Notifications in Alarm Rules for One Service with One-Click Monitoring Enabled

+

Function

This API is used to batch modify alarm notifications in alarm rules for one service with one-click monitoring enabled.

+
+

URI

PUT /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/notifications

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

one_click_alarm_id

+

Yes

+

String

+

One-click monitoring ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^([a-z]|[A-Z]|[0-9]){1,64}$

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. The default value is application/json; charset=UTF-8.

+

Default: application/json; charset=UTF-8

+

Minimum: 1

+

Maximum: 64

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

notification_enabled

+

Yes

+

Boolean

+

Whether to enable alarm notifications. The value can be true (enable) or false (disable).

+

alarm_notifications

+

No

+

Array of Notification objects

+

Action to be triggered by the alarm. Array length: 0 to 10

+

ok_notifications

+

No

+

Array of Notification objects

+

Action to be triggered after an alarm is cleared. Array length: 0 to 10

+

notification_begin_time

+

No

+

String

+

Time when the alarm notification was enabled. Example: 09:00

+

Regular expression matching: ^([01][0-9]|2[0-3]):([0-5][0-9])$

+

notification_end_time

+

No

+

String

+

Time when the alarm notification was disabled. Example: 12:00

+

Regular expression matching: ^([01][0-9]|2[0-3]):([0-5][0-9])$

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 Notification

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

Yes

+

String

+

Notification type.

+

The value can be:

+

notification: topic subscriptions. Notifications are sent using SMN topics.

+

contact: cloud account contacts. Notifications are sent using the mobile number and email address registered for your account.

+

notification_list

+

Yes

+

Array of strings

+

List of objects to be notified of alarm status changes. The value of topicUrn can be obtained from SMN. For details, see section Querying Topics. If type is set to notification, the value of notificationList cannot be empty. If type is set to autoscaling, the value of notificationList must be empty. If you set alarm_action_enabled to true, you must specify either alarm_actions or ok_actions. If alarm_actions and ok_actions coexist, their notificationList must be the same.

+

Array length: 0 to 20

+
+
+
+

Response Parameters

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Batch modify alarm notifications in alarm rules for one service that has one-click monitoring enabled.

+
PUT /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/notifications
+

Request body:

+
{
+  "notification_enabled" : true,
+  "alarm_notifications" : [ {
+    "type" : "notification",
+    "notification_list" : [ "urn:smn:123" ]
+  } ],
+  "ok_notifications" : [ {
+    "type" : "notification",
+    "notification_list" : [ "urn:smn:123" ]
+  } ],
+  "notification_begin_time" : "00:00",
+  "notification_end_time" : "23:59"
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

204

+

No Content

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

404

+

Resources not found.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: One-Click Monitoring
+
+
+ diff --git a/docs/ces/api-ref/UpdateResourceGroup.html b/docs/ces/api-ref/UpdateResourceGroup.html new file mode 100644 index 000000000..da7b60bf5 --- /dev/null +++ b/docs/ces/api-ref/UpdateResourceGroup.html @@ -0,0 +1,406 @@ + + +

Modifying a Resource Group

+

Function

This API is used to modify a resource group.

+
+

URI

PUT /v2/{project_id}/resource-groups/{group_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

For details about how to obtain the project ID, see Obtaining a Project ID.

+

Minimum: 1

+

Maximum: 64

+

Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

+

group_id

+

Yes

+

String

+

Resource group ID. The value starts with rg and is followed by 22 characters of letters, digits, or a combination of both.

+

Minimum: 24

+

Maximum: 24

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of X-Subject-Token in the response header is the token.

+

Minimum: 1

+

Maximum: 16384

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

group_name

+

Yes

+

String

+

Resource group name. The value allows a maximum of 128 characters and can only contain letters, digits, hyphens (-), and underscores (_).

+

Minimum: 1

+

Maximum: 128

+

tags

+

No

+

Array of ResourceGroupTagRelation objects

+

Associated tag during dynamic tag matching. This parameter must be specified when type is set to TAG.

+

Array length: 1 to 10

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 ResourceGroupTagRelation

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Tag key.

+

Minimum: 1

+

Maximum: 36

+

Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$

+

value

+

No

+

String

+

Tag value.

+

Minimum: 0

+

Maximum: 43

+

Regular expression matching: ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|\.|_|-)*$

+
+
+
+

Response Parameters

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 401

+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Status code customized by each cloud service when a request error occurs.

+

Minimum: 0

+

Maximum: 256

+

error_msg

+

String

+

Request error message.

+

Minimum: 0

+

Maximum: 256

+

request_id

+

String

+

Request ID.

+

Minimum: 0

+

Maximum: 256

+
+
+
+

Example Requests

Modifying the resource group named rg_test

+
{
+  "group_name" : "test",
+  "tags" : [ {
+    "key" : "key1",
+    "value" : "value1"
+  } ]
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

204

+

No Content

+

400

+

Parameter verification failed.

+

401

+

Authentication failed.

+

403

+

Authentication failed.

+

404

+

Resources not found.

+

500

+

Failed to complete the request because of an internal server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Groups
+
+
+ diff --git a/docs/ces/api-ref/ces_01_0054.html b/docs/ces/api-ref/ces_01_0054.html index 1e69d9329..cd160ff11 100644 --- a/docs/ces/api-ref/ces_01_0054.html +++ b/docs/ces/api-ref/ces_01_0054.html @@ -1,2715 +1,4263 @@

Events Supported by Event Monitoring

-

Events in Event Monitoring come from operations on cloud service resources and are not collected by the Agent in Server Monitoring.

+
  • Events in Event Monitoring come from operations on cloud service resources and are not collected by the Agent in Server Monitoring.
  • The name of a resource that supports event reporting can contain a maximum of 128 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). If it contains other characters, the event may fail to be reported to Cloud Eye.
-
Table 1 Elastic Cloud Server (ECS)

Event Source

+
- - - - - - + - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Elastic Cloud Server (ECS)

Event Source

Event Name

+

Namespace

Event ID

+

Event Name

Event Severity

+

Event ID

Description

+

Event Severity

Solution

+

Description

Impact

+

Solution

+

Impact

ECS

+

ECS

Delete ECS

+

SYS.ECS

deleteServer

+

Restart triggered due to hardware fault

Major

+

startAutoRecovery

The ECS was deleted

-
  • on the management console.
  • by calling APIs.
+

Major

Check whether the deletion was performed intentionally by a user.

+

ECSs on a faulty host would be automatically migrated to another properly-running host. During the migration, the ECSs was restarted.

Services are interrupted.

+

Wait for the event to end and check whether services are affected.

+

Services may be interrupted.

Reboot ECS

+

Restart completed due to hardware failure

rebootServer

+

endAutoRecovery

Minor

+

Major

The ECS was restarted

-
  • on the management console.
  • by calling APIs.
+

The ECS was recovered after the automatic migration.

Check whether the restart was performed intentionally by a user.

-
  • Deploy service applications in HA mode.
  • After the ECS starts up, check whether services recover.
+

This event indicates that the ECS has recovered and been working properly.

Services are interrupted.

+

None

Resize ECS

+

Auto recovery timeout (being processed on the backend)

resizeServer

+

faultAutoRecovery

Minor

+

Major

The ECS was resized

-
  • on the management console.
  • by calling APIs.
+

Migrating the ECS to a normal host timed out.

  • Check whether the operation was performed by a user.
  • Deploy service applications in HA mode.
  • After the ECS is resized, check whether services have recovered.
+

Migrate services to other ECSs.

Services are interrupted.

+

Services are interrupted.

Restart triggered due to system faults

+

ECS deleted

startAutoRecovery

+

deleteServer

Major

+

Major

ECSs on a faulty host would be automatically migrated to another properly-running host. During the migration, the ECSs was restarted.

+

The ECS was deleted

+
  • on the management console.
  • by calling APIs.

Wait for the event to end and check whether services are affected.

+

Check whether the deletion was performed intentionally by a user.

Services may be interrupted.

+

Services are interrupted.

Restart completed due to system faults

+

ECS restarted

endAutoRecovery

+

rebootServer

Major

+

Minor

The ECS was recovered after the automatic migration.

+

The ECS was restarted

+
  • on the management console.
  • by calling APIs.

This event indicates that the ECS has recovered and been working properly.

+

Check whether the restart was performed intentionally by a user.

+
  • Deploy service applications in HA mode.
  • After the ECS starts up, check whether services recover.

None

+

Services are interrupted.

Auto recovery timeout (being processed on the backend)

+

ECS stopped

faultAutoRecovery

+

stopServer

Major

+

Minor

Migrating the ECS to a normal host timed out.

+

The ECS was stopped

+
  • on the management console.
  • by calling APIs.

Migrate services to other ECSs.

+
  • Check whether the operation was intentionally performed by a user.
  • Deploy service applications in HA mode.
  • After the ECS starts up, check whether services recover.

Services are interrupted.

+

Services are interrupted.

Improper ECS running

+

NIC deleted

vmIsRunningImproperly

+

deleteNic

Major

+

Major

The ECS was faulty or the ECS NIC was abnormal.

+

The ECS NIC was deleted

+
  • on the management console.
  • by calling APIs.

Deploy service applications in HA mode.

-

After the fault is rectified, check whether services recover.

+
  • Check whether the deletion was performed intentionally by a user.
  • Deploy service applications in HA mode.
  • After the NIC is deleted, check whether services recover.

Services are interrupted.

+

Services may be interrupted.

Improper ECS running recovered

+

ECS resized

vmIsRunningImproperlyRecovery

+

resizeServer

Major

+

Minor

The ECS was restored to the normal status.

+

The ECS specifications were resized

+
  • on the management console.
  • by calling APIs.

Wait for the ECS status to become normal and check whether services are affected.

+
  • Check whether the operation was performed by a user.
  • Deploy service applications in HA mode.
  • After the ECS is resized, check whether services have recovered.

None

+

Services are interrupted.

VM faults caused by host process exceptions

+

GuestOS restarted

VMFaultsByHostProcessExceptions

+

RestartGuestOS

Critical

+

Minor

The host where the ECS resides is faulty. The system will automatically try to start the ECS.

+

The guest OS was restarted.

After the ECS is started, check whether this ECS and services on it can run properly.

+

Contact O&M personnel.

The ECS is faulty.

+

Services may be interrupted.

Restarted GuestOS

+

ECS failure caused by system faults

RestartGuestOS

+

VMFaultsByHostProcessExceptions

Minor

+

Critical

The guest OS was restarted.

+

The host where the ECS resides is faulty. The system will automatically try to start the ECS.

Contact O&M personnel.

+

After the ECS is started, check whether this ECS and services on it can run properly.

Services may be interrupted.

+

The ECS is faulty.

+

Startup failure

+

faultPowerOn

+

Major

+

The ECS failed to start.

+

Start the ECS again. If the problem persists, contact O&M personnel.

+

The ECS cannot start.

+

Host breakdown risk

+

hostMayCrash

+

Major

+

The host where the ECS resides may break down, and the risk cannot be prevented through live migration due to some reasons.

+

Migrate services running on the ECS first and delete or stop the ECS. Start the ECS only after the O&M personnel eliminate the risk.

+

The host may break down, causing service interruption.

+

Scheduled migration completed

+

instance_migrate_completed

+

Major

+

Scheduled ECS migration is completed.

+

Wait until the ECSs become available and check whether services are affected.

+

Services may be interrupted.

+

Scheduled migration being executed

+

instance_migrate_executing

+

Major

+

ECSs are being migrated as scheduled.

+

Wait until the event is complete and check whether services are affected.

+

Services may be interrupted.

+

Scheduled migration canceled

+

instance_migrate_canceled

+

Major

+

Scheduled ECS migration is canceled.

+

None

+

None

+

Scheduled migration failed

+

instance_migrate_failed

+

Major

+

ECSs failed to be migrated as scheduled.

+

Contact O&M personnel.

+

Services are interrupted.

+

Scheduled migration to be executed

+

instance_migrate_scheduled

+

Major

+

ECSs will be migrated as scheduled.

+

Clarify the impact on services during the execution window.

+

None

+

Scheduled specification modification failed

+

instance_resize_failed

+

Major

+

Specifications failed to be modified as scheduled.

+

Contact O&M personnel.

+

Services are interrupted.

+

Scheduled specification modification completed

+

instance_resize_completed

+

Major

+

Scheduled specifications modification is completed.

+

None

+

None

+

Scheduled specification modification being executed

+

instance_resize_executing

+

Major

+

Specifications are being modified as scheduled.

+

Wait until the event is completed and check whether services are affected.

+

Services are interrupted.

+

Scheduled specification modification canceled

+

instance_resize_canceled

+

Major

+

Scheduled specifications modification is canceled.

+

None

+

None

+

Scheduled specification modification to be executed

+

instance_resize_scheduled

+

Major

+

Specifications will be modified as scheduled.

+

Check the impact on services during the execution window.

+

None

+

Scheduled redeployment to be executed

+

instance_redeploy_scheduled

+

Major

+

ECSs will be redeployed on new hosts as scheduled.

+

Check the impact on services during the execution window.

+

None

+

Scheduled restart to be executed

+

instance_reboot_scheduled

+

Major

+

ECSs will be restarted as scheduled.

+

Check the impact on services during the execution window.

+

None

+

Scheduled stop to be executed

+

instance_stop_scheduled

+

Major

+

ECSs will be stopped as scheduled as they are affected by underlying hardware or system O&M.

+

Check the impact on services during the execution window.

+

None

+

Live migration started

+

liveMigrationStarted

+

Major

+

The host where the ECS is located may be faulty. Live migrate the ECS in advance to prevent service interruptions caused by host breakdown.

+

Wait for the event to end and check whether services are affected.

+

Services may be interrupted for less than 1s.

+

Live migration completed

+

liveMigrationCompleted

+

Major

+

The live migration is complete, and the ECS is running properly.

+

Check whether services are running properly.

+

None

+

Live migration failure

+

liveMigrationFailed

+

Major

+

An error occurred during the live migration of an ECS.

+

Check whether services are running properly.

+

There is a low probability that services are interrupted.

+

FPGA link fault

+

FPGALinkFault

+

Critical

+

The FPGA of the host on which the ECS is located was

+
  • faulty.
  • recovering from a fault.
+

Deploy service applications in HA mode.

+

After the FPGA fault is rectified, check whether services are restored.

+

Services are interrupted.

+

Scheduled redeployment to be authorized

+

instance_redeploy_inquiring

+

Major

+

As being affected by underlying hardware or system O&M, ECSs will be redeployed on new hosts as scheduled.

+

Authorize scheduled redeployment.

+

None

+

Local disk replacement canceled

+

localdisk_recovery_canceled

+

Major

+

Local disk failure

+

None

+

None

+

Local disk replacement to be executed

+

localdisk_recovery_scheduled

+

Major

+

Local disk failure

+

Clarify the impact on services during the execution window.

+

None

+

nvidia-smi suspended

+

nvidiaSmiHangEvent

+

Major

+

nvidia-smi timed out.

+

If services are affected, submit a service ticket.

+

The driver may report an error during service running.

+

NPU: uncorrectable ECC error

+

UncorrectableEccErrorCount

+

Major

+

There are uncorrectable ECC errors on the NPU.

+

If services are affected, replace the NPU with another one.

+

Services may be interrupted.

+

Scheduled redeployment canceled

+

instance_redeploy_canceled

+

Major

+

As being affected by underlying hardware or system O&M, ECSs will be redeployed on new hosts as scheduled.

+

None

+

None

+

Scheduled redeployment being executed

+

instance_redeploy_executing

+

Major

+

As being affected by underlying hardware or system O&M, ECSs will be redeployed on new hosts as scheduled.

+

Wait until the event is complete and check whether services are affected.

+

Services are interrupted.

+

Scheduled redeployment completed

+

instance_redeploy_completed

+

Major

+

As being affected by underlying hardware or system O&M, ECSs will be redeployed on new hosts as scheduled.

+

Wait until the redeployed ECSs are available and check whether services are affected.

+

None

+

Scheduled redeployment failed

+

instance_redeploy_failed

+

Major

+

As being affected by underlying hardware or system O&M, ECSs will be redeployed on new hosts as scheduled.

+

Contact O&M personnel.

+

Services are interrupted.

+

Local disk replacement to be authorized

+

localdisk_recovery_inquiring

+

Major

+

Local disks are faulty.

+

Authorize local disk replacement.

+

Local disks are unavailable.

+

Local disks being replaced

+

localdisk_recovery_executing

+

Major

+

Local disk failure

+

Wait until the local disks are replaced and check whether the local disks are available.

+

Local disks are unavailable.

+

Local disks replaced

+

localdisk_recovery_completed

+

Major

+

Local disk failure

+

Wait until the services are running properly and check whether local disks are available.

+

None

+

Local disk replacement failed

+

localdisk_recovery_failed

+

Major

+

Local disks are faulty.

+

Contact O&M personnel.

+

Local disks are unavailable.

+

NPU: device not found by npu-smi info

+

NPUSMICardNotFound

+

Major

+

The Ascend driver is faulty or the NPU is disconnected.

+

Transfer this issue to the Ascend or hardware team for handling.

+

The NPU cannot be used normally.

+

NPU: PCIe link error

+

PCIeErrorFound

+

Major

+

The possible cause is deskew_fifo overflow, symbol_unlock, deskew_unlock event, or phystatus timeout.

+

Transfer this issue to the hardware team for handling.

+

The NPU cannot be used properly.

+

NPU: device not found by lspci

+

LspciCardNotFound

+

Major

+

The NPU is disconnected.

+

Transfer this issue to the hardware team for handling.

+

The NPU cannot be used normally.

+

NPU: overtemperature

+

TemperatureOverUpperLimit

+

Major

+

The temperature of DDR or software is too high.

+

Stop services, restart the BMS, check the heat dissipation system, and reset the devices.

+

The ECS may be powered off due to overtemperature and devices may not be found.

+

NPU: request for instance restart

+

RebootVirtualMachine

+

Informational

+

A fault occurs and the BMS needs to be restarted.

+

Collect the fault information, and restart the BMS.

+

Services may be interrupted.

+

NPU: request for SoC reset

+

ResetSOC

+

Informational

+

A fault occurs and the SoC needs to be reset.

+

Collect the fault information, and reset the SoC.

+

Services may be interrupted.

+

NPU: request for restart AI process

+

RestartAIProcess

+

Informational

+

A fault occurs and the AI process needs to be restarted.

+

Collect the fault information, and restart the AI process.

+

The current AI task will be interrupted.

+

NPU: error codes

+

NPUErrorCodeWarning

+

Major

+

A large number of NPU error codes indicating major or higher-level errors are returned. You can further locate the faults based on the error codes.

+

Locate the faults according to the Black Box Error Code Information List and Health Management Error Definition.

+

Services may be interrupted.

+

DAVP: die device node not found by vasmi

+

DAVPSMICardNotFound

+

Major

+

The driver may be faulty or the card may be disconnected.

+

Restart the VM. If the device still cannot be loaded, transfer this issue to the hardware team for handling.

+

The DAVP cannot be used properly.

+

DAVP: device not found by lspci

+

DAVPLspciCardNotFound

+

Major

+

The DAVP is disconnected.

+

Transfer this issue to the hardware team for handling.

+

The DAVP cannot be used properly.

+

DAVP: temperature higher than the threshold 85°C

+

TemperatureOverDfLimit

+

Major

+

The core module temperature exceeds 85°C, which causes frequency reduction.

+

Stop services. Contact the hardware team to check the heat dissipation system and reset the device.

+

The DAVP card frequency is reduced.

+

DAVP: temperature higher than the threshold 105°C

+

TemperatureOverSdLimit

+

Major

+

The core module temperature exceeds 105°C, which generates a high temperature alarm.

+

Stop services. Contact the hardware team to check the heat dissipation system and reset the device.

+

Power-off protection is triggered. The DAVP cannot be used properly.

+

DAVP: core unit exception of the device node

+

DeviceCoreAbnormal

+

Major

+

You may need to restart the die device node.

+

Collect the fault information and restart die.

+

Services may be interrupted.

+

VM deletion failure

+

faultDeleteServer

+

Major

+

Failed to delete the ECS.

+

Check whether services are affected.

+

The ECS resources fail to be deleted.

+

Failed to delete the ECS.

+

Check whether services are affected.
-

Once a physical host running ECSs breaks down, the ECSs are automatically migrated to a functional physical host. During the migration, the ECSs will be restarted.

+

Automatic recovery: If the hardware where an ECS is located is faulty, the system automatically migrates it to a normal physical host. The ECS will restart during the migration.

-
Table 2 Advanced Anti-DDoS (AAD)

Event Source

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Bare Metal Server (BMS)

Event Source

Namespace

+

Namespace

Event Name

+

Event Name

Event ID

+

Event ID

Event Severity

+

Event Severity

Description

+

Description

Solution

+

Solution

Impact

+

Impact

AAD

-

+

BMS

SYS.DDOS

+

SYS.BMS

DDoS Attack Events

+

BMS restarted

ddosAttackEvents

+

osReboot

Major

+

Major

A DDoS attack occurs in the AAD protected lines.

+

The BMS was restarted

+
  • on the management console.
  • by calling APIs.

Judge the impact on services based on the attack traffic and attack type. If the attack traffic exceeds your purchased elastic bandwidth, change to another line or increase your bandwidth.

+
  • Deploy service applications in HA mode.
  • After the BMS is restarted, check whether services recover.

Services may be interrupted.

+

Services are interrupted.

Domain name scheduling event

+

Unexpected restart

domainNameDispatchEvents

+

serverReboot

Major

+

Major

The high-defense CNAME corresponding to the domain name is scheduled, and the domain name is resolved to another high-defense IP address.

+

The BMS restarted unexpectedly, which may be caused by

+
  • OS faults.
  • hardware faults.

Pay attention to the workloads involving the domain name.

+
  • Deploy service applications in HA mode.
  • After the BMS is restarted, check whether services recover.

Services are not affected.

+

Services are interrupted.

Blackhole event

+

BMS stopped

blackHoleEvents

+

osShutdown

Major

+

Major

The attack traffic exceeds the purchased AAD protection threshold.

+

The BMS was stopped

+
  • on the management console.
  • by calling APIs.

A blackhole is canceled after 30 minutes by default. The actual blackhole duration is related to the blackhole triggering times and peak attack traffic on the current day. The maximum duration is 24 hours. If you need to permit access before a blackhole becomes ineffective, contact technical support.

+
  • Deploy service applications in HA mode.
  • After the BMS is started, check whether services recover.

Services may be interrupted.

+

Services are interrupted.

Cancel Blackhole

+

Unexpected shutdown

cancelBlackHole

+

serverShutdown

Informational

+

Major

The customer's AAD instance recovers from the black hole state.

+

The BMS was stopped unexpectedly, which may be caused by

+
  • unexpected power-off.
  • hardware faults.

This is only a prompt and no action is required.

+
  • Deploy service applications in HA mode.
  • After the BMS is started, check whether services recover.

Customer services recover.

+

Services are interrupted.

IP address scheduling triggered

+

Network disconnection

ipDispatchEvents

+

linkDown

Major

+

Major

IP route changed

+

The BMS network was disconnected. Possible causes are as follows:

+
  • The BMS was unexpectedly stopped or restarted.
  • The switch was faulty.
  • The gateway was faulty.

Check the workloads of the IP address.

+
  • Deploy service applications in HA mode.
  • After the BMS is started, check whether services recover.

Services are not affected.

+

Services are interrupted.

+

PCIe error

+

pcieError

+

Major

+

The PCIe devices or main board of the BMS was faulty.

+
  • Deploy service applications in HA mode.
  • After the BMS is started, check whether services recover.
+

The network or disk read/write services are affected.

+

Disk fault

+

diskError

+

Major

+

The disk backplane or disks of the BMS were faulty.

+
  • Deploy service applications in HA mode.
  • After the fault is rectified, check whether services recover.
+

Data read/write services are affected, or the BMS cannot be started.

+

EVS error

+

storageError

+

Major

+

The BMS failed to connect to EVS disks. Possible causes are as follows:

+
  • The SDI card was faulty.
  • Remote storage devices were faulty.
+
  • Deploy service applications in HA mode.
  • After the fault is rectified, check whether services recover.
+

Data read/write services are affected, or the BMS cannot be started.

+

System maintenance inquiring

+

system_maintenance_inquiring

+

Major

+

The scheduled BMS maintenance task is being inquired.

+

Authorize the maintenance.

+

None

+

System maintenance waiting

+

system_maintenance_scheduled

+

Major

+

The scheduled BMS maintenance task is waiting to be executed.

+

Clarify the impact on services during the execution window.

+

None

+

System maintenance canceled

+

system_maintenance_canceled

+

Major

+

The scheduled BMS maintenance is canceled.

+

None

+

None

+

System maintenance executing

+

system_maintenance_executing

+

Major

+

BMSs are being maintained as scheduled.

+

After the maintenance is complete, check whether services are affected.

+

Services are interrupted.

+

System maintenance completed

+

system_maintenance_completed

+

Major

+

The scheduled BMS maintenance is completed.

+

Wait until the BMSs become available and check whether services recover.

+

None

+

System maintenance failure

+

system_maintenance_failed

+

Major

+

The scheduled BMS maintenance task failed.

+

Contact O&M personnel.

+

Services are interrupted.

+

NPU: device not found by npu-smi info

+

NPUSMICardNotFound

+

Major

+

The Ascend driver is faulty or the NPU is disconnected.

+

Transfer this issue to the Ascend or hardware team for handling.

+

The NPU cannot be used normally.

+

NPU: PCIe link error

+

PCIeErrorFound

+

Major

+

The lspci command returns rev ff indicating that the NPU is abnormal.

+

Restart the BMS. If the issue persists, transfer it to the hardware team for processing.

+

The NPU cannot be used normally.

+

NPU: device not found by lspci

+

LspciCardNotFound

+

Major

+

The NPU is disconnected.

+

Transfer this issue to the hardware team for handling.

+

The NPU cannot be used normally.

+

NPU: overtemperature

+

TemperatureOverUpperLimit

+

Major

+

The temperature of DDR or software is too high.

+

Stop services, restart the BMS, check the heat dissipation system, and reset the devices.

+

The BMS may be powered off and devices may not be found.

+

NPU: uncorrectable ECC error

+

UncorrectableEccErrorCount

+

Major

+

There are uncorrectable ECC errors on the NPU.

+

If services are affected, replace the NPU with another one.

+

Services may be interrupted.

+

NPU: request for BMS restart

+

RebootVirtualMachine

+

Informational

+

A fault occurs and the BMS needs to be restarted.

+

Collect the fault information, and restart the BMS.

+

Services may be interrupted.

+

NPU: request for SoC reset

+

ResetSOC

+

Informational

+

A fault occurs and the SoC needs to be reset.

+

Collect the fault information, and reset the SoC.

+

Services may be interrupted.

+

NPU: request for restart AI process

+

RestartAIProcess

+

Informational

+

A fault occurs and the AI process needs to be restarted.

+

Collect the fault information, and restart the AI process.

+

The current AI task will be interrupted.

+

NPU: error codes

+

NPUErrorCodeWarning

+

Major

+

A large number of NPU error codes indicating major or higher-level errors are returned. You can further locate the faults based on the error codes.

+

Locate the faults according to the Black Box Error Code Information List and Health Management Error Definition.

+

Services may be interrupted.

+

nvidia-smi suspended

+

nvidiaSmiHangEvent

+

Major

+

nvidia-smi timed out.

+

If services are affected, submit a service ticket.

+

The driver may report an error during service running.

+

nv_peer_mem loading error

+

NvPeerMemException

+

Minor

+

The NVLink or nv_peer_mem cannot be loaded.

+

Restore or reinstall the NVLink.

+

nv_peer_mem cannot be used.

+

Fabric Manager error

+

NvFabricManagerException

+

Minor

+

The BMS meets the NVLink conditions and NVLink is installed, but Fabric Manager is abnormal.

+

Restore or reinstall the NVLink.

+

NVLink cannot be used normally.

+

IB card error

+

InfinibandStatusException

+

Major

+

The IB card or its physical status is abnormal.

+

Transfer this issue to the hardware team for handling.

+

The IB card cannot work normally.

+

Local disk replacement to be authorized

+

localdisk_recovery_inquiring

+

Major

+

The local disk is faulty. Local disk replacement authorization is in progress.

+

Authorize local disk replacement.

+

Local disks are unavailable.

+

Local disks being replaced

+

localdisk_recovery_executing

+

Major

+

The local disk is faulty and is being replaced.

+

When the replacement is complete, check whether the local disks are available.

+

Local disks are unavailable.

+

Local disks replaced

+

localdisk_recovery_completed

+

Major

+

The local disk is faulty and is replaced.

+

Wait until the services are running properly and check whether local disks are available.

+

None

+

Local disk replacement failed

+

localdisk_recovery_failed

+

Major

+

The local disk is faulty and fails to be replaced.

+

Contact O&M personnel.

+

Local disks are unavailable.
-
Table 3 Elastic Load Balance (ELB)

Event Source

+
- - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
Table 3 Advanced Anti-DDoS (AAD)

Event Source

Namespace

+

Namespace

Event Name

+

Event Name

Event ID

+

Event ID

Event Severity

+

Event Severity

Description

+

Description

Solution

+

Solution

Impact

+

Impact

ELB

+

AAD

+

SYS.ELB

+

SYS.DDOS

The backend servers are unhealthy.

+

DDoS Attack Events

healthCheckUnhealthy

+

ddosAttackEvents

Major

+

Major

Generally, this problem occurs because backend server services are offline. This event will not be reported after it is reported for several times.

+

A DDoS attack occurs in the AAD protected lines.

Ensure that the backend servers are running properly.

+

Judge the impact on services based on the attack traffic and attack type. If the attack traffic exceeds your purchased elastic bandwidth, change to another line or increase your bandwidth.

ELB does not forward requests to unhealthy backend servers. If all backend servers in the backend server group are detected unhealthy, services will be interrupted.

+

Services may be interrupted.

The backend server is detected healthy.

+

Domain name scheduling event

healthCheckRecovery

+

domainNameDispatchEvents

Minor

+

Major

The backend server is detected healthy.

+

The high-defense CNAME corresponding to the domain name is scheduled, and the domain name is resolved to another high-defense IP address.

No further action is required.

+

Pay attention to the workloads involving the domain name.

The load balancer can properly route requests to the backend server.

+

Services are not affected.

+

Blackhole event

+

blackHoleEvents

+

Major

+

The attack traffic exceeds the purchased AAD protection threshold.

+

A blackhole is canceled after 30 minutes by default. The actual blackhole duration is related to the blackhole triggering times and peak attack traffic on the current day. The maximum duration is 24 hours. If you need to permit access before a blackhole becomes ineffective, contact technical support.

+

Services may be interrupted.

+

Cancel Blackhole

+

cancelBlackHole

+

Informational

+

The customer's AAD instance recovers from the black hole state.

+

This is only a prompt and no action is required.

+

Customer services recover.

+

IP address scheduling triggered

+

ipDispatchEvents

+

Major

+

IP route changed

+

Check the workloads of the IP address.

+

Services are not affected.
-
Table 4 Cloud Backup and Recovery (CBR)

Event Source

+
- - - - - - + - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 4 Elastic Load Balance (ELB)

Event Source

Event Name

+

Namespace

Event ID

+

Event Name

Event Severity

+

Event ID

Description

+

Event Severity

Solution

+

Description

Impact

+

Solution

+

Impact

CBR

+

ELB

Failed to create the backup.

+

SYS.ELB

backupFailed

+

The backend servers are unhealthy.

Critical

+

healthCheckUnhealthy

The backup failed to be created.

+

Major

Manually create a backup or contact customer service.

+

Generally, this problem occurs because backend server services are offline. This event will not be reported after it is reported for several times.

Data loss may occur.

+

Ensure that the backend servers are running properly.

+

ELB does not forward requests to unhealthy backend servers. If all backend servers in the backend server group are detected unhealthy, services will be interrupted.

Failed to restore the resource using a backup.

+

The backend server is detected healthy.

restorationFailed

+

healthCheckRecovery

Critical

+

Minor

The resource failed to be restored using a backup.

+

The backend server is detected healthy.

Restore the resource using another backup or contact customer service.

+

No further action is required.

Data loss may occur.

-

Failed to delete the backup.

-

backupDeleteFailed

-

Critical

-

The backup failed to be deleted.

-

Try again later or contact customer service.

-

Charging may be abnormal.

-

Failed to delete the vault.

-

vaultDeleteFailed

-

Critical

-

The vault failed to be deleted.

-

Try again later or contact technical support.

-

Charging may be abnormal.

-

Replication failure

-

replicationFailed

-

Critical

-

The backup failed to be replicated.

-

Try again later or contact technical support.

-

Data loss may occur.

-

The backup is created successfully.

-

backupSucceeded

-

Major

-

The backup was created.

-

None

-

None

-

Resource restoration using a backup succeeded.

-

restorationSucceeded

-

Major

-

The resource was restored using a backup.

-

Check whether the data is successfully restored.

-

None

-

The backup is deleted successfully.

-

backupDeletionSucceeded

-

Major

-

The backup was deleted.

-

None

-

None

-

The vault is deleted successfully.

-

vaultDeletionSucceeded

-

Major

-

The vault was deleted.

-

None

-

None

-

Replication success

-

replicationSucceeded

-

Major

-

The backup was replicated successfully.

-

None

-

None

-

Client offline

-

agentOffline

-

Critical

-

The backup client was offline.

-

Ensure that the Agent status is normal and the backup client can be connected to .

-

Backup tasks may fail.

-

Client online

-

agentOnline

-

Major

-

The backup client was online.

-

None

-

None

+

The load balancer can properly route requests to the backend server.
-
Table 5 Relational Database Service (RDS) — resource exception

Event Source

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 5 Cloud Backup and Recovery (CBR)

Event Source

Namespace

+

Namespace

Event Name

+

Event Name

Event ID

+

Event ID

Event Severity

+

Event Severity

Description

+

Description

Solution

+

Solution

Impact

+

Impact

RDS

+

CBR

SYS.RDS

+

SYS.CBR

+

+

+

+

+

+

+

+

+

+

+

DB instance creation failure

+

Failed to create the backup.

createInstanceFailed

+

backupFailed

Major

+

Critical

Generally, the cause is that the number of disks is insufficient due to quota limits, or underlying resources are exhausted.

+

The backup failed to be created.

The selected resource specifications are insufficient. Select other available specifications and try again.

+

Manually create a backup or contact customer service.

DB instances cannot be created.

+

Data loss may occur.

Full backup failure

+

Failed to restore the resource using a backup.

fullBackupFailed

+

restorationFailed

Major

+

Critical

A single full backup failure does not affect the files that have been successfully backed up, but prolong the incremental backup time during the point-in-time restore (PITR).

+

The resource failed to be restored using a backup.

Try again.

+

Restore the resource using another backup or contact customer service.

Restoration using backups will be affected.

+

Data loss may occur.

Read replica promotion failure

+

Failed to delete the backup.

activeStandBySwitchFailed

+

backupDeleteFailed

Major

+

Critical

The standby DB instance does not take over workloads from the primary DB instance due to network or server failures. The original primary DB instance continues to provide services within a short time.

+

The backup failed to be deleted.

Perform the operation again during off-peak hours.

+

Try again later or contact customer service.

Read replica promotion failed.

+

Charging may be abnormal.

Replication status abnormal

+

Failed to delete the vault.

abnormalReplicationStatus

+

vaultDeleteFailed

Major

+

Critical

The possible causes are as follows:

-

The replication delay between the primary instance and the standby instance or a read replica is too long, which usually occurs when a large amount of data is being written to databases or a large transaction is being processed. During peak hours, data may be blocked.

-

The network between the primary instance and the standby instance or a read replica is disconnected.

+

The vault failed to be deleted.

The issue is being fixed. Please wait for our notifications.

+

Try again later or contact technical support.

The replication status is abnormal.

+

Charging may be abnormal.

Replication status recovered

+

Replication failure

replicationStatusRecovered

+

replicationFailed

Major

+

Critical

The replication delay between the primary and standby instances is within the normal range, or the network connection between them has restored.

+

The backup failed to be replicated.

Check whether services are running properly.

+

Try again later or contact technical support.

Replication status is recovered.

+

Data loss may occur.

DB instance faulty

+

The backup is created successfully.

faultyDBInstance

+

backupSucceeded

Major

+

Major

A single or primary DB instance was faulty due to a catastrophic failure, for example, server failure.

+

The backup was created.

The issue is being fixed. Please wait for our notifications.

+

None

The instance status is abnormal.

+

None

DB instance recovered

+

Resource restoration using a backup succeeded.

DBInstanceRecovered

+

restorationSucceeded

Major

+

Major

RDS rebuilds the standby DB instance with its high availability. After the instance is rebuilt, this event will be reported.

+

The resource was restored using a backup.

The DB instance status is normal. Check whether services are running properly.

+

Check whether the data is successfully restored.

The instance is recovered.

+

None

Failure of changing single DB instance to primary/standby

+

The backup is deleted successfully.

singleToHaFailed

+

backupDeletionSucceeded

Major

+

Major

A fault occurs when RDS is creating the standby DB instance or configuring replication between the primary and standby DB instances. The fault may occur because resources are insufficient in the data center where the standby DB instance is located.

+

The backup was deleted.

Automatic retry is in progress.

+

None

Changing a single DB instance to primary/standby failed.

+

None

Database process restarted

+

The vault is deleted successfully.

DatabaseProcessRestarted

+

vaultDeletionSucceeded

Major

+

Major

The database process is stopped due to insufficient memory or high load.

+

The vault was deleted.

Check whether services are running properly.

+

None

The primary instance is restarted. Services are interrupted for a short period of time.

+

None

Instance storage full

+

Replication success

instanceDiskFull

+

replicationSucceeded

Major

+

Major

Generally, the cause is that the data space usage is too high.

+

The backup was replicated successfully.

Scale up the storage.

+

None

The instance storage is used up. No data can be written into databases.

+

None

Instance storage full recovered

+

Client offline

instanceDiskFullRecovered

+

agentOffline

Major

+

Critical

The instance disk is recovered.

+

The backup client was offline.

Check whether services are running properly.

+

Ensure that the Agent status is normal and the backup client can be connected to .

The instance has available storage.

+

Backup tasks may fail.

Kafka connection failed

+

Client online

kafkaConnectionFailed

+

agentOnline

Major

+

Major

The network is unstable or the Kafka server does not work properly.

+

The backup client was online.

Check whether services are affected.

+

None

None

+

None
-
Table 6 Document Database Service (DDS)

Event Source

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + +
Table 6 Relational Database Service (RDS) — resource exception

Event Source

Namespace

+

Namespace

Event Name

+

Event Name

Event ID

+

Event ID

Event Severity

+

Event Severity

Description

+

Description

Solution

+

Solution

Impact

+

Impact

DDS

+

RDS

+

+

+

+

+

SYS.DDS

+

SYS.RDS

+

+

+

+

+

DB instance creation failure

+

DB instance creation failure

DDSCreateInstanceFailed

+

createInstanceFailed

Major

+

Major

A DDS instance fails to be created due to insufficient disks, quotas, and underlying resources.

+

Generally, the cause is that the number of disks is insufficient due to quota limits, or underlying resources are exhausted.

Check the number and quota of disks. Release resources and create DDS instances again.

+

The selected resource specifications are insufficient. Select other available specifications and try again.

DDS instances cannot be created.

+

DB instances cannot be created.

Replication failed

+

Full backup failure

DDSAbnormalReplicationStatus

+

fullBackupFailed

Major

+

Major

The possible causes are as follows:

-

The replication delay between the primary instance and the standby instance or a read replica is too long, which usually occurs when a large amount of data is being written to databases or a large transaction is being processed. During peak hours, data may be blocked.

-

The network between the primary instance and the standby instance or a read replica is disconnected.

+

A single full backup failure does not affect the files that have been successfully backed up, but prolong the incremental backup time during the point-in-time restore (PITR).

Submit a service ticket.

+

Try again.

Your applications are not affected because this event does not interrupt data read and write.

+

Full backup failed.

Replication recovered

+

Read replica promotion failure

DDSReplicationStatusRecovered

+

activeStandBySwitchFailed

Major

+

Major

The replication delay between the primary and standby instances is within the normal range, or the network connection between them has restored.

+

The standby DB instance does not take over workloads from the primary DB instance due to network or server failures. The original primary DB instance continues to provide services within a short time.

No action is required.

+

Perform the switchover again during off-peak hours.

None

+

The primary/standby switchover will fail.

DB instance failed

+

Replication status abnormal

DDSFaultyDBInstance

+

abnormalReplicationStatus

Major

+

Major

This event is a key alarm event and is reported when an instance is faulty due to a disaster or a server failure.

+

The possible causes are as follows:

+

The replication delay between the primary instance and the standby instance or a read replica is too long, which usually occurs when a large amount of data is being written to databases or a large transaction is being processed. During peak hours, data may be blocked.

+

The network between the primary instance and the standby instance or a read replica is disconnected.

Submit a service ticket.

+

Database replication is being repaired. You will be notified immediately after the repair.

The database service may be unavailable.

+

The replication status is abnormal.

DB instance recovered

+

Replication status recovered

DDSDBInstanceRecovered

+

replicationStatusRecovered

Major

+

Major

If a disaster occurs, NoSQL provides an HA tool to automatically or manually rectify the fault. After the fault is rectified, this event is reported.

+

The replication delay between the primary and standby instances is within the normal range, or the network connection between them has restored.

No action is required.

+

Check whether services are running properly.

None

+

Replication status is recovered.

Faulty node

+

DB instance faulty

DDSFaultyDBNode

+

faultyDBInstance

Major

+

Major

This event is a key alarm event and is reported when a database node is faulty due to a disaster or a server failure.

+

A single or primary DB instance was faulty due to a catastrophic failure, for example, server failure.

Check whether the database service is available and submit a service ticket.

+

Instance status is being repaired. You will be notified immediately after the repair.

The database service may be unavailable.

+

The instance status is abnormal.

Node recovered

+

DB instance recovered

DDSDBNodeRecovered

+

DBInstanceRecovered

Major

+

Major

If a disaster occurs, NoSQL provides an HA tool to automatically or manually rectify the fault. After the fault is rectified, this event is reported.

+

RDS rebuilds the standby DB instance with its high availability. After the instance is rebuilt, this event will be reported.

No action is required.

+

The DB instance status is normal. Check whether services are running properly.

None

+

The instance is recovered.

Primary/standby switchover or failover

+

Failure of changing single DB instance to primary/standby

DDSPrimaryStandbySwitched

+

singleToHaFailed

Major

+

Major

A primary/standby switchover is performed or a failover is triggered.

+

A fault occurs when RDS is creating the standby DB instance or configuring replication between the primary and standby DB instances. The fault may occur because resources are insufficient in the data center where the standby DB instance is located.

No action is required.

+

Automatic retry is in progress.

None

+

Changing a single DB instance to primary/standby failed.

Insufficient storage space

+

Database process restarted

DDSRiskyDataDiskUsage

+

DatabaseProcessRestarted

Major

+

Major

The storage space is insufficient.

+

The database process is stopped due to insufficient memory or high load.

Scale up storage space. For details, see section "Scaling Up Storage Space" in the corresponding user guide.

+

Check whether services are running properly.

The instance is set to read-only and data cannot be written to the instance.

+

The primary instance is restarted. Services are interrupted for a short period of time.

Data disk expanded and being writable

+

Instance storage full

DDSDataDiskUsageRecovered

+

instanceDiskFull

Major

+

Major

The capacity of a data disk has been expanded and the data disk becomes writable.

+

Generally, the cause is that the data space usage is too high.

No further action is required.

+

Scale up the storage.

No adverse impact.

+

The instance storage is used up. No data can be written into databases.

Schedule for deleting a KMS key

+

Instance storage full recovered

DDSplanDeleteKmsKey

+

instanceDiskFullRecovered

Major

+

Major

A request to schedule deletion of a KMS key was submitted.

+

The instance disk is recovered.

After the KMS key is scheduled to be deleted, either decrypt the data encrypted by KMS key in a timely manner or cancel the key deletion.

+

Check whether services are running properly.

After the KMS key is deleted, users cannot encrypt disks.

+

The instance has available storage.

+

Kafka connection failed

+

kafkaConnectionFailed

+

Major

+

The network is unstable or the Kafka server does not work properly.

+

Check whether services are affected.

+

None
-
Table 7 GaussDB(for MySQL)

Event Source

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 7 Document Database Service (DDS)

Event Source

Namespace

+

Namespace

Event Name

+

Event Name

Event ID

+

Event ID

Event Severity

+

Event Severity

Description

+

Description

Solution

+

Solution

Impact

+

Impact

GaussDB(for MySQL)

+

DDS

SYS.GAUSSDB

-

+

SYS.DDS

Incremental backup failure

+

DB instance creation failure

TaurusIncrementalBackupInstanceFailed

+

DDSCreateInstanceFailed

Major

+

Major

The network between the instance and the management plane (or the OBS) is disconnected, or the backup environment created for the instance is abnormal.

+

A DDS instance fails to be created due to insufficient disks, quotas, and underlying resources.

Submit a service ticket.

+

Check the number and quota of disks. Release resources and create DDS instances again.

Backup jobs fail.

+

DDS instances cannot be created.

Read replica creation failure

+

Replication failed

addReadonlyNodesFailed

+

DDSAbnormalReplicationStatus

Major

+

Major

The quota is insufficient or underlying resources are exhausted.

+

The possible causes are as follows:

+
  1. The replication delay between the primary instance and the standby instance or a read replica is too long, which usually occurs when a large amount of data is being written to databases or a large transaction is being processed. During peak hours, data may be blocked.
  2. The network between the primary instance and the standby instance or a read replica is disconnected.

Check the read replica quota. Release resources and create read replicas again.

+

Submit a service ticket.

Read replicas fail to be created.

+
  1. Read and write operations on the original instance are not interrupted, but data updates on the standby instance may experience delays.
  2. The replication delay keeps growing between the primary and standby instances, and the standby instance may be disconnected.

DB instance creation failure

+

Replication status recovered

createInstanceFailed

+

DDSReplicationStatusRecovered

Major

+

Major

The instance quota or underlying resources are insufficient.

+

The replication delay between the primary and standby instances is within the normal range, or the network connection between them has restored.

Check the instance quota. Release resources and create instances again.

+

No action is required.

DB instances fail to be created.

+

None

Read replica promotion failure

+

DB instance failed

activeStandBySwitchFailed

+

DDSFaultyDBInstance

Major

+

Major

The read replica fails to be promoted to the primary node due to network or server failures. The original primary node takes over services quickly.

+

This event is a key alarm event and is reported when an instance is faulty due to a disaster or a server failure.

Submit a service ticket.

+

Submit a service ticket.

The read replica fails to be promoted to the primary node.

+

The database service may be unavailable.

Instance specifications change failure

+

DB instance recovered

flavorAlterationFailed

+

DDSDBInstanceRecovered

Major

+

Major

The quota is insufficient or underlying resources are exhausted.

+

If a disaster occurs, NoSQL provides an HA tool to automatically or manually rectify the fault. After the fault is rectified, this event is reported.

Submit a service ticket.

+

No action is required.

Instance specifications fail to be changed.

+

None

Faulty DB instance

+

Faulty node

TaurusInstanceRunningStatusAbnormal

+

DDSFaultyDBNode

Major

+

Major

The instance process is faulty or the communications between the instance and the DFV storage are abnormal.

+

This event is a key alarm event and is reported when a database node is faulty due to a disaster or a server failure.

Submit a service ticket.

+

Check whether the database service is available and submit a service ticket.

Services may be affected.

+

The database service may be unavailable.

DB instance recovered

+

Node recovered

TaurusInstanceRunningStatusRecovered

+

DDSDBNodeRecovered

Major

+

Major

The instance is recovered.

+

If a disaster occurs, NoSQL provides an HA tool to automatically or manually rectify the fault. After the fault is rectified, this event is reported.

Observe the service running status.

+

No action is required.

None

+

None

Faulty node

+

Primary/standby switchover or failover

TaurusNodeRunningStatusAbnormal

+

DDSPrimaryStandbySwitched

Major

+

Major

The node process is faulty or the communications between the node and the DFV storage are abnormal.

+

This event is reported when a primary/secondary switchover or failover is triggered.

Observe the instance and service running statuses.

+

No action is required.

A read replica may be promoted to the primary node.

+

None

Node recovered

+

Insufficient storage space

TaurusNodeRunningStatusRecovered

+

DDSRiskyDataDiskUsage

Major

+

Major

The node is recovered.

+

The storage space is insufficient.

Observe the service running status.

+

Scale up storage space. For details, see section "Scaling Up Storage Space" in the corresponding user guide.

None

+

The instance is set to read-only and data cannot be written to the instance.

Read replica deletion failure

+

Data disk expanded and being writable

TaurusDeleteReadOnlyNodeFailed

+

DDSDataDiskUsageRecovered

Major

+

Major

The communications between the management plane and the read replica are abnormal or the VM fails to be deleted from IaaS.

+

The capacity of a data disk has been expanded and the data disk becomes writable.

Submit a service ticket.

+

No further action is required.

Read replicas fail to be deleted.

+

No adverse impact.

Password reset failure

+

Schedule for deleting a KMS key

TaurusResetInstancePasswordFailed

+

planDeleteKmsKey

Major

+

Major

The communications between the management plane and the instance are abnormal or the instance is abnormal.

+

A request to schedule deletion of a KMS key was submitted.

Check the instance status and try again. If the fault persists, submit a service ticket.

+

After the KMS key is scheduled to be deleted, either decrypt the data encrypted by KMS key in a timely manner or cancel the key deletion.

Passwords fail to be reset for instances.

-

DB instance reboot failure

-

TaurusRestartInstanceFailed

-

Major

-

The network between the management plane and the instance is abnormal or the instance is abnormal.

-

Check the instance status and try again. If the fault persists, submit a service ticket.

-

Instances fail to be rebooted.

-

Restoration to new DB instance failure

-

TaurusRestoreToNewInstanceFailed

-

Major

-

The instance quota is insufficient, underlying resources are exhausted, or the data restoration logic is incorrect.

-

If the new instance fails to be created, check the instance quota, release resources, and try to restore to a new instance again. In other cases, submit a service ticket.

-

Backup data fails to be restored to new instances.

-

EIP binding failure

-

TaurusBindEIPToInstanceFailed

-

Major

-

The binding task fails.

-

Submit a service ticket.

-

EIPs fail to be bound to instances.

-

EIP unbinding failure

-

TaurusUnbindEIPFromInstanceFailed

-

Major

-

The unbinding task fails.

-

Submit a service ticket.

-

EIPs fail to be unbound from instances.

-

Parameter modification failure

-

TaurusUpdateInstanceParameterFailed

-

Major

-

The network between the management plane and the instance is abnormal or the instance is abnormal.

-

Check the instance status and try again. If the fault persists, submit a service ticket.

-

Instance parameters fail to be modified.

-

Parameter template application failure

-

TaurusApplyParameterGroupToInstanceFailed

-

Major

-

The network between the management plane and instances is abnormal or the instances are abnormal.

-

Check the instance status and try again. If the fault persists, submit a service ticket.

-

Parameter templates fail to be applied to instances.

-

Full backup failure

-

TaurusBackupInstanceFailed

-

Major

-

The network between the instance and the management plane (or the OBS) is disconnected, or the backup environment created for the instance is abnormal.

-

Submit a service ticket.

-

Backup jobs fail.

-

Primary/standby failover

-

TaurusActiveStandbySwitched

-

Major

-

When the network, physical machine, or database of the primary node is faulty, the system promotes a read replica to primary based on the failover priority to ensure service continuity.

-
  1. Check whether the service is running properly.
  2. Check whether an alarm is generated, indicating that the read replica failed to be promoted to primary.
-

During the failover, database connection is interrupted for a short period of time. After the failover is complete, you can reconnect to the database.

-

Database read-only

-

NodeReadonlyMode

-

Major

-

The database supports only query operations.

-

Submit a service ticket.

-

After the database becomes read-only, write operations cannot be processed.

-

Database read/write

-

NodeReadWriteMode

-

Major

-

The database supports both write and read operations.

-

Submit a service ticket.

-

None.

-

Instance DR switchover

-

DisasterSwitchOver

-

Major

-

If an instance is faulty and unavailable, a switchover is performed to ensure that the instance continues to provide services.

-

Contact technical support.

-

The database connection is intermittently interrupted. The HA service switches workloads from the primary node to a read replica and continues to provide services.

-

Database process restarted

-

TaurusDatabaseProcessRestarted

-

Major

-

The database process is stopped due to insufficient memory or high load.

-

Log in to the Cloud Eye console. Check whether the memory usage increases sharply or the CPU usage is too high for a long time. You can increase the specifications or optimize the service logic.

-

When the database process is suspended, workloads on the node are interrupted. In this case, the HA service automatically restarts the database process and attempts to recover the workloads.

+

After the KMS key is deleted, users cannot encrypt disks.
-
Table 8 GaussDB

Event Source

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 GeminiDB

Event Source

Namespace

+

Namespace

Event Name

+

Event Name

Event ID

+

Event ID

Event Severity

+

Event Severity

Description

+

Description

Solution

+

Solution

Impact

+

Impact

GaussDB

-

+

GeminiDB

+

+

SYS.GAUSSDBV5

+

SYS.NoSQL

+

+

Process status alarm

+

DB instance creation failed

ProcessStatusAlarm

+

NoSQLCreateInstanceFailed

Major

+

Major

Key processes exit, including CMS/CMA, ETCD, GTM, CN, and DN processes.

+

The instance quota or underlying resources are insufficient.

Wait until the process is automatically recovered or a primary/standby failover is automatically performed. Check whether services are recovered. If no, contact SRE engineers.

+

Release the instances that are no longer used and try to provision them again, or submit a service ticket to adjust the quota.

If processes on primary nodes are faulty, services are interrupted and then rolled back. If processes on standby nodes are faulty, services are not affected.

+

DB instances cannot be created.

Component status alarm

+

Specifications modification failed

ComponentStatusAlarm

+

NoSQLResizeInstanceFailed

Major

+

Major

Key components do not respond, including CMA, ETCD, GTM, CN, and DN components.

+

The underlying resources are insufficient.

Wait until the process is automatically recovered or a primary/standby failover is automatically performed. Check whether services are recovered. If no, contact SRE engineers.

+

Submit a service ticket. The O&M personnel will coordinate resources in the background, and then you need to change the specifications again.

If processes on primary nodes do not respond, neither do the services. If processes on standby nodes are faulty, services are not affected.

+

Services are interrupted.

Cluster status alarm

+

Node adding failed

ClusterStatusAlarm

+

NoSQLAddNodesFailed

Major

+

Major

The cluster status is abnormal. For example, the cluster is read-only; majority of ETCDs are faulty; or the cluster resources are unevenly distributed.

+

The underlying resources are insufficient.

Contact SRE engineers.

+

Submit a service ticket. The O&M personnel will coordinate resources in the background, and then you delete the node that failed to be added and add a new node.

If the cluster status is read-only, only read services are processed.

-

If the majority of ETCDs are fault, the cluster is unavailable.

-

If resources are unevenly distributed, the instance performance and reliability deteriorate.

+

None

Hardware resource alarm

+

Node deletion failed

HardwareResourceAlarm

+

NoSQLDeleteNodesFailed

Major

+

Major

A major hardware fault occurs in the instance, such as disk damage or GTM network fault.

+

The underlying resources fail to be released.

Contact SRE engineers.

+

Delete the node again.

Some or all services are affected.

+

None

Status transition alarm

+

Storage space scale-up failed

+

StateTransitionAlarm

+

NoSQLScaleUpStorageFailed

Major

+

Major

The following events occur in the instance: DN build failure, forcible DN promotion, primary/standby DN switchover/failover, or primary/standby GTM switchover/failover.

+

The underlying resources are insufficient.

Wait until the fault is automatically rectified and check whether services are recovered. If no, contact SRE engineers.

+

Submit a service ticket. The O&M personnel will coordinate resources in the background and then you scale up the storage space again.

Some services are interrupted.

+

Services may be interrupted.

Other abnormal alarm

+

Password reset failed

OtherAbnormalAlarm

+

NoSQLResetPasswordFailed

Major

+

Major

Disk usage threshold alarm

+

Resetting the password times out.

Focus on service changes and scale up storage space as needed.

+

Reset the password again.

If the used storage space exceeds the threshold, storage space cannot be scaled up.

+

None

Faulty DB instance

+

Parameter group change failed

TaurusInstanceRunningStatusAbnormal

+

NoSQLUpdateInstanceParamGroupFailed

Major

+

Major

This event is a key alarm event and is reported when an instance is faulty due to a disaster or a server failure.

+

Changing a parameter group times out.

Submit a service ticket.

+

Change the parameter group again.

The database service may be unavailable.

+

None

DB instance recovered

+

Backup policy configuration failed

TaurusInstanceRunningStatusRecovered

+

NoSQLSetBackupPolicyFailed

Major

+

Major

GaussDB(openGauss) provides an HA tool for automated or manual rectification of faults. After the fault is rectified, this event is reported.

+

The database connection is abnormal.

No further action is required.

+

Configure the backup policy again.

None

+

None

Faulty DB node

+

Manual backup creation failed

TaurusNodeRunningStatusAbnormal

+

NoSQLCreateManualBackupFailed

Major

+

Major

This event is a key alarm event and is reported when a database node is faulty due to a disaster or a server failure.

+

The backup files fail to be exported or uploaded.

Check whether the database service is available and submit a service ticket.

+

Submit a service ticket to the O&M personnel.

The database service may be unavailable.

+

Data cannot be backed up.

DB node recovered

+

Automated backup creation failed

TaurusNodeRunningStatusRecovered

+

NoSQLCreateAutomatedBackupFailed

Major

+

Major

GaussDB(openGauss) provides an HA tool for automated or manual rectification of faults. After the fault is rectified, this event is reported.

+

The backup files fail to be exported or uploaded.

No further action is required.

+

Submit a service ticket to the O&M personnel.

None

+

Data cannot be backed up.

DB instance creation failure

+

Faulty DB instance

GaussDBV5CreateInstanceFailed

+

NoSQLFaultyDBInstance

Major

+

Major

Instances fail to be created because the quota is insufficient or underlying resources are exhausted.

+

This event is a key alarm event and is reported when an instance is faulty due to a disaster or a server failure.

Release the instances that are no longer used and try to provision them again, or submit a service ticket to adjust the quota.

+

Submit a service ticket.

DB instances cannot be created.

+

The database service may be unavailable.

Node adding failure

+

DB instance recovered

GaussDBV5ExpandClusterFailed

+

NoSQLDBInstanceRecovered

Major

+

Major

The underlying resources are insufficient.

+

If a disaster occurs, NoSQL provides an HA tool to automatically or manually rectify the fault. After the fault is rectified, this event is reported.

Submit a service ticket. The O&M personnel will coordinate resources in the background, and then you delete the node that failed to be added and add a new node.

+

No action is required.

None

+

None

Storage scale-up failure

+

Faulty node

GaussDBV5EnlargeVolumeFailed

+

NoSQLFaultyDBNode

Major

+

Major

The underlying resources are insufficient.

+

This event is a key alarm event and is reported when a database node is faulty due to a disaster or a server failure.

Submit a service ticket. The O&M personnel will coordinate resources in the background and then you scale up the storage space again.

+

Check whether the database service is available and submit a service ticket.

Services may be interrupted.

+

The database service may be unavailable.

Reboot failure

+

Node recovered

GaussDBV5RestartInstanceFailed

+

NoSQLDBNodeRecovered

Major

+

Major

The network is abnormal.

+

If a disaster occurs, NoSQL provides an HA tool to automatically or manually rectify the fault. After the fault is rectified, this event is reported.

Retry the reboot operation or submit a service ticket to the O&M personnel.

+

No action is required.

The database service may be unavailable.

+

None

Full backup failure

+

Primary/standby switchover or failover

GaussDBV5FullBackupFailed

+

NoSQLPrimaryStandbySwitched

Major

+

Major

The backup files fail to be exported or uploaded.

+

This event is reported when a primary/secondary switchover or failover is triggered.

Submit a service ticket to the O&M personnel.

+

No action is required.

Data cannot be backed up.

+

None

Differential backup failure

+

HotKey occurred

GaussDBV5DifferentialBackupFailed

+

HotKeyOccurs

Major

+

Major

The backup files fail to be exported or uploaded.

+

The primary key is improperly configured. As a result, hotspot data is distributed in one partition. The improper application design causes frequent read and write operations on a key.

Submit a service ticket to the O&M personnel.

+

1. Choose a proper partition key.

+

2. Add service cache. The service application reads hotspot data from the cache first.

Data cannot be backed up.

+

The service request success rate is affected, and the cluster performance and stability also be affected.

Backup deletion failure

+

BigKey occurred

GaussDBV5DeleteBackupFailed

+

BigKeyOccurs

Major

+

Major

This function does not need to be implemented.

+

The primary key design is improper. The number of records or data in a single partition is too large, causing unbalanced node loads.

N/A

+

1. Choose a proper partition key.

+

2. Add a new partition key for hashing data.

N/A

+

As the data in the large partition increases, the cluster stability deteriorates.

EIP binding failure

+

Insufficient storage space

GaussDBV5BindEIPFailed

+

NoSQLRiskyDataDiskUsage

Major

+

Major

The EIP is bound to another resource.

+

The storage space is insufficient.

Submit a service ticket to the O&M personnel.

+

Scale up storage space. For details, see section "Scaling Up Storage Space" in the corresponding user guide.

The instance cannot be accessed from the Internet.

+

The instance is set to read-only and data cannot be written to the instance.

EIP unbinding failure

+

Data disk expanded and being writable

GaussDBV5UnbindEIPFailed

+

NoSQLDataDiskUsageRecovered

Major

+

Major

The network is faulty or EIP is abnormal.

+

The capacity of a data disk has been expanded and the data disk becomes writable.

Unbind the IP address again or submit a service ticket to the O&M personnel.

+

No operation is required.

IP addresses may be residual.

+

None

Parameter template application failure

+

Index creation failed

GaussDBV5ApplyParamFailed

+

NoSQLCreateIndexFailed

Major

+

Major

Modifying a parameter template times out.

+

The service load exceeds what the instance specifications can take. In this case, creating indexes consumes more instance resources. As a result, the response is slow or even frame freezing occurs, and the creation times out.

Modify the parameter template again.

+

Select the matched instance specifications based on the service load.

+

Create indexes during off-peak hours.

+

Create indexes in the background.

+

Select indexes as required.

None

+

The index fails to be created or is incomplete. As a result, the index is invalid. Delete the index and create an index.

Parameter modification failure

+

Write speed decreased

GaussDBV5UpdateInstanceParamGroupFailed

+

NoSQLStallingOccurs

Major

+

Major

Modifying a parameter template times out.

+

The write speed is fast, which is close to the maximum write capability allowed by the cluster scale and instance specifications. As a result, the flow control mechanism of the database is triggered, and requests may fail.

Modify the parameter template again.

+

1. Adjust the cluster scale or node specifications based on the maximum write rate of services.

+

2. Measures the maximum write rate of services.

None

+

The success rate of service requests is affected.

Backup and restoration failure

+

Data write stopped

GaussDBV5RestoreFromBcakupFailed

+

NoSQLStoppingOccurs

Major

+

Major

The underlying resources are insufficient or backup files fail to be downloaded.

+

The data write is too fast, reaching the maximum write capability allowed by the cluster scale and instance specifications. As a result, the flow control mechanism of the database is triggered, and requests may fail.

Submit a service ticket.

+

1. Adjust the cluster scale or node specifications based on the maximum write rate of services.

+

2. Measures the maximum write rate of services.

The database service may be unavailable during the restoration failure.

+

The success rate of service requests is affected.

Failed to upgrade the hot patch

+

Database restart failed

GaussDBV5UpgradeHotfixFailed

+

NoSQLRestartDBFailed

Major

+

Major

Generally, this fault is caused by an error reported during kernel upgrade.

+

The instance status is abnormal.

View the error information about the workflow and redo or skip the job.

+

Submit a service ticket to the O&M personnel.

None

+

The DB instance status may be abnormal.

+

Restoration to new DB instance failed

+

NoSQLRestoreToNewInstanceFailed

+

Major

+

The underlying resources are insufficient.

+

Submit a service order to ask the O&M personnel to coordinate resources in the background and add new nodes.

+

Data cannot be restored to a new DB instance.

+

Restoration to existing DB instance failed

+

NoSQLRestoreToExistInstanceFailed

+

Major

+

The backup file fails to be downloaded or restored.

+

Submit a service ticket to the O&M personnel.

+

The current DB instance may be unavailable.

+

Backup file deletion failed

+

NoSQLDeleteBackupFailed

+

Major

+

The backup files fail to be deleted from OBS.

+

Delete the backup files again.

+

None

+

Failed to enable Show Original Log

+

NoSQLSwitchSlowlogPlainTextFailed

+

Major

+

The DB engine does not support this function.

+

Refer to the GaussDB NoSQL User Guide to ensure that the DB engine supports Show Original Log. Submit a service ticket to the O&M personnel.

+

None

+

EIP binding failed

+

NoSQLBindEipFailed

+

Major

+

The node status is abnormal, an EIP has been bound to the node, or the EIP to be bound is invalid.

+

Check whether the node is normal and whether the EIP is valid.

+

The DB instance cannot be accessed from the Internet.

+

EIP unbinding failed

+

NoSQLUnbindEipFailed

+

Major

+

The node status is abnormal or the EIP has been unbound from the node.

+

Check whether the node and EIP status are normal.

+

None

+

Parameter modification failed

+

NoSQLModifyParameterFailed

+

Major

+

The parameter value is invalid.

+

Check whether the parameter value is within the valid range and submit a service ticket to the O&M personnel.

+

None

+

Parameter group application failed

+

NoSQLApplyParameterGroupFailed

+

Major

+

The instance status is abnormal. As a result, the parameter group cannot be applied.

+

Submit a service ticket to the O&M personnel.

+

None

+

Failed to enable or disable SSL

+

NoSQLSwitchSSLFailed

+

Major

+

Enabling or disabling SSL times out.

+

Try again or submit a service ticket. Do not change the connection mode.

+

The connection mode cannot be changed.

+

Row size too large

+

LargeRowOccurs

+

Major

+

If there is too much data in a single row, queries may time out, causing faults like OOM error.

+

1. Control the length of each column and row so that the sum of key and value lengths in each row does not exceed the preset threshold.

+

2. Check whether there are invalid writes or encoding resulting in large keys or values.

+

If there are rows that are too large, the cluster performance will deteriorate as the data volume grows.

+

Schedule for deleting a KMS key

+

planDeleteKmsKey

+

Major

+

A request to schedule deletion of a KMS key was submitted.

+

After the KMS key is scheduled to be deleted, either decrypt the data encrypted by KMS key in a timely manner or cancel the key deletion.

+

After the KMS key is deleted, users cannot encrypt disks.

+

Too many query tombstones

+

TooManyQueryTombstones

+

Major

+

If there are too many query tombstones, queries may time out, affecting query performance.

+

Select right query and deleting methods and avoid long range queries.

+

Queries may time out, affecting query performance.

+

Too large collection column

+

TooLargeCollectionColumn

+

Major

+

If there are too many elements in a collection column, queries to the column will fail.

+
  1. Limit elements in a collection column.
  2. Check for abnormal writes or coding at the service side.
+

Queries to the collection column will fail.

+

GeminiDB Influx instance connection limit reached

+

InfluxDBConnectionFull

+

Major

+

The connections on the instance node reach the upper limit.

+

1. Upgrade specifications if they cannot meet service requirements.

+

2. Check whether the client properly manages connections, for example, whether there are unreleased or long connections.

+

If no new connection can be created on a node, the client may fail to connect to a GeminiDB Influx instance. As a result, services may become instable.

+

High availability switchover

+

nodeHaSwitch

+

Major

+

The high availability switchover is triggered by underlying network jitters.

+

Check whether the business is normal and it can be restored automatically.

+

The network jitter causes a few seconds of delay.
-
Table 9 Distributed Database Middleware (DDM)

Event Source

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 9 TaurusDB

Event Source

Namespace

+

Namespace

Event Name

+

Event Name

Event ID

+

Event ID

Event Severity

+

Event Severity

Description

+

Description

Solution

+

Solution

Impact

+

Impact

DDM

+

TaurusDB

SYS.DDM

+

SYS.GAUSSDB

+

Failed to create a DDM instance

+

Incremental backup failure

createDdmInstanceFailed

+

TaurusIncrementalBackupInstanceFailed

Major

+

Major

The underlying resources are insufficient.

+

The network between the instance and the management plane (or the OBS) is disconnected, or the backup environment created for the instance is abnormal.

Release resources and create the instance again.

+

Submit a service ticket.

DDM instances cannot be created.

+

Backup jobs fail.

Failed to change class of a DDM instance

+

Read replica creation failure

resizeFlavorFailed

+

addReadonlyNodesFailed

Major

+

Major

The underlying resources are insufficient.

+

The quota is insufficient or underlying resources are exhausted.

Submit a service ticket to the O&M personnel to coordinate resources and try again.

+

Check the read replica quota. Release resources and create read replicas again.

Services on some nodes are interrupted.

+

Read replicas fail to be created.

Failed to scale out a DDM instance

+

DB instance creation failure

enlargeNodeFailed

+

createInstanceFailed

Major

+

Major

The underlying resources are insufficient.

+

The instance quota or underlying resources are insufficient.

Submit a service ticket to the O&M personnel to coordinate resources, delete the node that fails to be added, and add a node again.

+

Check the instance quota. Release resources and create instances again.

The instance fails to be scaled out.

+

DB instances fail to be created.

Failed to scale in a DDM instance

+

Read replica promotion failure

reduceNodeFailed

+

activeStandBySwitchFailed

Major

+

Major

The underlying resources fail to be released.

+

The read replica fails to be promoted to the primary node due to network or server failures. The original primary node takes over services quickly.

Submit a service ticket to the O&M personnel to release resources.

+

Submit a service ticket.

The instance fails to be scaled in.

+

The read replica fails to be promoted to the primary node.

Failed to restart a DDM instance

+

Instance specifications change failure

restartInstanceFailed

+

flavorAlterationFailed

Major

+

Major

The DB instances associated are abnormal.

+

The quota is insufficient or underlying resources are exhausted.

Check whether DB instances associated are normal. If the instances are normal, submit a service ticket to the O&M personnel.

+

Submit a service ticket.

Services on some nodes are interrupted.

+

Instance specifications fail to be changed.

Failed to create a schema

+

Faulty DB instance

createLogicDbFailed

+

TaurusInstanceRunningStatusAbnormal

Major

+

Major

The possible causes are as follows:

-
  • The password for the DB instance account is incorrect.
  • The security group of the DDM instance and the associated DB instance are incorrectly configured. As a result, the DDM instance cannot communicate with the associated DB instance.
+

The instance process is faulty or the communications between the instance and the DFV storage are abnormal.

Check whether

-
  • The username and password of the DB instance are correct.
  • The security groups associated with the DDM instance and underlying database instance are correctly configured.
+

Submit a service ticket.

Services cannot run properly.

+

Services may be affected.

Failed to bind an EIP

+

DB instance recovered

bindEipFailed

+

TaurusInstanceRunningStatusRecovered

Major

+

Major

The EIP is abnormal.

+

The instance is recovered.

Try again later. In case of emergency, contact O&M personnel to rectify the fault.

+

Observe the service running status.

The DDM instance cannot be accessed from the Internet.

+

None

Failed to scale out a schema

+

Faulty node

migrateLogicDbFailed

+

TaurusNodeRunningStatusAbnormal

Major

+

Major

The underlying resources fail to be processed.

+

The node process is faulty or the communications between the node and the DFV storage are abnormal.

Submit a service ticket to the O&M personnel.

+

Observe the instance and service running statuses.

The schema cannot be scaled out.

+

A read replica may be promoted to the primary node.

Failed to re-scale out a schema

+

Node recovered

retryMigrateLogicDbFailed

+

TaurusNodeRunningStatusRecovered

Major

+

Major

The underlying resources fail to be processed.

+

The node is recovered.

Submit a service ticket to the O&M personnel.

+

Observe the service running status.

The schema cannot be scaled out.

+

None

+

Read replica deletion failure

+

TaurusDeleteReadOnlyNodeFailed

+

Major

+

The communications between the management plane and the read replica are abnormal or the VM fails to be deleted from IaaS.

+

Submit a service ticket.

+

Read replicas fail to be deleted.

+

Password reset failure

+

TaurusResetInstancePasswordFailed

+

Major

+

The communications between the management plane and the instance are abnormal or the instance is abnormal.

+

Check the instance status and try again. If the fault persists, submit a service ticket.

+

Passwords fail to be reset for instances.

+

DB instance reboot failure

+

TaurusRestartInstanceFailed

+

Major

+

The network between the management plane and the instance is abnormal or the instance is abnormal.

+

Check the instance status and try again. If the fault persists, submit a service ticket.

+

Instances fail to be rebooted.

+

Restoration to new DB instance failure

+

TaurusRestoreToNewInstanceFailed

+

Major

+

The instance quota is insufficient, underlying resources are exhausted, or the data restoration logic is incorrect.

+

If the new instance fails to be created, check the instance quota, release resources, and try to restore to a new instance again. In other cases, submit a service ticket.

+

Backup data fails to be restored to new instances.

+

EIP binding failure

+

TaurusBindEIPToInstanceFailed

+

Major

+

The binding task fails.

+

Submit a service ticket.

+

EIPs fail to be bound to instances.

+

EIP unbinding failure

+

TaurusUnbindEIPFromInstanceFailed

+

Major

+

The unbinding task fails.

+

Submit a service ticket.

+

EIPs fail to be unbound from instances.

+

Parameter modification failure

+

TaurusUpdateInstanceParameterFailed

+

Major

+

The network between the management plane and the instance is abnormal or the instance is abnormal.

+

Check the instance status and try again. If the fault persists, submit a service ticket.

+

Instance parameters fail to be modified.

+

Parameter template application failure

+

TaurusApplyParameterGroupToInstanceFailed

+

Major

+

The network between the management plane and instances is abnormal or the instances are abnormal.

+

Check the instance status and try again. If the fault persists, submit a service ticket.

+

Parameter templates fail to be applied to instances.

+

Full backup failure

+

TaurusBackupInstanceFailed

+

Major

+

The network between the instance and the management plane (or the OBS) is disconnected, or the backup environment created for the instance is abnormal.

+

Submit a service ticket.

+

Backup jobs fail.

+

Primary/standby failover

+

TaurusActiveStandbySwitched

+

Major

+

When the network, physical machine, or database of the primary node is faulty, the system promotes a read replica to primary based on the failover priority to ensure service continuity.

+
  1. Check whether the service is running properly.
  2. Check whether an alarm is generated, indicating that the read replica failed to be promoted to primary.
+

During the failover, database connection is interrupted for a short period of time. After the failover is complete, you can reconnect to the database.

+

Database read-only

+

NodeReadonlyMode

+

Major

+

The database supports only query operations.

+

Submit a service ticket.

+

After the database becomes read-only, write operations cannot be processed.

+

Database read/write

+

NodeReadWriteMode

+

Major

+

The database supports both write and read operations.

+

Submit a service ticket.

+

None

+

Instance DR switchover

+

DisasterSwitchOver

+

Major

+

If an instance is faulty and unavailable, a switchover is performed to ensure that the instance continues to provide services.

+

Contact technical support.

+

The database connection is intermittently interrupted. The HA service switches workloads from the primary node to a read replica and continues to provide services.

+

Database process restarted

+

TaurusDatabaseProcessRestarted

+

Major

+

The database process is stopped due to insufficient memory or high load.

+

Log in to the Cloud Eye console. Check whether the memory usage increases sharply or the CPU usage is too high for a long time. You can increase the specifications or optimize the service logic.

+

When the database process is suspended, workloads on the node are interrupted. In this case, the HA service automatically restarts the database process and attempts to recover the workloads.
-
Table 10 Elastic Volume Service (EVS)

Event Source

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 GaussDB(for openGauss)

Event Source

Namespace

+

Namespace

Event Name

+

Event Name

Event ID

+

Event ID

Event Severity

+

Event Severity

Description

+

Description

Solution

+

Solution

Impact

+

Impact

EVS

+

GaussDB(for openGauss)

+

+

+

+

+

SYS.EVS

+

SYS.GAUSSDBV5

+

+

+

+

Update disk

+

Process status alarm

updateVolume

+

ProcessStatusAlarm

Minor

+

Major

Update the name and description of an EVS disk.

+

Key processes exit, including CMS/CMA, ETCD, GTM, CN, and DN processes.

No further action is required.

+

Wait until the process is automatically recovered or a primary/standby failover is automatically performed. Check whether services are recovered. If no, contact SRE engineers.

None

+

If processes on primary nodes are faulty, services are interrupted and then rolled back. If processes on standby nodes are faulty, services are not affected.

Expand disk

+

Component status alarm

extendVolume

+

ComponentStatusAlarm

Minor

+

Major

Expand an EVS disk.

+

Key components do not respond, including CMA, ETCD, GTM, CN, and DN components.

No further action is required.

+

Wait until the process is automatically recovered or a primary/standby failover is automatically performed. Check whether services are recovered. If no, contact SRE engineers.

None

+

If processes on primary nodes do not respond, neither do the services. If processes on standby nodes are faulty, services are not affected.

Delete disk

+

Cluster status alarm

deleteVolume

+

ClusterStatusAlarm

Major

+

Major

Delete an EVS disk.

+

The cluster status is abnormal. For example, the cluster is read-only; majority of ETCDs are faulty; or the cluster resources are unevenly distributed.

No further action is required.

+

Contact SRE engineers.

Deleted disks cannot be recovered.

+

If the cluster status is read-only, only read services are processed.

+

If the majority of ETCDs are fault, the cluster is unavailable.

+

If resources are unevenly distributed, the instance performance and reliability deteriorate.

QoS upper limit reached

+

Hardware resource alarm

reachQoS

+

HardwareResourceAlarm

Major

+

Major

The I/O latency increases as the QoS upper limits of the disk are frequently reached and flow control triggered.

+

A major hardware fault occurs in the instance, such as disk damage or GTM network fault.

Change the disk type to one with a higher specification.

+

Contact SRE engineers.

The current disk may fail to meet service requirements.

+

Some or all services are affected.

+

Status transition alarm

+

StateTransitionAlarm

+

Major

+

The following events occur in the instance: DN build failure, forcible DN promotion, primary/standby DN switchover/failover, or primary/standby GTM switchover/failover.

+

Wait until the fault is automatically rectified and check whether services are recovered. If no, contact SRE engineers.

+

Some services are interrupted.

+

Other abnormal alarm

+

OtherAbnormalAlarm

+

Major

+

Disk usage threshold alarm

+

Focus on service changes and scale up storage space as needed.

+

If the used storage space exceeds the threshold, storage space cannot be scaled up.

+

DB instance creation failure

+

GaussDBV5CreateInstanceFailed

+

Major

+

Instances fail to be created because the quota is insufficient or underlying resources are exhausted.

+

Release the instances that are no longer used and try to provision them again, or submit a service ticket to adjust the quota.

+

DB instances cannot be created.

+

Node adding failure

+

GaussDBV5ExpandClusterFailed

+

Major

+

The underlying resources are insufficient.

+

Submit a service ticket. The O&M personnel will coordinate resources in the background, and then you delete the node that failed to be added and add a new node.

+

None

+

Storage scale-up failure

+

GaussDBV5EnlargeVolumeFailed

+

Major

+

The underlying resources are insufficient.

+

Submit a service ticket. The O&M personnel will coordinate resources in the background and then you scale up the storage space again.

+

Services may be interrupted.

+

Reboot failure

+

GaussDBV5RestartInstanceFailed

+

Major

+

The network is abnormal.

+

Retry the reboot operation or submit a service ticket to the O&M personnel.

+

The database service may be unavailable.

+

Full backup failure

+

GaussDBV5FullBackupFailed

+

Major

+

The backup files fail to be exported or uploaded.

+

Submit a service ticket to the O&M personnel.

+

Data cannot be backed up.

+

Differential backup failure

+

GaussDBV5DifferentialBackupFailed

+

Major

+

The backup files fail to be exported or uploaded.

+

Submit a service ticket to the O&M personnel.

+

Data cannot be backed up.

+

Backup deletion failure

+

GaussDBV5DeleteBackupFailed

+

Major

+

The backup files fail to be deleted from OBS.

+

Delete the backup files again.

+

None

+

EIP binding failure

+

GaussDBV5BindEIPFailed

+

Major

+

The EIP is bound to another resource.

+

Submit a service ticket to the O&M personnel.

+

The instance cannot be accessed from the public network.

+

EIP unbinding failure

+

GaussDBV5UnbindEIPFailed

+

Major

+

The network is faulty or EIP is abnormal.

+

Unbind the IP address again or submit a service ticket to the O&M personnel.

+

IP addresses may be residual.

+

Parameter template application failure

+

GaussDBV5ApplyParamFailed

+

Major

+

Modifying a parameter template times out.

+

Modify the parameter template again.

+

None

+

Parameter modification failure

+

GaussDBV5UpdateInstanceParamGroupFailed

+

Major

+

Modifying a parameter template times out.

+

Modify the parameter template again.

+

None

+

Backup and restoration failure

+

GaussDBV5RestoreFromBcakupFailed

+

Major

+

The underlying resources are insufficient or backup files fail to be downloaded.

+

Submit a service ticket.

+

The database service may be unavailable during the restoration failure.

+

Failed to upgrade the hot patch

+

GaussDBV5UpgradeHotfixFailed

+

Major

+

Generally, this fault is caused by an error reported during kernel upgrade.

+

View the error information about the workflow and redo or skip the job.

+

None

+

DB instance faulty

+

GaussDBV5FaultyDBInstance

+

Major

+

This event is a key alarm event and is reported when an instance is faulty due to a disaster or a server failure.

+

Submit a service ticket.

+

The database service may be unavailable.

+

DB instance recovered

+

GaussDBV5InstanceRecovered

+

Major

+

GaussDB(for openGauss) provides an HA tool for automated or manual rectification of faults. After the fault is rectified, this event is reported.

+

No action is required.

+

None

+

Faulty node

+

GaussDBV5FaultyDBNode

+

Major

+

This event is a key alarm event and is reported when a database node is faulty due to a disaster or a server failure.

+

This event is a key alarm event and is reported when a database node is faulty due to a disaster or a server failure.

+

The database service may be unavailable.

+

Node recovered

+

GaussDBV5FaultyDBNodeRecovered

+

Major

+

GaussDB(for openGauss) provides an HA tool for automated or manual rectification of faults. After the fault is rectified, this event is reported.

+

No action is required.

+

None
-
Table 11 Key Management Service (KMS)

Event Source

+
- - - - + + + - - - - - + + + - - - + + + - - - + + + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 11 Distributed Database Middleware (DDM)

Event Source

Namespace

+

Namespace

Event Name

+

Event Name

Event ID

+

Event ID

Event Severity

+

Event Severity

+

Description

+

Solution

+

Impact

KMS

+

DDM

SYS.KMS

+

SYS.DDM (DDM 1.0)

+

SYS.DDMS (DDM 2.0)

Key disabled

+

Failed to create a DDM instance

disableKey

+

createDdmInstanceFailed

Major

+

Major

+

The underlying resources are insufficient.

+

Release resources and create the instance again.

+

DDM instances cannot be created.

Key deletion scheduled

+

Failed to change class of a DDM instance

scheduleKeyDeletion

+

resizeFlavorFailed

Minor

+

Major

+

The underlying resources are insufficient.

+

Submit a service ticket to the O&M personnel to coordinate resources and try again.

+

Services on some nodes are interrupted.

Grant retired

+

Failed to scale out a DDM instance

retireGrant

+

enlargeNodeFailed

Major

+

Major

+

The underlying resources are insufficient.

+

Submit a service ticket to the O&M personnel to coordinate resources, delete the node that fails to be added, and add a node again.

+

The instance fails to be scaled out.

Grant revoked

+

Failed to scale in a DDM instance

revokeGrant

+

reduceNodeFailed

Major

+

Major

+

The underlying resources fail to be released.

+

Submit a service ticket to the O&M personnel to release resources.

+

The instance fails to be scaled in.

+

Failed to restart a DDM instance

+

restartInstanceFailed

+

Major

+

The DB instances associated are abnormal.

+

Check whether DB instances associated are normal. If the instances are normal, submit a service ticket to the O&M personnel.

+

Services on some nodes are interrupted.

+

Failed to create a schema

+

createLogicDbFailed

+

Major

+

The possible causes are as follows:

+
  • The password for the DB instance account is incorrect.
  • The security group of the DDM instance and the associated DB instance are incorrectly configured. As a result, the DDM instance cannot communicate with the associated DB instance.
+

Check whether

+
  • The username and password of the DB instance are correct.
  • The security groups associated with the DDM instance and underlying database instance are correctly configured.
+

Services cannot run properly.

+

Failed to bind an EIP

+

bindEipFailed

+

Major

+

The EIP is abnormal.

+

Try again later. In case of emergency, contact O&M personnel to rectify the fault.

+

The DDM instance cannot be accessed from the Internet.

+

Failed to scale out a schema

+

migrateLogicDbFailed

+

Major

+

The underlying resources fail to be processed.

+

Submit a service ticket to the O&M personnel.

+

The schema cannot be scaled out.

+

Failed to re-scale out a schema

+

retryMigrateLogicDbFailed

+

Major

+

The underlying resources fail to be processed.

+

Submit a service ticket to the O&M personnel.

+

The schema cannot be scaled out.
-
Table 12 Cloud Eye (CES)

Event Source

+
- - - - - + + - - - - - - + + + + + + + + + + + + + + + + + + + + + + +
Table 12 Elastic Volume Service (EVS)

Event Source

Event Name

+

Namespace

Event ID

+

Event Name

Event Severity

+

Event ID

Description

+

Event Severity

Solution

+

Description

+

Solution

+

Impact

Cloud Eye

+

EVS

Agent heartbeat interruption

+

SYS.EVS

agentHeartbeatInterrupted

+

Update disk

Major

+

updateVolume

The Agent sends a heartbeat message to Cloud Eye every minute. If Cloud Eye cannot receive a heartbeat for 3 minutes, Agent Status is displayed as Faulty.

+

Minor

  • Confirm that the Agent domain name cannot be resolved.
  • Check whether your account is in arrears.
  • The Agent process is faulty. Restart the Agent. If the Agent process is still faulty after the restart, the Agent files may be damaged. In this case, reinstall the Agent.
  • Confirm that the server time is inconsistent with the local standard time.
  • Update the Agent to the latest version.
+

Update the name and description of an EVS disk.

+

No further action is required.

+

None

+

Expand disk

+

extendVolume

+

Minor

+

Expand an EVS disk.

+

No further action is required.

+

None

+

Delete disk

+

deleteVolume

+

Major

+

Delete an EVS disk.

+

No further action is required.

+

Deleted disks cannot be recovered.

+

QoS upper limit reached

+
NOTE:

This event is no longer supported for EVS and will be removed from Cloud Eye.

+
+

reachQoS

+

Major

+

The I/O latency increases as the QoS upper limits of the disk are frequently reached and flow control triggered.

+

Change the disk type to one with a higher specification.

+

The current disk may fail to meet service requirements.
-
Table 13 Distributed Cache Service (DCS)

Event Source

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 13 Identity and Access Management (IAM)

Event Source

Namespace

+

Namespace

Event Name

+

Event Name

Event ID

+

Event ID

Event Severity

-

Description

-

Solution

-

Impact

+

Event Severity

DCS

+

IAM

SYS.DCS

+

SYS.IAM

Full sync retry during online migration

+

Login

migrationFullResync

+

login

Minor

-

If online migration fails, full synchronization will be triggered because incremental synchronization cannot be performed.

-

Check whether full sync retries are triggered repeatedly. Check whether the source instance is connected and whether it is overloaded. If full sync retries are triggered repeatedly, contact O&M personnel.

-

The migration task is disconnected from the source instance, triggering another full sync. As a result, the CPU usage of the source instance may increase sharply.

+

Minor
  

masterStandbyFailover

+

Logout

Minor

+

logout

The master node was abnormal, promoting a replica to master.

-		    

Memcached master/standby switchover

-

memcachedMasterStandbyFailover

-

Minor

-

The master node was abnormal, promoting the standby node to master.

-

Check whether services can recover by themselves. If applications cannot recover, restart them.

-

Persistent connections to the instance will be interrupted.

+

Minor

Redis server abnormal

+

Password changed

redisNodeStatusAbnormal

+

changePassword

Major

-

The Redis server status was abnormal.

-

Check whether services are affected. If yes, contact O&M personnel.

-

If the master node is abnormal, an automatic failover is performed. If a standby node is abnormal and the client directly connects to the standby node for read/write splitting, no data can be read.

+

Major

Redis server recovered

+

User created

redisNodeStatusNormal

+

createUser

Major

-

The Redis server status recovered.

-

Check whether services can recover. If the applications are not reconnected, restart them.

-

Recover from an exception.

+

Minor

Sync failure in data migration

+

User deleted

migrateSyncDataFail

+

deleteUser

Major

-

Online migration failed.

-

Reconfigure the migration task and migrate data again. If the fault persists, contact O&M personnel.

-

Data migration fails.

+

Major

Memcached instance abnormal

+

User updated

memcachedInstanceStatusAbnormal

+

updateUser

Major

-

The Memcached node status was abnormal.

-

Check whether services are affected. If yes, contact O&M personnel.

-

The Memcached instance is abnormal and may not be accessed.

+

Minor

Memcached instance recovered

+

User group created

memcachedInstanceStatusNormal

+

createUserGroup

Major

-

The Memcached node status recovered.

-

Check whether services can recover. If the applications are not reconnected, restart them.

-

Recover from an exception.

+

Minor

Instance backup failure

+

User group deleted

instanceBackupFailure

+

deleteUserGroup

Major

-

The DCS instance fails to be backed up due to an OBS access failure.

-

Retry backup manually.

-

Automated backup fails.

+

Major

Instance node abnormal restart

+

User group updated

instanceNodeAbnormalRestart

+

updateUserGroup

Major

-

DCS nodes restarted unexpectedly when they became faulty.

-

Check whether services can recover. If the applications are not reconnected, restart them.

-

Persistent connections to the instance will be interrupted.

+

Minor

Long-running Lua scripts stopped

+

Identity provider created

scriptsStopped

+

createIdentityProvider

Informational

-

Lua scripts that had timed out automatically stopped running.

-

Optimize Lua scrips to prevent execution timeout.

-

If Lua scripts take a long time to execute, they will be forcibly stopped to avoid blocking the entire instance.

+

Minor

Node restarted

+

Identity provider deleted

nodeRestarted

+

deleteIdentityProvider

Informational

+

Major

After write operations had been performed, the node automatically restarted to stop Lua scripts that had timed out.

+

Identity provider updated

Check whether services can recover by themselves. If applications cannot recover, restart them.

+

updateIdentityProvider

Persistent connections to the instance will be interrupted.

+

Minor

+

Metadata updated

+

updateMetadata

+

Minor

+

Security policy updated

+

updateSecurityPolicies

+

Major

+

Credential added

+

addCredential

+

Major

+

Credential deleted

+

deleteCredential

+

Major

+

Project created

+

createProject

+

Minor

+

Project updated

+

updateProject

+

Minor

+

Project suspended

+

suspendProject

+

Major
-
Table 14 Config

Event Source

+
- - - - - - + - - - - - - - + - - - - - - + + + + + + + + + + + + + +
Table 14 Key Management Service (KMS)

Event Source

Event Name

+

Namespace

Event ID

+

Event Name

Event Severity

+

Event ID

Description

+

Event Severity

Solution

+

Description

Impact

+

Solution

+

Impact

RMS

+

KMS

Configuration noncompliance notification

+

SYS.KMS

configurationNoncomplianceNotification

+

Key disabled

Major

+

disableKey

The assignment evaluation result is Non-compliant.

+

Major

Modify the noncompliant configuration items of the resource.

+

A key is disabled and cannot be used.

None

+

If the customer needs to disable the key, no action is required. However, if the key is disabled by mistake, the customer needs to log in to the DEW console and enable it again.

+

Services may be affected if the key is being used.

Configuration compliance notification

+

Key deletion scheduled

configurationComplianceNotification

+

scheduleKeyDeletion

Informational

+

Minor

The assignment evaluation result changed to be Compliant.

+

A key is scheduled to be deleted and cannot be used.

None

+

If the customer needs to delete the key, no action is required. However, if the deletion of the key is scheduled by mistake, the customer needs to log in to the DEW console, cancel the scheduled deletion, and enable the key again.

None

+

Services may be affected if the key is being used.

+

Grant retired

+

retireGrant

+

Major

+

A grant is retired and the key cannot be used.

+

If the customer needs to cancel the key grant, no action is required. However, if the grant is canceled by mistake, the customer needs to log in to the DEW console and create the grant again.

+

Services may be affected if the key is being used.

+

Grant revoked

+

revokeGrant

+

Major

+

A grant is revoked and the key cannot be used.

+

If the customer needs to cancel the key grant, no action is required. However, if the grant is canceled by mistake, the customer needs to log in to the DEW console and create the grant again.

+

Services may be affected if the key is being used.
-
Table 15 Host Security Service (HSS)

Event Source

+
- - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + +
Table 15 Cloud Eye (CES)

Event Source

Namespace

+

Namespace

Event Name

+

Event Name

Event ID

+

Event ID

Event Severity

+

Event Severity

Description

+

Description

Solution

+

Solution

Impact

+

Impact

HSS

+

Cloud Eye

SYS.HSS

+

SYS.CES

HSS agent disconnected

+

Agent heartbeat interruption

hssAgentAbnormalOffline

+

agentHeartbeatInterrupted

Major

+

Major

The communication between the agent and the server is abnormal, or the agent process on the server is abnormal.

+

The collecting process of the Agent is faulty.

Fix your network connection. If the agent is still offline for a long time after the network recovers, the agent process may be abnormal. In this case, log in to the server and restart the agent process.

+
  • Confirm that the Agent domain name cannot be resolved.
  • Check whether your account is in arrears.
  • The Agent process is faulty. Restart the Agent. If the Agent process is still faulty after the restart, the Agent files may be damaged. In this case, reinstall the Agent.
  • Confirm that the server time is inconsistent with the local standard time.
  • Update the Agent to the latest version.

Services are interrupted.

+

The Agent will stop collecting and reporting metrics.

Abnormal HSS agent status

+

Agent back to normal

hssAgentAbnormalProtection

+

agentResumed

Major

+

Informational

The agent is abnormal probably because it does not have sufficient resources.

+

The Agent was back to normal.

Log in to the server and check your resources. If the usage of memory or other system resources is too high, increase their capacity first. If the resources are sufficient but the fault persists after the agent process is restarted, submit a service ticket to the O&M personnel.

+

No action is required.

Services are interrupted.

+

None

+

Agent faulty

+

agentFaulted

+

Major

+

The Agent was faulty and this status was reported to Cloud Eye.

+

The Agent process is faulty. Restart the Agent. If the Agent process is still faulty after the restart, the Agent files may be damaged. In this case, reinstall the Agent.

+

Update the Agent to the latest version.

+

The Agent will stop collecting and reporting metrics.

+

Agent disconnected

+

agentDisconnected

+

Major

+

The communication process of the Agent is faulty.

+

Confirm that the Agent domain name cannot be resolved.

+

Check whether your account is in arrears.

+

The Agent process is faulty. Restart the Agent. If the Agent process is still faulty after the restart, the Agent files may be damaged. In this case, reinstall the Agent.

+

Confirm that the server time is inconsistent with the local standard time.

+

Update the Agent to the latest version.

+

The Agent will stop collecting and reporting metrics.
-
Table 16 Image Management Service (IMS)

Event Source

+
- - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 16 Distributed Cache Service (DCS)

Event Source

Namespace

+

Namespace

Event Name

+

Event Name

Event ID

+

Event ID

Event Severity

+

Event Severity

Description

+

Description

Solution

+

Solution

Impact

+

Impact

IMS

+

DCS

+

+

SYS.IMS

+

SYS.DCS

+

+

Create Image

+

Full sync retry during online migration

createImage

+

migrationFullResync

Major

+

Minor

An image was created.

+

If online migration fails, full synchronization will be triggered because incremental synchronization cannot be performed.

None

+

Check whether full sync retries are triggered repeatedly. Check whether the source instance is connected and whether it is overloaded. If full sync retries are triggered repeatedly, contact O&M personnel.

You can use this image to create cloud servers.

+

The migration task is disconnected from the source instance, triggering another full sync. As a result, the CPU usage of the source instance may increase sharply.

Update Image

+

Memcached master/standby switchover

updateImage

+

memcachedMasterStandbyFailover

Major

+

Minor

Metadata of an image was modified.

+

The master node was abnormal, promoting the standby node to master.

None

+

Check whether services can recover by themselves. If applications cannot recover, restart them.

Cloud servers may fail to be created from this image.

+

Persistent connections to the instance will be interrupted.

Delete Image

+

Redis server abnormal

deleteImage

+

redisNodeStatusAbnormal

Major

+

Major

An image was deleted.

+

The Redis server status was abnormal.

None

+

Check whether services are affected. If yes, contact O&M personnel.

This image will be unavailable on the management console.

+

If the master node is abnormal, an automatic failover is performed. If a standby node is abnormal and the client directly connects to the standby node for read/write splitting, no data can be read.

+

Redis server recovered

+

redisNodeStatusNormal

+

Major

+

The Redis server status recovered.

+

Check whether services can recover. If the applications are not reconnected, restart them.

+

Recover from an exception.

+

Sync failure in data migration

+

migrateSyncDataFail

+

Major

+

Online migration failed.

+

Reconfigure the migration task and migrate data again. If the fault persists, contact O&M personnel.

+

Data migration fails.

+

Memcached instance abnormal

+

memcachedInstanceStatusAbnormal

+

Major

+

The Memcached node status was abnormal.

+

Check whether services are affected. If yes, contact O&M personnel.

+

The Memcached instance is abnormal and may not be accessed.

+

Memcached instance recovered

+

memcachedInstanceStatusNormal

+

Major

+

The Memcached node status recovered.

+

Check whether services can recover. If the applications are not reconnected, restart them.

+

Recover from an exception.

+

Instance backup failure

+

instanceBackupFailure

+

Major

+

The DCS instance fails to be backed up due to an OBS access failure.

+

Retry backup manually.

+

Automated backup fails.

+

Instance node abnormal restart

+

instanceNodeAbnormalRestart

+

Major

+

DCS nodes restarted unexpectedly when they became faulty.

+

Check whether services can recover by themselves. If applications cannot recover, restart them.

+

Persistent connections to the instance will be interrupted.

+

Long-running Lua scripts stopped

+

scriptsStopped

+

Informational

+

Lua scripts that had timed out automatically stopped running.

+

Optimize Lua scrips to prevent execution timeout.

+

If Lua scripts take a long time to execute, they will be forcibly stopped to avoid blocking the entire instance.

+

Node restarted

+

nodeRestarted

+

Informational

+

After write operations had been performed, the node automatically restarted to stop Lua scripts that had timed out.

+

Check whether services can recover by themselves. If applications cannot recover, restart them.

+

Persistent connections to the instance will be interrupted.

+

Automatic failover

+

masterStandbyFailover

+

Major

+

The master node failed due to a hard/software fault, triggering the replica node to take over services.

+

Check that the application reconnected to the instance and the fault was rectified. Otherwise, restart the application.

+

Access errors interrupt persistent connections to the instance.

+

Manual switchover

+

masterStandbySwitchover

+

Major

+

Performing master/standby switchovers on the console or calling the master/standby switchover API triggers these events. Master/Standby switchovers occur during specification changes or after instance restarts. Manual O&M on the backend required by fault drills or resource migration initiates master/standby switchovers.

+

Check that the application reconnected to the instance and the fault was rectified. Otherwise, restart the application.

+

Access errors interrupt persistent connections to the instance.
-
Table 17 Bare Metal Server (BMS)

Event Source

+
- - - - - - + - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 17 Host Security Service (HSS)

Event Source

Event Name

+

Namespace

Event ID

+

Event Name

Event Severity

+

Event ID

Description

+

Event Severity

Solution

+

Description

Impact

+

Solution

+

Impact

BMS

+

HSS

ECC uncorrectable errors generated on GPU SRAM

+

SYS.HSS

SRAMUncorrectableEccError

+

HSS agent disconnected

Major

+

hssAgentAbnormalOffline

There are ECC uncorrectable errors generated on GPU SRAM.

+

Major

If services are affected, submit a service ticket.

+

The communication between the agent and the server is abnormal, or the agent process on the server is abnormal.

The GPU hardware may be faulty. As a result, the GPU memory is faulty, and services exit abnormally.

+

Fix your network connection. If the agent is still offline for a long time after the network recovers, the agent process may be abnormal. In this case, log in to the server and restart the agent process.

+

Services are interrupted.

osShutdown

+

Abnormal HSS agent status

osShutdown

+

hssAgentAbnormalProtection

Major

+

Major

The BMS was stopped

-
  • on the management console.
  • by calling APIs.
+

The agent is abnormal probably because it does not have sufficient resources.

  • Deploy service applications in HA mode.
  • After the BMS is started, check whether services recover.
+

Log in to the server and check your resources. If the usage of memory or other system resources is too high, increase their capacity first. If the resources are sufficient but the fault persists after the agent process is restarted, submit a service ticket to the O&M personnel.

Services are interrupted.

-

Abnormal shutdown

-

serverShutdown

-

Major

-

The BMS was stopped unexpectedly, which may be caused by

-
  • unexpected power-off.
  • hardware faults.
-
  • Deploy service applications in HA mode.
  • After the BMS is started, check whether services recover.
-

Services are interrupted.

-

Abnormal reboot

-

serverReboot

-

Major

-

The BMS restarted unexpectedly, which may be caused by

-
  • OS faults.
  • hardware faults.
-
  • Deploy service applications in HA mode.
  • After the BMS is restarted, check whether services recover.
-

Services are interrupted.

-

Network interruption

-

linkDown

-

Major

-

The BMS network was disconnected. Possible causes are as follows:

-
  • The BMS was unexpectedly stopped or restarted.
  • The switch was faulty.
  • The gateway was faulty.
-
  • Deploy service applications in HA mode.
  • After the BMS is started, check whether services recover.
-

Services are interrupted.

-

PCIE error

-

pcieError

-

Major

-

The PCIe devices or main board of the BMS was faulty.

-
  • Deploy service applications in HA mode.
  • After the BMS is started, check whether services recover.
-

The network or disk read/write services are affected.

-

Disk error

-

diskError

-

Major

-

The disk backplane or disks of the BMS were faulty.

-
  • Deploy service applications in HA mode.
  • After the fault is rectified, check whether services recover.
-

Data read/write services are affected, or the BMS cannot be started.

-

Storage error

-

storageError

-

Major

-

The BMS failed to connect to EVS disks. Possible causes are as follows:

-
  • The SDI card was faulty.
  • Remote storage devices were faulty.
-
  • Deploy service applications in HA mode.
  • After the fault is rectified, check whether services recover.
-

Data read/write services are affected, or the BMS cannot be started.

-

OS reboot

-

osReboot

-

Major

-

The BMS was restarted

-
  • on the management console.
  • by calling APIs.
-
  • Deploy service applications in HA mode.
  • After the BMS is restarted, check whether services recover.
-

Services are interrupted.

-

Inforom alarm generated on GPU

-

gpuInfoROMAlarm

-

Major

-

The driver failed to read inforom information due to GPU faults.

-

Non-critical services can continue to use the GPU card. For critical services, submit a service ticket to resolve this issue.

-

Services will not be affected if inforom information cannot be read. If error correction code (ECC) errors are reported on GPU, faulty pages may not be automatically retired and services are affected.

-

Double-bit ECC alarm generated on GPU

-

doubleBitEccError

-

Major

-

A double-bit ECC error occurred on GPU.

-
  1. If services are interrupted, restart the services to restore.
  2. If services cannot be restarted, restart the VM where services are running.
  3. If services still cannot be restored, submit a service ticket.
-

Services may be interrupted. After faulty pages are retired, the GPU card can continue to be used.

-

Too many retired pages

-

gpuTooManyRetiredPagesAlarm

-

Major

-

An ECC page retirement error occurred on GPU.

-

If services are affected, submit a service ticket.

-

Services may be affected.

-

ECC alarm generated on GPU A100

-

gpuA100EccAlarm

-

Major

-

An ECC error occurred on GPU.

-
  1. If services are interrupted, restart the services to restore.
  2. If services cannot be restarted, restart the VM where services are running.
  3. If services still cannot be restored, submit a service ticket.
-

Services may be interrupted. After faulty pages are retired, the GPU card can continue to be used.

-

GPU ECC memory page retirement failure

-

eccPageRetirementRecordingFailure

-

Major

-

Automatic page retirement failed due to ECC errors.

-
  1. If services are interrupted, restart the services to restore.
  2. If services cannot be restarted, restart the VM where services are running.
  3. If services still cannot be restored, submit a service ticket.
-

Services may be interrupted, and memory page retirement fails. As a result, services cannot no longer use the GPU card.

-

GPU ECC page retirement alarm generated

-

eccPageRetirementRecordingEvent

-

Minor

-

Memory pages are automatically retired due to ECC errors.

-
  1. If services are interrupted, restart the services to restore.
  2. If services cannot be restarted, restart the VM where services are running.
  3. If services still cannot be restored, submit a service ticket.
-

Generally, this alarm is generated together with the ECC error alarm. If this alarm is generated independently, services are not affected.

-

Too many single-bit ECC errors on GPU

-

highSingleBitEccErrorRate

-

Major

-

There are too many single-bit ECC errors.

-
  1. If services are interrupted, restart the services to restore.
  2. If services cannot be restarted, restart the VM where services are running.
  3. If services still cannot be restored, submit a service ticket.
-

Single-bit errors can be automatically rectified and do not affect GPU-related applications.

-

GPU card not found

-

gpuDriverLinkFailureAlarm

-

Major

-

A GPU link is normal, but the NVIDIA driver cannot find the GPU card.

-
  1. Restart the VM to restore services.
  2. If services still cannot be restored, submit a service ticket.
-

The GPU card cannot be found.

-

GPU link faulty

-

gpuPcieLinkFailureAlarm

-

Major

-

GPU hardware information cannot be queried through lspci due to a GPU link fault.

-

If services are affected, submit a service ticket.

-

The driver cannot use GPU.

-

GPU card lost

-

vmLostGpuAlarm

-

Major

-

The number of GPU cards on the VM is less than the number specified in the specifications.

-

If services are affected, submit a service ticket.

-

GPU cards get lost.

-

GPU memory page faulty

-

gpuMemoryPageFault

-

Major

-

The GPU memory page is faulty, which may be caused by applications, drivers, or hardware.

-

If services are affected, submit a service ticket.

-

The GPU hardware may be faulty. As a result, the GPU memory is faulty, and services exit abnormally.

-

GPU image engine faulty

-

graphicsEngineException

-

Major

-

The GPU image engine is faulty, which may be caused by applications, drivers, or hardware.

-

If services are affected, submit a service ticket.

-

The GPU hardware may be faulty. As a result, the image engine is faulty, and services exit abnormally.

-

GPU temperature too high

-

highTemperatureEvent

-

Major

-

GPU temperature too high

-

If services are affected, submit a service ticket.

-

If the GPU temperature exceeds the threshold, the GPU performance may deteriorate.

-

GPU NVLink faulty

-

nvlinkError

-

Major

-

A hardware fault occurs on the NVLink.

-

If services are affected, submit a service ticket.

-

The NVLink link is faulty and unavailable.

-

nvidia-smi suspended

-

nvidiaSmiHangEvent

-

Major

-

nvidia-smi timed out.

-

If services are affected, submit a service ticket.

-

The driver may report an error during service running.

+

Services are interrupted.
-
Table 18 Virtual Private Cloud (VPC)

Event Source

+
- - - + + + + - - - - + + + + - - - + + + - - - - - - - - - - - - - - - - - - -
Table 18 Image Management Service (IMS)

Event Source

Event Name

+

Namespace

Event ID

+

Event Name

Event Severity

+

Event ID

+

Event Severity

+

Description

+

Solution

+

Impact

Elastic IP and bandwidth

+

IMS

Delete VPC

+

SYS.IMS

deleteVpc

+

Create Image

Major

+

createImage

+

Major

+

An image was created.

+

None

+

You can use this image to create cloud servers.

Modify VPC

+

Update Image

modifyVpc

+

updateImage

Minor

+

Major

+

Metadata of an image was modified.

+

None

+

Cloud servers may fail to be created from this image.

Delete subnet

+

Delete Image

deleteSubnet

+

deleteImage

Minor

+

Major

Modify subnet

+

An image was deleted.

modifySubnet

+

None

Minor

-

Modify bandwidth

-

modifyBandwidth

-

Minor

-

Delete VPN

-

deleteVpn

-

Major

-

Modify VPN

-

modifyVpn

-

Minor

+

This image will be unavailable on the management console.
-
Table 19 Object Storage Service (OBS)

Event Source

+
- - - + + + + - - - - + + + + - - - + + + - - - + + + - - - + + + + + + + + + +
Table 19 Virtual Private Cloud (VPC)

Event Source

Event Name

+

Namespace

Event ID

+

Event Name

Event Severity

+

Event ID

+

Event Severity

+

Description

+

Solution

+

Impact

OBS

+

Elastic IP and bandwidth

+

+

+

+

Delete bucket

+

SYS.VPC

+

+

+

+

deleteBucket

+

Delete VPC

Major

+

deleteVpc

+

Major

+

The VPC resources were deleted.

+

Check whether the VPC resources were deleted by mistake.

+

Deleting the VPC may affect customer services.

Delete bucket policy

+

Modify VPC

deleteBucketPolicy

+

modifyVpc

Major

+

Minor

+

The VPC information was modified.

+

Check whether the VPC information was modified by mistake.

+

Modifying the VPC may affect customer services.

Set bucket ACL

+

Delete subnet

setBucketAcl

+

deleteSubnet

Minor

+

Minor

+

Subnets are deleted.

+

Check whether the EIP was release by mistake.

+

Deleting the VPC subnets may affect customer services.

Set bucket policy

+

Modify subnet

setBucketPolicy

+

modifySubnet

Minor

+

Minor

+

The subnet information was modified.

+

Check whether the subnet information was modified by mistake.

+

Modifying the VPC subnets may affect customer services.

+

Modify bandwidth

+

modifyBandwidth

+

Minor

+

The bandwidth information was modified.

+

Check whether the bandwidth information was modified by mistake.

+

Services may be interrupted.
-
Table 20 Elastic IP (EIP)

Event Source

+
- - - - - - + - - - - - - - + - - - - - - - - - - - - - - - - - - - +
Table 20 Object Storage Service (OBS)

Event Source

Event Name

+

Namespace

Event ID

+

Event Name

Event Severity

+

Event ID

Description

+

Event Severity

Solution

+

Description

Impact

+

Solution

+

Impact

EIP

+

OBS

EIP bandwidth overflow

+

SYS.OBS

EIPBandwidthOverflow

+

Delete bucket

Major

+

deleteBucket

The used bandwidth exceeded the purchased one, which may slow down the network or cause packet loss. The value of this event is the maximum value in a monitoring period, and the value of the EIP inbound and outbound bandwidth is the value at a specific time point in the period.

-

The metrics are described as follows:

-

egressDropBandwidth: dropped outbound packets (bytes)

-

egressAcceptBandwidth: accepted outbound packets (bytes)

-

egressMaxBandwidthPerSec: peak outbound bandwidth (byte/s)

-

ingressAcceptBandwidth: accepted inbound packets (bytes)

-

ingressMaxBandwidthPerSec: peak inbound bandwidth (byte/s)

-

ingressDropBandwidth: dropped inbound packets (bytes)

+

Major

Check whether the EIP bandwidth keeps increasing and whether services are normal. Increase bandwidth if necessary.

+

An event is reported when a bucket deletion takes place.

The network becomes slow or packets are lost.

+

Once deleted, buckets cannot be restored. Create a new one if needed.

+
CAUTION:

If you want to reuse the name of a deleted bucket for a new bucket, wait at least 30 minutes after the bucket is deleted.

+
+

Deleting buckets may affect your services. Before deleting a bucket, make sure that your services do not depend on it.

Delete EIP

+

Delete bucket policy

deleteEip

+

deleteBucketPolicy

Minor

+

Major

The EIP was released.

+

An event is reported when a bucket policy deletion takes place.

Check whether the EIP was release by mistake.

+
  • You can delete unwanted bucket policies.
  • If you delete a bucket policy by mistake, you can create one.

The server that has the EIP bound cannot access the Internet.

+

After a bucket policy is deleted, some users may fail to access the associated bucket and the objects in it.

EIP blocked

+

Set bucket ACL

blockEIP

+

setBucketAcl

Critical

+

Minor

The used bandwidth of an EIP exceeded 5 Gbit/s, the EIP were blocked and packets were discarded. Such an event may be caused by DDoS attacks.

+

An event is reported when a bucket ACL configuration takes place.

Replace the EIP to prevent services from being affected.

-

Locate and deal with the fault.

+

If you do not want an account to access a bucket or the objects in it, you can delete the bucket ACL.

Services are impacted.

+

A bucket ACL grants an account the access to the bucket and the objects in it.

EIP unblocked

+

Set bucket policy

unblockEIP

+

setBucketPolicy

Critical

+

Minor

The EIP was unblocked.

+

An event is reported when a bucket policy configuration takes place.

Use the previous EIP again.

+

If you do not need a bucket policy to perform fine-grained access control over a bucket and the objects in it, you can delete the bucket policy.

None

+

A bucket policy grants an account some operation permissions for the bucket or the objects in it under certain conditions.

Start DDoS traffic scrubbing

+
+
+ +
+ + + + + + + + + - - - - - + - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/ces/api-ref/ces_03_0001.html b/docs/ces/api-ref/ces_03_0001.html index 62177ae35..54a00b7ba 100644 --- a/docs/ces/api-ref/ces_03_0001.html +++ b/docs/ces/api-ref/ces_03_0001.html @@ -4,6 +4,6 @@

Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.

Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.

For details about how to use APIs, see API Usage Guidelines.

-

An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For example, the endpoint of the eu-de region is ces.eu-de.otc.t-systems.com. For the endpoints of all services, see Regions and Endpoints.

+

An endpoint is the request address for calling an API. Endpoints vary with services and regions. For example, the endpoint of the eu-de region is ces.eu-de.otc.t-systems.com. For the endpoints of all services, see Regions and Endpoints.

diff --git a/docs/ces/api-ref/ces_03_0018.html b/docs/ces/api-ref/ces_03_0018.html index 732baa081..c168048ee 100644 --- a/docs/ces/api-ref/ces_03_0018.html +++ b/docs/ces/api-ref/ces_03_0018.html @@ -1,6 +1,6 @@ -

API Description

+

API V1

@@ -15,6 +15,8 @@
  • Quotas
    • +
  • Resource Groups
    +
  • Event Monitoring
    • diff --git a/docs/ces/api-ref/ces_03_0019.html b/docs/ces/api-ref/ces_03_0019.html index d34eb31e7..7fb3d83d6 100644 --- a/docs/ces/api-ref/ces_03_0019.html +++ b/docs/ces/api-ref/ces_03_0019.html @@ -12,7 +12,7 @@
    -
    Parent topic: API Description
    +
    Parent topic: API V1
    diff --git a/docs/ces/api-ref/ces_03_0021.html b/docs/ces/api-ref/ces_03_0021.html index 691573f79..c2513e6a7 100644 --- a/docs/ces/api-ref/ces_03_0021.html +++ b/docs/ces/api-ref/ces_03_0021.html @@ -198,7 +198,7 @@ -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/ces/api-ref/ces_03_0022.html b/docs/ces/api-ref/ces_03_0022.html index 1d1b8551f..48239816b 100644 --- a/docs/ces/api-ref/ces_03_0022.html +++ b/docs/ces/api-ref/ces_03_0022.html @@ -10,7 +10,7 @@
    -
    Parent topic: API Description
    +
    Parent topic: API V1
    diff --git a/docs/ces/api-ref/ces_03_0023.html b/docs/ces/api-ref/ces_03_0023.html index 5cae2030c..7d948768c 100644 --- a/docs/ces/api-ref/ces_03_0023.html +++ b/docs/ces/api-ref/ces_03_0023.html @@ -19,8 +19,11 @@ - @@ -85,7 +88,7 @@ - @@ -113,7 +116,7 @@

    Request

    None

    Response

    • Response parameters -
    Table 21 Elastic IP (EIP)

    Event Source

    +

    Event Name

    +

    Event ID

    +

    Event Severity

    +

    Description

    +

    Solution

    +

    Impact

    +

    EIP

    ddosCleanEIP

    +

    EIP bandwidth overflow

    Major

    +

    EIPBandwidthOverflow

    Traffic scrubbing on the EIP was started to prevent DDoS attacks.

    +

    Major

    Check whether the EIP was attacked.

    +

    The used bandwidth exceeded the purchased one, which may slow down the network or cause packet loss. The value of this event is the maximum value in a monitoring period, and the value of the EIP inbound and outbound bandwidth is the value at a specific time point in the period.

    +

    The metrics are described as follows:

    +

    egressDropBandwidth: dropped outbound packets (bytes)

    +

    egressAcceptBandwidth: accepted outbound packets (bytes)

    +

    egressMaxBandwidthPerSec: peak outbound bandwidth (byte/s)

    +

    ingressAcceptBandwidth: accepted inbound packets (bytes)

    +

    ingressMaxBandwidthPerSec: peak inbound bandwidth (byte/s)

    +

    ingressDropBandwidth: dropped inbound packets (bytes)

    Services may be interrupted.

    +

    Check whether the EIP bandwidth keeps increasing and whether services are normal. Increase bandwidth if necessary.

    +

    The network becomes slow or packets are lost.

    Stop DDoS traffic scrubbing

    +

    Delete EIP

    ddosEndCleanEip

    +

    deleteEip

    Major

    +

    Minor

    Traffic scrubbing on the EIP to prevent DDoS attacks was ended.

    +

    The EIP was released.

    Check whether the EIP was attacked.

    +

    Check whether the EIP was release by mistake.

    Services may be interrupted.

    +

    The server that has the EIP bound cannot access the Internet.

    Enterprise-class QoS bandwidth limit exceeded

    +

    EIP blocked

    EIPBandwidthRuleOverflow

    +

    blockEIP

    Major

    +

    Critical

    The used QoS bandwidth exceeded the allocated one, which may slow down the network or cause packet loss. The value of this event is the maximum value in a monitoring period, and the value of the EIP inbound and outbound bandwidth is the value at a specific time point in the period.

    -

    egressDropBandwidth: dropped outbound packets (bytes)

    -

    egressAcceptBandwidth: accepted outbound packets (bytes)

    -

    egressMaxBandwidthPerSec: peak outbound bandwidth (byte/s)

    -

    ingressAcceptBandwidth: accepted inbound packets (bytes)

    -

    ingressMaxBandwidthPerSec: peak inbound bandwidth (byte/s)

    -

    ingressDropBandwidth: dropped inbound packets (bytes)

    +

    The used bandwidth of an EIP exceeded 5 Gbit/s, the EIP were blocked and packets were discarded. Such an event may be caused by DDoS attacks.

    Check whether the EIP bandwidth keeps increasing and whether services are normal. Increase bandwidth if necessary.

    +

    Replace the EIP to prevent services from being affected.

    +

    Locate and deal with the fault.

    The network becomes slow or packets are lost.

    +

    Services are impacted.

    +

    EIP unblocked

    +

    unblockEIP

    +

    Critical

    +

    The EIP was unblocked.

    +

    Use the previous EIP again.

    +

    None

    +

    Start DDoS traffic scrubbing

    +

    ddosCleanEIP

    +

    Major

    +

    Traffic scrubbing on the EIP was started to prevent DDoS attacks.

    +

    Check whether the EIP was attacked.

    +

    Services may be interrupted.

    +

    Stop DDoS traffic scrubbing

    +

    ddosEndCleanEip

    +

    Major

    +

    Traffic scrubbing on the EIP to prevent DDoS attacks was ended.

    +

    Check whether the EIP was attacked.

    +

    Services may be interrupted.

    +

    Enterprise-class QoS bandwidth limit exceeded

    +

    EIPBandwidthRuleOverflow

    +

    Major

    +

    The used QoS bandwidth exceeded the allocated one, which may slow down the network or cause packet loss. The value of this event is the maximum value in a monitoring period, and the value of the EIP inbound and outbound bandwidth is the value at a specific time point in the period.

    +

    egressDropBandwidth: dropped outbound packets (bytes)

    +

    egressAcceptBandwidth: accepted outbound packets (bytes)

    +

    egressMaxBandwidthPerSec: peak outbound bandwidth (byte/s)

    +

    ingressAcceptBandwidth: accepted inbound packets (bytes)

    +

    ingressMaxBandwidthPerSec: peak inbound bandwidth (byte/s)

    +

    ingressDropBandwidth: dropped inbound packets (bytes)

    +

    Check whether the EIP bandwidth keeps increasing and whether services are normal. Increase bandwidth if necessary.

    +

    The network becomes slow or packets are lost.

    Yes

    Specifies the project ID.

    -

    For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    Specifies the project ID.

    +

    For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    Minimum: 1

    +

    Maximum: 64

    +

    Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

    Integer

    Supported range: 1 to 1000 (default)

    +

    Range: 1 to 1000 (default)

    This parameter is used to limit the number of query results.
    Table 3 Parameter description

    Parameter

    +
    @@ -175,7 +178,9 @@ - @@ -194,7 +199,7 @@ - @@ -312,7 +317,7 @@ -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/ces/api-ref/ces_03_0026.html b/docs/ces/api-ref/ces_03_0026.html index 72b59ddac..748ab37f2 100644 --- a/docs/ces/api-ref/ces_03_0026.html +++ b/docs/ces/api-ref/ces_03_0026.html @@ -15,10 +15,20 @@
  • Creating an Alarm Rule
    • +
  • Creating a Custom Alarm Template
    +
    • +
  • Deleting a Custom Alarm Template
    +
    • +
  • Querying the Alarm History of an Alarm Rule
    +
    • +
  • Updating a Custom Alarm Template
    +
    • +
  • Modifying an Alarm Rule
    +
    • -
    Parent topic: API Description
    +
    Parent topic: API V1
    diff --git a/docs/ces/api-ref/ces_03_0027.html b/docs/ces/api-ref/ces_03_0027.html index a147a4311..42f35f787 100644 --- a/docs/ces/api-ref/ces_03_0027.html +++ b/docs/ces/api-ref/ces_03_0027.html @@ -18,7 +18,10 @@ @@ -71,7 +74,7 @@ - @@ -102,7 +105,7 @@

    Request

    None

    Response

    • Response parameters -
    Table 3 Response parameters

    Parameter

    Type

    String

    Specifies the metric unit.

    +

    Specifies the data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

    +

    Minimum: 0

    +

    Maximum: 32

    String

    Specifies the dimension. For example, the ECS dimension is instance_id. For details about the dimension of each service, see the key column in Services Interconnected with Cloud Eye.

    +

    Specifies the monitoring dimension name. For example, the ECS dimension is instance_id. For details about the dimension of each monitored object, see the documentation of a specific cloud service. You can navigate there directly from the Services Interconnected with Cloud Eye page.

    value

    @@ -202,7 +207,7 @@

    String

    Specifies the dimension value, for example, an ECS ID.

    -

    Enter 1 to 256 characters.

    +

    The value contains 1 to 256 characters.

    Yes

    Specifies the project ID.

    -

    For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    Minimum: 1

    +

    Maximum: 64

    +

    Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

    Integer

    Supported range: 1 to 100 (default)

    +

    Range: 1 to 100 (default)

    This parameter is used to limit the number of query results.
    Table 4 Parameter description

    Parameter

    +
    @@ -216,7 +219,7 @@ - - @@ -304,7 +307,7 @@ - @@ -312,7 +315,7 @@ - @@ -333,7 +336,7 @@ - @@ -369,22 +372,23 @@ - - - @@ -392,7 +396,9 @@ - - @@ -589,7 +585,7 @@ -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/ces/api-ref/ces_03_0028.html b/docs/ces/api-ref/ces_03_0028.html index 38d081395..f5e70ef1c 100644 --- a/docs/ces/api-ref/ces_03_0028.html +++ b/docs/ces/api-ref/ces_03_0028.html @@ -18,7 +18,10 @@
    - - @@ -232,7 +235,7 @@ - @@ -240,7 +243,7 @@ - @@ -261,7 +264,7 @@ - @@ -269,7 +272,7 @@ - @@ -297,30 +300,32 @@ - - - - - @@ -452,7 +446,7 @@ -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/ces/api-ref/ces_03_0029.html b/docs/ces/api-ref/ces_03_0029.html index 8afd01008..fe93c2c54 100644 --- a/docs/ces/api-ref/ces_03_0029.html +++ b/docs/ces/api-ref/ces_03_0029.html @@ -17,8 +17,11 @@
    - @@ -115,7 +118,7 @@ -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/ces/api-ref/ces_03_0030.html b/docs/ces/api-ref/ces_03_0030.html index 6496dff5f..3282dc880 100644 --- a/docs/ces/api-ref/ces_03_0030.html +++ b/docs/ces/api-ref/ces_03_0030.html @@ -17,8 +17,11 @@
    - - @@ -95,8 +98,8 @@ @@ -221,8 +224,8 @@ - @@ -255,7 +258,7 @@ - @@ -265,9 +268,9 @@ - @@ -291,7 +294,7 @@ - @@ -302,8 +305,8 @@ @@ -327,9 +330,8 @@ - @@ -339,8 +341,8 @@ - - -
    Table 4 Response parameters

    Parameter

    Type

    Long

    Specifies when the alarm status changed. The time is a UNIX timestamp and the unit is ms.

    +

    Specifies when the alarm status changed. The value is a UNIX timestamp, in milliseconds.

    alarm_state

    @@ -277,7 +280,7 @@

    String

    Specifies the dimension. For example, the ECS dimension is instance_id. For details about the dimension of each service, see the key column in Services Interconnected with Cloud Eye.

    +

    Specifies the monitoring dimension name. For example, the ECS dimension is instance_id. For details about the dimension of each monitored object, see the documentation of a specific cloud service. You can navigate there directly from the Services Interconnected with Cloud Eye page.

    value

    @@ -285,7 +288,7 @@

    String

    Specifies the dimension value, for example, an ECS ID.

    -

    Enter 1 to 256 characters.

    +

    The value contains 1 to 256 characters.

    String

    Specifies the alarm notification type.
    • notification: indicates that a notification will be sent.
    • autoscaling: indicates that a scaling action will be triggered.
    +
    Specifies the alarm notification type.
    • notification: A notification will be sent.
    • autoscaling: A scaling action will be triggered.

    Array of strings

    Specifies the list of objects to be notified if the alarm status changes.

    +

    Specifies the list of objects to be notified of alarm status changes.

    NOTE:

    The IDs in the list are strings.

    String

    Specifies the notification type when an alarm is triggered.
    • notification: indicates that a notification will be sent.
    • autoscaling: indicates that a scaling action will be triggered.
    +
    Specifies the notification type when an alarm is triggered.
    • notification: A notification will be sent.
    • autoscaling: A scaling action will be triggered.

    String

    Specifies the data rollup method, which can be

    -
    • average: Cloud Eye calculates the average value of metric data within a rollup period.
    • max: Cloud Eye calculates the maximum value of metric data within a rollup period.
    • min: Cloud Eye calculates the minimum value of metric data within a rollup period.
    • sum: Cloud Eye calculates the sum of metric data within a rollup period.
    • variance: Cloud Eye calculates the variance value of metric data within a rollup period.
    +

    Specifies the data aggregation method. The value can be:

    +
    • average: average value of metric data within an aggregation period.
    • max: maximum value of metric data in an aggregation period.
    • min: Cloud Eye calculates the minimum value of metric data within a rollup period.
    • sum: sum of metric data within an aggregation period.
    • variance: variance value of metric data within an aggregation period.

    comparison_operator

    String

    Specifies the alarm threshold operator, which can be >, =, <, >=, or <=.

    +

    Specifies the alarm threshold operator, which can be >, =, <, >=, <=, or !=.

    value

    Double

    Specifies the alarm threshold. Supported range: 0 to Number. MAX_VALUE (1.7976931348623157e+108)

    +

    Specifies the alarm threshold.

    +

    Range: 0 to Number. MAX_VALUE (1.7976931348623157e+108)

    For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS cpu_util in Services Interconnected with Cloud Eye to 80.

    String

    Specifies the data unit. Enter up to 32 characters.

    +

    Specifies the data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

    +

    Minimum: 0

    +

    Maximum: 32

    count

    @@ -406,18 +412,8 @@

    Integer

    Specifies the interval for triggering an alarm if the alarm persists.

    -

    Possible intervals are as follows:

    -

    0: Cloud Eye triggers the alarm only once.

    -

    300: Cloud Eye triggers the alarm every 5 minutes.

    -

    600: Cloud Eye triggers the alarm every 10 minutes.

    -

    900: Cloud Eye triggers the alarm every 15 minutes.

    -

    1800: Cloud Eye triggers the alarm every 30 minutes.

    -

    3600: Cloud Eye triggers the alarm every hour.

    -

    10800: Cloud Eye triggers the alarm every 3 hours.

    -

    21600: Cloud Eye triggers the alarm every 6 hours.

    -

    43200: Cloud Eye triggers the alarm every 12 hours.

    -

    86400: Cloud Eye triggers the alarm every day.

    +

    Specifies the interval for triggering an alarm if the alarm persists. The value can be:

    +
    • 0: The alarm is triggered only once.
    • 300: An alarm is triggered every 5 minutes.
    • 600: An alarm is triggered every 10 minutes.
    • 900: An alarm is triggered every 15 minutes.
    • 1800: An alarm is triggered every 30 minutes.
    • 3600: An alarm is triggered every hour.
    • 10800: An alarm is triggered every 3 hours.
    • 21600: An alarm is triggered every 6 hours.
    • 43200: An alarm is triggered every 12 hours.
    • 86400: An alarm is triggered every day.

    Yes

    Specifies the project ID.

    -

    For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    Minimum: 1

    +

    Maximum: 64

    +

    Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

    alarm_id

    @@ -144,7 +147,7 @@

    Long

    Specifies when the alarm status changed. The time is a UNIX timestamp and the unit is ms.

    +

    Specifies when the alarm status changed. The value is a UNIX timestamp, in milliseconds.

    alarm_state

    @@ -205,7 +208,7 @@

    String

    Specifies the dimension. For example, the ECS dimension is instance_id. For details about the dimension of each service, see the key column in Services Interconnected with Cloud Eye.

    +

    Specifies the monitoring dimension name. For example, the ECS dimension is instance_id. For details about the dimension of each monitored object, see the documentation of a specific cloud service. You can navigate there directly from the Services Interconnected with Cloud Eye page.

    value

    @@ -213,7 +216,7 @@

    String

    Specifies the dimension value, for example, an ECS ID.

    -

    Enter 1 to 256 characters.

    +

    The value contains 1 to 256 characters.

    String

    Specifies the alarm notification type.
    • notification: indicates that a notification will be sent.
    • autoscaling: indicates that a scaling action will be triggered.
    +
    Specifies the alarm notification type.
    • notification: A notification will be sent.
    • autoscaling: A scaling action will be triggered.

    Array of strings

    Specifies the list of objects to be notified if the alarm status changes.

    +

    Specifies the list of objects to be notified of alarm status changes.

    NOTE:

    The IDs in the list are strings.

    String

    Specifies the notification type when an alarm is triggered.
    • notification: indicates that a notification will be sent.
    • autoscaling: indicates that a scaling action will be triggered.
    +
    Specifies the notification type when an alarm is triggered.
    • notification: A notification will be sent.
    • autoscaling: A scaling action will be triggered.

    Array of strings

    Specifies the list of objects to be notified if the alarm status changes.

    +

    Specifies the list of objects to be notified of alarm status changes.

    NOTE:

    The IDs in the list are strings.

    String

    Specifies the data rollup method, which can be

    -
    • average: Cloud Eye calculates the average value of metric data within a rollup period.
    • max: Cloud Eye calculates the maximum value of metric data within a rollup period.
    • min: Cloud Eye calculates the minimum value of metric data within a rollup period.
    • sum: Cloud Eye calculates the sum of metric data within a rollup period.
    • variance: Cloud Eye calculates the variance value of metric data within a rollup period.
    +

    Specifies the data aggregation method. The value can be:

    +
    • average: average value of metric data within an aggregation period.
    • max: maximum value of metric data in an aggregation period.
    • min: minimum value of metric data within an aggregation period.
    • sum: sum of metric data within an aggregation period.
    • variance: variance value of metric data within an aggregation period.

    comparison_operator

    String

    Specifies the alarm threshold operator, which can be >, =, <, >=, or <=.

    +

    Specifies the alarm threshold operator, which can be >, =, <, >=, <=, or !=.

    value

    Double

    Specifies the alarm threshold. Supported range: 0 to Number. MAX_VALUE (1.7976931348623157e+108)

    -

    For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS cpu_util in Services Interconnected with Cloud Eye to 80.

    +

    Specifies the alarm threshold. Range: 0 to Number. MAX_VALUE (1.7976931348623157e+108)

    +

    For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS cpu_util in Services Interconnected with Cloud Eye to 80.

    unit

    String

    Specifies the data unit. Enter up to 32 characters.

    +

    Specifies the data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

    +

    Minimum: 0

    +

    Maximum: 32

    count

    @@ -334,18 +339,7 @@

    Integer

    Specifies the interval for triggering an alarm if the alarm persists.

    -

    Possible intervals are as follows:

    -

    0: Cloud Eye triggers the alarm only once.

    -

    300: Cloud Eye triggers the alarm every 5 minutes.

    -

    600: Cloud Eye triggers the alarm every 10 minutes.

    -

    900: Cloud Eye triggers the alarm every 15 minutes.

    -

    1800: Cloud Eye triggers the alarm every 30 minutes.

    -

    3600: Cloud Eye triggers the alarm every hour.

    -

    10800: Cloud Eye triggers the alarm every 3 hours.

    -

    21600: Cloud Eye triggers the alarm every 6 hours.

    -

    43200: Cloud Eye triggers the alarm every 12 hours.

    -

    86400: Cloud Eye triggers the alarm every day.

    +

    Specifies the interval for triggering an alarm if the alarm persists. The value can be: 0: alarm triggered only once. 300: alarm triggered every 5 minutes. 600: alarm triggered every 10 minutes. 900: alarm triggered every 15 minutes. 1800: alarm triggered every 30 minutes. 3600: alarm triggered every 1 hour. 10800: alarm triggered every 3 hours. 21600: alarm triggered every 6 hours. 43200: alarm triggered every 12 hours. 86400: alarm triggered every day.

    Yes

    Specifies the project ID.

    -

    For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    Specifies the project ID.

    +

    For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    Minimum: 1

    +

    Maximum: 64

    +

    Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

    alarm_id

    @@ -53,7 +56,7 @@

    Boolean

    Specifies whether the alarm rule is enabled.

    -
    • true: indicates that the alarm rule is enabled.
    • false: indicates that the alarm rule is disabled.
    +
    • true: enabled
    • false: disabled

    Yes

    Specifies the project ID.

    -

    For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    Specifies the project ID.

    +

    For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    Minimum: 1

    +

    Maximum: 64

    +

    Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

    alarm_id

    @@ -87,7 +90,7 @@ -

    Error Codes

    See Error Codes.

    +

    Error Codes

    See Error Codes.

    diff --git a/docs/ces/api-ref/ces_03_0031.html b/docs/ces/api-ref/ces_03_0031.html index d321824b9..4e62807b9 100644 --- a/docs/ces/api-ref/ces_03_0031.html +++ b/docs/ces/api-ref/ces_03_0031.html @@ -17,8 +17,11 @@

    Yes

    Specifies the project ID.

    -

    For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    Specifies the project ID.

    +

    For details about how to obtain the project ID, see Obtaining a Project ID.

    +

    Minimum: 1

    +

    Maximum: 64

    +

    Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

    Boolean

    Specifies whether to enable the action to be triggered by an alarm. The default value is true.

    -
    NOTE:

    If you set alarm_action_enabled to true, you must specify either alarm_actions or ok_actions. (You do not need to configure the deprecated parameter insufficientdata_actions.)

    -

    If alarm_actions and ok_actions coexist, their notificationList must be the same. (You do not need to configure the deprecated parameter insufficientdata_actions.)

    +
    NOTE:

    If you set alarm_action_enabled to true, you must specify either alarm_actions or ok_actions.

    +

    If alarm_actions and ok_actions coexist, their notificationList must be the same.

    String

    Specifies the dimension. For example, the ECS dimension is instance_id. For details about the dimension of each service, see the key column in Services Interconnected with Cloud Eye.

    -

    Start with a letter. Enter 1 to 32 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

    +

    Specifies the monitoring dimension name. For example, the ECS dimension is instance_id. For details about the dimension of each monitored object, see the documentation of a specific cloud service. You can navigate there directly from the Services Interconnected with Cloud Eye page.

    +

    The value must start with a letter. It allows 1 to 32 characters and can only contain letters, digits, underscores (_), and hyphens (-).

    value

    @@ -232,7 +235,7 @@

    String

    Specifies the dimension value, for example, an ECS ID.

    -

    Start with a letter or a digit. Enter 1 to 256 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

    +

    The value must start with a letter or digit. It allows 1 to 256 characters and can only contain letters, digits, underscores (_), and hyphens (-).

    String

    Specifies the alarm notification type.
    • notification: indicates that a notification will be sent.
    • autoscaling: indicates that a scaling action will be triggered.
    +
    Specifies the alarm notification type.
    • notification: A notification will be sent.
    • autoscaling: A scaling action will be triggered.

    Array of strings

    Specifies the list of objects to be notified if the alarm status changes. You can add up to 5 object IDs. You can obtain the topicUrn value from SMN in the following format: urn:smn:([a-z]|[A-Z]|[0-9]|\-){1,32}:([a-z]|[A-Z]|[0-9]){32}:([a-z]|[A-Z]|[0-9]|\-|\_){1,256}.

    +

    Specifies the list of objects to be notified of alarm status changes. You can add up to 5 object IDs. You can obtain the topicUrn value from SMN in the following format: urn:smn:([a-z]|[A-Z]|[0-9]|\-){1,32}:([a-z]|[A-Z]|[0-9]){32}:([a-z]|[A-Z]|[0-9]|\-|\_){1,256}.

    If you set type to notification, you must specify notificationList. If you set type to autoscaling, you must set notificationList to [].

    -
    NOTE:
    • To make the AS alarm rules take effect, you must bind scaling policies. For details, see the Auto Scaling API Reference.
    • If you set alarm_action_enabled to true, you must specify either alarm_actions or ok_actions. (You do not need to configure the deprecated parameter insufficientdata_actions.)
    • If alarm_actions and ok_actions coexist, their notificationList must be the same. (You do not need to configure the deprecated parameter insufficientdata_actions.)
    • The IDs in the list are strings.
    +
    NOTE:
    • To make the AS alarm rules take effect, you must bind scaling policies. For details, see the Auto Scaling API Reference.
    • If you set alarm_action_enabled to true, you must specify either alarm_actions or ok_actions.
    • If alarm_actions and ok_actions coexist, their notificationList must be the same.
    • The IDs in the list are strings.

    String

    Specifies the notification type when an alarm is triggered.
    • notification: indicates that a notification will be sent.
    • autoscaling: indicates that a scaling action will be triggered.
    +
    Specifies the notification type when an alarm is triggered.
    • notification: A notification will be sent.
    • autoscaling: A scaling action will be triggered.

    Array of objects

    Specifies the list of objects to be notified if the alarm status changes. You can add up to 5 object IDs. You can obtain the topicUrn value from SMN in the following format: urn:smn:([a-z]|[A-Z]|[0-9]|\-){1,32}:([a-z]|[A-Z]|[0-9]){32}:([a-z]|[A-Z]|[0-9]|\-|\_){1,256}.

    -
    NOTE:

    If you set alarm_action_enabled to true, you must specify either alarm_actions or ok_actions. (You do not need to configure the deprecated parameter insufficientdata_actions.)

    -

    If alarm_actions and ok_actions coexist, their notificationList must be the same. (You do not need to configure the deprecated parameter insufficientdata_actions.)

    +
    NOTE:

    If you set alarm_action_enabled to true, you must specify either alarm_actions or ok_actions.

    +

    If alarm_actions and ok_actions coexist, their notificationList must be the same.

    Integer

    Specifies the period during which Cloud Eye determines whether to trigger an alarm. Unit: second

    -

    Possible periods are 1, 300, 1200, 3600, 14400, and 86400.

    -
    NOTE:
    • If you set period to 1, Cloud Eye uses raw data to determine whether to trigger an alarm.
    +

    Specifies the interval (in seconds) at which the system determines whether to generate an alarm. The value can be 0, 1, 300, 1200, 3600, 14400, or 86400.

    +
    NOTE:
    • If you set period to 1, Cloud Eye uses raw data to determine whether to trigger an alarm.
    • You can set this parameter to 0 when you set alarm_type to (EVENT.SYS| EVENT.CUSTOM).

    String

    Specifies the data rollup method.

    -

    Possible methods are max, min, average, sum, or variance.

    +

    Specifies the data aggregation method. The value can be:

    +
    • average: average value of metric data within an aggregation period.
    • max: maximum value of metric data in an aggregation period.
    • min: minimum value of metric data within an aggregation period.
    • sum: sum of metric data within an aggregation period.
    • variance: variance value of metric data within an aggregation period.

    comparison_operator

    @@ -349,8 +351,7 @@

    String

    Specifies the alarm threshold operator.

    -

    Possible operators are >, =, <, >=, and <=.

    +

    Specifies the alarm threshold operator, which can be >, =, <, >=, <=, or !=.

    value

    @@ -361,7 +362,7 @@

    Specifies the alarm threshold.

    Supported range: 0 to Number. MAX_VALUE (1.7976931348623157e+108)

    -

    For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS cpu_util in Services Interconnected with Cloud Eye to 80.

    +

    For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS cpu_util in Services Interconnected with Cloud Eye to 80.

    unit

    @@ -370,7 +371,9 @@

    String

    Specifies the data unit. Enter up to 32 characters.

    +

    Specifies the data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

    +

    Minimum: 0

    +

    Maximum: 32

    count

    @@ -484,8 +487,8 @@ } -

    Response

    • Response parameter -
      Table 8 Parameter description

      Parameter

      +

      Response

      • Response parameters +
        @@ -557,7 +560,7 @@ -

        Error Codes

        See Error Codes.

        +

        Error Codes

        See Error Codes.

        diff --git a/docs/ces/api-ref/ces_03_0032.html b/docs/ces/api-ref/ces_03_0032.html index 126f7c0e9..74be8ded2 100644 --- a/docs/ces/api-ref/ces_03_0032.html +++ b/docs/ces/api-ref/ces_03_0032.html @@ -16,7 +16,7 @@
        -
        Parent topic: API Description
        +
        Parent topic: API V1
        diff --git a/docs/ces/api-ref/ces_03_0033.html b/docs/ces/api-ref/ces_03_0033.html index 894fa96ca..ee758315f 100644 --- a/docs/ces/api-ref/ces_03_0033.html +++ b/docs/ces/api-ref/ces_03_0033.html @@ -3,11 +3,11 @@

        Querying Monitoring Data of a Metric

        Function

        This API is used to query the monitoring data of a specified metric at a specified granularity in a specified time range. You can specify the dimension of data to be queried.

        -

        URI

        GET /V1.0/{project_id}/metric-data?namespace={namespace}&metric_name={metric_name}&dim.{i}=key,value&from={from}&to={to}&period={period}&filter={filter}

        +

        URI

        GET /V1.0/{project_id}/metric-data

        • Parameter description
        Table 8 Response parameters

        Parameter

        Type
        - @@ -17,8 +17,11 @@ - @@ -27,9 +30,9 @@
        Table 1 Parameter description

        Parameter

        Mandatory

        +

        Mandatory

        Description

        Yes

        Specifies the project ID.

        -

        For details about how to obtain the project ID, see Obtaining a Project ID.

        +

        Specifies the project ID.

        +

        For details about how to obtain the project ID, see Obtaining a Project ID.

        +

        Minimum: 1

        +

        Maximum: 64

        +

        Regular expression matching: ^[a-zA-Z0-9-]{1,64}$
        - - @@ -60,7 +63,7 @@ - @@ -95,8 +98,8 @@ - @@ -107,8 +110,8 @@ - @@ -127,9 +130,9 @@

        Request

        None

        Response

        • Response parameters -
        Table 2 Query parameter description

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        String

        Specifies the start time of the query. The time is a UNIX timestamp and the unit is ms.

        +

        Specifies the start time of the query. The value is a UNIX timestamp, in milliseconds.

        Rollup aggregates the raw data generated within a period to the start time of the period. If from and to are within a period, the query result will be empty due to the rollup failure. Set from to at least one period earlier than the current time.

        Take the 5-minute period as an example. If it is 10:35 now, the raw data generated between 10:30 and 10:35 will be aggregated to 10:30. In this example, if period is 5 minutes, from should be 10:30.

        NOTE:

        Cloud Eye rounds up from based on the level of granularity required to perform the rollup.

        @@ -74,7 +77,7 @@

        String

        Specifies the end time of the query.

        -

        The time is a UNIX timestamp and the unit is ms.

        +

        The value is a UNIX timestamp, in milliseconds.

        from must be earlier than to.

        String

        Specifies the data rollup method, which can be

        -
        • average: Cloud Eye calculates the average value of metric data within a rollup period.
        • max: Cloud Eye calculates the maximum value of metric data within a rollup period.
        • min: Cloud Eye calculates the minimum value of metric data within a rollup period.
        • sum: Cloud Eye calculates the sum of metric data within a rollup period.
        • variance: Cloud Eye calculates the variance value of metric data within a rollup period.
        +

        Specifies the data aggregation method. The value can be:

        +
        • average: average value of metric data within an aggregation period.
        • max: maximum value of metric data in an aggregation period.
        • min: minimum value of metric data within an aggregation period.
        • sum: sum of metric data within an aggregation period.
        • variance: variance value of metric data within an aggregation period.
        NOTE:

        Rollup uses a rollup method to aggregate raw data generated within a specific period. Take the 5-minute period as an example. If it is 10:35 now, the raw data generated between 10:30 and 10:35 will be aggregated to 10:30.

        String

        A maximum of three metric dimensions are supported, and the dimensions are numbered from zero in the dim.{i}=key,value format. key cannot exceed 32 characters and value cannot exceed 256 characters.

        -

        The following dimensions are only examples. For details about whether multiple dimensions are supported, see the dimension description in the monitoring indicator description of each service.

        +

        Specifies the metric dimensions. A maximum of three metric dimensions are supported, and the dimensions are numbered from zero in the dim.{i}=key,value format. key cannot exceed 32 characters and value cannot exceed 256 characters.

        +

        The following dimensions are only examples. For details about whether multiple dimensions are supported, see the dimension description of each service.

        Single dimension: dim.0=instance_id,i-12345

        Multiple dimensions: dim.0=instance_id,i-12345&dim.1=instance_name,i-1234
        Table 3 Parameter description

        Parameter

        +
        - @@ -155,11 +158,11 @@
        Table 3 Response parameters

        Parameter

        Type

        +

        Type

        Description

        -
        Table 4 datapoints data structure description

        Parameter

        +
        - - @@ -209,7 +212,9 @@ - @@ -298,7 +303,7 @@ -

        Error Codes

        See Error Codes.

        +

        Error Codes

        See Error Codes.

        diff --git a/docs/ces/api-ref/ces_03_0034.html b/docs/ces/api-ref/ces_03_0034.html index 3dd8e9c8b..e206c93ea 100644 --- a/docs/ces/api-ref/ces_03_0034.html +++ b/docs/ces/api-ref/ces_03_0034.html @@ -1,13 +1,13 @@

        Querying Monitoring Data of Multiple Metrics

        -

        Function

        You can query the monitoring data of specified metrics within a specified time range and at a specified granularity. You can query the monitoring data of up to 10 metrics in one batch.

        +

        Function

        You can query the data of specified metrics within a specified time range and at a specified granularity. You can query the monitoring data of up to 10 metrics in one batch.

        URI

        POST /V1.0/{project_id}/batch-query-metric-data

        • Parameter description
        Table 4 datapoints data structure description

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        String

        Specifies the metric unit.

        +

        Specifies the data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

        +

        Minimum: 0

        +

        Maximum: 32
        - @@ -17,8 +17,11 @@ - @@ -26,20 +29,16 @@ -

        Request

        1. The size of a POST request cannot exceed 512 KB. Otherwise, the request will be denied.
        2. The default maximum query intervals of different periods are different.

          If period is 1, the maximum interval between from and to is 4 hours. If the interval between from and to is longer than 4 hours, adjust the value of from to to - 4*3600*1000.

          -

          If period is 300, the maximum interval between from and to is one day. If the interval between from and to is longer than one day, adjust the value of from to to - 24*3600*1000.

          -

          If period is 1200, the maximum interval between from and to is three days. If the interval between from and to is longer than three days, adjust the value of from to to - 3*24*3600*1000.

          -

          If period is 3600, the maximum interval between from and to is 10 days. If the interval between from and to is longer than 10 days, adjust the value of from to to - 10*24*3600*1000.

          -

          If period is 14400, the maximum interval between from and to is 30 days. If the interval between from and to is longer than 30 days, adjust the value of from to to - 30*24*3600*1000.

          -

          If period is 86400, the maximum interval between from and to is 180 days. If the interval between from and to is longer than 180 days, adjust the value of from to to - 180*24*3600*1000.

          +

          Request

          1. The size of a POST request cannot exceed 512 KB. Otherwise, the request will be denied.
          2. The default maximum query interval (to–from) varies depending on period and the number of metrics to be queried. The rule is as follows: Number of metrics x (to - from)/Monitoring interval ≤ 3000.
            • If period is 1, the monitoring interval is 60,000 ms (60 x 1000).
            • If period is 300, the monitoring interval is 300,000 ms (300 x 1000).
            • If period is 1200, the monitoring interval is 1,200,000 ms (1200 x 1000).
            • If period is 3600, the monitoring interval is 3,600,000 ms (3600 x 1000).
            • If period is 14400, the monitoring interval is 14,400,000 ms (14400 x 1000).
            • If period is 86400, the monitoring interval is 86,400,000 ms (86400 x 1000).
            +

            For example, if 300 metrics are queried in batches and the monitoring interval is 60,000 ms, the maximum value of (to-from) is 600000. If (to-from) exceeds 600,000, from is automatically changed to to-600000.

          • Request parameters
        Table 1 Parameter description

        Parameter

        Mandatory

        +

        Mandatory

        Description

        Yes

        Specifies the project ID.

        -

        For details about how to obtain the project ID, see Obtaining a Project ID.

        +

        Specifies the project ID.

        +

        For details about how to obtain the project ID, see Obtaining a Project ID.

        +

        Minimum: 1

        +

        Maximum: 64

        +

        Regular expression matching: ^[a-zA-Z0-9-]{1,64}$
        - - @@ -61,7 +60,10 @@ - @@ -72,7 +74,10 @@ - - @@ -100,13 +105,13 @@
        Table 2 Request parameters

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        Long

        Specifies the start time of the query. The time is a UNIX timestamp and the unit is ms. Set from to at least one period earlier than the current time. Rollup aggregates the raw data generated within a period to the start time of the period. If from and to are within a period, the query result will be empty due to the rollup failure. Set from to at least one period earlier than the current time. Take the 5-minute period as an example. If it is 10:35 now, the raw data generated between 10:30 and 10:35 will be aggregated to 10:30. In this example, if period is 5 minutes, from should be 10:30.

        +

        Specifies the start time of the query. The value is a UNIX timestamp, in milliseconds. Set from to at least one period earlier than the current time. Rollup aggregates the raw data generated within a period to the start time of the period. If from and to are within a period, the query result will be empty due to the rollup failure. Set from to at least one period earlier than the current time. Take the 5-minute period as an example. If it is 10:35 now, the raw data generated between 10:30 and 10:35 will be aggregated to 10:30. In this example, if period is 5 minutes, from should be 10:30.

        +

        Range

        +

        Minimum: 1111111111111

        +

        Maximum: 9999999999999

        NOTE:

        Cloud Eye rounds up from based on the level of granularity required to perform the rollup.

        Long

        Specifies the end time of the query. The time is a UNIX timestamp and the unit is ms. from must be earlier than to.

        +

        Specifies the end time of the query. The value is a UNIX timestamp, in milliseconds. from must be earlier than to.

        +

        Range

        +

        Minimum: 1111111111111

        +

        Maximum: 9999999999999

        period

        @@ -91,8 +96,8 @@

        String

        Specifies the data rollup method, which can be

        -
        • average: Cloud Eye calculates the average value of metric data within a rollup period.
        • max: Cloud Eye calculates the maximum value of metric data within a rollup period.
        • min: Cloud Eye calculates the minimum value of metric data within a rollup period.
        • sum: Cloud Eye calculates the sum of metric data within a rollup period.
        • variance: Cloud Eye calculates the variance value of metric data within a rollup period.
        +

        Specifies the data aggregation method. The value can be:

        +
        • average: average value of metric data within an aggregation period.
        • max: maximum value of metric data in an aggregation period.
        • min: minimum value of metric data within an aggregation period.
        • sum: sum of metric data within an aggregation period.
        • variance: variance value of metric data within an aggregation period.

        filter does not affect the query result of raw data. (The period is 1.)
        -
        Table 3 metrics data structure description

        Parameter

        +
        - - - @@ -127,7 +132,7 @@
        Table 3 metrics data structure description

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        +

        Description

        String

        Specifies the metric ID. For example, if the monitoring metric of an ECS is CPU usage, metric_name is cpu_util. For details, see Services Interconnected with Cloud Eye.

        -

        The value must start with a letter. Enter 1 to 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

        +

        The value must start with a letter and allows 1 to 96 characters. It can only contain letters, digits, underscores (_), and hyphens (-).

        dimensions

        @@ -149,13 +154,13 @@
        -
        Table 4 dimensions data structure description

        Parameter

        +
        - - - @@ -165,8 +170,8 @@ - @@ -185,7 +190,7 @@
        • dimensions can be obtained from the response body by calling the API for querying metrics.
        • OBS metric data can be queried only when the related OBS APIs are called.
        -
        • Example request

          Request example 1: Query the average disk usage of the OS on the ECS whose instance_id is 07d878a9-2243-4e84-aeef-c47747d18024 and mount_point is 012bec14bc176310c19f40e384fd629b from 20:00:00 to 22:00:00 on April 30, 2019.

          +
          • Example requests

            Example 1: Query the average disk usage of the OS of the ECS whose instance_id is 07d878a9-2243-4e84-aeef-c47747d18024 and mount_point is 012bec14bc176310c19f40e384fd629b from 20:00:00 to 22:00:00 on April 30, 2019.

            {
 	"from": 1556625600000,
 	"to": 1556632800000,
@@ -203,7 +208,7 @@
 		"namespace": "AGT.ECS"
 	}]
 }
            -

            Request example 2: Query the average memory usage of the OS of the ECS whose instance_id is 238764d4-c4e1-4274-88a1-5956b057766b from 20:00:00 to 22:00:00 on April 30, 2019.

            +

            Example 2: Query the average memory usage of the OS of the ECS whose instance_id is 238764d4-c4e1-4274-88a1-5956b057766b from 20:00:00 to 22:00:00 on April 30, 2019.

            {
 	"from": 1556625600000,
 	"to": 1556632800000,
@@ -218,7 +223,7 @@
 		"namespace": "AGT.ECS"
 	}]
 }
            -

            Request example 3: Query the average cpu_util of the five ECSs whose instance_id are faea5b75-e390-4e2b-8733-9226a9026070, faea5b75-e390-4e2b-8733-9226a9026071, faea5b75-e390-4e2b-8733-9226a9026072, faea5b75-e390-4e2b-8733-9226a9026073, and faea5b75-e390-4e2b-8733-9226a9026074 from 00:00:00 to 23:59:59 on August 21, 2024. Query five metrics. The monitoring period is 60,000 ms. The maximum value of (to-from) is 36,000,000. The value of the request parameter (to-from) is 86,399,000, which exceeds the maximum value 36,000,000. The formula is as follows: The number of metrics × (to-from)/Monitoring period ≤ 3000. The value of from in the request parameter is automatically changed to to-36,000,000, that is, 1,724,219,999,000.

            +

            Example 3: Query the average cpu_util of the five ECSs whose values of instance_id are faea5b75-e390-4e2b-8733-9226a9026070, faea5b75-e390-4e2b-8733-9226a9026071, faea5b75-e390-4e2b-8733-9226a9026072, faea5b75-e390-4e2b-8733-9226a9026073, and faea5b75-e390-4e2b-8733-9226a9026074 from 00:00:00 to 23:59:59 on August 21, 2024. Query five metrics. The monitoring period is 60,000 ms. The maximum value of (to – from) is 36000000. The value of the request parameter (to – from) is 86399000, which exceeds the maximum value 36000000. The formula is as follows: Number of metrics × Value of (to – from)/Monitoring period ≤ 3000. The system automatically sets the value of from to to – 36000000, that is, 1724219999000.

            {
     "metrics": [
        {
@@ -270,7 +275,7 @@
                 }
             ],
             "metric_name": "cpu_util"
-        },
+        }
     ], 
     "from": 1724169600000,
     "to": 1724255999000,
@@ -278,7 +283,7 @@
     "filter": "average"
 }
            -
            Request example 4: View the average cpu_util of the ECS whose instance_id is faea5b75-e390-4e2b-8733-9226a9026070 and the average network_vm_connections of the ECS whose instance_id is 06b4020f-461a-4a52-84da-53fa71c2f42b. The monitoring data was collected from 20:00:00 to 22:00:00 on April 30, 2019.
            {
+
            Example 4: View the average cpu_util of the ECS whose instance_id is faea5b75-e390-4e2b-8733-9226a9026070 and the average network_vm_connections of the ECS whose instance_id is 06b4020f-461a-4a52-84da-53fa71c2f42b. The monitoring data was collected from 20:00:00 to 22:00:00 on April 30, 2019.
            {
     "metrics": [
        {
             "namespace": "SYS.ECS",
@@ -308,7 +313,7 @@
 }
 
            
 
            
-
            Request example 5: View the sums of rds021_myisam_buf_usage of the RDS instance whose rds_cluster_id is 3c8cc15614ab46f5b8743317555e0de2in01 and the RDS instance whose rds_cluster_id is 3b2fa8b55a9b4adca3713962a9d31884in01. The monitoring data was collected from 20:00:00 to 22:00:00 on April 30, 2019.
            {
+
            Example 5: View the sums of rds021_myisam_buf_usage of the RDS instance whose rds_cluster_id is 3c8cc15614ab46f5b8743317555e0de2in01 and the RDS instance whose rds_cluster_id is 3b2fa8b55a9b4adca3713962a9d31884in01. The monitoring data was collected from 20:00:00 to 22:00:00 on April 30, 2019.
            {
     "metrics": [
         {
             "namespace": "SYS.RDS",
@@ -337,7 +342,7 @@
     "filter": "sum"
 }
            
 
            
-
            Example request 6: View the minimum proc_specified_count of the server whose instance_id is cd841102-f6b1-407d-a31f-235db796dcbb and proc is b28354b543375bfa94dabaeda722927f. The monitoring data is collected from 20:00:00 to 22:00:00 on April 30, 2019 and the rollup period is 20 minutes.
            {
+
            Example 6: View the minimum proc_specified_count of the server whose instance_id is cd841102-f6b1-407d-a31f-235db796dcbb and proc is b28354b543375bfa94dabaeda722927f. The monitoring data is collected from 20:00:00 to 22:00:00 on April 30, 2019 and the aggregation period is 20 minutes.
            {
     "metrics": [
         {
             "namespace": "AGT.ECS",
@@ -363,9 +368,9 @@

          Response

          • Response parameters -
        Table 4 dimensions data structure description

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        +

        Description

        String

        Specifies the dimension. For example, the ECS dimension is instance_id. For details about the dimension of each service, see the key column in Services Interconnected with Cloud Eye.

        -

        Start with a letter. Enter 1 to 32 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

        +

        Specifies the monitoring dimension name. For example, the ECS dimension is instance_id. For details about the dimension of each monitored object, see the documentation of a specific cloud service. You can navigate there directly from the Services Interconnected with Cloud Eye page.

        +

        The value must start with a letter. It allows 1 to 32 characters and can only contain letters, digits, underscores (_), and hyphens (-).

        value

        @@ -176,7 +181,7 @@

        String

        Specifies the dimension value, for example, an ECS ID. dimensions can be obtained from the response body by calling the API for querying metrics.

        -

        Start with a letter or a digit. Enter 1 to 256 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

        +

        The value must start with a letter or digit. It allows 1 to 256 characters and can only contain letters, digits, underscores (_), and hyphens (-).
        Table 5 Parameter description

        Parameter

        +
        - @@ -383,11 +388,11 @@
        Table 5 Response parameters

        Parameter

        Type

        +

        Type

        Description

        -
        Table 6 metrics data structure description

        Parameter

        +
        - - @@ -395,7 +400,9 @@ -
        Table 6 metrics data structure description

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        String

        Specifies the metric unit.

        +

        Specifies the data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

        +

        Minimum: 0

        +

        Maximum: 32

        datapoints

        @@ -437,11 +444,11 @@
        -
        Table 7 dimensions data structure description

        Parameter

        +
        - - @@ -449,8 +456,8 @@ -
        Table 7 dimensions data structure description

        Parameter

        Type

        +

        Type

        Description

        +

        Description

        String

        Specifies the dimension. For example, the ECS dimension is instance_id. For details about the dimension of each service, see the key column in Services Interconnected with Cloud Eye.

        -

        Start with a letter. Enter 1 to 32 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

        +

        Specifies the monitoring dimension name. For example, the ECS dimension is instance_id. For details about the dimension of each monitored object, see the documentation of a specific cloud service. You can navigate there directly from the Services Interconnected with Cloud Eye page.

        +

        The value must start with a letter. It allows 1 to 32 characters and can only contain letters, digits, underscores (_), and hyphens (-).

        value

        @@ -458,18 +465,18 @@

        String

        Specifies the dimension value, for example, an ECS ID.

        -

        Start with a letter or a digit. Enter 1 to 256 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

        +

        The value must start with a letter or digit. It allows 1 to 256 characters and can only contain letters, digits, underscores (_), and hyphens (-).
        -
        - @@ -64,7 +67,7 @@ @@ -99,7 +102,7 @@

        Request

        None

        Response

        • Response parameters -
        Table 8 datapoints data structure description

        Parameter

        +
        - - @@ -519,7 +526,7 @@
        Table 8 datapoints data structure description

        Parameter

        Type

        +

        Type

        Description

        +

        Description
        -
        • Example response
          Example response 1: The average cpu_util of the ECS whose instance_id is faea5b75-e390-4e2b-8733-9226a9026070 and the average network_vm_connections of the ECS whose instance_id is 06b4020f-461a-4a52-84da-53fa71c2f42b are displayed.
          {
+
          • Example responses
            Example response 1: The average cpu_util of the ECS whose instance_id is faea5b75-e390-4e2b-8733-9226a9026070 and the average network_vm_connections of the ECS whose instance_id is 06b4020f-461a-4a52-84da-53fa71c2f42b are displayed.
            {
     "metrics": [
         {
             "namespace": "SYS.ECS",
@@ -693,7 +700,7 @@
          -

          Error Codes

          See Error Codes.

          +

          Error Codes

          See Error Codes.

          diff --git a/docs/ces/api-ref/ces_03_0035.html b/docs/ces/api-ref/ces_03_0035.html index f826f3b70..7c08d4976 100644 --- a/docs/ces/api-ref/ces_03_0035.html +++ b/docs/ces/api-ref/ces_03_0035.html @@ -19,8 +19,11 @@

        Yes

        Specifies the project ID.

        -

        For details about how to obtain the project ID, see Obtaining a Project ID.

        +

        Specifies the project ID.

        +

        For details about how to obtain the project ID, see Obtaining a Project ID.

        +

        Minimum: 1

        +

        Maximum: 64

        +

        Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

        String

        Specifies the start time of the query.

        -

        The time is a UNIX timestamp and the unit is ms.

        +

        The value is a UNIX timestamp, in milliseconds.

        to

        @@ -74,7 +77,7 @@

        String

        Specifies the end time of the query.

        -

        The time is a UNIX timestamp and the unit is ms.

        +

        The value is a UNIX timestamp, in milliseconds.

        from must be earlier than to.
        Table 2 Parameter description

        Parameter

        +
        @@ -139,7 +142,7 @@ - - @@ -70,7 +73,7 @@
        Table 2 Response parameters

        Parameter

        Type

        Long

        Specifies when the event is reported. It is a UNIX timestamp and the unit is ms.

        +

        Specifies when the event was reported. The value is a UNIX timestamp, in milliseconds.

        value

        @@ -216,7 +219,7 @@ -

        Error Codes

        See Error Codes.

        +

        Error Codes

        See Error Codes.

        diff --git a/docs/ces/api-ref/ces_03_0036.html b/docs/ces/api-ref/ces_03_0036.html index e1c92d3e1..02b5752f7 100644 --- a/docs/ces/api-ref/ces_03_0036.html +++ b/docs/ces/api-ref/ces_03_0036.html @@ -10,7 +10,7 @@
        -
        Parent topic: API Description
        +
        Parent topic: API V1
        diff --git a/docs/ces/api-ref/ces_03_0037.html b/docs/ces/api-ref/ces_03_0037.html index 9fb2501b5..fa292ebb8 100644 --- a/docs/ces/api-ref/ces_03_0037.html +++ b/docs/ces/api-ref/ces_03_0037.html @@ -17,8 +17,11 @@

        Yes

        Specifies the project ID.

        -

        For details about how to obtain the project ID, see Obtaining a Project ID.

        +

        Specifies the project ID.

        +

        For details about how to obtain the project ID, see Obtaining a Project ID.

        +

        Minimum: 1

        +

        Maximum: 64

        +

        Regular expression matching: ^[a-zA-Z0-9-]{1,64}$
        -
        Table 4 Data structure description of resources

        Parameter

        +
        @@ -173,7 +176,7 @@ -

        Error Codes

        See Error Codes.

        +

        Error Codes

        See Error Codes.

        diff --git a/docs/ces/api-ref/ces_03_0038.html b/docs/ces/api-ref/ces_03_0038.html index 1af9a7a96..d74a2f4f3 100644 --- a/docs/ces/api-ref/ces_03_0038.html +++ b/docs/ces/api-ref/ces_03_0038.html @@ -1,8 +1,7 @@

        Event Monitoring

        -

        -
        +
        -
        Parent topic: API Description
        +
        Parent topic: API V1
        diff --git a/docs/ces/api-ref/ces_03_0042.html b/docs/ces/api-ref/ces_03_0042.html new file mode 100644 index 000000000..79d8b060a --- /dev/null +++ b/docs/ces/api-ref/ces_03_0042.html @@ -0,0 +1,32 @@ + + +

        API V2

        +

        +
        + + diff --git a/docs/ces/api-ref/ces_03_0057.html b/docs/ces/api-ref/ces_03_0057.html index ea76e537e..793ab2df5 100644 --- a/docs/ces/api-ref/ces_03_0057.html +++ b/docs/ces/api-ref/ces_03_0057.html @@ -32,7 +32,7 @@ }

        Obtain a Project ID from the Console

        A project ID needs to be specified in the URIs of some APIs. Therefore, you need to obtain the project ID before calling APIs. The following procedure describes how to obtain a project ID:
        1. Log in to the management console.
        2. Click the username and select My Credentials from the drop-down list.

          On the My Credentials page, view project IDs in the project list.

          -
          Figure 1 Viewing project IDs
          +
          Figure 1 Viewing project IDs

          In multi-project scenarios, expand the region, and obtain your sub-project ID from the Project ID column.

        diff --git a/docs/ces/api-ref/ces_03_0059.html b/docs/ces/api-ref/ces_03_0059.html index 78dfe8e69..0369ebb00 100644 --- a/docs/ces/api-ref/ces_03_0059.html +++ b/docs/ces/api-ref/ces_03_0059.html @@ -1,208 +1,247 @@

        Services Interconnected with Cloud Eye

        -
        -
        Table 4 resources data structure description

        Parameter

        Type

        Category

        +
        +
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - + + +
        Table 1 Cloud service metrics

        Category

        Service

        +

        Service

        Namespace

        +

        Namespace

        Reference

        +

        Reference

        Compute

        +

        Compute

        +

        Elastic Cloud Server

        +

        Elastic Cloud Server

        SYS.ECS

        +

        SYS.ECS

        Basic ECS metrics

        +

        Basic ECS metrics

        Bare Metal Server

        +

        Bare Metal Server

        SERVICE.BMS

        +

        SERVICE.BMS

        BMS metrics (with the Agent installed)

        +

        BMS metrics (with the Agent installed)

        Auto Scaling

        +

        Auto Scaling

        SYS.AS

        +

        SYS.AS

        AS metrics

        +

        AS metrics

        Storage

        +

        Storage

        Elastic Volume Service (attached to an ECS or BMS)

        +

        Elastic Volume Service (attached to an ECS or BMS)

        SYS.EVS

        +

        SYS.EVS

        EVS metrics

        +

        EVS metrics

        Object Storage Service

        +

        Object Storage Service

        SYS.OBS

        +

        SYS.OBS

        OBS metrics

        +

        OBS metrics

        Scalable File Service

        +

        Scalable File Service

        SYS.SFS

        +

        SYS.SFS

        SFS metrics

        +

        SFS metrics

        SFS Turbo

        +

        SFS Turbo

        SYS.EFS

        +

        SYS.EFS

        SFS Turbo metrics

        +

        SFS Turbo metrics

        Cloud Backup and Recovery

        +

        Cloud Backup and Recovery

        SYS.CBR

        +

        SYS.CBR

        CBR metrics

        +

        CBR metrics

        Network

        -

        +

        Networking

        +

        Elastic IP and bandwidth

        +

        Elastic IP and bandwidth

        SYS.VPC

        +

        SYS.VPC

        VPC metrics

        +

        VPC metrics

        Elastic Load Balance

        +

        Elastic Load Balance

        SYS.ELB

        +

        SYS.ELB

        ELB metrics

        +

        ELB metrics

        Direct Connect

        +

        Direct Connect

        SYS.DCAAS

        +

        SYS.DCAAS

        Direct Connect metrics

        +

        Direct Connect metrics

        NAT Gateway

        +

        NAT Gateway

        SYS.NAT

        +

        SYS.NAT

        NAT Gateway metrics

        +

        NAT Gateway metrics

        Virtual Private Network

        +

        Virtual Private Network

        SYS.VPN

        +

        SYS.VPN

        VPN metrics

        +

        VPN metrics

        Security

        +

        Security and Compliance

        Web Application Firewall

        +

        Web Application Firewall

        SYS.WAF

        +

        SYS.WAF

        WAF metrics

        +

        WAF metrics

        Application

        -

        +

        Application Services

        +

        Distributed Message Service

        +

        Distributed Message Service

        SYS.DMS

        +

        SYS.DMS

        DMS metrics

        +

        DMS metrics

        Distributed Cache Service

        +

        Distributed Cache Service

        SYS.DCS

        +

        SYS.DCS

        DCS metrics

        +

        DCS metrics

        API Gateway

        +

        API Gateway

        SYS.APIC

        +

        SYS.APIC

        API Gateway metrics

        +

        API Gateway metrics

        Database

        +

        Databases

        Relational Database Service

        +

        Relational Database Service

        SYS.RDS

        +

        SYS.RDS

        RDS for MySQL metrics

        -

        RDS for PostgreSQL metrics

        -

        RDS for SQL Server metrics

        +

        RDS for MySQL metrics

        +

        RDS for PostgreSQL metrics

        +

        RDS for SQL Server metrics

        Document Database Service

        +

        Document Database Service

        SYS.DDS

        +

        SYS.DDS

        DDS metrics

        +

        DDS metrics

        GeminiDB

        +

        GeminiDB

        SYS.NoSQL

        +

        SYS.NoSQL

        GeminiDB metrics

        +

        GeminiDB metrics

        GaussDB(for MySQL)

        +

        TaurusDB

        SYS.GAUSSDB

        +

        SYS.GAUSSDB

        GaussDB(for MySQL) metrics

        +

        TaurusDB metrics

        GaussDB(for openGauss)

        +

        GaussDB(for openGauss)

        SYS.GAUSSDBV5

        +

        SYS.GAUSSDBV5

        GaussDB(for openGauss) metrics

        +

        GaussDB(for openGauss) metrics

        Data analysis

        +

        Distributed Database Middleware

        Data Warehouse Service

        +

        SYS.DDM (DDM 1.0)

        +

        SYS.DDMS (DDM 2.0)

        SYS.DWS

        -

        DWS metrics

        +

        DDM instance metrics

        +

        DDM network metrics

        Cloud Search Service

        +

        Data Analytics

        SYS.ES

        +

        Data Warehouse Service

        CSS metrics

        +

        SYS.DWS

        +

        DWS metrics

        Data Ingestion Service (DIS)

        +

        Cloud Search Service

        SYS.DAYU

        +

        SYS.ES

        DIS Metrics

        +

        CSS metrics

        +
        +
        +

        In addition to the preceding cloud services, the following cloud services also support event monitoring. For details about monitored events, see Events Supported by Event Monitoring.

        + +
        + + + + + + + + + + + + + + + + + diff --git a/docs/ces/api-ref/ces_03_0060.html b/docs/ces/api-ref/ces_03_0060.html index aaa802b4e..5e4bd590b 100644 --- a/docs/ces/api-ref/ces_03_0060.html +++ b/docs/ces/api-ref/ces_03_0060.html @@ -8,7 +8,14 @@ - + + + - - - - - - - - - @@ -283,7 +292,7 @@ -

        Error Codes

        See Error Codes.

        +

        Error Codes

        See Error Codes.

        diff --git a/docs/ces/api-ref/ces_03_0075.html b/docs/ces/api-ref/ces_03_0075.html index 93793d248..5157c276b 100644 --- a/docs/ces/api-ref/ces_03_0075.html +++ b/docs/ces/api-ref/ces_03_0075.html @@ -21,8 +21,11 @@
        - - - - - - - @@ -540,7 +545,7 @@ -

        Error Codes

        See Error Codes.

        +

        Error Codes

        See Error Codes.

        diff --git a/docs/ces/api-ref/en-us_image_0000001508295281.png b/docs/ces/api-ref/en-us_image_0000002446115165.png similarity index 100% rename from docs/ces/api-ref/en-us_image_0000001508295281.png rename to docs/ces/api-ref/en-us_image_0000002446115165.png diff --git a/docs/ces/api-ref/en-us_topic_0032831274.html b/docs/ces/api-ref/en-us_topic_0032831274.html index b1ab04617..11cb3360b 100644 --- a/docs/ces/api-ref/en-us_topic_0032831274.html +++ b/docs/ces/api-ref/en-us_topic_0032831274.html @@ -18,8 +18,11 @@
        - @@ -92,8 +95,8 @@ @@ -112,8 +115,9 @@ - @@ -191,8 +195,8 @@ -
        Table 2 Cloud services that support event monitoring only

        Service

        +

        Namespace

        +

        Cloud Eye (CES)

        +

        SYS.CES

        +

        Host Security Service (HSS)

        +

        SYS.HSS

        +

        Identity and Access Management (IAM)

        +

        SYS.IAM

        +

        Image Management Service (IMS)

        +

        SYS.IMS

        +

        Key Management Service (KMS)

        +

        SYS.KMS

        2025-01-04

        +

        2025-11-18

        +

        This release incorporates the following changes:

        + + +

        2025-01-04

        This release incorporates the following changes:

        Updated Reporting Events, added the dimensions parameter to Table 4, and added Table 5.

        @@ -164,13 +171,13 @@

        Deleted Resource Template Service (RTS) metrics.

        2016-9-30

        +

        2016-09-30

        This release incorporates the following change:

        Added Resource Template Service (RTS) metrics.

        2016-8-25

        +

        2016-08-25

        This release incorporates the following changes:

        • Added the Cloud Container Engine (CCE), Relational Database Service (RDS), and Domain Name Service (DNS) services in Regions and Endpoints.
        • Added Elastic Cloud Server (ECS) metrics.
        • Added Relational Database Service (RDS) metrics.
        diff --git a/docs/ces/api-ref/ces_03_0062.html b/docs/ces/api-ref/ces_03_0062.html new file mode 100644 index 000000000..179029cdd --- /dev/null +++ b/docs/ces/api-ref/ces_03_0062.html @@ -0,0 +1,351 @@ + + +

        Creating a Custom Alarm Template

        +

        Function

        This API is used to create a custom alarm template to add alarm rules for one or more metrics.

        +
        +

        URI

        POST /V1.0/{project_id}/alarm-template

        +
        • Parameter description +
          + + + + + + + + + +
          Table 1 Parameter description

          Parameter

          +

          Mandatory

          +

          Description

          +

          project_id

          +

          Yes

          +

          Specifies the project ID.

          +

          For details about how to obtain the project ID, see Obtaining a Project ID.

          +

          Minimum: 1

          +

          Maximum: 64

          +

          Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

          +
          +
          +
        +
        • Example
          POST https://{Cloud Eye endpoint}/V1.0/{project_id}/alarm-template
          +
        +
        +

        Request

        • Request parameters +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Table 2 Request parameters

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          template_name

          +

          Yes

          +

          String

          +

          Specifies the name of the custom alarm template. The name can contain 1 to 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

          +

          template_description

          +

          No

          +

          String

          +

          Provides supplementary information about the custom alarm template. The description can contain 0 to 256 characters.

          +

          namespace

          +

          Yes

          +

          String

          +

          Specifies the resource type selected for creating the custom alarm template, that is, the service namespace. For example, if you select ECS, namespace is SYS.ECS.

          +
          NOTICE:

          If you select OS monitoring, namespace must be SYS.ECS.

          +
          +

          dimension_name

          +

          Yes

          +

          String

          +

          Specifies the dimension corresponding to the resource type. If ECS is selected, the dimension is ECS and dimension_name is instance_id.

          +

          template_items

          +

          Yes

          +

          Array of objects

          +

          Specifies the alarm rules that you add to the custom alarm template. You can add up to 20 alarm rules.

          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + + + +
          Table 3 template_items data structure description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          metric_name

          +

          Yes

          +

          String

          +

          Specifies the metric you add to the custom alarm template. For example, you can add ECS cpu_util. To view metrics of each resource, see Services Interconnected with Cloud Eye.

          +

          condition

          +

          Yes

          +

          Condition object

          +

          Specifies the alarm policy you created for the custom alarm template.

          +

          For details, see Table 4.

          +

          alarm_level

          +

          No

          +

          Integer

          +

          Specifies the alarm severity.

          +

          Possible severities are 1 (critical), 2 (major), 3 (minor), and 4 (informational).

          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Table 4 condition data structure description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          comparison_operator

          +

          Yes

          +

          String

          +

          Specifies the alarm threshold operator, which can be >, =, <, >=, <=, or !=.

          +

          count

          +

          Yes

          +

          Integer

          +

          Specifies the number of consecutive occurrence times that the alarm policy was met. Supported range: 1 to 5

          +

          filter

          +

          Yes

          +

          String

          +

          Specifies the data aggregation method. The value can be:

          +
          • average: average value of metric data within an aggregation period.
          • max: maximum value of metric data in an aggregation period.
          • min: minimum value of metric data within an aggregation period.
          • sum: sum of metric data within an aggregation period.
          • variance: variance value of metric data within an aggregation period.
          +

          period

          +

          Yes

          +

          Integer

          +

          Specifies the period during which Cloud Eye determines whether to trigger an alarm.

          +

          Unit: second

          +

          Possible periods are 0, 1, 300, 1200, 3600, 14400, and 86400.

          +
          NOTE:

          If you set period to 1, Cloud Eye uses raw data to determine whether to trigger an alarm. You can set this parameter to 0 when you set alarm_type to (EVENT.SYS| EVENT.CUSTOM).

          +
          +

          unit

          +

          No

          +

          String

          +

          Specifies the data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

          +

          Minimum: 0

          +

          Maximum: 32

          +

          value

          +

          Yes

          +

          Double

          +

          Specifies the alarm threshold, which ranges from 0 to Number. MAX_VALUE (1.7976931348623157e+108). For detailed thresholds, see the value range of each metric in Services Interconnected with Cloud Eye. For example, you can set ECS cpu_util to 80.

          +

          suppress_duration

          +

          No

          +

          Integer

          +

          Specifies the interval for triggering an alarm if the alarm persists. Possible intervals are as follows:

          +

          0: Cloud Eye triggers the alarm only once.

          +

          300: Cloud Eye triggers the alarm every 5 minutes.

          +

          600: Cloud Eye triggers the alarm every 10 minutes.

          +

          900: Cloud Eye triggers the alarm every 15 minutes.

          +

          1800: Cloud Eye triggers the alarm every 30 minutes.

          +

          3600: Cloud Eye triggers the alarm every 1 hour.

          +

          10800: Cloud Eye triggers the alarm every 3 hours.

          +

          21600: Cloud Eye triggers the alarm every 6 hours.

          +

          43200: Cloud Eye triggers the alarm every 12 hours.

          +

          86400: Cloud Eye triggers the alarm every day.

          +
          +
          +
        +
        • Example request
          {
+    "template_name": "alarmTemplate-Test01",
+    "template_description": "Creating a custom alarm template",
+    "namespace": "SYS.ECS",
+    "dimension_name": "instance_id",
+    "template_items": [
+        {
+           "metric_name": "cpu_util",
+           "condition": {
+               "period": 1,
+               "filter": "average",
+               "comparison_operator": ">=",
+               "value": 90,
+               "unit": "%",
+               "count": 3,
+               "suppress_duration": 300
+            },
+           "alarm_level": 2
+       },
+       {
+           "metric_name": "mem_util",
+           "condition": {
+               "period": 1,
+               "filter": "average",
+               "comparison_operator": ">=",
+               "value": 90,
+               "unit": "%",
+               "count": 3,
+               "suppress_duration": 600
+            },
+           "alarm_level": 2
+       }
+   ]
+ }
+
          +
        +
        +

        Response

        • Response parameters +
          + + + + + + + + + +
          Table 5 Response parameters

          Parameter

          +

          Type

          +

          Description

          +

          template_id

          +

          String

          +

          Specifies the ID of the custom alarm template.

          +
          +
          +
        +
        • Example response
          { 
+    "template_id":"at1603252280799wLRyGLxnz"
+}
          +
        +
        +

        Returned Values

        • Normal

          201

          +
        • Abnormal +
          + + + + + + + + + + + + + + + + + + + + + + + + + +

          Returned Values

          +

          Description

          +

          400 Bad Request

          +

          Request error.

          +

          401 Unauthorized

          +

          The authentication information is not provided or is incorrect.

          +

          403 Forbidden

          +

          Access to the requested page is forbidden.

          +

          408 Request Timeout

          +

          The request timed out.

          +

          429 Too Many Requests

          +

          Concurrent requests are excessive.

          +

          500 Internal Server Error

          +

          Failed to complete the request because of an internal service error.

          +

          503 Service Unavailable

          +

          The service is currently unavailable.

          +
          +
          +
        +
        +

        Error Codes

        See Error Codes.

        +
        +
        +
        +
        +
        Parent topic: Alarm Rules
        +
        +
        + diff --git a/docs/ces/api-ref/ces_03_0063.html b/docs/ces/api-ref/ces_03_0063.html new file mode 100644 index 000000000..ee49f4cb4 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0063.html @@ -0,0 +1,101 @@ + + +

        Deleting a Custom Alarm Template

        +

        Function

        This API is used to delete a custom alarm template.

        +
        +

        URI

        DELETE /V1.0/{project_id}/alarm-template/{template_id}

        +
        • Parameter description +
          + + + + + + + + + + + + + +
          Table 1 Parameter description

          Parameter

          +

          Mandatory

          +

          Description

          +

          project_id

          +

          Yes

          +

          Specifies the project ID.

          +

          For details about how to obtain the project ID, see Obtaining a Project ID.

          +

          Minimum: 1

          +

          Maximum: 64

          +

          Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

          +

          template_id

          +

          Yes

          +

          Specifies the ID of the custom alarm template you want to delete.

          +
          +
          +
        +
        • Example
          DELETE https://{Cloud Eye endpoint}/V1.0/{project_id}/alarm-template/at1603252280799wLRyGLxnz
          +
        +
        +

        Request

        The request has no message body.

        +
        +

        Response

        The response has no message body.

        +
        +

        Returned Values

        • Normal

          204

          +
        • Abnormal +
          + + + + + + + + + + + + + + + + + + + + + + + + + +

          Returned Value

          +

          Description

          +

          400 Bad Request

          +

          Request error.

          +

          401 Unauthorized

          +

          The authentication information is not provided or is incorrect.

          +

          403 Forbidden

          +

          Access to the requested page is forbidden.

          +

          408 Request Timeout

          +

          The request timed out.

          +

          429 Too Many Requests

          +

          Concurrent requests are excessive.

          +

          500 Internal Server Error

          +

          Failed to complete the request because of an internal service error.

          +

          503 Service Unavailable

          +

          The service is currently unavailable.

          +
          +
          +
        +
        +

        Error Codes

        See Error Codes.

        +
        +
        +
        +
        +
        Parent topic: Alarm Rules
        +
        +
        + diff --git a/docs/ces/api-ref/ces_03_0064.html b/docs/ces/api-ref/ces_03_0064.html new file mode 100644 index 000000000..f7f883b58 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0064.html @@ -0,0 +1,894 @@ + + +

        Querying the Alarm History of an Alarm Rule

        +

        Function

        This API is used to query the alarm history of an alarm rule based on the alarm rule ID.

        +
        +

        URI

        GET /V1.0/{project_id}/alarm-histories

        +
        • Querying parameter description +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Table 1 Querying parameter description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          project_id

          +

          Yes

          +

          String

          +

          Specifies the project ID.

          +

          For details about how to obtain the project ID, see Obtaining a Project ID.

          +

          Minimum: 1

          +

          Maximum: 64

          +

          Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

          +

          group_id

          +

          No

          +

          String

          +

          Specifies the resource group ID, for example, rg1603107497873DK4O2pXbn.

          +

          alarm_id

          +

          No

          +

          String

          +

          Specifies the alarm rule ID, for example, al1603088932912v98rGl1al.

          +

          alarm_name

          +

          No

          +

          String

          +

          Specifies the alarm rule name, for example, alarm-test01.

          +

          alarm_status

          +

          No

          +

          String

          +

          Specifies the alarm status, which can be ok, alarm, or insufficient_data.

          +

          alarm_level

          +

          No

          +

          Integer

          +

          Specifies the alarm severity, which can be 1 (critical), 2 (major), 3 (minor), or 4 (informational).

          +

          namespace

          +

          No

          +

          String

          +

          Specifies the resource namespace. For example, the ECS namespace is SYS.ECS. To view the namespace of each service, see Services Interconnected with Cloud Eye.

          +

          from

          +

          No

          +

          String

          +

          Specifies the time from when you want to query the alarm history. The time is a UNIX timestamp (ms), for example, 1602501480905. If you do not configure from or to, to is the current time by default, and from is the timestamp of seven days earlier than the current time.

          +

          to

          +

          No

          +

          String

          +

          Specifies when you want your alarm history query to end. The value is a UNIX timestamp in milliseconds. from must be earlier than to.

          +

          If you do not configure from or to, to is the current time by default, and from is the timestamp of seven days earlier than the current time.

          +

          start

          +

          No

          +

          Integer

          +

          Specifies the start value of pagination. The value is an integer. The default value is 0.

          +

          limit

          +

          No

          +

          Integer

          +

          Specifies the maximum number of records that can be queried at a time. Supported range: 1 to 100 (default)

          +
          +
          +
        +
        • Example
          GET https://{Cloud Eye endpoint}/V1.0/{project_id}/alarm-histories?limit=10&start=0&from=1602494921346&to=1603099721346&alarm_name=alarm-test01
          +
        +
        +

        Request

        None

        +
        +

        Response

        • Response parameters +
          + + + + + + + + + + + + + + + + +

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          alarm_histories

          +

          No

          +

          Array of objects

          +

          Specifies details about one or more alarm history records.

          +

          For details, see Table 2.

          +

          meta_data

          +

          No

          +

          MetaData object

          +

          Specifies the total number of query results returned.

          +

          For details, see Table 11.

          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Table 2 alarm_histories data structure description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          alarm_id

          +

          No

          +

          String

          +

          Specifies the alarm rule ID, for example, al1603131199286dzxpqK3Ez.

          +

          alarm_name

          +

          No

          +

          String

          +

          Specifies the alarm rule name, for example, alarm-test01.

          +

          alarm_description

          +

          No

          +

          String

          +

          Provides supplementary information about the alarm rule.

          +

          metric

          +

          No

          +

          Metric object

          +

          Specifies the metric information.

          +

          For details, see Table 3.

          +

          condition

          +

          No

          +

          Condition object

          +

          Specifies the alarm policy set in the alarm rule.

          +

          For details, see Table 8.

          +

          alarm_level

          +

          No

          +

          Integer

          +

          Specifies the alarm severity, which can be 1 (critical), 2 (major), 3 (minor), or 4 (informational).

          +

          alarm_type

          +

          No

          +

          String

          +

          Specifies the alarm rule type. This parameter applies only to event alarms. The types are as follows:

          +

          EVENT.SYS: system event alarm

          +

          EVENT.CUSTOM: custom event alarm

          +

          DNSHealthCheck: DNS health check alarm

          +

          RESOURCE_GROUP: resource group alarm

          +

          MULTI_INSTANCE: alarm for a specific resource

          +

          alarm_enabled

          +

          No

          +

          Boolean

          +

          Specifies whether the alarm rule has been enabled. Possible values are true and false.

          +

          alarm_action_enabled

          +

          No

          +

          Boolean

          +

          Specifies whether the alarm action has been triggered. Possible values are true and false.

          +

          alarm_actions

          +

          No

          +

          Array of objects

          +

          Specifies the action to be triggered by an alarm. The structure is as follows: {"type": "notification", "notificationList": ["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] }

          +

          The value of type can be:

          +

          notification: A notification will be sent.

          +

          autoscaling: A scaling action will be triggered.

          +

          notificationList indicates the list of recipients to be notified of alarm status changes.

          +

          For details, see Table 5.

          +

          ok_actions

          +

          No

          +

          Array of objects

          +

          Specifies the action to be triggered after the alarm is cleared. The structure is as follows: {"type": "notification", "notificationList": ["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] }

          +

          The value of type can be:

          +

          notification: A notification will be sent.

          +

          notificationList indicates the list of recipients to be notified of alarm status changes.

          +

          For details, see Table 6.

          +

          insufficientdata_actions

          +

          No

          +

          Array of objects

          +

          Specifies the action triggered by data insufficiency. The structure is as follows: {"type": "notification", "notificationList": ["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"]}

          +

          The value of type can be:

          +

          notification: An alarm is triggered due to insufficient data.

          +

          notificationList: Specifies the ID list of the notification objects when an alarm notification is triggered due to insufficient data.

          +

          For details, see Table 7.

          +

          update_time

          +

          No

          +

          Long

          +

          Specifies when the alarm status changed. The time is a UNIX timestamp (ms), for example, 1603131199000.

          +

          enterprise_project_id

          +

          No

          +

          String

          +

          Specifies the enterprise project ID. Value all_granted_eps indicates all enterprise projects. Value 0 indicates enterprise project default.

          +

          trigger_time

          +

          No

          +

          Long

          +

          Specifies when the alarm was triggered. The time is a UNIX timestamp (ms), for example, 1603131199469.

          +

          alarm_status

          +

          No

          +

          String

          +

          Specifies the alarm status, which can be ok, alarm, or insufficient_data.

          +

          datapoints

          +

          No

          +

          Array of objects

          +

          Specifies when the monitoring data of the alarm history is reported and the monitoring data that is calculated.

          +

          For details, see Table 9.

          +

          additional_info

          +

          No

          +

          AdditionalInfo object

          +

          Specifies the additional field of the alarm history, which applies only to the alarm history generated for event monitoring.

          +

          For details, see Table 10.

          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + + + +
          Table 3 metric data structure description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          dimensions

          +

          No

          +

          Array of objects

          +

          Specifies the metric dimension.

          +

          For details, see Table 4.

          +

          metric_name

          +

          No

          +

          String

          +

          Specifies the metric name. Start with a letter. Enter 1 to 64 characters. Only letters, digits, and underscores (_) are allowed. For details, see the metric name queried in Services Interconnected with Cloud Eye.

          +

          namespace

          +

          No

          +

          String

          +

          Specifies the metric namespace in service.item format. service and item each must contain 3 to 32 characters, start with a letter, and contain only letters, digits, and underscores (_).

          +
          NOTE:

          You can leave this parameter blank when you set alarm_type to (EVENT.SYS| EVENT.CUSTOM).

          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 4 dimensions data structure description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          name

          +

          No

          +

          String

          +

          Specifies the monitoring dimension name. For example, the ECS dimension is instance_id. For details about the dimension of each monitored object, see the documentation of a specific cloud service. You can navigate there directly from the Services Interconnected with Cloud Eye page.

          +

          value

          +

          No

          +

          String

          +

          Specifies the dimension value, for example, an ECS ID.

          +

          The value contains 1 to 256 characters.

          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 5 alarm_actions data structure description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          type

          +

          Yes

          +

          String

          +
          Specifies the alarm notification type.
          • notification: A notification will be sent.
          • autoscaling: A scaling action will be triggered.
          +
          +

          notificationList

          +

          Yes

          +

          Array of strings

          +

          Specifies the list of objects to be notified of alarm status changes.

          +
          NOTE:

          The IDs in the list are strings. You can configure up to 5 object IDs.

          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 6 ok_actions data structure description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          type

          +

          Yes

          +

          String

          +
          Specifies the alarm notification type.
          • notification: A notification will be sent.
          • autoscaling: A scaling action will be triggered.
          +
          +

          notificationList

          +

          Yes

          +

          Array of strings

          +

          Specifies the list of objects to be notified of alarm status changes.

          +
          NOTE:

          The IDs in the list are strings. You can configure up to 5 object IDs.

          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 7 insufficientdata_actions data structure description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          type

          +

          Yes

          +

          String

          +
          Specifies the alarm notification type.
          • notification: A notification will be sent.
          • autoscaling: A scaling action will be triggered.
          +
          +

          notificationList

          +

          Yes

          +

          Array of strings

          +

          Specifies the list of objects to be notified of alarm status changes.

          +
          NOTE:

          The IDs in the list are strings. You can configure up to 5 object IDs.

          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Table 8 condition data structure description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          period

          +

          No

          +

          Integer

          +

          Specifies how often Cloud Eye aggregates data, which can be

          +
          • 0: Event alarms are triggered immediately.
          • 1: Cloud Eye performs no aggregation and displays raw data.
          +
          • 300: Cloud Eye aggregates data every 5 minutes.
          • 1200: Cloud Eye aggregates data every 20 minutes.
          • 3600: Cloud Eye aggregates data every hour.
          • 14400: Cloud Eye aggregates data every 4 hours.
          • 86400: Cloud Eye aggregates data every 24 hours.
          +
          NOTE:

          If you set period to 1, Cloud Eye uses raw data to determine whether to trigger an alarm. You can set this parameter to 0 when you set alarm_type to (EVENT.SYS| EVENT.CUSTOM).

          +
          +

          filter

          +

          No

          +

          String

          +

          Specifies the data aggregation method. The value can be:

          +
          • average: average value of metric data within an aggregation period.
          • max: maximum value of metric data in an aggregation period.
          • min: minimum value of metric data within an aggregation period.
          • sum: sum of metric data within an aggregation period.
          • variance: variance value of metric data within an aggregation period.
          +

          comparison_operator

          +

          No

          +

          String

          +

          Specifies the alarm threshold operator, which can be >, =, <, >=, <=, or !=.

          +

          value

          +

          Yes

          +

          Double

          +

          Specifies the alarm threshold. Range: 0 to Number. MAX_VALUE (1.7976931348623157e+108)

          +

          For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS cpu_util in Services Interconnected with Cloud Eye to 80.

          +

          unit

          +

          No

          +

          String

          +

          Specifies the data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

          +

          Minimum: 0

          +

          Maximum: 32

          +

          count

          +

          No

          +

          Integer

          +

          Specifies the number of consecutive occurrence times that the alarm policy was met. Supported range: 1 to 5

          +

          suppress_duration

          +

          No

          +

          Integer

          +

          Specifies the interval for triggering an alarm if the alarm persists. Possible intervals are as follows:

          +

          0: Cloud Eye triggers the alarm only once.

          +

          300: Cloud Eye triggers the alarm every 5 minutes.

          +

          600: Cloud Eye triggers the alarm every 10 minutes.

          +

          900: Cloud Eye triggers the alarm every 15 minutes.

          +

          1800: Cloud Eye triggers the alarm every 30 minutes.

          +

          3600: Cloud Eye triggers the alarm every hour.

          +

          10800: Cloud Eye triggers the alarm every 3 hours.

          +

          21600: Cloud Eye triggers the alarm every 6 hours.

          +

          43200: Cloud Eye triggers the alarm every 12 hours.

          +

          86400: Cloud Eye triggers the alarm every day.

          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 9 datapoints data structure description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          time

          +

          No

          +

          Long

          +

          Specifies when the monitoring data of the alarm history is reported, which is a UNIX timestamp in milliseconds, for example, 1603131028000.

          +

          value

          +

          No

          +

          Double

          +

          Specifies the calculated monitoring data of the alarm history, for example, 7.019.

          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + + + +
          Table 10 additional_info data structure description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          resource_id

          +

          No

          +

          String

          +

          Specifies the resource ID corresponding to the alarm history, for example, 22d98f6c-16d2-4c2d-b424-50e79d82838f.

          +

          resource_name

          +

          No

          +

          String

          +

          Specifies the resource name corresponding to the alarm history, for example, ECS-Test01.

          +

          event_id

          +

          No

          +

          String

          +

          Specifies the event ID of the alarm history, for example, ev16031292300990kKN8p17J.

          +
          +
          + +
          + + + + + + + + + + + +
          Table 11 meta_data data structure description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          total

          +

          Yes

          +

          Integer

          +

          Specifies the total number of query results.

          +
          +
          +
        • Example response
          {
+ "alarm_histories": [
+   {
+     "alarm_id": "al1604473987569z6n6nkpm1",
+     "alarm_name": "TC_CES_FunctionBaseline_Alarm_008",
+     "alarm_description": "",
+     "metric": {
+       "namespace": "SYS.VPC",
+       "dimensions": [
+         {
+           "name": "bandwidth_id",
+           "value": "79a9cc0c-f626-4f15-bf99-a1f184107f88"
+         }
+       ],
+       "metric_name": "downstream_bandwidth"
+     },
+     "condition": {
+       "period": 1,
+       "filter": "average",
+       "comparison_operator": ">=",
+       "value": 0,
+       "count": 3
+     },
+     "alarm_level": 2,
+     "alarm_type": "",
+     "alarm_enabled": false,
+     "alarm_action_enabled": false,
+     "alarm_actions": [],
+     "ok_actions": [],
+     "insufficientdata_actions": [],
+     "update_time": 1604473988000,
+     "enterprise_project_id": "0",
+     "trigger_time": 1604473987607,
+     "alarm_status": "alarm",
+     "datapoints": [
+       {
+         "time": 1604473860000,
+         "value": 0
+       },
+       {
+         "time": 1604473800000,
+         "value": 0
+       },
+       {
+         "time": 1604473740000,
+         "value": 0
+       }
+     ],
+     "additional_info": {
+       "resource_id": "",
+       "resource_name": "",
+       "event_id": ""
+     }
+   },
+   {
+     "alarm_id": "al1604473978613MvlvlbVZD",
+     "alarm_name": "alarm_merge",
+     "alarm_description": "",
+     "metric": {
+       "namespace": "AGT.ECS",
+       "dimensions": [
+         {
+           "name": "instance_id",
+           "value": "22d98f6c-16d2-4c2d-b424-50e79d82838f"
+         }
+       ],
+       "metric_name": "load_average5",
+       "resource_group_id": "rg160447397837330303XQbK",
+       "resource_group_name": "group1"
+     },
+     "condition": {
+       "period": 1,
+       "filter": "average",
+       "comparison_operator": ">=",
+       "value": 0,
+       "count": 3
+     },
+     "alarm_level": 2,
+     "alarm_type": "RESOURCE_GROUP",
+     "alarm_enabled": false,
+     "alarm_action_enabled": false,
+     "alarm_actions": [],
+     "ok_actions": [],
+     "insufficientdata_actions": [],
+     "update_time": 1604473979000,
+     "enterprise_project_id": "0",
+     "trigger_time": 1604473979070,
+     "alarm_status": "insufficient_data",
+     "datapoints": [],
+     "additional_info": {
+       "resource_id": "",
+       "resource_name": "",
+       "event_id": ""
+     }
+   }
+ ],
+ "meta_data": {
+   "total": 2
+ }
+}
          +
        +
        +

        Returned Values

        • Normal

          200

          +
        • Abnormal +
          + + + + + + + + + + + + + + + + + + + + + + + + + +

          Returned Value

          +

          Description

          +

          400 Bad Request

          +

          Request error.

          +

          401 Unauthorized

          +

          The authentication information is not provided or is incorrect.

          +

          403 Forbidden

          +

          Access to the requested page is forbidden.

          +

          408 Request Timeout

          +

          The request timed out.

          +

          429 Too Many Requests

          +

          Concurrent requests are excessive.

          +

          500 Internal Server Error

          +

          Failed to complete the request because of an internal service error.

          +

          503 Service Unavailable

          +

          The service is currently unavailable.

          +
          +
          +
        +
        +

        Error Codes

        See Error Codes.

        +
        +
        +
        +
        +
        Parent topic: Alarm Rules
        +
        +
        + diff --git a/docs/ces/api-ref/ces_03_0066.html b/docs/ces/api-ref/ces_03_0066.html new file mode 100644 index 000000000..fe5a214e3 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0066.html @@ -0,0 +1,335 @@ + + +

        Updating a Custom Alarm Template

        +

        Function

        This API is used to update a custom alarm template.

        +
        +

        URI

        PUT /V1.0/{project_id}/alarm-template/{template_id}

        +
        • Parameter description +
          + + + + + + + + + + + + + +
          Table 1 Parameter description

          Parameter

          +

          Mandatory

          +

          Description

          +

          project_id

          +

          Yes

          +

          Specifies the project ID.

          +

          For details about how to obtain the project ID, see Obtaining a Project ID.

          +

          Minimum: 1

          +

          Maximum: 64

          +

          Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

          +

          template_id

          +

          Yes

          +

          Specifies the ID of the custom alarm template you want to update.

          +
          +
          +
        +
        • Example
          PUT https://{Cloud Eye endpoint}/V1.0/{project_id}/alarm-template/{template_id}
          +
        +
        +

        Request

        • Request parameters +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Table 2 Request parameters

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          template_name

          +

          Yes

          +

          String

          +

          Specifies the name of the custom alarm template. The name can contain 1 to 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

          +

          template_description

          +

          No

          +

          String

          +

          Provides supplementary information about the custom alarm template. The description can contain 0 to 256 characters.

          +

          namespace

          +

          Yes

          +

          String

          +

          Specifies the resource type selected for creating the custom alarm template, that is, the service namespace. For example, if you select ECS, namespace is SYS.ECS.

          +

          dimension_name

          +

          Yes

          +

          String

          +

          Specifies the dimension corresponding to the resource type. If ECS is selected, the dimension is ECS and dimension_name is instance_id.

          +

          template_items

          +

          Yes

          +

          Array of objects

          +

          Specifies the alarm rules that you add to the custom alarm template. You can add up to 20 alarm rules.

          +

          For details, see Table 3.

          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + + + +
          Table 3 template_items data structure description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          metric_name

          +

          Yes

          +

          String

          +

          Specifies the metric you add to the custom alarm template. For example, you can add ECS cpu_util.

          +

          For the metric names of each resource, see Services Interconnected with Cloud Eye.

          +

          condition

          +

          Yes

          +

          Condition object

          +

          Specifies the alarm policy you created for the custom alarm template.

          +

          For details, see Table 4.

          +

          alarm_level

          +

          No

          +

          Integer

          +

          Specifies the alarm severity.

          +

          Possible severities are 1 (critical), 2 (major), 3 (minor), and 4 (informational).

          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Table 4 condition data structure description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          comparison_operator

          +

          Yes

          +

          String

          +

          Specifies the alarm threshold operator, which can be >, =, <, >=, <=, or !=.

          +

          count

          +

          Yes

          +

          Integer

          +

          Specifies the number of consecutive occurrence times that the alarm policy was met. Supported range: 1 to 5

          +

          filter

          +

          Yes

          +

          String

          +

          Specifies the data aggregation method. The value can be:

          +
          • average: average value of metric data within an aggregation period.
          • max: maximum value of metric data in an aggregation period.
          • min: minimum value of metric data within an aggregation period.
          • sum: sum of metric data within an aggregation period.
          • variance: variance value of metric data within an aggregation period.
          +

          period

          +

          Yes

          +

          Integer

          +

          Specifies how often Cloud Eye aggregates data.

          +

          The value can be:

          +
          • 0: Event alarms are triggered immediately.
          • 1: Cloud Eye performs no aggregation and displays raw data.
          +
          • 300: Cloud Eye aggregates data every 5 minutes.
          • 1200: Cloud Eye aggregates data every 20 minutes.
          • 3600: Cloud Eye aggregates data every hour.
          • 14400: Cloud Eye aggregates data every 4 hours.
          • 86400: Cloud Eye aggregates data every 24 hours.
          +

          unit

          +

          No

          +

          String

          +

          Specifies the data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

          +

          Minimum: 0

          +

          Maximum: 32

          +

          value

          +

          Yes

          +

          Double

          +

          Specifies the alarm threshold. Range: 0 to Number. MAX_VALUE (1.7976931348623157e+108) For detailed thresholds, see the value ranges of metrics in Services Interconnected with Cloud Eye. For example, you can set ECS cpu_util to 80.

          +

          suppress_duration

          +

          No

          +

          Integer

          +

          Specifies the interval for triggering an alarm if the alarm persists.

          +

          Possible intervals are as follows:

          +

          0: Cloud Eye triggers the alarm only once.

          +

          300: Cloud Eye triggers the alarm every 5 minutes.

          +

          600: Cloud Eye triggers the alarm every 10 minutes.

          +

          900: Cloud Eye triggers the alarm every 15 minutes.

          +

          1800: Cloud Eye triggers the alarm every 30 minutes.

          +

          3600: Cloud Eye triggers the alarm every hour.

          +

          10800: Cloud Eye triggers the alarm every 3 hours.

          +

          21600: Cloud Eye triggers the alarm every 6 hours.

          +

          43200: Cloud Eye triggers the alarm every 12 hours.

          +

          86400: Cloud Eye triggers the alarm every day.

          +
          +
          +
        +
        • Example request
          {
+   "template_name": "alarmTemplate-Test01",
+   "template_description": "Updating a custom alarm template",
+   "namespace": "SYS.ECS",
+   "dimension_name": "instance_id",
+   "template_items": [
+       {
+           "metric_name": "cpu_util",
+           "condition": {
+               "period": 1,
+               "filter": "average",
+               "comparison_operator": ">=",
+               "value": 90,
+               "unit": "%",
+               "count": 3,
+               "suppress_duration": 300
+           },
+           "alarm_level": 2
+       },
+       {
+           "metric_name": "mem_util",
+           "condition": {
+               "period": 1,
+               "filter": "average",
+               "comparison_operator": ">=",
+               "value": 90,
+               "unit": "%",
+               "count": 3,
+               "suppress_duration": 600
+           },
+           "alarm_level": 2
+       }
+   ]
+}
+
          +
        +
        +

        Response

        The response has no message body.

        +
        +

        Returned Values

        • Normal

          204

          +
        • Abnormal +
          + + + + + + + + + + + + + + + + + + + + + + + + + +

          Returned Values

          +

          Description

          +

          400 Bad Request

          +

          Request error.

          +

          401 Unauthorized

          +

          The authentication information is not provided or is incorrect.

          +

          403 Forbidden

          +

          Access to the requested page is forbidden.

          +

          408 Request Timeout

          +

          The request timed out.

          +

          429 Too Many Requests

          +

          Concurrent requests are excessive.

          +

          500 Internal Server Error

          +

          Failed to complete the request because of an internal service error.

          +

          503 Service Unavailable

          +

          The service is currently unavailable.

          +
          +
          +
        +
        +

        Error Codes

        See Error Codes.

        +
        +
        +
        +
        +
        Parent topic: Alarm Rules
        +
        +
        + diff --git a/docs/ces/api-ref/ces_03_0067.html b/docs/ces/api-ref/ces_03_0067.html new file mode 100644 index 000000000..bc12450a1 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0067.html @@ -0,0 +1,24 @@ + + +

        Resource Groups

        +

        +
        + + diff --git a/docs/ces/api-ref/ces_03_0068.html b/docs/ces/api-ref/ces_03_0068.html new file mode 100644 index 000000000..1e817e43f --- /dev/null +++ b/docs/ces/api-ref/ces_03_0068.html @@ -0,0 +1,342 @@ + + +

        Querying Resources in a Resource Group

        +

        Function

        This API is used to query resources in a resource group based on the resource group ID.

        +
        +

        URI

        GET /V1.0/{project_id}/resource-groups/{group_id}

        +
        • Parameter description +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Table 1 Parameter description

          Parameter

          +

          Mandatory

          +

          Description

          +

          project_id

          +

          Yes

          +

          Specifies the project ID.

          +

          For details about how to obtain the project ID, see Obtaining a Project ID.

          +

          Minimum: 1

          +

          Maximum: 64

          +

          Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

          +

          group_id

          +

          Yes

          +

          Specifies the resource group ID.

          +

          status

          +

          No

          +

          Specifies the resource health status. The value can be:

          +
          • health: No alarms have been generated for the resource group.
          • unhealth: An alarm or alarms have been generated for a resource or resources in the resource group.
          • no_alarm_rule: No alarm rules have been set for the resource group.
          +

          namespace

          +

          No

          +

          Specifies the resource namespace. For example, the ECS namespace is SYS.ECS. To view the namespace of each service, see Services Interconnected with Cloud Eye.

          +

          dname

          +

          No

          +

          Specifies the resource dimension. For example, the ECS dimension is instance_id. To view the dimension of each resource, see Services Interconnected with Cloud Eye.

          +

          This parameter must be used together with the namespace parameter.

          +

          start

          +

          No

          +

          Specifies the start value of pagination. The value is an integer. The default value is 0.

          +

          limit

          +

          No

          +

          Specifies the maximum number of records that can be queried at a time. The value range is (0,100] and the default value is 100.

          +
          +
          +
        +
        • Example: Query resources in a resource group.
          GET https://{Cloud Eye endpoint}/V1.0/{project_id}/resource-groups/{group_id}
          +
        +
        +

        Request

        None

        +
        +

        Response

        • Response parameters +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Table 2 Response parameters

          Parameter

          +

          Type

          +

          Description

          +

          group_name

          +

          String

          +

          Specifies the resource group, for example, Resource-Group-ECS-01.

          +

          group_id

          +

          String

          +

          Specifies the resource group ID, for example, rg1603786526428bWbVmk4rP.

          +

          resources

          +

          Array of objects

          +

          Specifies information about one or more resource groups.

          +

          For details, see Table 3.

          +

          status

          +

          String

          +

          Specifies the resource group status, which can be health, unhealth, or no_alarm_rule.

          +
          • health: No alarms have been generated for the resource group.
          • unhealth: An alarm or alarms have been generated for a resource or resources in the resource group.
          • no_alarm_rule: No alarm rules have been set for the resource group.
          +

          create_time

          +

          Long

          +

          Specifies the time when the resource group was created. The value is a UNIX timestamp, in milliseconds. Example: 1603819753000

          +

          meta_data

          +

          MetaData object

          +

          Specifies the metadata of query results, including the pagination information.

          +

          For details, see Table 5.

          +

          enterprise_project_id

          +

          String

          +

          Specifies the enterprise project associated with the resource group. The default value 0 indicates enterprise project default.

          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + + + +
          Table 3 resources data structure description

          Parameter

          +

          Type

          +

          Description

          +

          namespace

          +

          String

          +

          Specifies the resource namespace. For example, the ECS namespace is SYS.ECS. To view the namespace of each service, see Services Interconnected with Cloud Eye.

          +

          dimensions

          +

          Array of objects

          +

          Specifies one or more resource dimensions.

          +

          For details, see Table 4.

          +

          status

          +

          String

          +

          Specifies the resource group status, which can be health, unhealth, or no_alarm_rule.

          +

          health: No alarms have been generated for the resource group.

          +

          unhealth: An alarm or alarms have been generated for a resource or resources in the resource group.

          +

          no_alarm_rule: No alarm rules have been set for the resource group.

          +

          event_type

          +

          Integer

          +

          Specifies the event type. The default value is 0.

          +
          +
          + +
          + + + + + + + + + + + + + +
          Table 4 dimensions data structure description

          Parameter

          +

          Type

          +

          Description

          +

          name

          +

          String

          +

          Specifies the resource dimension. For example, the ECS dimension is instance_id. To view the dimension of each resource, see Services Interconnected with Cloud Eye.

          +

          value

          +

          String

          +

          Specifies the resource dimension value, which is the instance ID. Example: 4270ff17-aba3-4138-89fa-820594c39755

          +
          +
          + +
          + + + + + + + + + + + + + + + + + +
          Table 5 meta_data data structure description

          Parameter

          +

          Type

          +

          Description

          +

          count

          +

          Integer

          +

          Specifies the number of returned results.

          +

          total

          +

          Integer

          +

          Specifies the total number of query results.

          +

          marker

          +

          String

          +

          Specifies the pagination marker.

          +
          +
          +
          • Example response
            {
+ "group_name": "ResourceGroup-Test-01",
+ "resources": [
+   {
+     "namespace": "SYS.ECS",
+     "dimensions": [
+       {
+         "name": "instance_id",
+         "value": "6cffb0bd-fd37-400f-ae6f-8f4be021ff7e"
+       }
+     ],
+     "status": "health",
+     "event_type": 0
+   },
+   {
+     "namespace": "SYS.ECS",
+     "dimensions": [
+       {
+         "name": "instance_id",
+         "value": "e37d6238-9dd3-4720-abcc-eb9f8fb08ca0"
+       }
+     ],
+     "status": "health",
+     "event_type": 0
+   }
+ ],
+ "create_time": 1604476378000,
+ "group_id": "rg16044763786104XvXvl00a",
+ "status": "health",
+ "meta_data": {
+   "count": 0,
+   "marker": "",
+   "total": 2
+ },
+ "enterprise_project_id": "0"
+}
            +
          +
        +
        +

        Returned Values

        • Normal

          200

          +
        • Abnormal +
          + + + + + + + + + + + + + + + + + + + + + + + + + +

          Returned Values

          +

          Description

          +

          400 Bad Request

          +

          Request error.

          +

          401 Unauthorized

          +

          The authentication information is not provided or is incorrect.

          +

          403 Forbidden

          +

          Access to the requested page is forbidden.

          +

          408 Request Timeout

          +

          The request timed out.

          +

          429 Too Many Requests

          +

          Concurrent requests are excessive.

          +

          500 Internal Server Error

          +

          Failed to complete the request because of an internal service error.

          +

          503 Service Unavailable

          +

          The service is currently unavailable.

          +
          +
          +
        +
        +

        Error Codes

        See Error Codes.

        +
        +
        +
        +
        +
        Parent topic: Resource Groups
        +
        +
        + diff --git a/docs/ces/api-ref/ces_03_0069.html b/docs/ces/api-ref/ces_03_0069.html new file mode 100644 index 000000000..55e7515b5 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0069.html @@ -0,0 +1,373 @@ + + +

        Modifying an Alarm Rule

        +

        Function

        This API is used to modify an alarm rule.

        +
        +

        URI

        PUT /V1.0/{project_id}/alarms/{alarm_id}

        +
        • Parameter description +
          + + + + + + + + + + + + + +
          Table 1 Parameter description

          Parameter

          +

          Mandatory

          +

          Description

          +

          project_id

          +

          Yes

          +

          Specifies the project ID.

          +

          For details about how to obtain the project ID, see Obtaining a Project ID.

          +

          Minimum: 1

          +

          Maximum: 64

          +

          Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

          +

          alarm_id

          +

          Yes

          +

          Specifies the alarm rule ID.

          +
          +
          +
        +
        • Example
          PUT https://{Cloud Eye endpoint}/V1.0/{project_id}/alarms/{alarm_id}
          +
        +
        +

        Request

        • Request parameters +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Table 2 Parameter description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          alarm_name

          +

          No

          +

          String

          +

          Specifies the alarm rule name. Only letters, digits, underscores (_), and hyphens (-) are allowed.

          +

          alarm_description

          +

          No

          +

          String

          +

          Provides supplementary information about the alarm rule. Enter 0 to 256 characters.

          +

          condition

          +

          No

          +

          Condition object

          +

          Specifies the alarm policy set in the alarm rule.

          +

          For details, see Table 3.

          +

          alarm_action_enabled

          +

          No

          +

          Boolean

          +

          Specifies whether to enable the action to be triggered by an alarm. The default value is true.

          +
          NOTE:

          If you set alarm_action_enabled to true, you must specify either alarm_actions or ok_actions. If alarm_actions and ok_actions coexist, their notificationList must be the same.

          +
          +

          alarm_level

          +

          No

          +

          Integer

          +

          Specifies the alarm severity, which can be 1, 2 (default), 3 or 4, indicating critical, major, minor, and informational, respectively.

          +

          alarm_type

          +

          No

          +

          String

          +

          Specifies the alarm rule type. The value cannot be changed and must be the same as the alarm type of the current alarm rule.

          +

          alarm_actions

          +

          No

          +

          Array of objects

          +

          Specifies the action to be triggered by an alarm. The structure is as follows: { "type": "notification","notificationList": ["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] }

          +

          Possible values of type are as follows:

          +

          notification: A notification will be sent.

          +

          autoscaling: A scaling action will be triggered.

          +

          For details, see Table 4.

          +

          ok_actions

          +

          No

          +

          Array of objects

          +

          Specifies the action to be triggered after the alarm is cleared.

          +

          For details, see Table 5.

          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Table 3 condition data structure description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          period

          +

          Yes

          +

          Integer

          +

          Specifies how often Cloud Eye aggregates data, which can be

          +
          • 0: Event alarms are triggered immediately.
          • 1: Cloud Eye performs no aggregation and displays raw data.
          +
          • 300: Cloud Eye aggregates data every 5 minutes.
          • 1200: Cloud Eye aggregates data every 20 minutes.
          • 3600: Cloud Eye aggregates data every hour.
          • 14400: Cloud Eye aggregates data every 4 hours.
          • 86400: Cloud Eye aggregates data every 24 hours.
          +

          filter

          +

          Yes

          +

          String

          +

          Specifies the data aggregation method. The value can be:

          +
          • average: average value of metric data within an aggregation period.
          • max: maximum value of metric data in an aggregation period.
          • min: minimum value of metric data within an aggregation period.
          • sum: sum of metric data within an aggregation period.
          • variance: variance value of metric data within an aggregation period.
          +

          comparison_operator

          +

          Yes

          +

          String

          +

          Specifies the alarm threshold operator, which can be >, =, <, >=, <=, or !=.

          +

          value

          +

          Yes

          +

          Double

          +

          Specifies the alarm threshold.

          +

          Supported range: 0 to Number. MAX_VALUE (1.7976931348623157e+108)

          +

          For detailed thresholds, see the value range of each metric in the appendix. For example, you can set ECS cpu_util to 80.

          +

          unit

          +

          No

          +

          String

          +

          Specifies the data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

          +

          Minimum: 0

          +

          Maximum: 32

          +

          count

          +

          Yes

          +

          Integer

          +

          Specifies the number of consecutive occurrence times that the alarm policy was met. Supported range: 1 to 5

          +

          suppress_duration

          +

          No

          +

          Integer

          +

          Specifies the interval for triggering an alarm if the alarm persists. Possible intervals are as follows:

          +

          0: Cloud Eye triggers the alarm only once.

          +

          300: Cloud Eye triggers the alarm every 5 minutes.

          +

          600: Cloud Eye triggers the alarm every 10 minutes.

          +

          900: Cloud Eye triggers the alarm every 15 minutes.

          +

          1800: Cloud Eye triggers the alarm every 30 minutes.

          +

          3600: Cloud Eye triggers the alarm every hour.

          +

          10800: Cloud Eye triggers the alarm every 3 hours.

          +

          21600: Cloud Eye triggers the alarm every 6 hours.

          +

          43200: Cloud Eye triggers the alarm every 12 hours.

          +

          86400: Cloud Eye triggers the alarm every day.

          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 4 alarm_actions data structure description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          type

          +

          Yes

          +

          String

          +
          Specifies the alarm notification type.
          • notification: A notification will be sent.
          • autoscaling: A scaling action will be triggered.
          +
          +

          notificationList

          +

          Yes

          +

          Array of strings

          +

          Specifies the list of objects to be notified of alarm status changes. You can add up to 5 object IDs. You can obtain the topicUrn value from SMN in the following format: urn:smn:([a-z]|[A-Z]|[0-9]|\-){1,32}:([a-z]|[A-Z]|[0-9]){32}:([a-z]|[A-Z]|[0-9]|\-|\_){1,256}.

          +

          If you set type to notification, you must specify notificationList. If you set type to autoscaling, you must set notificationList to [].

          +
          NOTE:
          • To make the AS alarm rules take effect, you must bind scaling policies. For details, see the Auto Scaling API Reference.
          • If you set alarm_action_enabled to true, you must specify either alarm_actions or ok_actions.
          • If alarm_actions and ok_actions coexist, their notificationList must be the same.
          • The IDs in the list are strings.
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 5 ok_actions data structure description

          Parameter

          +

          Mandatory

          +

          Type

          +

          Description

          +

          type

          +

          Yes

          +

          String

          +
          Specifies the notification type when an alarm is triggered.
          • notification: A notification will be sent.
          • autoscaling: A scaling action will be triggered.
          +
          +

          notificationList

          +

          Yes

          +

          Array of objects

          +

          Specifies the list of objects to be notified if the alarm status changes. You can add up to 5 object IDs. You can obtain the topicUrn value from SMN in the following format: urn:smn:([a-z]|[A-Z]|[0-9]|\-){1,32}:([a-z]|[A-Z]|[0-9]){32}:([a-z]|[A-Z]|[0-9]|\-|\_){1,256}.

          +
          NOTE:

          If you set alarm_action_enabled to true, you must specify either alarm_actions or ok_actions.

          +

          If alarm_actions and ok_actions coexist, their notificationList must be the same.

          +
          +
          +
          +
        +
        +
        • Example request
          {
+   "alarm_name": "alarm-update-test01",
+   "alarm_description": "alarm-update-test01",
+   "condition": {
+       "comparison_operator": ">=",
+       "count": 3,
+       "filter": "average",
+       "period": 1,
+       "value": 95
+   },
+   "alarm_action_enabled": false,
+   "alarm_level": 2
+}
          +
        +

        Returned Values

        • Normal

          204

          +
        • Abnormal +
          + + + + + + + + + + + + + + + + + + + + + + + + + +

          Returned Value

          +

          Description

          +

          400 Bad Request

          +

          Request error.

          +

          401 Unauthorized

          +

          The authentication information is not provided or is incorrect.

          +

          403 Forbidden

          +

          Access to the requested page is forbidden.

          +

          408 Request Timeout

          +

          The request timed out.

          +

          429 Too Many Requests

          +

          Concurrent requests are excessive.

          +

          500 Internal Server Error

          +

          Failed to complete the request because of an internal service error.

          +

          503 Service Unavailable

          +

          The service is currently unavailable.

          +
          +
          +
        +
        +

        Error Codes

        See Error Codes.

        +
        +
        +
        +
        +
        Parent topic: Alarm Rules
        +
        +
        + diff --git a/docs/ces/api-ref/ces_03_0070.html b/docs/ces/api-ref/ces_03_0070.html new file mode 100644 index 000000000..354f55f0d --- /dev/null +++ b/docs/ces/api-ref/ces_03_0070.html @@ -0,0 +1,237 @@ + + +

        Creating a Resource Group

        +

        Function

        This API is used to create a resource group. You can use resource groups to manage resources by service, and view monitoring and alarm information by group to ease O&M.

        +
        +

        URI

        POST /V1.0/{project_id}/resource-groups

        +
        • Parameter description +
          + + + + + + + + + + + +
          Table 1 Parameter description

          Parameter

          +

          Type

          +

          Mandatory

          +

          Description

          +

          project_id

          +

          String

          +

          Yes

          +

          Specifies the project ID.

          +

          For details about how to obtain the project ID, see Obtaining a Project ID.

          +

          Minimum: 1

          +

          Maximum: 64

          +

          Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

          +
          +
          +
        • Request example
          POST https://{Cloud Eye endpoint}/V1.0/{project_id}/resource-groups
          +
        +
        +

        Request

        • Request parameters +
          + + + + + + + + + + + + + + + + +
          Table 2 Request parameters

          Parameter

          +

          Type

          +

          Mandatory

          +

          Description

          +

          group_name

          +

          String

          +

          Yes

          +

          Specifies the resource group name. Enter 1 to 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. Example: ResourceGroup-Test01

          +

          resources

          +

          Array of objects

          +

          Yes

          +

          Select one or more resources for the resource group to be created.

          +

          For details, see Table 3.

          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 3 resources data structure description

          Parameter

          +

          Type

          +

          Mandatory

          +

          Description

          +

          namespace

          +

          String

          +

          Yes

          +

          Specifies the resource namespace. For example, the ECS namespace is SYS.ECS. To view the namespace of each service, see Services Interconnected with Cloud Eye.

          +

          dimensions

          +

          Array of objects

          +

          Yes

          +

          Specifies one or more resource dimensions.

          +

          For details, see Table 4.

          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 4 dimensions data structure description

          Parameter

          +

          Type

          +

          Mandatory

          +

          Description

          +

          name

          +

          String

          +

          Yes

          +

          Specifies the resource dimension. For example, the ECS dimension is instance_id. To view the dimension of each resource, see Services Interconnected with Cloud Eye.

          +

          value

          +

          String

          +

          Yes

          +

          Specifies the resource dimension value, which is the instance ID. Example: 4270ff17-aba3-4138-89fa-820594c39755

          +
          +
          +
        +
        +

        Example Requests

        {
+  "group_name" : "Resource-Group-Test01",
+  "resources" : [ {
+    "namespace" : "SYS.ECS",
+    "dimensions" : [ {
+      "name" : "instance_id",
+      "value" : "063a83da-a2b5-4630-ab6b-9b4fcfc261ea"
+    } ]
+  }, {
+    "namespace" : "SYS.ECS",
+    "dimensions" : [ {
+      "name" : "instance_id",
+      "value" : "518ace88-abde-46bf-829b-0d1f0f2fb2e9"
+    } ]
+  } ]
+}
        +
        +

        Response

        • Response parameters +
          + + + + + + + + + +
          Table 5 Response parameters

          Parameter

          +

          Type

          +

          Description

          +

          group_id

          +

          String

          +

          Specifies the resource group ID, for example, rg1603786526428bWbVmk4rP.

          +
          +
          +
        +
        +

        Example Responses

        Status code: 201

        +

        OK

        +
        {
+  "group_id" : "rg1606377637506DmVOENVyL"
+}
        +
        +

        Returned Values

        • Normal

          201

          +
        • Abnormal +
          + + + + + + + + + + + + + + + + + + + + + + + + + +

          Returned Value

          +

          Description

          +

          400 Bad Request

          +

          Request error.

          +

          401 Unauthorized

          +

          The authentication information is not provided or is incorrect.

          +

          403 Forbidden

          +

          Access to the requested page is forbidden.

          +

          408 Request Timeout

          +

          The request timed out.

          +

          429 Too Many Requests

          +

          Concurrent requests are excessive.

          +

          500 Internal Server Error

          +

          Failed to complete the request because of an internal service error.

          +

          503 Service Unavailable

          +

          The service is currently unavailable.

          +
          +
          +
        +
        +

        Error Codes

        See Error Codes.

        +
        +
        +
        +
        +
        Parent topic: Resource Groups
        +
        +
        + diff --git a/docs/ces/api-ref/ces_03_0071.html b/docs/ces/api-ref/ces_03_0071.html new file mode 100644 index 000000000..8db205830 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0071.html @@ -0,0 +1,237 @@ + + +

        Updating a Resource Group

        +

        Function

        This API is used to update a resource group. You can use resource groups to manage resources by service, and view monitoring and alarm information by group to ease O&M.

        +
        +

        URI

        PUT /V1.0/{project_id}/resource-groups/{group_id}

        +
        • Parameter description +
          + + + + + + + + + + + + + + + + +
          Table 1 Parameter description

          Parameter

          +

          Type

          +

          Mandatory

          +

          Description

          +

          project_id

          +

          String

          +

          Yes

          +

          Specifies the project ID.

          +

          For details about how to obtain the project ID, see Obtaining a Project ID.

          +

          Minimum: 1

          +

          Maximum: 64

          +

          Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

          +

          group_id

          +

          String

          +

          Yes

          +

          Specifies the resource group ID.

          +
          +
          +
        • Request example
          PUT https://{Cloud Eye endpoint}/V1.0/{project_id}/resource-groups/{group_id}
          +
        +
        +

        Request

        • Request parameters +
          + + + + + + + + + + + + + + + + +
          Table 2 Request parameters

          Parameter

          +

          Type

          +

          Mandatory

          +

          Description

          +

          group_name

          +

          String

          +

          Yes

          +

          Specifies the resource group name. Enter 1 to 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. Example: ResourceGroup-Test01

          +

          resources

          +

          Array of objects

          +

          No

          +

          Specifies resources in the resource group.

          +

          For details, see Table 3.

          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 3 resources data structure description

          Parameter

          +

          Type

          +

          Mandatory

          +

          Description

          +

          namespace

          +

          String

          +

          Yes

          +

          Specifies the resource namespace. For example, the ECS namespace is SYS.ECS. To view the namespace of each service, see Services Interconnected with Cloud Eye.

          +

          dimensions

          +

          Array of objects

          +

          Yes

          +

          Specifies one or more resource dimensions.

          +

          For details, see Table 4.

          +
          +
          + +
          + + + + + + + + + + + + + + + + +
          Table 4 dimensions data structure description

          Parameter

          +

          Type

          +

          Mandatory

          +

          Description

          +

          name

          +

          String

          +

          Yes

          +

          Specifies the resource dimension. For example, the ECS dimension is instance_id. To view the dimension of each resource, see Services Interconnected with Cloud Eye.

          +

          value

          +

          String

          +

          Yes

          +

          Specifies the resource dimension value, which is the instance ID. Example: 4270ff17-aba3-4138-89fa-820594c39755

          +
          +
          +
        +
        • Example request
          {
+   "group_name": "Resource-Group-Test01",
+   "resources": [
+       {
+           "namespace": "SYS.ECS",
+           "dimensions": [
+               {
+                   "name": "instance_id",
+                   "value": "063a83da-a2b5-4630-ab6b-9b4fcfc261ea"
+               }
+           ]
+       },
+       {
+           "namespace": "SYS.ECS",
+           "dimensions": [
+               {
+                   "name": "instance_id",
+                   "value": "518ace88-abde-46bf-829b-0d1f0f2fb2e9"
+               }
+           ]
+       },
+       {
+           "namespace": "SYS.ECS",
+           "dimensions": [
+               {
+                   "name": "instance_id",
+                   "value": "675006b5-477a-4aab-948c-0aa467de9c68"
+               }
+           ]
+       }
+   ]
+}
          +
        +
        +

        Response

        None

        +
        +

        Returned Values

        • Normal

          204

          +
        • Abnormal +
          + + + + + + + + + + + + + + + + + + + + + + + + + +

          Returned Value

          +

          Description

          +

          400 Bad Request

          +

          Request error.

          +

          401 Unauthorized

          +

          The authentication information is not provided or is incorrect.

          +

          403 Forbidden

          +

          Access to the requested page is forbidden.

          +

          408 Request Timeout

          +

          The request timed out.

          +

          429 Too Many Requests

          +

          Concurrent requests are excessive.

          +

          500 Internal Server Error

          +

          Failed to complete the request because of an internal service error.

          +

          503 Service Unavailable

          +

          The service is currently unavailable.

          +
          +
          +
        +
        +

        Error Codes

        See Error Codes.

        +
        +
        +
        +
        +
        Parent topic: Resource Groups
        +
        +
        + diff --git a/docs/ces/api-ref/ces_03_0072.html b/docs/ces/api-ref/ces_03_0072.html new file mode 100644 index 000000000..d359532db --- /dev/null +++ b/docs/ces/api-ref/ces_03_0072.html @@ -0,0 +1,106 @@ + + +

        Deleting a Resource Group

        +

        Function

        This API is used to delete a resource group.

        +
        +

        URI

        DELETE /V1.0/{project_id}/resource-groups/{group_id}

        +
        • Parameter description +
          + + + + + + + + + + + + + + + + +
          Table 1 Parameter description

          Parameter

          +

          Type

          +

          Mandatory

          +

          Description

          +

          project_id

          +

          String

          +

          Yes

          +

          Specifies the project ID.

          +

          For details about how to obtain the project ID, see Obtaining a Project ID.

          +

          Minimum: 1

          +

          Maximum: 64

          +

          Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

          +

          group_id

          +

          String

          +

          Yes

          +

          Specifies the resource group ID.

          +
          +
          +
        • Request example
          DELETE https://{Cloud Eye endpoint}/V1.0/{project_id}/resource-groups/{group_id}
          +
        +
        +

        Request

        None

        +
        +

        Response

        None

        +
        +

        Returned Value

        • Normal

          204

          +
        • Abnormal +
          + + + + + + + + + + + + + + + + + + + + + + + + + +

          Returned Value

          +

          Description

          +

          400 Bad Request

          +

          Request error.

          +

          401 Unauthorized

          +

          The authentication information is not provided or is incorrect.

          +

          403 Forbidden

          +

          Access to the requested page is forbidden.

          +

          408 Request Timeout

          +

          The request timed out.

          +

          429 Too Many Requests

          +

          Concurrent requests are excessive.

          +

          500 Internal Server Error

          +

          Failed to complete the request because of an internal service error.

          +

          503 Service Unavailable

          +

          The service is currently unavailable.

          +
          +
          +
        +
        +

        Error Codes

        See Error Codes.

        +
        +
        +
        +
        +
        Parent topic: Resource Groups
        +
        +
        + diff --git a/docs/ces/api-ref/ces_03_0073.html b/docs/ces/api-ref/ces_03_0073.html new file mode 100644 index 000000000..72e8e605a --- /dev/null +++ b/docs/ces/api-ref/ces_03_0073.html @@ -0,0 +1,432 @@ + + +

        Query Resource Groups

        +

        Function

        This API is used to query all resource groups you created.

        +
        +

        URI

        GET /V1.0/{project_id}/resource-groups

        +
        • Parameter description +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Table 1 Parameter description

          Parameter

          +

          Type

          +

          Mandatory

          +

          Description

          +

          project_id

          +

          String

          +

          Yes

          +

          Specifies the project ID.

          +

          For details about how to obtain the project ID, see Obtaining a Project ID.

          +

          Minimum: 1

          +

          Maximum: 64

          +

          Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

          +

          group_name

          +

          String

          +

          No

          +

          Specifies the resource group, for example, Resource-Group-ECS-01.

          +

          group_id

          +

          String

          +

          No

          +

          Specifies the resource group ID, for example, rg1603786526428bWbVmk4rP.

          +

          status

          +

          String

          +

          No

          +

          Specifies the resource group status, which can be health, unhealth, or no_alarm_rule.

          +
          • health: No alarms have been generated for the resource group.
          • unhealth: An alarm or alarms have been generated for a resource or resources in the resource group.
          • no_alarm_rule: No alarm rules have been set for the resource group.
          +

          start

          +

          Integer

          +

          No

          +

          Specifies the start value of pagination. The value is an integer. The default value is 0.

          +

          limit

          +

          Integer

          +

          No

          +

          Specifies the maximum number of records that can be queried at a time. Supported range: 1 to 100 (default)

          +
          +
          +
        +
        • Example
          GET https://{Cloud Eye endpoint}/V1.0/{project_id}/resource-groups
          +
        +
        +

        Request

        None

        +
        +

        Response

        • Response parameters +
          + + + + + + + + + + + + + + + + +
          Table 2 Response parameters

          Parameter

          +

          Type

          +

          Mandatory

          +

          Description

          +

          resource_groups

          +

          Array of objects

          +

          No

          +

          Specifies information about one or more resource groups.

          +

          For details, see Table 3.

          +

          meta_data

          +

          MetaData object

          +

          No

          +

          Specifies the number of metadata records in the query result.

          +

          For details, see Table 5.

          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Table 3 resource_groups data structure description

          Parameter

          +

          Type

          +

          Mandatory

          +

          Description

          +

          group_name

          +

          String

          +

          No

          +

          Specifies the resource group name, for example, ResourceGroup-Test01.

          +

          group_id

          +

          String

          +

          No

          +

          Specifies the resource group ID, for example, rg1603786526428bWbVmk4rP.

          +

          create_time

          +

          Long

          +

          No

          +

          Specifies the time when the resource group was created. The value is a UNIX timestamp, in milliseconds. Example: 1603819753000

          +

          relation_ids

          +

          Array of strings

          +

          No

          +

          Specifies the enterprise project IDs.

          +

          type

          +

          String

          +

          No

          +

          Specifies the method of adding or matching resources to a resource group.

          +

          The value can be:

          +

          EPS: matching resources by enterprise project.

          +

          TAG: matching resources by tag.

          +

          NAME: matching resources by instance name.

          +

          COMB: matching resources by multiple criteria.

          +

          Manual: add resources manually.

          +

          If the response parameter is empty, resources are manually added.

          +

          Minimum length: 0 character

          +

          Maximum length: 32 characters

          +

          resources

          +

          Array of Resource objects

          +

          No

          +

          Specifies information about one or more resources.

          +

          Array length: 0 to 20

          +

          instance_statistics

          +

          InstanceStatistics object

          +

          No

          +

          Specifies the resource statistics in the resource group.

          +

          For details, see Table 4.

          +

          status

          +

          String

          +

          No

          +

          Specifies the resource group status, which can be health, unhealth, or no_alarm_rule.

          +
          • health: No alarms have been generated for the resource group.
          • unhealth: An alarm or alarms have been generated for a resource or resources in the resource group.
          • no_alarm_rule: No alarm rules have been set for the resource group.
          +

          enterprise_project_id

          +

          String

          +

          No

          +

          Specifies the enterprise project associated with the resource group. The default value 0 indicates enterprise project default.

          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + + + +
          Table 4 instance_statistics data structure description

          Parameter

          +

          Type

          +

          Mandatory

          +

          Description

          +

          unhealth

          +

          Integer

          +

          No

          +

          Specifies the number of resources in the Alarm state in the resource group.

          +

          total

          +

          Integer

          +

          No

          +

          Specifies the total number of resources in the resource group.

          +

          type_statistics

          +

          Integer

          +

          No

          +

          Specifies the total number of resource types in the resource group. For example, if ECS, EIP and bandwidth are added to the resource group, the type_statistics value is 2.

          +
          +
          + +
          + + + + + + + + + + + +
          Table 5 meta_data data structure description

          Parameter

          +

          Type

          +

          Mandatory

          +

          Description

          +

          total

          +

          Integer

          +

          No

          +

          Specifies the total number of query results.

          +
          +
          +
          • Example response
            {
+  "resource_groups": [
+   {
+     "group_name": "ResourceGroup-Test01",
+     "create_time": 1606374365000,
+     "group_id": "rg16063743652226ew93e64p",
+     "relation_ids": ["0"],
+     "instance_statistics": {
+       "unhealth": 2,
+       "total": 10,
+       "type_statistics": 1
+     },
+     "status": "unhealth",
+     "enterprise_project_id": "0",
+     "type": "TAG",
+     "resources": []
+   },
+   {
+     "group_name": "RS",
+     "create_time": 1606327955000,
+     "group_id": "rg1606327955657LRj1lrE4y",
+     "relation_ids": ["0"],
+     "instance_statistics": {
+       "unhealth": 0,
+       "total": 2,
+       "type_statistics": 1
+     },
+     "status": "no_alarm_rule",
+     "enterprise_project_id": "0",
+     "type": "TAG",
+     "resources": []
+   },
+   {
+     "group_name": "RS",
+     "create_time": 1606327947000,
+     "group_id": "rg1606327947514v9OWqAD3N",
+     "relation_ids": ["0"],
+     "instance_statistics": {
+       "unhealth": 0,
+       "total": 2,
+       "type_statistics": 1
+     },
+     "status": "no_alarm_rule",
+     "enterprise_project_id": "0",
+     "type": "TAG",
+     "resources": []
+   },
+   {
+     "group_name": "RS",
+     "create_time": 1606327946000,
+     "group_id": "rg1606327946625PYogr059N",
+     "relation_ids": ["0"],
+     "instance_statistics": {
+       "unhealth": 0,
+       "total": 2,
+       "type_statistics": 1
+     },
+     "status": "no_alarm_rule",
+     "enterprise_project_id": "0",
+     "type": "TAG",
+     "resources": []
+   },
+   {
+     "group_name": "ResourceGroupCorrect_2",
+     "create_time": 1606325669000,
+     "group_id": "rg1606325669900Rk4eKkLMZ",
+     "relation_ids": ["0"],
+     "instance_statistics": {
+       "unhealth": 0,
+       "total": 1,
+       "type_statistics": 1
+     },
+     "status": "no_alarm_rule",
+     "enterprise_project_id": "0",
+     "type": "TAG",
+     "resources": []
+   }
+ ],
+ "meta_data": {
+   "total": 5
+ }
+}
            +
          +
        +
        +

        Returned Values

        • Normal

          200

          +
        • Abnormal +
          + + + + + + + + + + + + + + + + + + + + + + + + + +

          Returned Value

          +

          Description

          +

          400 Bad Request

          +

          Request error.

          +

          401 Unauthorized

          +

          The authentication information is not provided or is incorrect.

          +

          403 Forbidden

          +

          Access to the requested page is forbidden.

          +

          408 Request Timeout

          +

          The request timed out.

          +

          429 Too Many Requests

          +

          Concurrent requests are excessive.

          +

          500 Internal Server Error

          +

          Failed to complete the request because of an internal service error.

          +

          503 Service Unavailable

          +

          The service is currently unavailable.

          +
          +
          +
        +
        +

        Error Codes

        See Error Codes.

        +
        +
        +
        +
        +
        Parent topic: Resource Groups
        +
        +
        + diff --git a/docs/ces/api-ref/ces_03_0074.html b/docs/ces/api-ref/ces_03_0074.html index 26764de8a..344d482bb 100644 --- a/docs/ces/api-ref/ces_03_0074.html +++ b/docs/ces/api-ref/ces_03_0074.html @@ -21,8 +21,11 @@

        Yes

        Specifies the project ID.

        -

        For details about how to obtain the project ID, see Obtaining a Project ID.

        +

        Specifies the project ID.

        +

        For details about how to obtain the project ID, see Obtaining a Project ID.

        +

        Minimum: 1

        +

        Maximum: 64

        +

        Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

        event_type

        @@ -31,7 +34,7 @@

        No

        Specifies the event type. Possible types are EVENT.SYS (system event) and EVENT.CUSTOM (custom event).

        +

        Specifies the event type. The value can be EVENT.SYS (system event) or EVENT.CUSTOM (custom event).

        event_name

        @@ -49,7 +52,9 @@

        No

        Specifies the start time of the query. The time is a UNIX timestamp and the unit is ms. Example: 1605952700911

        +

        Specifies the start time of the query. The value is a UNIX timestamp in milliseconds, for example, 1605952700911. A timestamp shorter than 13 digits is not recommended.

        +

        Maximum: 13

        +

        Minimum: 1

        to

        @@ -58,7 +63,11 @@

        No

        Specifies the end time of the query. The time is a UNIX timestamp and the unit is ms. from must be smaller than to. For example, set to to 1606557500911.

        +

        Specifies the end time of the query. The value is a UNIX timestamp in milliseconds. from must be earlier than to, for example, 1606557500911. A timestamp shorter than 13 digits is not recommended.

        +

        Maximum: 13

        +

        Minimum: 1

        +
        NOTE:

        If the format of the from and to parameters is incorrect, the monitoring data of the last day is displayed.

        +

        start

        @@ -67,7 +76,7 @@

        No

        Specifies the start value of pagination. The value is an integer. The default value is 0.

        +

        Specifies the pagination start value. The value is an integer. Specifies the page number. Its value is no less than 0. The default value is 0.

        limit

        @@ -166,7 +175,7 @@

        No

        Specifies when the event last occurred.

        +

        Specifies when the event occurred. The value is a UNIX timestamp, in milliseconds.

        latest_event_source

        @@ -175,7 +184,7 @@

        No

        If the event is a system event, the source is the namespace of each service. To view the namespace of each service, see Services Interconnected with Cloud Eye.

        +

        Specifies the event source. If the event is a system event, the source is the namespace of each service. To view the namespace of each service, see Services Interconnected with Cloud Eye.

        If the event is a custom event, the event source is defined by the user.

        Yes

        Specifies the project ID.

        -

        For details about how to obtain the project ID, see Obtaining a Project ID.

        +

        Specifies the project ID.

        +

        For details about how to obtain the project ID, see Obtaining a Project ID.

        +

        Minimum: 1

        +

        Maximum: 64

        +

        Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

        event_name

        @@ -49,7 +52,7 @@

        No

        Specifies the event name. The name can be a system event name or a custom event name.

        +

        Specifies the event source. If the event is a system event, the source is the namespace of each service. To view the namespace of each service, see Services Interconnected with Cloud Eye. If the event is a custom event, the event source is defined by the user.

        event_level

        @@ -85,7 +88,7 @@

        No

        Specifies the start time of the query. The time is a UNIX timestamp and the unit is ms. Example: 1605952700911

        +

        Specifies the start time of the query. The value is a UNIX timestamp, in milliseconds. Example: 1605952700911

        to

        @@ -94,7 +97,7 @@

        No

        Specifies the end time of the query. The time is a UNIX timestamp and the unit is ms. The from value must be smaller than the to value.

        +

        Specifies the end time of the query. The value is a UNIX timestamp, in milliseconds. The from value must be smaller than the to value.

        start

        @@ -168,7 +171,7 @@

        No

        Specifies the event source. For a system event, the source is the namespace of each service. To view the namespace of each service, see Services Interconnected with Cloud Eye. If the event is a custom event, the event source is defined by the user.

        +

        Specifies the event source. If the event is a system event, the source is the namespace of each service. To view the namespace of each service, see Services Interconnected with Cloud Eye. If the event is a custom event, the event source is defined by the user.

        event_info

        @@ -229,7 +232,9 @@

        Yes

        Specifies when the event occurred, which is a UNIX timestamp (ms). Since there is a latency between the client and the server, the data timestamp to be inserted should be within the period that starts from one hour before the current time plus 20s to 10 minutes after the current time minus 20s. In this way, the timestamp will be inserted to the database without being affected by the latency.

        +

        Specifies the time when the event occurred. The value is a UNIX timestamp, in milliseconds.

        +
        NOTE:

        Since there is a latency between the client and the server, the timestamp when data was inserted must be within the time range [Current time – 1h + 20s, Current time + 10 mins – 20s]. In this way, the data will be inserted to the database without being affected by the latency.

        +

        detail

        @@ -370,7 +375,7 @@

        No

        Specifies the dimension. For example, the ECS dimension is instance_id. For details about the dimension of each service, see the key column in Services Interconnected with Cloud Eye.

        +

        Specifies the monitoring dimension name. For example, the ECS dimension is instance_id. For details about the dimension of each monitored object, see the documentation of a specific cloud service. You can navigate there directly from the Services Interconnected with Cloud Eye page.

        value

        @@ -380,7 +385,7 @@

        No

        Specifies the dimension value, for example, an ECS ID.

        -

        Enter 1 to 256 characters.

        +

        The value contains 1 to 256 characters.

        Yes

        Specifies the project ID.

        -

        For details about how to obtain the project ID, see Obtaining a Project ID.

        +

        Specifies the project ID.

        +

        For details about how to obtain the project ID, see Obtaining a Project ID.

        +

        Minimum: 1

        +

        Maximum: 64

        +

        Regular expression matching: ^[a-zA-Z0-9-]{1,64}$

        Long

        Specifies when the data was collected.

        -

        The time is UNIX timestamp (ms) format.

        -
        NOTE:

        Since there is a latency between the client and the server, the data timestamp to be inserted should be within the period that starts from three days before the current time plus 20s to 10 minutes after the current time minus 20s. In this way, the timestamp will be inserted to the database without being affected by the latency.

        +

        The value is a UNIX timestamp, in milliseconds.

        +
        NOTE:

        Since there is a latency between the client and the server, the timestamp when data was inserted must be within the time range [Current time – 3d + 20s, Current time + 10 mins – 20s]. In this way, the data will be inserted to the database without being affected by the latency.

        String

        Specifies the data unit.

        -

        Enter a maximum of 32 characters.

        +

        Specifies the data unit. The value can contain a maximum of 32 characters. You can set this parameter based on your service needs.

        +

        Minimum: 0

        +

        Maximum: 32

        type

        @@ -123,7 +127,7 @@

        String

        Specifies the enumerated type.

        -

        Possible types:

        +

        The value can be:

        • int
        • float

        String

        Specifies the dimension. For example, the ECS dimension is instance_id. For details about the dimension of each service, see the key column in Services Interconnected with Cloud Eye.

        -

        Start with a letter. Enter 1 to 32 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

        +

        Specifies the monitoring dimension name. For example, the ECS dimension is instance_id. For details about the dimension of each monitored object, see the documentation of a specific cloud service. You can navigate there directly from the Services Interconnected with Cloud Eye page.

        +

        The value must start with a letter. It allows 1 to 32 characters and can only contain letters, digits, underscores (_), and hyphens (-).

        value

        @@ -202,14 +206,14 @@

        String

        Specifies the dimension value, for example, an ECS ID.

        -

        Start with a letter or a digit. Enter 1 to 256 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

        +

        The value must start with a letter or digit. It allows 1 to 256 characters and can only contain letters, digits, underscores (_), and hyphens (-).
        -
        • Example request
          Example request 1: Add cpu_util data of a custom dimension. The instance ID is 6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d.
          [
+
          • Example requests
            Example request 1: Add cpu_util data of a custom dimension. The instance ID is 6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d.
            [
     {
         "metric": {
             "namespace": "MINE.APP",
@@ -251,7 +255,7 @@
         "metric": {
             "namespace": "SYS.RDS",
             "dimensions": [
-                {
+    {
                     "name": "rds_cluster_id",
                     "value": "3c8cc15614ab46f5b8743317555e0de2in01"
                 }
@@ -318,7 +322,7 @@
          -

          Error Codes

          See Error Codes.

          +

          Error Codes

          See Error Codes.

          diff --git a/docs/ces/api-ref/en-us_topic_0109034020.html b/docs/ces/api-ref/en-us_topic_0109034020.html index 979d83a32..d8af393c9 100644 --- a/docs/ces/api-ref/en-us_topic_0109034020.html +++ b/docs/ces/api-ref/en-us_topic_0109034020.html @@ -5,20 +5,27 @@

          URI

          POST /V1.0/{project_id}/events