diff --git a/docs/aom/api-ref/ALL_META.TXT.json b/docs/aom/api-ref/ALL_META.TXT.json index 68113a8d..f4ee5a6c 100644 --- a/docs/aom/api-ref/ALL_META.TXT.json +++ b/docs/aom/api-ref/ALL_META.TXT.json @@ -1,181 +1,688 @@ [ { - "uri":"aom_04_0000.html", + "dockw":"API Reference" + }, + { + "uri":"en-us_topic_0000001409488734.html", + "node_id":"en-us_topic_0000001409488734.xml", "product_code":"aom", "code":"1", "des":"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 ", "doc_type":"api", "kw":"API Usage Guidelines,API Reference", + "search_title":"", + "metedata":[ + { + "IsBot":"Yes", + "prodname":"aom", + "documenttype":"api", + "opensource":"true", + "IsMulti":"Yes" + } + ], "title":"API Usage Guidelines", "githuburl":"" }, { - "uri":"aom_04_1010.html", + "uri":"aom_04_0010.html", + "node_id":"aom_04_0010.xml", "product_code":"aom", "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":"APIs", - "title":"APIs", + "kw":"API", + "search_title":"", + "metedata":[ + { + "IsBot":"Yes", + "prodname":"aom", + "documenttype":"api", + "opensource":"true", + "IsMulti":"Yes" + } + ], + "title":"API", "githuburl":"" }, { - "uri":"aom_04_1045.html", - "product_code":"aom", + "uri":"aom_04_0045.html", + "node_id":"aom_04_0045.xml", + "product_code":"", "code":"3", "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 APIs", - "title":"Monitoring APIs", + "kw":"Monitoring", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Monitoring", "githuburl":"" }, { - "uri":"aom_04_1011.html", - "product_code":"aom", + "uri":"ListSeries.html", + "node_id":"listseries.xml", + "product_code":"", "code":"4", - "des":"This API is used to query the metrics that can be monitored in the system. You can specify the namespace, metric name, dimension, resource ID (format: resType_resId), sta", + "des":"This API is used to query the time series objects that can be monitored in the system. You can specify a namespace, name, dimension, and resource ID (format: resType_resI", "doc_type":"api", - "kw":"Querying Metrics,Monitoring APIs,API Reference", + "kw":"Querying Time Series Objects,Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListSeries" + } + ], + "title":"Querying Time Series Objects", + "githuburl":"" + }, + { + "uri":"ListSample.html", + "node_id":"listsample.xml", + "product_code":"", + "code":"5", + "des":"This API is used to query time series data within a specified time period. You can specify a dimension or period to query.POST /v2/{project_id}/samplesStatus code: 200Sta", + "doc_type":"api", + "kw":"Querying Time Series Data,Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListSample" + } + ], + "title":"Querying Time Series Data", + "githuburl":"" + }, + { + "uri":"ListMetricItems.html", + "node_id":"listmetricitems.xml", + "product_code":"", + "code":"6", + "des":"This API is used to query the metrics that can be monitored in the system. You can query specific metrics by specifying a namespace, metric name, dimension, and resource ", + "doc_type":"api", + "kw":"Querying Metrics,Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListMetricItems" + } + ], "title":"Querying Metrics", "githuburl":"" }, { - "uri":"aom_04_1012.html", - "product_code":"aom", - "code":"5", - "des":"This API is used to query monitoring data of metrics within a specified time period. You can specify a dimension or period to query data.POST /v2/{project_id}/ams/metricd", + "uri":"ShowMetricsData.html", + "node_id":"showmetricsdata.xml", + "product_code":"", + "code":"7", + "des":"This API is used to query monitoring data of metrics within a specified time period. You can specify a dimension or period to query.POST /v1/{project_id}/ams/metricdataSt", "doc_type":"api", - "kw":"Querying Monitoring Data,Monitoring APIs,API Reference", + "kw":"Querying Monitoring Data,Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowMetricsData" + } + ], "title":"Querying Monitoring Data", "githuburl":"" }, { - "uri":"aom_04_1013.html", - "product_code":"aom", - "code":"6", - "des":"This API is used to add one or more monitoring data records to a server.POST /v2/{project_id}/ams/report/metricdataTable 1 describes the parameters.Request parametersTabl", + "uri":"aom_04_0013.html", + "node_id":"aom_04_0013.xml", + "product_code":"", + "code":"8", + "des":"This API is used to add one or more monitoring data records to a server.POST /v1/{project_id}/ams/report/metricdataStatus code: 200Add a piece of monitoring data to the s", "doc_type":"api", - "kw":"Adding Monitoring Data,Monitoring APIs,API Reference", + "kw":"Adding Monitoring Data,Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"AddMetricData" + } + ], "title":"Adding Monitoring Data", "githuburl":"" }, { - "uri":"aom_04_1014.html", - "product_code":"aom", - "code":"7", - "des":"This API is used to add a threshold rule.POST /v2/{project_id}/ams/alarmsRequest parametersTable 1 describes the request parameters.Request headersTable 2 describes the r", + "uri":"AddOrUpdateServiceDiscoveryRules.html", + "node_id":"addorupdateservicediscoveryrules.xml", + "product_code":"", + "code":"9", + "des":"This API is used to add or modify one or more service discovery rules. A maximum of 100 rules can be added to a project.PUT /v1/{project_id}/inv/servicediscoveryrulesStat", "doc_type":"api", - "kw":"Adding a Threshold Rule,Monitoring APIs,API Reference", + "kw":"Adding or Modifying One or More Service Discovery Rules,Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"AddOrUpdateServiceDiscoveryRules" + } + ], + "title":"Adding or Modifying One or More Service Discovery Rules", + "githuburl":"" + }, + { + "uri":"DeleteserviceDiscoveryRules.html", + "node_id":"deleteservicediscoveryrules.xml", + "product_code":"", + "code":"10", + "des":"This API is used to delete a service discovery rule.DELETE /v1/{project_id}/inv/servicediscoveryrulesStatus code: 200Delete a service discovery rule with a specified ID.S", + "doc_type":"api", + "kw":"Deleting a Service Discovery Rule,Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"DeleteserviceDiscoveryRules" + } + ], + "title":"Deleting a Service Discovery Rule", + "githuburl":"" + }, + { + "uri":"ListServiceDiscoveryRules.html", + "node_id":"listservicediscoveryrules.xml", + "product_code":"", + "code":"11", + "des":"This API is used to query existing service discovery rules in the system.GET /v1/{project_id}/inv/servicediscoveryrulesStatus code: 200Query the application discovery rul", + "doc_type":"api", + "kw":"Querying Existing Service Discovery Rules,Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListServiceDiscoveryRules" + } + ], + "title":"Querying Existing Service Discovery Rules", + "githuburl":"" + }, + { + "uri":"AddAlarmRule.html", + "node_id":"addalarmrule.xml", + "product_code":"", + "code":"12", + "des":"This API is used to add a threshold rule.POST /v2/{project_id}/alarm-rulesStatus code: 200Status code: 400Add a threshold rule whose name is testaom, alarm severity is 3,", + "doc_type":"api", + "kw":"Adding a Threshold Rule,Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"AddAlarmRule" + } + ], "title":"Adding a Threshold Rule", "githuburl":"" }, { - "uri":"aom_04_1019.html", - "product_code":"aom", - "code":"8", - "des":"This API is used to modify a threshold rule.PUT /v2/{project_id}/ams/alarmsRequest parametersTable 1 describes the request parameters.Request headersTable 2 describes the", + "uri":"ListAlarmRule.html", + "node_id":"listalarmrule.xml", + "product_code":"", + "code":"13", + "des":"This API is used to query the threshold rule list.GET /v2/{project_id}/alarm-rulesStatus code: 200Status code: 400Obtain the alarm rule list of a user whose ID is Project", "doc_type":"api", - "kw":"Modifying a Threshold Rule,Monitoring APIs,API Reference", + "kw":"Querying the Threshold Rule List,Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListAlarmRule" + } + ], + "title":"Querying the Threshold Rule List", + "githuburl":"" + }, + { + "uri":"UpdateAlarmRule.html", + "node_id":"updatealarmrule.xml", + "product_code":"", + "code":"14", + "des":"This API is used to modify a threshold rule.PUT /v2/{project_id}/alarm-rulesStatus code: 200Status code: 400Modify a threshold rule whose name is testaom, alarm severity ", + "doc_type":"api", + "kw":"Modifying a Threshold Rule,Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"UpdateAlarmRule" + } + ], "title":"Modifying a Threshold Rule", "githuburl":"" }, { - "uri":"aom_04_1015.html", - "product_code":"aom", - "code":"9", - "des":"This API is used to query a threshold rule list.GET /v2/{project_id}/ams/alarmsRequest parametersTable 1 describes the request parameters.Request headersTable 2 describes", + "uri":"DeleteAlarmRule.html", + "node_id":"deletealarmrule.xml", + "product_code":"", + "code":"15", + "des":"This API is used to delete a threshold rule.DELETE /v2/{project_id}/alarm-rules/{alarm_rule_id}Status code: 400Delete a threshold rule.Status code: 400Bad Request: The re", "doc_type":"api", - "kw":"Querying a Threshold Rule List,Monitoring APIs,API Reference", - "title":"Querying a Threshold Rule List", - "githuburl":"" - }, - { - "uri":"aom_04_1016.html", - "product_code":"aom", - "code":"10", - "des":"This API is used to query a threshold rule.GET /v2/{project_id}/ams/alarms/{alarm_id}Request parametersTable 1 describes the request parameters.Request headersTable 2 des", - "doc_type":"api", - "kw":"Querying a Threshold Rule,Monitoring APIs,API Reference", - "title":"Querying a Threshold Rule", - "githuburl":"" - }, - { - "uri":"aom_04_1017.html", - "product_code":"aom", - "code":"11", - "des":"This API is used to delete a threshold rule.DELETE /v2/{project_id}/ams/alarms/{alarm_id}Request parametersTable 1 describes the request parameters.Request headersTable 2", - "doc_type":"api", - "kw":"Deleting a Threshold Rule,Monitoring APIs,API Reference", + "kw":"Deleting a Threshold Rule,Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"DeleteAlarmRule" + } + ], "title":"Deleting a Threshold Rule", "githuburl":"" }, { - "uri":"aom_04_1047.html", - "product_code":"aom", - "code":"12", - "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.", + "uri":"ShowAlarmRule.html", + "node_id":"showalarmrule.xml", + "product_code":"", + "code":"16", + "des":"This API is used to query a threshold rule.GET /v2/{project_id}/alarm-rules/{alarm_rule_id}Status code: 200Status code: 400Obtain the details about the alarm rule whose I", "doc_type":"api", - "kw":"Log APIs", - "title":"Log APIs", + "kw":"Querying a Threshold Rule,Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ShowAlarmRule" + } + ], + "title":"Querying a Threshold Rule", "githuburl":"" }, { - "uri":"aom_04_1034.html", - "product_code":"aom", - "code":"13", - "des":"This API is used to query logs by different dimensions such as cluster, IP address, or application.POST /v2/{project_id}/als/action?type=querylogsTable 1 describes the p", + "uri":"DeleteAlarmRules.html", + "node_id":"deletealarmrules.xml", + "product_code":"", + "code":"17", + "des":"This API is used to delete threshold rules in batches.POST /v2/{project_id}/alarm-rules/deleteStatus code: 400Delete threshold rules in batches by rule name.Status code: ", "doc_type":"api", - "kw":"Querying Logs,Log APIs,API Reference", + "kw":"Deleting Threshold Rules in Batches,Monitoring,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"DeleteAlarmRules" + } + ], + "title":"Deleting Threshold Rules in Batches", + "githuburl":"" + }, + { + "uri":"aom_04_0047.html", + "node_id":"aom_04_0047.xml", + "product_code":"", + "code":"18", + "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":"Log", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Log", + "githuburl":"" + }, + { + "uri":"ListLogItems.html", + "node_id":"listlogitems.xml", + "product_code":"", + "code":"19", + "des":"This API is used to query logs by different dimensions, such as by cluster, IP address, or application. Pagination queries are supported.POST /v1/{project_id}/als/actionS", + "doc_type":"api", + "kw":"Querying Logs,Log,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListLogItems" + } + ], "title":"Querying Logs", "githuburl":"" }, { - "uri":"aom_04_0066.html", + "uri":"aom_04_0079.html", + "node_id":"aom_04_0079.xml", + "product_code":"", + "code":"20", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api" + } + ], + "title":"Alarm", + "githuburl":"" + }, + { + "uri":"ListEvents.html", + "node_id":"listevents.xml", + "product_code":"", + "code":"21", + "des":"This API is used to query events and alarms of a user.POST /v2/{project_id}/eventsStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 500Status c", + "doc_type":"api", + "kw":"Querying Events and Alarms,Alarm,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"ListEvents" + } + ], + "title":"Querying Events and Alarms", + "githuburl":"" + }, + { + "uri":"CountEvents.html", + "node_id":"countevents.xml", + "product_code":"", + "code":"22", + "des":"This API is used to count events and alarms that meet specified conditions.POST /v2/{project_id}/events/statisticStatus code: 200Status code: 400Status code: 401Status co", + "doc_type":"api", + "kw":"Counting Events and Alarms,Alarm,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"CountEvents" + } + ], + "title":"Counting Events and Alarms", + "githuburl":"" + }, + { + "uri":"PushEvents.html", + "node_id":"pushevents.xml", + "product_code":"", + "code":"23", + "des":"This API is used to report events and alarms of a user.PUT /v2/{project_id}/push/eventsNoneReport an alarm named \"test\".NoneSee Error Codes.", + "doc_type":"api", + "kw":"Reporting Events and Alarms,Alarm,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api", + "operation_id":"PushEvents" + } + ], + "title":"Reporting Events and Alarms", + "githuburl":"" + }, + { + "uri":"aom_04_0061.html", + "node_id":"aom_04_0061.xml", "product_code":"aom", - "code":"14", + "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":"Permissions Policies and Supported Actions", + "search_title":"", + "metedata":[ + { + "IsBot":"Yes", + "prodname":"aom", + "documenttype":"api", + "opensource":"true", + "IsMulti":"Yes" + } + ], + "title":"Permissions Policies and Supported Actions", + "githuburl":"" + }, + { + "uri":"aom_04_0022.html", + "node_id":"aom_04_0022.xml", + "product_code":"aom", + "code":"25", + "des":"This section describes fine-grained permissions management for AOM. If your cloud account does not need individual IAM users, then you may skip over this section.By defau", + "doc_type":"api", + "kw":"Introduction,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "IsBot":"Yes", + "prodname":"aom", + "documenttype":"api", + "opensource":"true", + "IsMulti":"Yes" + } + ], + "title":"Introduction", + "githuburl":"" + }, + { + "uri":"aom_04_0062.html", + "node_id":"aom_04_0062.xml", + "product_code":"aom", + "code":"26", + "des":"√: supported; x: not supported", + "doc_type":"api", + "kw":"Monitoring Actions,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "IsBot":"Yes", + "prodname":"aom", + "documenttype":"api", + "opensource":"true", + "IsMulti":"Yes" + } + ], + "title":"Monitoring Actions", + "githuburl":"" + }, + { + "uri":"aom_04_0064.html", + "node_id":"aom_04_0064.xml", + "product_code":"aom", + "code":"27", + "des":"√: supported; x: not supported", + "doc_type":"api", + "kw":"Log Actions,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "IsBot":"Yes", + "prodname":"aom", + "documenttype":"api", + "opensource":"true", + "IsMulti":"Yes" + } + ], + "title":"Log Actions", + "githuburl":"" + }, + { + "uri":"aom_04_0065.html", + "node_id":"aom_04_0065.xml", + "product_code":"aom", + "code":"28", + "des":"√: supported; x: not supported", + "doc_type":"api", + "kw":"Alarm Actions,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "IsBot":"Yes", + "prodname":"aom", + "documenttype":"api", + "opensource":"true", + "IsMulti":"Yes" + } + ], + "title":"Alarm Actions", + "githuburl":"" + }, + { + "uri":"aom_04_0066.html", + "node_id":"aom_04_0066.xml", + "product_code":"aom", + "code":"29", "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", + "search_title":"", + "metedata":[ + { + "IsBot":"Yes", + "prodname":"aom", + "documenttype":"api", + "opensource":"true", + "IsMulti":"Yes" + } + ], "title":"Appendix", "githuburl":"" }, { "uri":"aom_04_0018.html", + "node_id":"aom_04_0018.xml", "product_code":"aom", - "code":"15", - "des":"Table 1 describes the status codes.", + "code":"30", + "des":"Table 1 describes status codes.", "doc_type":"api", "kw":"Status Codes,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "IsBot":"Yes", + "prodname":"aom", + "documenttype":"api", + "opensource":"true", + "IsMulti":"Yes" + } + ], "title":"Status Codes", "githuburl":"" }, { - "uri":"aom_04_0008.html", + "uri":"ErrorCode.html", + "node_id":"errorcode_1.xml", + "product_code":"", + "code":"31", + "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":"Error Codes,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "opensource":"true", + "documenttype":"api" + } + ], + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000001409328750.html", + "node_id":"en-us_topic_0000001409328750.xml", "product_code":"aom", - "code":"16", + "code":"32", + "des":"When making API calls, you may need to enter the username, user ID, project name, and project ID in some URIs. You can obtain them on the My Credentials page.", + "doc_type":"api", + "kw":"Obtaining an Account ID and Project ID,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "IsBot":"Yes", + "prodname":"aom", + "documenttype":"api", + "opensource":"true", + "IsMulti":"Yes" + } + ], + "title":"Obtaining an Account ID and Project ID", + "githuburl":"" + }, + { + "uri":"aom_04_0008.html", + "node_id":"aom_04_0008.xml", + "product_code":"aom", + "code":"33", "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 Request Headers,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "IsBot":"Yes", + "prodname":"aom", + "documenttype":"api", + "opensource":"true", + "IsMulti":"Yes" + } + ], "title":"Common Request Headers", "githuburl":"" }, { "uri":"aom_04_0009.html", + "node_id":"aom_04_0009.xml", "product_code":"aom", - "code":"17", + "code":"34", "des":"A response usually contains the following headers:", "doc_type":"api", "kw":"Common Response Headers,Appendix,API Reference", + "search_title":"", + "metedata":[ + { + "IsBot":"Yes", + "prodname":"aom", + "documenttype":"api", + "opensource":"true", + "IsMulti":"Yes" + } + ], "title":"Common Response Headers", "githuburl":"" }, { "uri":"aom_04_0020.html", + "node_id":"aom_04_0020.xml", "product_code":"aom", - "code":"18", + "code":"35", "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", + "search_title":"", + "metedata":[ + { + "IsBot":"Yes", + "prodname":"aom", + "documenttype":"api", + "opensource":"true", + "IsMulti":"Yes" + } + ], "title":"Change History", "githuburl":"" } diff --git a/docs/aom/api-ref/AddAlarmRule.html b/docs/aom/api-ref/AddAlarmRule.html new file mode 100644 index 00000000..f33cb73c --- /dev/null +++ b/docs/aom/api-ref/AddAlarmRule.html @@ -0,0 +1,458 @@ + + +

Adding a Threshold Rule

+

Function

This API is used to add a threshold rule.

+
+

URI

POST /v2/{project_id}/alarm-rules

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token obtained from IAM.

+

Content-Type

+

Yes

+

String

+

Content type, which is application/json.

+

Enumeration values:

+

  • application/json

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

Parameter

+

Mandatory

+

Type

+

Description

+

action_enabled

+

No

+

Boolean

+

Whether to enable notification.

+

alarm_actions

+

No

+

Array of strings

+

List of alarm notifications.

+

alarm_advice

+

No

+

String

+

Alarm clearance suggestion.

+

Minimum: 0

+

Maximum: 255

+

alarm_description

+

No

+

String

+

Threshold rule description.

+

Minimum: 0

+

Maximum: 1024

+

alarm_level

+

Yes

+

Integer

+

Alarm severity. Values: 1 (critical), 2 (major), 3 (minor), and 4 (warning).

+

Enumeration values:

+

  • 1

    +

  • 2

    +

  • 3

    +

  • 4

    +
+

alarm_rule_name

+

Yes

+

String

+

Threshold rule name. Enter a maximum of 100 characters and do not start or end with a special character. Only letters, digits, underscores (_), and hyphens (-) are allowed.

+

comparison_operator

+

Yes

+

String

+

Comparison operator. Options: <: less than the threshold; >: greater than the threshold; <=: less than or equal to the threshold; >=: greater than or equal to the threshold.

+

Enumeration values:

+

  • <

    +

  • >

    +

  • <=

    +

  • >=

    +
+

dimensions

+

Yes

+

Array of Dimension objects

+

List of time series dimensions.

+

evaluation_periods

+

Yes

+

Integer

+

Interval.

+

Minimum: 1

+

Maximum: 5

+

id_turn_on

+

No

+

Boolean

+

Whether to enable the threshold rule.

+

insufficient_data_actions

+

No

+

Array of strings

+

List of insufficient data notifications.

+

metric_name

+

Yes

+

String

+

Time series name. Length: 1 to 255 characters.

+

namespace

+

Yes

+

String

+

Time series objects' namespace.

+

ok_actions

+

No

+

Array of strings

+

List of normal status notifications.

+

period

+

Yes

+

Integer

+

Statistical period. Options: 60000: one minute; 300000: five minutes; 900000: 15 minutes; 3600000: one hour.

+

Enumeration values:

+

  • 60000

    +

  • 300000

    +

  • 900000

    +

  • 36000000

    +
+

statistic

+

Yes

+

String

+

Statistic.

+

Enumeration values:

+

  • maximum

    +

  • minimum

    +

  • average

    +

  • sum

    +

  • sampleCount

    +
+

threshold

+

Yes

+

String

+

Threshold value.

+

unit

+

Yes

+

String

+

Time series unit.

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

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Dimension name.

+

value

+

Yes

+

String

+

Dimension value.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

alarm_rule_id

+

Long

+

Threshold rule ID.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+

error_type

+

String

+

Error type.

+

trace_id

+

String

+

Trace ID, which is used to search for logs and locate faults. If 2xx is returned, trace_id is empty. If 4xx, trace_id is not empty.

+
+
+
+

Example Requests

Add a threshold rule whose name is testaom, alarm severity is 3, namespace is PAAS.CONTAINER, and statistical mode is average.

+
https://{Endpoint}/v2/{project_id}/alarm-rules
+
+{
+  "id_turn_on" : true,
+  "action_enabled" : false,
+  "alarm_actions" : [ ],
+  "alarm_advice" : "",
+  "alarm_description" : "",
+  "alarm_level" : 3,
+  "alarm_rule_name" : "aom_rule",
+  "comparison_operator" : ">=",
+  "dimensions" : [ {
+    "name" : "appName",
+    "value" : "rhm-broker"
+  } ],
+  "evaluation_periods" : 1,
+  "insufficient_data_actions" : [ ],
+  "metric_name" : "cpuCoreLimit",
+  "namespace" : "PAAS.CONTAINER",
+  "ok_actions" : [ ],
+  "period" : 60000,
+  "statistic" : "average",
+  "threshold" : 0,
+  "unit" : "Core"
+}
+
+

Example Responses

Status code: 200

+

OK: The request is successful.

+
{
+  "alarm_rule_id" : 1134050083814244400
+}
+

Status code: 400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+
{
+  "error_code" : "AOM.02001AOM.02001SVCSTG_AMS_4000115",
+  "error_msg" : "Invalid request parameter",
+  "error_type" : "BAD_REQUEST",
+  "trace_id" : ""
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK: The request is successful.

+

400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+

401

+

Unauthorized: The authentication information is incorrect or invalid.

+

403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+

500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+

503

+

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Monitoring
+
+
+ diff --git a/docs/aom/api-ref/AddOrUpdateServiceDiscoveryRules.html b/docs/aom/api-ref/AddOrUpdateServiceDiscoveryRules.html new file mode 100644 index 00000000..075d15ac --- /dev/null +++ b/docs/aom/api-ref/AddOrUpdateServiceDiscoveryRules.html @@ -0,0 +1,639 @@ + + +

Adding or Modifying One or More Service Discovery Rules

+

Function

This API is used to add or modify one or more service discovery rules. A maximum of 100 rules can be added to a project.

+
+

URI

PUT /v1/{project_id}/inv/servicediscoveryrules

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token obtained from IAM.

+

Content-Type

+

Yes

+

String

+

Content type, which is application/json.

+

Enumeration values:

+

  • application/json

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

Parameter

+

Mandatory

+

Type

+

Description

+

appRules

+

No

+

Array of AppRules objects

+

Service parameters.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 AppRules

Parameter

+

Mandatory

+

Type

+

Description

+

createTime

+

No

+

String

+

Creation time. When creating a service discovery rule, leave this parameter blank. When modifying a service discovery rule, enter the returned createTime.

+

Default: 1599098476654

+

enable

+

Yes

+

Boolean

+

Whether a rule is enabled. Values: true and false.

+

eventName

+

Yes

+

String

+

aom_inventory_rules_event Rule event name. For service discovery, the fixed value is aom_inventory_rules_event.

+

hostid

+

No

+

Array of strings

+

Host ID. Currently, this parameter is not used and can be left blank.

+

id

+

Yes

+

String

+

Rule ID. When creating a service discovery rule, leave this parameter blank. When modifying a service discovery rule, enter a rule ID.

+

name

+

Yes

+

String

+

Rule name, which contains a maximum of 64 characters. It must start with a lowercase letter but cannot end with a hyphen (-). Only digits, lowercase letters, and hyphens are allowed.

+

projectid

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+

spec

+

Yes

+

AppRulesSpec object

+

Rule details.

+

desc

+

No

+

String

+

Custom description

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 AppRulesSpec

Parameter

+

Mandatory

+

Type

+

Description

+

appType

+

Yes

+

String

+

Service type, which is used only for rule classification and UI display. You can enter any field. For example, enter Java or Python by technology stack, or enter collector or database by function.

+

attrList

+

No

+

Array of strings

+

Attribute list. Currently, this parameter is not used and can be left blank. Values: cmdLine and env.

+

detectLog

+

Yes

+

String

+

Whether to enable log collection. Values: true and false.

+

discoveryRule

+

Yes

+

Array of DiscoveryRule objects

+

Discovery rule. If the array contains multiple conditions, only the processes that meet all the conditions will be matched. If the value of checkType is cmdLine, set the value of checkMode to contain. checkContent is in the format of ["xxx"], indicating that the process must contain the xxx parameter. If the value of checkType is env, set the value of checkMode to contain. checkContent is in the format of ["k1","v1"], indicating that the process must contain the environment variable whose name is k1 and value is v1. If the value of checkType is scope, set the value of checkMode to equals. checkContent is in the format of ["hostId1","hostId2"], indicating that the rule takes effect only on specified nodes. If no nodes are specified, the rule applies to all nodes of the project.

+

isDefaultRule

+

Yes

+

String

+

Whether the rule is the default one. Values: true and false.

+

isDetect

+

Yes

+

String

+

Whether the scenario is a pre-check scenario. No rules will be saved in the pre-check scenario. This scenario is designed only to check whether a rule can detect node processes before it is delivered. Values: true and false.

+

logFileFix

+

Yes

+

Array of strings

+

Log file suffix. Values: log, trace, and out.

+

logPathRule

+

No

+

Array of LogPathRule objects

+

Log path configuration rule. If cmdLineHash is a fixed string, logs in the specified log path or log file are collected. Otherwise, only the files whose names end with .log or .trace are collected. If the value of nameType is cmdLineHash, args is in the format of ["00001"] and value is in the format of ["/xxx/xx.log"], indicating that the log path is /xxx/xx.log when the startup command is 00001.

+

nameRule

+

Yes

+

NameRule object

+

Naming rules for discovered services and applications.

+

priority

+

Yes

+

Integer

+

Rule priority. Value range: 1 to 9999. Default value: 9999.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 DiscoveryRule

Parameter

+

Mandatory

+

Type

+

Description

+

checkContent

+

Yes

+

Array of strings

+

Matched value.

+

checkMode

+

Yes

+

String

+

Match condition. Values: contain and equals.

+

checkType

+

Yes

+

String

+

Match type. Values: cmdLine, env, and scope.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 7 LogPathRule

Parameter

+

Mandatory

+

Type

+

Description

+

args

+

Yes

+

Array of strings

+

Command.

+

nameType

+

Yes

+

String

+

Value type, which can be cmdLineHash.

+

value

+

Yes

+

Array of strings

+

Log path.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 8 NameRule

Parameter

+

Mandatory

+

Type

+

Description

+

appNameRule

+

Yes

+

Array of AppNameRule objects

+

Service name rule. If there are multiple objects in the array, the character strings extracted from these objects constitute the service name. If the value of nameType is cmdLine, args is in the format of ["start", "end"], indicating that the characters between start and end in the command are extracted.If the value of nameType is cmdLine, args is in the format of ["aa"], indicating that the environment variable named aa is extracted.If the value of nameType is str, args is in the format of ["fix"], indicating that the service name is suffixed with fix.If the value of nameType is cmdLineHash, args is in the format of ["0001"] and value is in the format of ["ser"], indicating that the service name is ser when the startup command is 0001.

+

applicationNameRule

+

Yes

+

Array of ApplicationNameRule objects

+

Application name rule.If the value of nameType is cmdLine, args is in the format of ["start", "end"], indicating that the characters between start and end in the command are extracted.If the value of nameType is cmdLine, args is in the format of ["aa"], indicating that the environment variable named aa is extracted.If the value of nameType is str, args is in the format of ["fix"], indicating that the service name is suffixed with fix.If the value of nameType is cmdLineHash, args is in the format of ["0001"] and value is in the format of ["ser"], indicating that the application name is ser when the startup command is 0001.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 9 AppNameRule

Parameter

+

Mandatory

+

Type

+

Description

+

nameType

+

Yes

+

String

+

Value type. Values: cmdLineHash, cmdLine, env, and str.

+

args

+

Yes

+

Array of strings

+

Input value.

+

value

+

No

+

Array of strings

+

Service name, which is mandatory only when the value of nameType is cmdLineHash.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 10 ApplicationNameRule

Parameter

+

Mandatory

+

Type

+

Description

+

nameType

+

Yes

+

String

+

Value type. Values: cmdLineHash, cmdLine, env, and str.

+

args

+

Yes

+

Array of strings

+

Input value.

+

value

+

No

+

Array of strings

+

Service name, which is mandatory only when the value of nameType is cmdLineHash.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

errorCode

+

String

+

Response code.

+

errorMessage

+

String

+

Response message.

+

responseStatus

+

Integer

+

Response status code.

+
+
+
+

Example Requests

Add an application discovery rule whose name is aom_inventory_rules_event and project ID is 684fc87a79d7xxxx22e62a7da95b.

+
https://{endpoint}/v1/{project_id}/inv/servicediscoveryrules
+
+{
+  "appRules" : [ {
+    "createTime" : "1694705766730",
+    "enable" : true,
+    "name" : "ica**nt",
+    "eventName" : "aom_inventory_rules_event",
+    "hostid" : [ ],
+    "id" : "b53a5152-****-****-****-302367e04c0b",
+    "projectid" : "684fc87a79d7xxxx22e62a7da95b",
+    "spec" : {
+      "detectLog" : "true",
+      "editable" : null,
+      "logPathRule" : [ ],
+      "priority" : 9999,
+      "attrList" : [ "cmdLine" ],
+      "nameRule" : {
+        "appNameRule" : [ {
+          "args" : [ "/opt/********* -DNFW=ica**nt" ],
+          "nameType" : "cmdLineHash",
+          "value" : [ "aicagentserver" ]
+        } ],
+        "applicationNameRule" : [ {
+          "args" : [ "/opt/*********** -DNFW=ica**nt" ],
+          "nameType" : "cmdLineHash",
+          "value" : [ "aica**nt" ]
+        } ]
+      },
+      "appType" : "",
+      "aom_metric_relabel_configs" : null,
+      "logFileFix" : [ "log", "trace", "out" ],
+      "isDetect" : "false",
+      "isDefaultRule" : null,
+      "dataSource" : null,
+      "discoveryRule" : [ {
+        "checkType" : "cmdLine",
+        "checkContent" : [ "-DNFW=ica**nt" ],
+        "checkMode" : "contain"
+      } ]
+    },
+    "desc" : "Custom description"
+  } ],
+  "errorMessage" : null,
+  "errorCode" : "SVCSTG.INV.2000000",
+  "id" : [ ]
+}
+
+

Example Responses

Status code: 200

+

OK: The request is successful.

+
{
+  "errorCode" : "SVCSTG.INV.2000000",
+  "errorMessage" : null,
+  "id" : [ ],
+  "results" : [ {
+    "name" : "aom_inventory_rules_event",
+    "id" : "b53a5152-****-****-****-302367e04c0b"
+  } ]
+}
+

Status code: 400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+
{
+  "errorCode" : "SVCSTG.INV.4000115",
+  "errorMessage" : "Request param is invalid",
+  "id" : [ ],
+  "results" : [ ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK: The request is successful.

+

400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+

401

+

Unauthorized: The authentication information is incorrect or invalid.

+

403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+

500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+

503

+

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Monitoring
+
+
+ diff --git a/docs/aom/api-ref/CLASS.TXT.json b/docs/aom/api-ref/CLASS.TXT.json index e6b6c043..49a103bb 100644 --- a/docs/aom/api-ref/CLASS.TXT.json +++ b/docs/aom/api-ref/CLASS.TXT.json @@ -3,7 +3,7 @@ "desc":"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 ", "product_code":"aom", "title":"API Usage Guidelines", - "uri":"aom_04_0000.html", + "uri":"en-us_topic_0000001409488734.html", "doc_type":"api", "p_code":"", "code":"1" @@ -11,8 +11,8 @@ { "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":"aom", - "title":"APIs", - "uri":"aom_04_1010.html", + "title":"API", + "uri":"aom_04_0010.html", "doc_type":"api", "p_code":"", "code":"2" @@ -20,101 +20,236 @@ { "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":"aom", - "title":"Monitoring APIs", - "uri":"aom_04_1045.html", + "title":"Monitoring", + "uri":"aom_04_0045.html", "doc_type":"api", "p_code":"2", "code":"3" }, { - "desc":"This API is used to query the metrics that can be monitored in the system. You can specify the namespace, metric name, dimension, resource ID (format: resType_resId), sta", + "desc":"This API is used to query the time series objects that can be monitored in the system. You can specify a namespace, name, dimension, and resource ID (format: resType_resI", "product_code":"aom", - "title":"Querying Metrics", - "uri":"aom_04_1011.html", + "title":"Querying Time Series Objects", + "uri":"ListSeries.html", "doc_type":"api", "p_code":"3", "code":"4" }, { - "desc":"This API is used to query monitoring data of metrics within a specified time period. You can specify a dimension or period to query data.POST /v2/{project_id}/ams/metricd", + "desc":"This API is used to query time series data within a specified time period. You can specify a dimension or period to query.POST /v2/{project_id}/samplesStatus code: 200Sta", "product_code":"aom", - "title":"Querying Monitoring Data", - "uri":"aom_04_1012.html", + "title":"Querying Time Series Data", + "uri":"ListSample.html", "doc_type":"api", "p_code":"3", "code":"5" }, { - "desc":"This API is used to add one or more monitoring data records to a server.POST /v2/{project_id}/ams/report/metricdataTable 1 describes the parameters.Request parametersTabl", + "desc":"This API is used to query the metrics that can be monitored in the system. You can query specific metrics by specifying a namespace, metric name, dimension, and resource ", "product_code":"aom", - "title":"Adding Monitoring Data", - "uri":"aom_04_1013.html", + "title":"Querying Metrics", + "uri":"ListMetricItems.html", "doc_type":"api", "p_code":"3", "code":"6" }, { - "desc":"This API is used to add a threshold rule.POST /v2/{project_id}/ams/alarmsRequest parametersTable 1 describes the request parameters.Request headersTable 2 describes the r", + "desc":"This API is used to query monitoring data of metrics within a specified time period. You can specify a dimension or period to query.POST /v1/{project_id}/ams/metricdataSt", "product_code":"aom", - "title":"Adding a Threshold Rule", - "uri":"aom_04_1014.html", + "title":"Querying Monitoring Data", + "uri":"ShowMetricsData.html", "doc_type":"api", "p_code":"3", "code":"7" }, { - "desc":"This API is used to modify a threshold rule.PUT /v2/{project_id}/ams/alarmsRequest parametersTable 1 describes the request parameters.Request headersTable 2 describes the", + "desc":"This API is used to add one or more monitoring data records to a server.POST /v1/{project_id}/ams/report/metricdataStatus code: 200Add a piece of monitoring data to the s", "product_code":"aom", - "title":"Modifying a Threshold Rule", - "uri":"aom_04_1019.html", + "title":"Adding Monitoring Data", + "uri":"aom_04_0013.html", "doc_type":"api", "p_code":"3", "code":"8" }, { - "desc":"This API is used to query a threshold rule list.GET /v2/{project_id}/ams/alarmsRequest parametersTable 1 describes the request parameters.Request headersTable 2 describes", + "desc":"This API is used to add or modify one or more service discovery rules. A maximum of 100 rules can be added to a project.PUT /v1/{project_id}/inv/servicediscoveryrulesStat", "product_code":"aom", - "title":"Querying a Threshold Rule List", - "uri":"aom_04_1015.html", + "title":"Adding or Modifying One or More Service Discovery Rules", + "uri":"AddOrUpdateServiceDiscoveryRules.html", "doc_type":"api", "p_code":"3", "code":"9" }, { - "desc":"This API is used to query a threshold rule.GET /v2/{project_id}/ams/alarms/{alarm_id}Request parametersTable 1 describes the request parameters.Request headersTable 2 des", + "desc":"This API is used to delete a service discovery rule.DELETE /v1/{project_id}/inv/servicediscoveryrulesStatus code: 200Delete a service discovery rule with a specified ID.S", "product_code":"aom", - "title":"Querying a Threshold Rule", - "uri":"aom_04_1016.html", + "title":"Deleting a Service Discovery Rule", + "uri":"DeleteserviceDiscoveryRules.html", "doc_type":"api", "p_code":"3", "code":"10" }, { - "desc":"This API is used to delete a threshold rule.DELETE /v2/{project_id}/ams/alarms/{alarm_id}Request parametersTable 1 describes the request parameters.Request headersTable 2", + "desc":"This API is used to query existing service discovery rules in the system.GET /v1/{project_id}/inv/servicediscoveryrulesStatus code: 200Query the application discovery rul", "product_code":"aom", - "title":"Deleting a Threshold Rule", - "uri":"aom_04_1017.html", + "title":"Querying Existing Service Discovery Rules", + "uri":"ListServiceDiscoveryRules.html", "doc_type":"api", "p_code":"3", "code":"11" }, { - "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":"This API is used to add a threshold rule.POST /v2/{project_id}/alarm-rulesStatus code: 200Status code: 400Add a threshold rule whose name is testaom, alarm severity is 3,", "product_code":"aom", - "title":"Log APIs", - "uri":"aom_04_1047.html", + "title":"Adding a Threshold Rule", + "uri":"AddAlarmRule.html", "doc_type":"api", - "p_code":"2", + "p_code":"3", "code":"12" }, { - "desc":"This API is used to query logs by different dimensions such as cluster, IP address, or application.POST /v2/{project_id}/als/action?type=querylogsTable 1 describes the p", + "desc":"This API is used to query the threshold rule list.GET /v2/{project_id}/alarm-rulesStatus code: 200Status code: 400Obtain the alarm rule list of a user whose ID is Project", + "product_code":"aom", + "title":"Querying the Threshold Rule List", + "uri":"ListAlarmRule.html", + "doc_type":"api", + "p_code":"3", + "code":"13" + }, + { + "desc":"This API is used to modify a threshold rule.PUT /v2/{project_id}/alarm-rulesStatus code: 200Status code: 400Modify a threshold rule whose name is testaom, alarm severity ", + "product_code":"aom", + "title":"Modifying a Threshold Rule", + "uri":"UpdateAlarmRule.html", + "doc_type":"api", + "p_code":"3", + "code":"14" + }, + { + "desc":"This API is used to delete a threshold rule.DELETE /v2/{project_id}/alarm-rules/{alarm_rule_id}Status code: 400Delete a threshold rule.Status code: 400Bad Request: The re", + "product_code":"aom", + "title":"Deleting a Threshold Rule", + "uri":"DeleteAlarmRule.html", + "doc_type":"api", + "p_code":"3", + "code":"15" + }, + { + "desc":"This API is used to query a threshold rule.GET /v2/{project_id}/alarm-rules/{alarm_rule_id}Status code: 200Status code: 400Obtain the details about the alarm rule whose I", + "product_code":"aom", + "title":"Querying a Threshold Rule", + "uri":"ShowAlarmRule.html", + "doc_type":"api", + "p_code":"3", + "code":"16" + }, + { + "desc":"This API is used to delete threshold rules in batches.POST /v2/{project_id}/alarm-rules/deleteStatus code: 400Delete threshold rules in batches by rule name.Status code: ", + "product_code":"aom", + "title":"Deleting Threshold Rules in Batches", + "uri":"DeleteAlarmRules.html", + "doc_type":"api", + "p_code":"3", + "code":"17" + }, + { + "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":"aom", + "title":"Log", + "uri":"aom_04_0047.html", + "doc_type":"api", + "p_code":"2", + "code":"18" + }, + { + "desc":"This API is used to query logs by different dimensions, such as by cluster, IP address, or application. Pagination queries are supported.POST /v1/{project_id}/als/actionS", "product_code":"aom", "title":"Querying Logs", - "uri":"aom_04_1034.html", + "uri":"ListLogItems.html", "doc_type":"api", - "p_code":"12", - "code":"13" + "p_code":"18", + "code":"19" + }, + { + "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":"aom", + "title":"Alarm", + "uri":"aom_04_0079.html", + "doc_type":"api", + "p_code":"2", + "code":"20" + }, + { + "desc":"This API is used to query events and alarms of a user.POST /v2/{project_id}/eventsStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 500Status c", + "product_code":"aom", + "title":"Querying Events and Alarms", + "uri":"ListEvents.html", + "doc_type":"api", + "p_code":"20", + "code":"21" + }, + { + "desc":"This API is used to count events and alarms that meet specified conditions.POST /v2/{project_id}/events/statisticStatus code: 200Status code: 400Status code: 401Status co", + "product_code":"aom", + "title":"Counting Events and Alarms", + "uri":"CountEvents.html", + "doc_type":"api", + "p_code":"20", + "code":"22" + }, + { + "desc":"This API is used to report events and alarms of a user.PUT /v2/{project_id}/push/eventsNoneReport an alarm named \"test\".NoneSee Error Codes.", + "product_code":"aom", + "title":"Reporting Events and Alarms", + "uri":"PushEvents.html", + "doc_type":"api", + "p_code":"20", + "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.", + "product_code":"aom", + "title":"Permissions Policies and Supported Actions", + "uri":"aom_04_0061.html", + "doc_type":"api", + "p_code":"", + "code":"24" + }, + { + "desc":"This section describes fine-grained permissions management for AOM. If your cloud account does not need individual IAM users, then you may skip over this section.By defau", + "product_code":"aom", + "title":"Introduction", + "uri":"aom_04_0022.html", + "doc_type":"api", + "p_code":"24", + "code":"25" + }, + { + "desc":"√: supported; x: not supported", + "product_code":"aom", + "title":"Monitoring Actions", + "uri":"aom_04_0062.html", + "doc_type":"api", + "p_code":"24", + "code":"26" + }, + { + "desc":"√: supported; x: not supported", + "product_code":"aom", + "title":"Log Actions", + "uri":"aom_04_0064.html", + "doc_type":"api", + "p_code":"24", + "code":"27" + }, + { + "desc":"√: supported; x: not supported", + "product_code":"aom", + "title":"Alarm Actions", + "uri":"aom_04_0065.html", + "doc_type":"api", + "p_code":"24", + "code":"28" }, { "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.", @@ -123,16 +258,34 @@ "uri":"aom_04_0066.html", "doc_type":"api", "p_code":"", - "code":"14" + "code":"29" }, { - "desc":"Table 1 describes the status codes.", + "desc":"Table 1 describes status codes.", "product_code":"aom", "title":"Status Codes", "uri":"aom_04_0018.html", "doc_type":"api", - "p_code":"14", - "code":"15" + "p_code":"29", + "code":"30" + }, + { + "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":"aom", + "title":"Error Codes", + "uri":"ErrorCode.html", + "doc_type":"api", + "p_code":"29", + "code":"31" + }, + { + "desc":"When making API calls, you may need to enter the username, user ID, project name, and project ID in some URIs. You can obtain them on the My Credentials page.", + "product_code":"aom", + "title":"Obtaining an Account ID and Project ID", + "uri":"en-us_topic_0000001409328750.html", + "doc_type":"api", + "p_code":"29", + "code":"32" }, { "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.", @@ -140,8 +293,8 @@ "title":"Common Request Headers", "uri":"aom_04_0008.html", "doc_type":"api", - "p_code":"14", - "code":"16" + "p_code":"29", + "code":"33" }, { "desc":"A response usually contains the following headers:", @@ -149,8 +302,8 @@ "title":"Common Response Headers", "uri":"aom_04_0009.html", "doc_type":"api", - "p_code":"14", - "code":"17" + "p_code":"29", + "code":"34" }, { "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.", @@ -159,6 +312,6 @@ "uri":"aom_04_0020.html", "doc_type":"api", "p_code":"", - "code":"18" + "code":"35" } ] \ No newline at end of file diff --git a/docs/aom/api-ref/CountEvents.html b/docs/aom/api-ref/CountEvents.html new file mode 100644 index 00000000..5b40fa3e --- /dev/null +++ b/docs/aom/api-ref/CountEvents.html @@ -0,0 +1,591 @@ + + +

Counting Events and Alarms

+

Function

This API is used to count events and alarms that meet specified conditions.

+
+

URI

POST /v2/{project_id}/events/statistic

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

No

+

String

+

Type of information to be queried. active_alert: Active alarms are to be queried. history_alert: Historical alarms are to be queried. If this parameter is not transferred or other values are transferred, information that meets the specified search criteria will be returned.

+

Enumeration values:

+

  • history_alert

    +

  • active_alert

    +
+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token obtained from IAM.

+

Content-Type

+

Yes

+

String

+

Content type, which is application/json.

+

Enumeration values:

+

  • application/json

    +
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

time_range

+

Yes

+

String

+

Time range specified to query data of the last N minutes when the client time is inconsistent with the server time. It can also be used to accurately query the data of a specified period.

+

Example:

+

  • -1.-1.60: indicates that the data of the latest 60 minutes is queried. This query is based on the server time regardless of the current client time.

    +

  • 1650852000000.1650852300000.5: indicates the five minutes from 10:00:00 to 10:05:00 on April 25, 2022 GMT+08:00.

    +
+

Format:

+

startTimeInMillis.endTimeInMillis.durationInMinutes

+

Parameter description:

+

  • startTimeInMillis: Start time of the query, in milliseconds. If this parameter is set to -1, the server calculates the start time as follows: endTimeInMillis – durationInMinutes x 60 x 1000. For example, -1.1650852300000.5 is equivalent to 1650852000000.1650852300000.5.

    +

  • endTimeInMillis: End time of the query, in milliseconds. If this parameter is set to -1, the server calculates the end time as follows: startTimeInMillis + durationInMinutes x 60 x 1000. If the calculated end time is later than the current system time, the current system time is used. For example, 1650852000000.-1.5 is equivalent to 1650852000000.1650852300000.5.

    +

  • durationInMinutes: Time span, in minutes. The value must be greater than 0 and greater than or equal to the result of "(endTimeInMillis – startTimeInMillis)/(60 x 1000) – 1". If both the start time and end time are set to -1, the system sets the end time to the current UTC time (in milliseconds) and calculates the start time as follows: endTimeInMillis – durationInMinutes x 60 x 1000. For example, -1.-1.60 indicates the latest 60 minutes.

    +
+

Constraint:

+

In a single request, the following condition must be met: durationInMinutes x 60/period ≤ 1440

+

step

+

Yes

+

Long

+

Statistical step (unit: ms). For example, if the statistical step is one minute, set this parameter to 60,000.

+

search

+

No

+

String

+

Field specified for fuzzy query, which can be left blank. If this field is not left blank, the system will return metadata's mandatory fields that are fuzzily matched.

+

sort

+

No

+

sort object

+

Sorting order, which can be left blank.

+

metadata_relation

+

No

+

Array of RelationModel objects

+

Combination of search criteria, which can be left blank.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 sort

Parameter

+

Mandatory

+

Type

+

Description

+

order_by

+

No

+

Array of strings

+

List of sorted fields. Fields in this list are sorted based on the specified order.

+

order

+

No

+

String

+

Sorting order. asc: ascending order. desc: descending order.

+

Enumeration values:

+

  • asc

    +

  • desc

    +
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 RelationModel

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Key specified for query, which corresponds to the key in the metadata.

+

value

+

No

+

Array of strings

+

Value of the specified key in the search criterion.

+

relation

+

No

+

String

+

Relationship between search criteria. Values: AND: All criteria must be met. OR: One of the criteria needs to be met. NOT: None of the criteria can be met.

+

Enumeration values:

+

  • AND

    +

  • OR

    +

  • NOT

    +
+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

step

+

Long

+

Statistical step (unit: ms). For example, if the statistical step is one minute, set this parameter to 60,000.

+

timestamps

+

Array of longs

+

Time series object corresponding to the statistical result.

+

series

+

Array of EventSeries objects

+

Statistical results of a time series object's different severities of events or alarms.

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 EventSeries

Parameter

+

Type

+

Description

+

event_severity

+

String

+

Enumerated values of event or alarm severities.

+

Enumeration values:

+

  • Critical

    +

  • Major

    +

  • Minor

    +

  • Info

    +
+

values

+

Array of integers

+

Event or alarm statistical result.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Response code.

+

error_msg

+

String

+

Error description.

+

error_type

+

String

+

API call failure type.

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Response code.

+

error_msg

+

String

+

Error description.

+

error_type

+

String

+

API call failure type.

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Response code.

+

error_msg

+

String

+

Error description.

+

error_type

+

String

+

API call failure type.

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Response code.

+

error_msg

+

String

+

Error description.

+

error_type

+

String

+

API call failure type.

+
+
+

Status code: 503

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Response code.

+

error_msg

+

String

+

Error description.

+

error_type

+

String

+

API call failure type.

+
+
+
+

Example Requests

Query the events and alarms on the step basis in a specified time range.

+
https://{endpoint}/v2/{project_id}/events/statistic
+
+{
+  "time_range" : "-1.-1.5",
+  "step" : 60000
+}
+
+

Example Responses

Status code: 200

+

OK: The request is successful.

+
{
+  "series" : [ {
+    "event_severity" : "Minor",
+    "values" : [ 0, 0, 0, 0, 0, 0 ]
+  }, {
+    "event_severity" : "Info",
+    "values" : [ 0, 0, 0, 0, 0, 0 ]
+  } ],
+  "step" : 60000,
+  "timestamps" : [ 1642820700000, 1642820760000, 1642820820000, 1642820880000, 1642820940000, 1642821000000 ]
+}
+

Status code: 400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+
{
+  "error_code" : "AOM.0400",
+  "error_message" : "param error",
+  "error_type" : "SC_BAD_REQUEST"
+}
+

Status code: 401

+

Unauthorized: The authentication information is incorrect or invalid.

+
{
+  "error_code" : "AOM.0401",
+  "error_message" : "you dont have permission",
+  "error_type" : "SC_UNAUTHORIZED"
+}
+

Status code: 403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+
{
+  "error_code" : "AOM.0403",
+  "error_message" : "you dont have permission",
+  "error_type" : "SC_FORBIDDEN"
+}
+

Status code: 500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+
{
+  "error_code" : "AOM.0500",
+  "error_message" : "SC_INTERNAL_SERVER_ERROR",
+  "error_type" : "SC_INTERNAL_SERVER_ERROR"
+}
+

Status code: 503

+

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

+
{
+  "error_code" : "AOM.0503",
+  "error_message" : "SC_NOT_IMPLEMENTED",
+  "error_type" : "SC_NOT_IMPLEMENTED"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK: The request is successful.

+

400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+

401

+

Unauthorized: The authentication information is incorrect or invalid.

+

403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+

500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+

503

+

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm
+
+
+ diff --git a/docs/aom/api-ref/DeleteAlarmRule.html b/docs/aom/api-ref/DeleteAlarmRule.html new file mode 100644 index 00000000..a6693b78 --- /dev/null +++ b/docs/aom/api-ref/DeleteAlarmRule.html @@ -0,0 +1,179 @@ + + +

Deleting a Threshold Rule

+

Function

This API is used to delete a threshold rule.

+
+

URI

DELETE /v2/{project_id}/alarm-rules/{alarm_rule_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+

alarm_rule_id

+

Yes

+

String

+

Threshold rule ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token obtained from IAM.

+

Content-Type

+

Yes

+

String

+

Content type, which is application/json.

+

Enumeration values:

+

  • application/json

    +
+
+
+
+

Response Parameters

Status code: 400

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+

error_type

+

String

+

Error type.

+

trace_id

+

String

+

Trace ID, which is used to search for logs and locate faults. If 2xx is returned, trace_id is empty. If 4xx, trace_id is not empty.

+
+
+
+

Example Requests

Delete a threshold rule.

+
https://{Endpoint}/v2/{project_id}/alarm-rules/{alarm_rule_id}
+
+

Example Responses

Status code: 400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+
{
+  "error_code" : "AOM.02001AOM.02001SVCSTG_AMS_4000115",
+  "error_msg" : "please check request param",
+  "error_type" : "BAD_REQUEST",
+  "trace_id" : ""
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK: The request is successful.

+

400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+

401

+

Unauthorized: The authentication information is incorrect or invalid.

+

403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+

500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+

503

+

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Monitoring
+
+
+ diff --git a/docs/aom/api-ref/DeleteAlarmRules.html b/docs/aom/api-ref/DeleteAlarmRules.html new file mode 100644 index 00000000..c2f33077 --- /dev/null +++ b/docs/aom/api-ref/DeleteAlarmRules.html @@ -0,0 +1,197 @@ + + +

Deleting Threshold Rules in Batches

+

Function

This API is used to delete threshold rules in batches.

+
+

URI

POST /v2/{project_id}/alarm-rules/delete

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token obtained from IAM.

+

Content-Type

+

Yes

+

String

+

Content type, which is application/json.

+

Enumeration values:

+

  • application/json

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

Parameter

+

Mandatory

+

Type

+

Description

+

alarm_rules

+

Yes

+

Array of strings

+

Name of the rule to be deleted.

+
+
+
+

Response Parameters

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+

error_type

+

String

+

Error type.

+

trace_id

+

String

+

Trace ID, which is used to search for logs and locate faults. If 2xx is returned, trace_id is empty. If 4xx, trace_id is not empty.

+
+
+
+

Example Requests

Delete threshold rules in batches by rule name.

+
https://{Endpoint}/v2/{project_id}/alarm-rules/delete
+
+{
+  "alarm_rules" : [ ]
+}
+
+

Example Responses

Status code: 400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+
{
+  "error_code" : "AOM.02001AOM.02001SVCSTG_AMS_4000115",
+  "error_msg" : "please check request param",
+  "error_type" : "BAD_REQUEST",
+  "trace_id" : ""
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK: The request is successful.

+

400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+

401

+

Unauthorized: The authentication information is incorrect or invalid.

+

403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+

500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+

503

+

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Monitoring
+
+
+ diff --git a/docs/aom/api-ref/DeleteserviceDiscoveryRules.html b/docs/aom/api-ref/DeleteserviceDiscoveryRules.html new file mode 100644 index 00000000..01f90f33 --- /dev/null +++ b/docs/aom/api-ref/DeleteserviceDiscoveryRules.html @@ -0,0 +1,211 @@ + + +

Deleting a Service Discovery Rule

+

Function

This API is used to delete a service discovery rule.

+
+

URI

DELETE /v1/{project_id}/inv/servicediscoveryrules

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

appRulesIds

+

Yes

+

Array

+

Discovery rule ID. Multiple IDs need to be separated by commas (,). The parameter cannot be empty.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token obtained from IAM.

+

Content-Type

+

Yes

+

String

+

Content type, which is application/json.

+

Enumeration values:

+

  • application/json

    +
+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

errorCode

+

String

+

Response code.

+

errorMessage

+

String

+

Response message.

+

responseStatus

+

Integer

+

Response status code.

+
+
+
+

Example Requests

Delete a service discovery rule with a specified ID.

+
https://{Endpoint}/v1/{project_id}/inv/servicediscoveryrules?appRulesIds=b788349e-62b2-xxxx-xxxx-02c611d59801
+
+

Example Responses

Status code: 200

+

OK: The request is successful.

+
{
+  "errorCode" : "SVCSTG.INV.2000000",
+  "errorMessage" : null,
+  "id" : [ ]
+}
+

Status code: 400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+
{
+  "errorCode" : "SVCSTG.INV.4000118",
+  "errorMessage" : "Request param is invalid",
+  "id" : [ ]
+}
+

Status code: 404

+

Not Found: The requested resource could not be found. The client should not repeat this request without modification.

+
{
+  "errorCode" : "SVCSTG.INV.4040000",
+  "errorMessage" : "Inventory does not exists",
+  "id" : [ ]
+}
+

Status code: 500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+
{
+  "error_code" : "APM.00000500",
+  "error_msg" : "Internal Server Error",
+  "trace_id" : ""
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK: The request is successful.

+

400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+

401

+

Unauthorized: The authentication information is incorrect or invalid.

+

403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+

404

+

Not Found: The requested resource could not be found. The client should not repeat this request without modification.

+

500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+

503

+

Unauthorized: The authentication information is incorrect or invalid.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Monitoring
+
+
+ diff --git a/docs/aom/api-ref/ErrorCode.html b/docs/aom/api-ref/ErrorCode.html new file mode 100644 index 00000000..61c5f896 --- /dev/null +++ b/docs/aom/api-ref/ErrorCode.html @@ -0,0 +1,2677 @@ + + +

Error Codes

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

Status Code

+

Error Code

+

Message

+

Description

+

Solution

+

200

+

SVCSTG.INV.2000000

+

null

+

The request is properly executed.

+

No action is required after the request is executed.

+

300

+

AOM.08001300

+

The maximum number of rules has been reached.

+

The maximum number of rules has been reached.

+

Delete unneeded rules and try again.

+

400

+

AOM.0400

+

Bad request.

+

Incorrect request parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001101

+

Invalid rule name.

+

Invalid rule name.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001102

+

The rule name already exists.

+

The rule name already exists.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001103

+

Invalid description.

+

Invalid description.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001104

+

Invalid threshold.

+

Invalid threshold.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001105

+

Invalid period.

+

Invalid period.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001106

+

Invalid email.

+

Invalid email.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001107

+

The maximum number of rules has been reached.

+

The maximum number of rules has been reached.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001108

+

Invalid time range.

+

Invalid time range.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001109

+

Threshold rule xxx does not exist.

+

Threshold rule xxx does not exist.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001110

+

Invalid limit.

+

Invalid limit.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001111

+

Invalid offset.

+

Invalid offset.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001112

+

Invalid request parameter.

+

Invalid request parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001115

+

Invalid request parameter.

+

Invalid request parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001118

+

Invalid number of consecutive periods.

+

Invalid number of consecutive periods.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001119

+

Invalid statistic.

+

Invalid statistic.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001120

+

Invalid comparison operator.

+

Invalid comparison operator.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001121

+

The rule does not exist.

+

The rule does not exist.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001400

+

Bad request.

+

Bad request.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02002101

+

Invalid rule.

+

Invalid rule.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02002102

+

The rule name already exists.

+

The rule name already exists.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02002103

+

Invalid description.

+

Invalid description.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02002104

+

Invalid threshold.

+

Invalid threshold.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02002105

+

Invalid period.

+

Invalid period.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02002106

+

Invalid email.

+

Invalid email.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02002107

+

The maximum number of rules has been reached.

+

The maximum number of rules has been reached.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02002108

+

Invalid time range.

+

Invalid time range.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02002109

+

Invalid project ID.

+

Invalid project ID.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02002110

+

Invalid limit.

+

Invalid limit.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02002111

+

Invalid offset.

+

Invalid offset.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02002112

+

Invalid request parameter.

+

Invalid request parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02002115

+

Invalid request parameter.

+

Invalid request parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02002118

+

Invalid number of consecutive periods.

+

Invalid number of consecutive periods.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02002119

+

Invalid statistic.

+

Invalid statistic.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02002120

+

Invalid comparison operator.

+

Invalid comparison operator.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02002121

+

The rule does not exist.

+

The rule does not exist.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02002400

+

Bad request.

+

Bad request.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003101

+

Invalid rule.

+

Invalid rule.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003102

+

The rule name already exists.

+

The rule name already exists.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003103

+

Invalid description.

+

Invalid description.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003104

+

Invalid threshold.

+

Invalid threshold.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003105

+

Invalid period.

+

Invalid period.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003106

+

Invalid email.

+

Invalid email.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003107

+

The maximum number of rules has been reached.

+

The maximum number of rules has been reached.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003108

+

Invalid time range.

+

Invalid time range.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003109

+

Invalid project ID.

+

Invalid project ID.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003110

+

Invalid limit.

+

Invalid limit.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003111

+

Invalid offset.

+

Invalid offset.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003112

+

Invalid request parameter.

+

Invalid request parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003115

+

Invalid request parameter.

+

Invalid request parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003118

+

Invalid number of consecutive periods.

+

Invalid number of consecutive periods.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003119

+

Invalid statistic.

+

Invalid statistic.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003120

+

Invalid comparison operator.

+

Invalid comparison operator.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003121

+

The rule does not exist.

+

The rule does not exist.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003400

+

Bad request.

+

Bad request.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02004101

+

Invalid rule.

+

Invalid rule.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02004102

+

The rule name already exists.

+

The rule name already exists.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02004103

+

Invalid description.

+

Invalid description.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02004104

+

Invalid threshold.

+

Invalid threshold.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02004105

+

Invalid period.

+

Invalid period.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02004106

+

Invalid email.

+

Invalid email.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02004107

+

The maximum number of rules has been reached.

+

The maximum number of rules has been reached.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02004108

+

Invalid time range.

+

Invalid time range.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02004109

+

Invalid project ID.

+

Invalid project ID.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02004110

+

Invalid limit.

+

Invalid limit.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02004111

+

Invalid offset.

+

Invalid offset.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02004112

+

Invalid request parameter.

+

Invalid request parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02004115

+

Invalid request parameter.

+

Invalid request parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02004118

+

Invalid number of consecutive periods.

+

Invalid number of consecutive periods.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02004119

+

Invalid statistic.

+

Invalid statistic.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02004120

+

Invalid comparison operator.

+

Invalid comparison operator.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02004121

+

The rule does not exist.

+

The rule does not exist.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02004400

+

Bad request.

+

Bad request.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005101

+

Invalid rule.

+

Invalid rule.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005102

+

The rule name already exists.

+

The rule name already exists.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005103

+

Invalid description.

+

Invalid description.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005104

+

Invalid threshold.

+

Invalid threshold.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005105

+

Invalid period.

+

Invalid period.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005106

+

Invalid email.

+

Invalid email.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005107

+

The maximum number of rules has been reached.

+

The maximum number of rules has been reached.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005108

+

Invalid time range.

+

Invalid time range.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005109

+

Invalid project ID.

+

Invalid project ID.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005110

+

Invalid limit.

+

Invalid limit.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005111

+

Invalid offset.

+

Invalid offset.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005112

+

Invalid request parameter.

+

Invalid request parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005115

+

Invalid request parameter.

+

Invalid request parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005118

+

Invalid number of consecutive periods.

+

Invalid number of consecutive periods.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005119

+

Invalid statistic.

+

Invalid statistic.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005120

+

Invalid comparison operator.

+

Invalid comparison operator.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005121

+

The rule does not exist.

+

The rule does not exist.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005400

+

Bad request.

+

Bad request.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04007101

+

Invalid namespace.

+

Invalid namespace.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04007102

+

Invalid inventory ID.

+

Invalid inventory ID.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04007103

+

The project ID cannot be left blank.

+

The project ID cannot be left blank.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04007104

+

Invalid type.

+

Invalid type.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04007105

+

Invalid limit.

+

Invalid limit.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04007106

+

Invalid offset.

+

Invalid offset.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04007107

+

Invalid parent inventory ID.

+

Invalid parent inventory ID.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04007108

+

Invalid type and relation.

+

Invalid type and relation.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04007109

+

Invalid metric name.

+

Invalid metric name.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04007110

+

Invalid relation.

+

Invalid relation.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04007111

+

The type and relation cannot be left blank.

+

The type and relation cannot be left blank.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04007112

+

Invalid request parameter.

+

Invalid request parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04007115

+

Invalid request parameter.

+

Invalid request parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04007118

+

Invalid number of consecutive periods.

+

Invalid number of consecutive periods.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04007119

+

Invalid statistic.

+

Invalid statistic.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04007120

+

Invalid comparison operator.

+

Invalid comparison operator.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04007400

+

Bad request.

+

Bad request.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04008101

+

Invalid namespace.

+

Invalid namespace.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04008102

+

Invalid inventory ID.

+

Invalid inventory ID.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04008103

+

The project ID cannot be left blank.

+

The project ID cannot be left blank.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04008104

+

Invalid type.

+

Invalid type.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04008105

+

Invalid limit.

+

Invalid limit.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04008106

+

Invalid offset.

+

Invalid offset.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04008107

+

Invalid parent inventory ID.

+

Invalid parent inventory ID.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04008108

+

Invalid type and relation.

+

Invalid type and relation.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04008109

+

Invalid metric name.

+

Invalid metric name.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04008110

+

Invalid relation.

+

Invalid relation.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04008111

+

The type and relation cannot be left blank.

+

The type and relation cannot be left blank.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04008112

+

Invalid request parameter.

+

Invalid request parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04008115

+

Invalid request parameter.

+

Invalid request parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04008118

+

Invalid number of consecutive periods.

+

Invalid number of consecutive periods.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04008119

+

Invalid statistic.

+

Invalid statistic.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04008120

+

Invalid comparison operator.

+

Invalid comparison operator.

+

Check whether the parameter meets requirements.

+

400

+

AOM.04008400

+

Bad request.

+

Bad request.

+

Check whether the parameter meets requirements.

+

400

+

AOM.07001400

+

Invalid parameter.

+

Invalid parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.11015003

+

The request body is empty.

+

The request body is empty.

+

Check whether the parameter meets requirements.

+

400

+

AOM.11015004

+

Parse request parameter failed.

+

Parse request parameter failed.

+

Check whether the parameter meets requirements.

+

400

+

AOM.11015005

+

Too many Prometheus instances.

+

Too many Prometheus instances.

+

Check whether the parameter meets requirements.

+

400

+

AOM.11017013

+

The Prometheus instance ID is empty.

+

The Prometheus instance ID is empty.

+

Check whether the parameter meets requirements.

+

400

+

AOM.11017014

+

Prometheus instance not found.

+

Prometheus instance not found.

+

Check whether the parameter meets requirements.

+

400

+

AOM.11017015

+

Invalid Prometheus instance name

+

Invalid Prometheus instance name.

+

Check whether the parameter meets requirements.

+

400

+

AOM.11017016

+

Invalid Prometheus instance ID.

+

Invalid Prometheus instance ID.

+

Check whether the parameter meets requirements.

+

400

+

AOM.11017017

+

Invalid Prometheus instance type.

+

Invalid Prometheus instance type.

+

Check whether the parameter meets requirements.

+

400

+

AOM.11017018

+

Invalid Prometheus instance status.

+

Invalid Prometheus instance status.

+

Check whether the parameter meets requirements.

+

400

+

AOM.11017019

+

Invalid application name.

+

Invalid application name.

+

Check whether the parameter meets requirements.

+

400

+

AOM.4001021

+

Group name repeate.

+

Duplicate group name.

+

Check whether the parameter meets requirements.

+

400

+

AOM.4001023

+

Group name must be set.

+

The group name cannot be empty.

+

Check whether the parameter meets requirements.

+

400

+

AOM.4001024

+

Record filed must be set.

+

The recording field cannot be empty.

+

Check whether the parameter meets requirements.

+

400

+

AOM.4001025

+

Expr filed must be set.

+

The expression cannot be empty.

+

Check whether the parameter meets requirements.

+

400

+

AOM.4001026

+

Recording rule format invalid.

+

Invalid recording rule format.

+

Check whether the parameter meets requirements.

+

400

+

AOM.4001028

+

The requested content exceeds the maximum.

+

The request is too long.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG.INV.4000115

+

Invalid request parameter.

+

Invalid request parameter.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000001

+

Invalid request parameter.

+

Invalid request parameter.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000002

+

Invalid namespace.

+

Invalid namespace.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000003

+

Dimensions cannot be left blank.

+

Dimensions cannot be left blank.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000005

+

Invalid metric data type.

+

Invalid metric data type.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000006

+

The metric data value cannot be left blank.

+

The metric data cannot be left blank.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000007

+

Invalid dimension.

+

Invalid dimension.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000008

+

The request exceeds 40 KB.

+

The request cannot exceed 40 KB.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000009

+

The number of elements in the dimension array exceeds the allowed limit.

+

Too many elements in the dimension array.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000010

+

Invalid collection time.

+

Invalid collection time.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000101

+

The namespace or alarm name is invalid, or the project ID is left blank.

+

The namespace or alarm name is invalid, or the project ID is left blank.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000102

+

The inventory ID is invalid, the metric data value is left blank, or the threshold rule name already exists.

+

The inventory ID is invalid, the metric data value is left blank, or the threshold rule name already exists.

+

Check whether the parameter meets requirements, or change the rule name and try again.

+

400

+

SVCSTG_AMS_4000103

+

Invalid range or alarm description.

+

Invalid range or alarm description.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000104

+

Invalid statistics or alarm threshold.

+

Invalid statistics or alarm threshold.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000105

+

Invalid limit, metric, or alarm period.

+

Invalid limit, metric, or alarm period.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000106

+

Invalid offset, time range, or email.

+

Invalid offset, time range, or email.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000107

+

The number of data points in a time range exceeds 1440 or the maximum number of threshold rules has been reached.

+

The number of data points in a time range exceeds 1440 or the maximum number of threshold rules has been reached.

+

Check whether the parameter meets the requirements or contact technical support.

+

400

+

SVCSTG_AMS_4000108

+

Invalid time range.

+

Invalid time range.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000109

+

Invalid metric name or project ID.

+

Invalid metric name or project ID.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000110

+

Invalid filled value or limit.

+

Invalid filled value or limit.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000111

+

Invalid offset.

+

Invalid offset.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000115

+

Invalid request parameter.

+

Invalid request parameter.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000118

+

Invalid number of consecutive periods.

+

Invalid number of consecutive periods.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000119

+

Invalid statistic.

+

Invalid statistic.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000120

+

Invalid comparison operator.

+

Invalid comparison operator.

+

Check whether the parameter meets requirements.

+

400

+

SVCSTG_AMS_4000121

+

The rule does not exist.

+

The rule does not exist.

+

Check whether the threshold rule exists.

+

400

+

AOM.02006404

+

The rule to be deleted does not exist.

+

The rule does not exist.

+

Check whether the threshold rule exists.

+

400

+

AOM.02005404

+

The rule does not exist.

+

The rule does not exist.

+

Check whether the threshold rule exists.

+

400

+

AOM.02004404

+

The rule does not exist.

+

The rule does not exist.

+

Check whether the threshold rule exists.

+

400

+

AOM.02004001

+

Incorrect request parameter.

+

Incorrect request parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02005001

+

Incorrect request parameter.

+

Incorrect request parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02003001

+

Incorrect request parameter.

+

Incorrect request parameter.

+

Check whether the parameter meets requirements.

+

400

+

AOM.02001AOM.02001SVCSTG_AMS_4000115

+

Invalid request parameter.

+

Incorrect request parameter.

+

Check whether the parameter meets requirements.

+

401

+

AOM.0401

+

Unauthorized.

+

Incorrect authentication information.

+

Check the authentication information carried in the request.

+

401

+

AOM.02001401

+

Unauthorized.

+

Unauthorized.

+

Contact technical support.

+

401

+

AOM.02002401

+

Unauthorized.

+

Unauthorized.

+

Contact technical support.

+

401

+

AOM.02003401

+

Unauthorized.

+

Unauthorized.

+

Contact technical support.

+

401

+

AOM.02004401

+

Unauthorized.

+

Unauthorized.

+

Contact technical support.

+

401

+

AOM.02005401

+

Unauthorized.

+

Unauthorized.

+

Contact technical support.

+

401

+

AOM.04007401

+

Request unauthorized.

+

Request unauthorized.

+

Contact technical support.

+

401

+

AOM.04008401

+

Request unauthorized.

+

Request unauthorized.

+

Contact technical support.

+

403

+

AOM.0403

+

Forbidden.

+

Insufficient permissions.

+

Check your permissions.

+

403

+

AOM.02001403

+

Forbidden.

+

Forbidden.

+

Contact technical support.

+

403

+

AOM.02002403

+

Forbidden.

+

Forbidden.

+

Contact technical support.

+

403

+

AOM.02003403

+

Forbidden.

+

Forbidden.

+

Contact technical support.

+

403

+

AOM.02004403

+

Forbidden.

+

Forbidden.

+

Contact technical support.

+

403

+

AOM.02005403

+

Forbidden.

+

Forbidden.

+

Contact technical support.

+

403

+

AOM.04007403

+

Request forbidden.

+

Request forbidden.

+

Contact technical support.

+

403

+

AOM.04008403

+

Request forbidden.

+

Request forbidden.

+

Contact technical support.

+

403

+

AOM.07001403

+

Insufficient permissions.

+

Insufficient permissions.

+

Obtain required permissions.

+

403

+

SVCSTG.INV.4030000

+

Insufficient permissions.

+

Insufficient permissions.

+

Use an authorized account.

+

404

+

SVCSTG.INV.4040000

+

Inventory does not exists.

+

The resource does not exist.

+

Check whether the resource exists.

+

429

+

AOM.07001429

+

The traffic has been restricted.

+

The traffic has been restricted.

+

Send fewer API call requests.

+

429

+

AOM.08001429

+

Too many requests.

+

Too many requests.

+

Check whether the parameter meets requirements.

+

500

+

AOM.0500

+

Internal server error.

+

Internal server error.

+

Contact technical support.

+

500

+

AOM.02001500

+

Internal server error.

+

Internal server error.

+

Contact technical support.

+

500

+

AOM.02001501

+

The Cassandra session is null.

+

The Cassandra session is null.

+

Contact technical support.

+

500

+

AOM.02001502

+

The Cassandra execution is abnormal.

+

The Cassandra execution is abnormal.

+

Contact technical support.

+

500

+

AOM.02002500

+

Internal server error.

+

Internal server error.

+

Contact technical support.

+

500

+

AOM.02002501

+

The Cassandra session is null.

+

The Cassandra session is null.

+

Contact technical support.

+

500

+

AOM.02002502

+

The Cassandra execution is abnormal.

+

The Cassandra execution is abnormal.

+

Contact technical support.

+

500

+

AOM.02003500

+

Internal server error.

+

Internal server error.

+

Contact technical support.

+

500

+

AOM.02003501

+

The Cassandra session is null.

+

The Cassandra session is null.

+

Contact technical support.

+

500

+

AOM.02003502

+

The Cassandra execution is abnormal.

+

The Cassandra execution is abnormal.

+

Contact technical support.

+

500

+

AOM.02004500

+

Internal server error.

+

Internal server error.

+

Contact technical support.

+

500

+

AOM.02004501

+

The Cassandra session is null.

+

The Cassandra session is null.

+

Contact technical support.

+

500

+

AOM.02004502

+

The Cassandra execution is abnormal.

+

The Cassandra execution is abnormal.

+

Contact technical support.

+

500

+

AOM.02005500

+

Internal server error.

+

Internal server error.

+

Contact technical support.

+

500

+

AOM.02005501

+

The Cassandra session is null.

+

The Cassandra session is null.

+

Contact technical support.

+

500

+

AOM.02005502

+

The Cassandra execution is abnormal.

+

The Cassandra execution is abnormal.

+

Contact technical support.

+

500

+

AOM.04007500

+

Internal server error.

+

Internal server error.

+

Contact technical support.

+

500

+

AOM.04007501

+

The Cassandra session is null.

+

The Cassandra session is null.

+

Contact technical support.

+

500

+

AOM.04007502

+

The Cassandra execution is abnormal.

+

The Cassandra execution is abnormal.

+

Contact technical support.

+

500

+

AOM.04008500

+

Internal server error.

+

Internal server error.

+

Contact technical support.

+

500

+

AOM.04008501

+

The Cassandra session is null.

+

The Cassandra session is null.

+

Contact technical support.

+

500

+

AOM.04008502

+

The Cassandra execution is abnormal.

+

The Cassandra execution is abnormal.

+

Contact technical support.

+

500

+

AOM.11014001

+

Internal server error.

+

Internal server error.

+

Contact technical support.

+

500

+

AOM.11014002

+

Incorrect conversion result.

+

Incorrect conversion result.

+

Contact technical support.

+

500

+

AOM.5001010

+

Internal server error.

+

Internal server error.

+

Contact technical support.

+

500

+

AOM.5001019

+

Recording rule exist for the prometheus instance.

+

The rule already exists.

+

Contact technical support.

+

500

+

SVCSTG.INV.5000001

+

The Elasticsearch session is null.

+

The Elasticsearch session is null.

+

Contact technical support.

+

500

+

SVCSTG.INV.5000002

+

The Elasticsearch execution is abnormal.

+

The Elasticsearch execution is abnormal.

+

Contact technical support.

+

500

+

SVCSTG.INV.5000003

+

The ICMGR invocation is abnormal.

+

The ICMGR invocation is abnormal.

+

Contact technical support.

+

500

+

SVCSTG.INV.5000006

+

The rule name already exists.

+

The rule name already exists.

+

Use another name.

+

500

+

SVCSTG.INV.5000007

+

The maximum number of rules has been reached.

+

The maximum number of rules has been reached.

+

Delete unnecessary rules and add new ones.

+

500

+

SVCSTG_AMS_5000000

+

Internal server error.

+

Internal server error.

+

Contact technical support.

+

503

+

AOM.0503

+

Server unavailable.

+

Server unavailable.

+

Contact technical support.

+

503

+

AOM.02001503

+

Server unavailable.

+

Server unavailable.

+

Contact technical support.

+

503

+

AOM.02002503

+

Server unavailable.

+

Server unavailable.

+

Contact technical support.

+

503

+

AOM.02003503

+

Server unavailable.

+

Server unavailable.

+

Contact technical support.

+

503

+

AOM.02004503

+

Server unavailable.

+

Server unavailable.

+

Contact technical support.

+

503

+

AOM.02005503

+

Server unavailable.

+

Server unavailable.

+

Contact technical support.

+

503

+

AOM.04007503

+

Server unavailable.

+

Server unavailable.

+

Contact technical support.

+

503

+

AOM.04008503

+

Server unavailable.

+

Server unavailable.

+

Contact technical support.

+

503

+

AOM.07001503

+

Service error.

+

Service error.

+

Check whether the backend service is normal.

+

503

+

SVCSTG_AMS_5030001

+

The Cassandra session is null.

+

The Cassandra session is null.

+

Contact technical support.

+

503

+

SVCSTG_AMS_5030002

+

The Cassandra execution is abnormal.

+

The Cassandra execution is abnormal.

+

Contact technical support.

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/aom/api-ref/ListAlarmRule.html b/docs/aom/api-ref/ListAlarmRule.html new file mode 100644 index 00000000..d1ef5f4a --- /dev/null +++ b/docs/aom/api-ref/ListAlarmRule.html @@ -0,0 +1,514 @@ + + +

Querying the Threshold Rule List

+

Function

This API is used to query the threshold rule list.

+
+

URI

GET /v2/{project_id}/alarm-rules

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

String

+

Pagination information.

+

limit

+

No

+

Integer

+

Maximum number of returned records. Value range: 1–1000. Default value: 1000.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token obtained from IAM.

+

Content-Type

+

Yes

+

String

+

Content type, which is application/json.

+

Enumeration values:

+

  • application/json

    +
+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

meta_data

+

MetaData object

+

Metadata, including pagination information.

+

thresholds

+

Array of QueryAlarmResult objects

+

Parameters specified for querying a threshold rule.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 MetaData

Parameter

+

Type

+

Description

+

count

+

Integer

+

Number of returned records.

+

start

+

String

+

Start of the next page, which is used for pagination. null: No more data.

+

total

+

Integer

+

Total number of records.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 QueryAlarmResult

Parameter

+

Type

+

Description

+

action_enabled

+

Boolean

+

Whether to enable notification.

+

alarm_actions

+

Array of strings

+

List of alarm notifications.

+

alarm_advice

+

String

+

Alarm clearance suggestion.

+

alarm_description

+

String

+

Threshold rule description.

+

alarm_level

+

String

+

Alarm severity.

+

alarm_rule_id

+

String

+

Threshold rule ID.

+

alarm_rule_name

+

String

+

Threshold rule name.

+

comparison_operator

+

String

+

Comparison operator.

+

dimensions

+

Array of Dimension objects

+

List of time series dimensions.

+

evaluation_periods

+

Integer

+

Interval.

+

id_turn_on

+

Boolean

+

Whether to enable the threshold rule.

+

insufficient_data_actions

+

Array of strings

+

List of insufficient data notifications.

+

metric_name

+

String

+

Time series name.

+

namespace

+

String

+

Time series objects' namespace.

+

ok_actions

+

Array of strings

+

List of normal status notifications.

+

period

+

Integer

+

Statistical period.

+

policy_name

+

String

+

Threshold rule name.

+

resources

+

Array of strings

+

Resource information (discarded).

+

state_reason

+

String

+

Cause description.

+

state_updated_timestamp

+

String

+

Time when the status was updated.

+

state_value

+

String

+

Service status.

+

statistic

+

String

+

Statistic.

+

threshold

+

String

+

Threshold value.

+

type

+

String

+

Threshold rule type.

+

unit

+

String

+

Threshold unit.

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

Parameter

+

Type

+

Description

+

name

+

String

+

Dimension name.

+

value

+

String

+

Dimension value.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+

error_type

+

String

+

Error type.

+

trace_id

+

String

+

Trace ID, which is used to search for logs and locate faults. If 2xx is returned, trace_id is empty. If 4xx, trace_id is not empty.

+
+
+
+

Example Requests

Obtain the alarm rule list of a user whose ID is Project_Id.

+
https://{EndPoint}/v2/{Project_Id}/alarm-rules
+
+

Example Responses

Status code: 200

+

OK: The request is successful.

+
{
+  "meta_data" : [ {
+    "count" : 10,
+    "total" : 100
+  } ],
+  "thresholds" : [ {
+    "action_enable" : false,
+    "alarm_actions" : null,
+    "alarm_advice" : null,
+    "alarm_description" : null,
+    "alarm_level" : 3,
+    "alarm_rule_id" : 2137,
+    "alarm_rule_name" : "aom_rule",
+    "comparison_operator" : ">=",
+    "dimensions" : [ {
+      "name" : "appName"
+    }, {
+      "value" : "rhm-broker"
+    } ],
+    "evaluation_periods" : 1,
+    "id_turn_on" : true,
+    "insufficient_data_actions" : null,
+    "metric_name" : "cpuCoreLimit",
+    "namespace" : "PAAS.CONTAINER",
+    "ok_actions" : null,
+    "period" : 60000,
+    "policy_name" : "23,",
+    "resources" : [ ],
+    "state_reason" : null,
+    "state_updated_timestamp" : null,
+    "state_value" : "alarm",
+    "statistic" : "average",
+    "threshold" : 0,
+    "type" : "single,",
+    "unit" : "Core"
+  } ]
+}
+

Status code: 400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+
{
+  "error_code" : "AOM.02001AOM.02001SVCSTG_AMS_4000115",
+  "error_msg" : "please check request param",
+  "error_type" : "BAD_REQUEST",
+  "trace_id" : ""
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK: The request is successful.

+

400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+

401

+

Unauthorized: The authentication information is incorrect or invalid.

+

403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+

500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+

503

+

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Monitoring
+
+
+ diff --git a/docs/aom/api-ref/ListEvents.html b/docs/aom/api-ref/ListEvents.html new file mode 100644 index 00000000..f01a8c42 --- /dev/null +++ b/docs/aom/api-ref/ListEvents.html @@ -0,0 +1,637 @@ + + +

Querying Events and Alarms

+

Function

This API is used to query events and alarms of a user.

+
+

URI

POST /v2/{project_id}/events

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

No

+

String

+

Type of information to be queried. active_alert: Active alarms are to be queried. history_alert: Historical alarms are to be queried. If this parameter is not transferred or other values are transferred, information that meets the specified search criteria will be returned.

+

Enumeration values:

+

  • history_alert

    +

  • active_alert

    +
+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token obtained from IAM.

+

Content-Type

+

Yes

+

String

+

Content type, which is application/json.

+

Enumeration values:

+

  • application/json

    +
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

time_range

+

Yes

+

String

+

Time range specified to query data of the last N minutes when the client time is inconsistent with the server time. It can also be used to accurately query the data of a specified period.

+

Example:

+

  • -1.-1.60: indicates that the data of the latest 60 minutes is queried. This query is based on the server time regardless of the current client time.

    +

  • 1650852000000.1650852300000.5: indicates the five minutes from 10:00:00 to 10:05:00 on April 25, 2022 GMT+08:00.

    +
+

Format:

+

startTimeInMillis.endTimeInMillis.durationInMinutes

+

Parameter description:

+

  • startTimeInMillis: Start time of the query, in milliseconds. If this parameter is set to -1, the server calculates the start time as follows: endTimeInMillis – durationInMinutes x 60 x 1000. For example, -1.1650852300000.5 is equivalent to 1650852000000.1650852300000.5.

    +

  • endTimeInMillis: End time of the query, in milliseconds. If this parameter is set to -1, the server calculates the end time as follows: startTimeInMillis + durationInMinutes x 60 x 1000. If the calculated end time is later than the current system time, the current system time is used. For example, 1650852000000.-1.5 is equivalent to 1650852000000.1650852300000.5.

    +

  • durationInMinutes: Time span, in minutes. The value must be greater than 0 and greater than or equal to the result of "(endTimeInMillis – startTimeInMillis)/(60 x 1000) – 1". If both the start time and end time are set to -1, the system sets the end time to the current UTC time (in milliseconds) and calculates the start time as follows: endTimeInMillis – durationInMinutes x 60 x 1000. For example, -1.-1.60 indicates the latest 60 minutes.

    +
+

Constraint:

+

In a single request, the following condition must be met: durationInMinutes x 60/period ≤ 1440

+

step

+

No

+

Long

+

Statistical step (unit: ms). For example, if the statistical step is one minute, set this parameter to 60,000.

+

search

+

No

+

String

+

Field specified for fuzzy query, which can be left blank. If this field is not left blank, fuzzy query can be performed accordingly. In that case, the metadata field is mandatory.

+

sort

+

No

+

sort object

+

Sorting order, which can be left blank.

+

metadata_relation

+

No

+

Array of RelationModel objects

+

Combination of search criteria, which can be left blank.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 sort

Parameter

+

Mandatory

+

Type

+

Description

+

order_by

+

No

+

Array of strings

+

List of sorted fields. Fields in this list are sorted based on the specified order.

+

order

+

No

+

String

+

Sorting order. asc: ascending order. desc: descending order.

+

Enumeration values:

+

  • asc

    +

  • desc

    +
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 RelationModel

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Key specified for query, which corresponds to the key in the metadata.

+

value

+

No

+

Array of strings

+

Value of the specified key in the search criterion.

+

relation

+

No

+

String

+

Relationship between search criteria. Values: AND: All criteria must be met. OR: One of the criteria needs to be met. NOT: None of the criteria can be met.

+

Enumeration values:

+

  • AND

    +

  • OR

    +

  • NOT

    +
+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

events

+

Array of EventModel objects

+

Event or alarm details.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 EventModel

Parameter

+

Type

+

Description

+

starts_at

+

Long

+

Time when an event or alarm is generated (CST timestamp precise down to the millisecond).

+

ends_at

+

Long

+

Time when an event or alarm is cleared (CST timestamp precise down to the millisecond). 0: The event or alarm is not deleted.

+

timeout

+

Long

+

Duration (in milliseconds) at which an alarm is automatically cleared. For example, if an alarm needs to be automatically cleared in one minute, set this parameter to 60000. The default value is 3 days (that is, 3 days x 24 hours x 60 minutes x 1000 ms = 4,320,000 ms).

+

metadata

+

Map<String,String>

+

Details of an event or alarm. The value is a key-value pair. The following fields are mandatory:

+

  • event_name: event or alarm name, which is a string.

    +

  • event_severity: event severity, which is an enumerated value with string elements. Value: Critical, Major, Minor, or Info.

    +

  • event_type: event type, which is an enumerated value with string elements. Value: event or alarm.

    +

  • resource_provider: name of a cloud service corresponding to an event, which is a string.

    +

  • resource_type: resource type corresponding to an event, which is a string.

    +

  • resource_id: resource ID corresponding to an event, which is a string.

    +
+

annotations

+

Map<String,String>

+

Additional field for an event or alarm, which can be left blank.

+

attach_rule

+

Map<String,String>

+

Reserved field for an event or alarm, which can be left blank.

+

id

+

String

+

Event or alarm ID, which is automatically generated by the system.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Response code.

+

error_msg

+

String

+

Error description.

+

error_type

+

String

+

API call failure type.

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Response code.

+

error_msg

+

String

+

Error description.

+

error_type

+

String

+

API call failure type.

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Response code.

+

error_msg

+

String

+

Error description.

+

error_type

+

String

+

API call failure type.

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Response code.

+

error_msg

+

String

+

Error description.

+

error_type

+

String

+

API call failure type.

+
+
+

Status code: 503

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Response code.

+

error_msg

+

String

+

Error description.

+

error_type

+

String

+

API call failure type.

+
+
+
+

Example Requests

Query the events and alarms of a specified user.

+
https://{endpoint}/v2/{project_id}/events
+
+{
+  "time_range" : "-1.-1.30",
+  "metadata_relation" : [ {
+    "key" : "event_type",
+    "relation" : "AND",
+    "value" : [ "alarm" ]
+  }, {
+    "key" : "event_severity",
+    "relation" : "AND",
+    "value" : [ "Critical", "Major", "Minor", "Info" ]
+  } ],
+  "search" : "",
+  "sort" : {
+    "order_by" : [ "starts_at" ],
+    "order" : "desc"
+  }
+}
+
+

Example Responses

Status code: 200

+

OK: The request is successful.

+
{
+  "events" : [ {
+    "annotations" : {
+      "alarm_probableCause_zh_cn" : "Possible Causes",
+      "message" : "Alarm Details",
+      "alarm_fix_suggestion_zh_cn" : "Suggestions"
+    },
+    "attach_rule" : { },
+    "ends_at" : 0,
+    "id" : "6775161208461480000",
+    "metadata" : {
+      "event_type" : "alarm",
+      "event_severity" : "Major",
+      "resource_type" : "vm",
+      "event_name" : "test",
+      "resource_id" : "ecs123",
+      "resource_provider" : "ecs"
+    },
+    "starts_at" : 16377362908000,
+    "timeout" : 60000
+  } ]
+}
+

Status code: 400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+
{
+  "error_code" : "AOM.0400",
+  "error_message" : "param error",
+  "error_type" : "SC_BAD_REQUEST"
+}
+

Status code: 401

+

Unauthorized: The authentication information is incorrect or invalid.

+
{
+  "error_code" : "AOM.0401",
+  "error_message" : "you dont have permission",
+  "error_type" : "SC_UNAUTHORIZED"
+}
+

Status code: 403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+
{
+  "error_code" : "AOM.0403",
+  "error_message" : "you dont have permission",
+  "error_type" : "SC_FORBIDDEN"
+}
+

Status code: 500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+
{
+  "error_code" : "AOM.0500",
+  "error_message" : "SC_INTERNAL_SERVER_ERROR",
+  "error_type" : "SC_INTERNAL_SERVER_ERROR"
+}
+

Status code: 503

+

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

+
{
+  "error_code" : "AOM.0503",
+  "error_message" : "SC_NOT_IMPLEMENTED",
+  "error_type" : "SC_NOT_IMPLEMENTED"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK: The request is successful.

+

400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+

401

+

Unauthorized: The authentication information is incorrect or invalid.

+

403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+

500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+

503

+

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm
+
+
+ diff --git a/docs/aom/api-ref/ListLogItems.html b/docs/aom/api-ref/ListLogItems.html new file mode 100644 index 00000000..64062aea --- /dev/null +++ b/docs/aom/api-ref/ListLogItems.html @@ -0,0 +1,549 @@ + + +

Querying Logs

+

Function

This API is used to query logs by different dimensions, such as by cluster, IP address, or application. Pagination queries are supported.

+
+

URI

POST /v1/{project_id}/als/action

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

Yes

+

String

+

Log API call mode. When the value is querylogs, this API is used to query logs.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token obtained from IAM.

+

Content-Type

+

Yes

+

String

+

Content type, which is application/json.

+

Enumeration values:

+

  • application/json

    +
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

category

+

Yes

+

String

+

Log type. Values: app_log: application log. node_log: node log.custom_log: log in a custom path.

+

endTime

+

Yes

+

Long

+

End time of the query (UTC, in ms).

+

hideSyslog

+

No

+

Integer

+

Whether to hide system logs during log queries. 0: Hide system logs. 1: Show system logs.

+

keyWord

+

No

+

String

+

Keyword for search.

+

  1. Exact search by keyword is supported. A keyword is between two adjacent delimiters.

    +

  2. Fuzzy search by keyword is supported. Example: RROR, ERRO?, ROR, ERR*, or ER*OR.

    +

  3. Exact search by phrase is supported. Example: Start to refresh alm Statistic.

    +

  4. Search using AND (&&) or OR (||) is supported. Example: query&&logs or query||logs. Note: Default delimiters: , '";=()[]{}@&<>/:\n\t\r

    +
+

lineNum

+

No

+

String

+

Sequence number of the final log in the last query result. This parameter is not required for the first query, but is required for subsequent pagination queries.

+

pageSize/size

+

No

+

String

+

Number of logs queried each time. Default value: 5000. Recommended value: 100. For the first query, pageSize is used. For subsequent pagination queries, size is used.

+

searchKey

+

Yes

+

SearchKey object

+

Log filter criteria, which vary according to log sources.

+

startTime

+

Yes

+

Long

+

Start time of the query (UTC, in ms).

+

type

+

No

+

String

+

Pagination query. This parameter is not required for the first query, but is required for subsequent pagination queries.

+

isDesc

+

No

+

Boolean

+

Whether to query logs based on lineNum in ascending or descending order. true: lineNum in descending order (from the latest time to the earliest time) false: lineNum in ascending order (from the earliest time to the latest time)

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 SearchKey

Parameter

+

Mandatory

+

Type

+

Description

+

appName

+

No

+

String

+

Application name.

+

clusterId

+

Yes

+

String

+

CCE cluster ID.

+

hostIP

+

No

+

String

+

IP address of the VM where logs are located.

+

nameSpace

+

No

+

String

+

CCE cluster namespace.

+

pathFile

+

No

+

String

+

Log file name.

+

podName

+

No

+

String

+

Container instance name.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

errorCode

+

String

+

Response code. SVCSTG_AMS_2000000: Success response.

+

errorMessage

+

String

+

Response message.

+

result

+

String

+

Metadata, including results and the total number of returned records.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

errorCode

+

String

+

Response code.

+

errorMessage

+

String

+

Response message.

+
+
+

Status code: 401

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

Parameter

+

Type

+

Description

+

errorCode

+

String

+

Response code.

+

errorMessage

+

String

+

Response message.

+
+
+

Status code: 403

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

Parameter

+

Type

+

Description

+

errorCode

+

String

+

Response code.

+

errorMessage

+

String

+

Response message.

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

errorCode

+

String

+

Response code.

+

errorMessage

+

String

+

Response message.

+
+
+

Status code: 503

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

Parameter

+

Type

+

Description

+

errorCode

+

String

+

Response code.

+

errorMessage

+

String

+

Response message.

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

OK: The request is successful.

+
{
+  "errorCode" : "SVCSTG.ALS.200.200",
+  "errorMessage" : "Query data success",
+  "result" : [ {
+    "data" : [ {
+      "appName" : "axxs0712",
+      "category" : "apx",
+      "clusterId" : "c6xxxx7c-54cd-11e8-8055-025xxx1e40",
+      "collectTime" : 153900000983,
+      "containerName" : "contsssner-0",
+      "hostIP" : "1xx.xxx.0.1xxx",
+      "hostId" : "c11xxxxx11-0000b-4925-bef4-d0xxxx9b0",
+      "hostName" : "1x2.168.0.xxx",
+      "lineNum" : "1xxx23xxxxxx2VW5xxxxxx0ZWdlcg==",
+      "logContent" : "warn:2018/10/09 06:57:01 helloworld.go:108: the main processis running now.",
+      "logContentSize" : null,
+      "loghash" : "4xxxxx0d40a83c17f262540xxxxxxxxfeaa30eb",
+      "nameSpace" : "default",
+      "pathFile" : "/xxx/xxx/xxx/xxx/xxx/xxx.trxe",
+      "podName" : "axxx12-7xxf884-qxxwp",
+      "serviceID" : ""
+    } ],
+    "total" : 5000
+  } ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK: The request is successful.

+

400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+

401

+

Unauthorized: The authentication information is incorrect or invalid.

+

403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+

500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+

503

+

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Log
+
+
+ diff --git a/docs/aom/api-ref/ListMetricItems.html b/docs/aom/api-ref/ListMetricItems.html new file mode 100644 index 00000000..57dcf7ec --- /dev/null +++ b/docs/aom/api-ref/ListMetricItems.html @@ -0,0 +1,443 @@ + + +

Querying Metrics

+

Function

This API is used to query the metrics that can be monitored in the system. You can query specific metrics by specifying a namespace, metric name, dimension, and resource ID (format: resType_resId). You can also specify the start position and the maximum number of returned records for a pagination query.

+
+

URI

POST /v1/{project_id}/ams/metrics

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

No

+

String

+

Metric query mode.

+

limit

+

No

+

String

+

Maximum number of returned records. Value range: 1–1000. Default value: 1000.

+

Minimum: 0

+

Maximum: 4

+

start

+

No

+

String

+

Start position of a pagination query. The value is a non-negative integer.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token obtained from IAM.

+

Content-Type

+

Yes

+

String

+

Content type, which is application/json.

+

Enumeration values:

+

  • application/json

    +
+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

inventoryId

+

No

+

String

+

Resource ID, which must be in the format of resType_resId. Enumerated values of resType: host, application, instance, container, process, network, storage, and volume.When type (a URI parameter) is inventory, this parameter instead of metricItems is used for associated metric queries.

+

metricItems

+

No

+

Array of QueryMetricItemOptionParam objects

+

If the value of type in the URI is not inventory, metrics are queried based on the information carried by metricItems.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 QueryMetricItemOptionParam

Parameter

+

Mandatory

+

Type

+

Description

+

dimensions

+

No

+

Array of Dimension objects

+

List of metric dimensions.

+

metricName

+

No

+

String

+

Metric name. Length: 1 to 255 characters. Value range: cpuUsage, cpuCoreUsed, and other basic metrics provided by AOM. cpuUsage: CPU usage. cpuCoreUsed: used CPU cores. Custom metrics.

+

namespace

+

Yes

+

String

+

Metric namespace. Values: PAAS.CONTAINER: namespace of component, instance, process, and container metrics. PAAS.NODE: namespace of host, network, disk, and file system metrics. PAAS.SLA: namespace of SLA metrics. PAAS.AGGR: namespace of cluster metrics. CUSTOMMETRICS: default namespace of custom metrics.

+

Enumeration values:

+

  • PAAS.CONTAINER

    +

  • PAAS.NODE

    +

  • PAAS.SLA

    +

  • PAAS.AGGR

    +

  • CUSTOMMETRICS

    +
+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 Dimension

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Dimension name.

+

value

+

Yes

+

String

+

Dimension value.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

metaData

+

metaData object

+

Metadata, including pagination information.

+

metrics

+

Array of MetricItemResultAPI objects

+

Metric list.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 8 metaData

Parameter

+

Type

+

Description

+

count

+

Integer

+

Number of returned records.

+

nextToken

+

Long

+

Start of the next page, which is used for pagination. null: No more data.

+

total

+

Integer

+

Total number of records.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 9 MetricItemResultAPI

Parameter

+

Type

+

Description

+

dimensions

+

Array of Dimension objects

+

List of metric dimensions.

+

metricName

+

String

+

Metric name.

+

namespace

+

String

+

Namespace.

+

unit

+

String

+

Metric unit.

+
+
+ +
+ + + + + + + + + + + + + +
Table 10 Dimension

Parameter

+

Type

+

Description

+

name

+

String

+

Dimension name.

+

value

+

String

+

Dimension value.

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

OK: The request is successful.

+
{
+  "errorCode" : "SVCSTG_AMS_2000000",
+  "errorMessage" : "success",
+  "metaData" : {
+    "count" : 1,
+    "nextToken" : null,
+    "total" : 1
+  },
+  "metrics" : [ {
+    "namespace" : "PAAS.CONTAINER",
+    "metricName" : "aom_process_cpu_usage",
+    "unit" : "Percent",
+    "dimensions" : [ {
+      "name" : "appName",
+      "value" : "aomApp"
+    } ]
+  } ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK: The request is successful.

+

400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+

401

+

Unauthorized: The authentication information is incorrect or invalid.

+

403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+

500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+

503

+

Service Unavailable

+

The requested service is invalid. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Monitoring
+
+
+ diff --git a/docs/aom/api-ref/ListSample.html b/docs/aom/api-ref/ListSample.html new file mode 100644 index 00000000..c73cda2b --- /dev/null +++ b/docs/aom/api-ref/ListSample.html @@ -0,0 +1,492 @@ + + +

Querying Time Series Data

+

Function

This API is used to query time series data within a specified time period. You can specify a dimension or period to query.

+
+

URI

POST /v2/{project_id}/samples

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

fill_value

+

No

+

String

+

Value filled for breakpoints in time series data. Default value: –1. –1: Breakpoints are filled with –1. 0: Breakpoints are filled with 0. null: Breakpoints are filled with null. average: Breakpoints are filled with the average value of the adjacent valid data. If there is no valid data, breakpoints are filled with null.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

samples

+

Yes

+

Array of QuerySample objects

+

List of time series objects. A JSON array can contain up to 20 objects.

+

statistics

+

Yes

+

Array of strings

+

Statistic. Values: maximum, minimum, sum, average, and sampleCount.

+

period

+

Yes

+

Integer

+

Granularity for monitoring data, which is an enumerated value. Values: 60: The data monitoring granularity is 1 minute. 300: The data monitoring granularity is 5 minutes. 900: The data monitoring granularity is 15 minutes. 3600: The data monitoring granularity is 1 hour.

+

time_range

+

Yes

+

String

+

Time range specified to query data of the last N minutes when the client time is inconsistent with the server time. It can also be used to accurately query the data of a specified period.

+

Example:

+

  • -1.-1.60: indicates that the data of the latest 60 minutes is queried. This query is based on the server time regardless of the current client time.

    +

  • 1650852000000.1650852300000.5: indicates the five minutes from 10:00:00 to 10:05:00 on April 25, 2022 GMT+08:00.

    +
+

Format:

+

startTimeInMillis.endTimeInMillis.durationInMinutes

+

Parameter description:

+

  • startTimeInMillis: Start time of the query, in milliseconds. If this parameter is set to -1, the server calculates the start time as follows: endTimeInMillis – durationInMinutes x 60 x 1000. For example, -1.1650852300000.5 is equivalent to 1650852000000.1650852300000.5.

    +

  • endTimeInMillis: End time of the query, in milliseconds. If this parameter is set to -1, the server calculates the end time as follows: startTimeInMillis + durationInMinutes x 60 x 1000. If the calculated end time is later than the current system time, the current system time is used. For example, 1650852000000.-1.5 is equivalent to 1650852000000.1650852300000.5.

    +

  • durationInMinutes: Time span, in minutes. The value must be greater than 0 and greater than or equal to the result of "(endTimeInMillis – startTimeInMillis)/(60 x 1000) – 1". If both the start time and end time are set to -1, the system sets the end time to the current UTC time (in milliseconds) and calculates the start time as follows: endTimeInMillis – durationInMinutes x 60 x 1000. For example, -1.-1.60 indicates the latest 60 minutes.

    +
+

Constraint:

+

In a single request, the following condition must be met: durationInMinutes x 60/period ≤ 1440

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 QuerySample

Parameter

+

Mandatory

+

Type

+

Description

+

namespace

+

Yes

+

String

+

Namespace of time series objects. Value range: PAAS.CONTAINER, PAAS.NODE, PAAS.SLA, PAAS.AGGR, or CUSTOMMETRICS. PAAS.CONTAINER: namespace of application time series objects. PAAS.NODE: namespace of node time series objects. PAAS.SLA: namespace of SLA time series objects. PAAS.AGGR: namespace of cluster time series objects. CUSTOMMETRICS: namespace of custom time series objects.

+

dimensions

+

Yes

+

Array of DimensionSeries objects

+

List of time series dimensions.You can call the /v2/{project_id}/series API to query the time series dimension list by namespace and metric_name.

+

metric_name

+

Yes

+

String

+

Time series name. Length: 1 to 255 characters. Values: cpuUsage: CPU usage. cpuCoreUsed: used CPU cores. Custom time series names.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 DimensionSeries

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Dimension name.

+

value

+

No

+

String

+

Dimension value.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

samples

+

Array of SampleDataValue objects

+

List of time series objects.

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 SampleDataValue

Parameter

+

Type

+

Description

+

sample

+

QuerySample object

+

List of time series objects.

+

data_points

+

Array of MetricDataPoints objects

+

Time series data.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 8 QuerySample

Parameter

+

Type

+

Description

+

namespace

+

String

+

Namespace of time series objects. Value range: PAAS.CONTAINER, PAAS.NODE, PAAS.SLA, PAAS.AGGR, or CUSTOMMETRICS. PAAS.CONTAINER: namespace of application time series objects. PAAS.NODE: namespace of node time series objects. PAAS.SLA: namespace of SLA time series objects. PAAS.AGGR: namespace of cluster time series objects. CUSTOMMETRICS: namespace of custom time series objects.

+

dimensions

+

Array of DimensionSeries objects

+

List of time series dimensions.You can call the /v2/{project_id}/series API to query the time series dimension list by namespace and metric_name.

+

metric_name

+

String

+

Time series name. Length: 1 to 255 characters. Values: cpuUsage: CPU usage. cpuCoreUsed: used CPU cores. Custom time series names.

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 DimensionSeries

Parameter

+

Type

+

Description

+

name

+

String

+

Dimension name.

+

value

+

String

+

Dimension value.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 10 MetricDataPoints

Parameter

+

Type

+

Description

+

statistics

+

Array of StatisticValue objects

+

Statistic.

+

timestamp

+

Long

+

Timestamp.

+

unit

+

String

+

Time series unit.

+
+
+ +
+ + + + + + + + + + + + + +
Table 11 StatisticValue

Parameter

+

Type

+

Description

+

statistic

+

String

+

Statistic.

+

value

+

Double

+

Statistical result.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+

error_type

+

String

+

Error type.

+
+
+
+

Example Requests

Query time series data in the last five minutes by namespace, metric_name, and dimensions.

+
https://{Endpoint}/v2/{project_id}/samples
+
+{
+    "samples": [
+        {
+            "namespace": "PAAS.CONTAINER",
+            "metric_name": "aom_process_cpu_usage",
+            "dimensions": [
+                {
+                    "name": "appName",
+                    "value": "aomApp"
+                }
+            ]
+        }
+    ],
+    "period": 60,
+    "time_range": "-1.-1.5",// Last 5 minutes
+      "statistics": [
+        "sum"
+    ]
+}
+
+

Example Responses

Status code: 200

+

OK: The request is successful.

+
{
+  "samples" : [ {
+    "sample" : {
+      "namespace" : "PAAS.CONTAINER",
+      "metric_name" : "aom_process_cpu_usage",
+      "dimensions" : [ {
+        "name" : "appName",
+        "value" : "aomApp"
+      } ]
+    },
+    "data_points" : [ {
+      "timestamp" : "1694673300000",
+      "unit" : "Percent",
+      "statistics" : [ {
+        "statistic" : "sum",
+        "value" : "23"
+      } ]
+    } ]
+  } ]
+}
+

Status code: 400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+
{
+  "error_code" : "AOM.04008001",
+  "error_msg" : "please check request param",
+  "error_type" : "BAD_REQUEST"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK: The request is successful.

+

400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+

401

+

Unauthorized: The authentication information is incorrect or invalid.

+

403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+

500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+

503

+

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Monitoring
+
+
+ diff --git a/docs/aom/api-ref/ListSeries.html b/docs/aom/api-ref/ListSeries.html new file mode 100644 index 00000000..e4f66b6a --- /dev/null +++ b/docs/aom/api-ref/ListSeries.html @@ -0,0 +1,414 @@ + + +

Querying Time Series Objects

+

Function

This API is used to query the time series objects that can be monitored in the system. You can specify a namespace, name, dimension, and resource ID (format: resType_resId). You can also specify the start position and the maximum number of returned records for a pagination query.

+
+

URI

POST /v2/{project_id}/series

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

String

+

Maximum number of returned records. Value range: 1–1000. Default value: 1000.

+

offset

+

No

+

String

+

Start position of a pagination query. The value is a non-negative integer.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

series

+

Yes

+

Array of QuerySeriesOptionParam objects

+

Array for querying time series objects.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 QuerySeriesOptionParam

Parameter

+

Mandatory

+

Type

+

Description

+

namespace

+

Yes

+

String

+

Namespace of time series objects. Value range: PAAS.CONTAINER, PAAS.NODE, PAAS.SLA, PAAS.AGGR, or CUSTOMMETRICS. PAAS.CONTAINER: namespace of application time series objects. PAAS.NODE: namespace of node time series objects. PAAS.SLA: namespace of SLA time series objects. PAAS.AGGR: namespace of cluster time series objects. CUSTOMMETRICS: namespace of custom time series objects.

+

metric_name

+

No

+

String

+

Time series name. Length: 1 to 255 characters. Values: cpuUsage: CPU usage. cpuCoreUsed: used CPU cores. Custom time series names.

+

dimensions

+

No

+

Array of DimensionSeries objects

+

List of time series dimensions. You can call the /v2/{project_id}/series API to query the time series dimension list by namespace and metric_name.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 DimensionSeries

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Dimension name.

+

value

+

No

+

String

+

Dimension value.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

series

+

Array of SeriesQueryItemResult objects

+

List of time series objects.

+

meta_data

+

MetaDataSeries object

+

Metadata, including pagination information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 7 SeriesQueryItemResult

Parameter

+

Type

+

Description

+

namespace

+

String

+

Namespace.

+

dimensions

+

Array of DimensionSeries objects

+

Dimension list.

+

metric_name

+

String

+

Time series name.

+

unit

+

String

+

Time series unit.

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 DimensionSeries

Parameter

+

Type

+

Description

+

name

+

String

+

Dimension name.

+

value

+

String

+

Dimension value.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 9 MetaDataSeries

Parameter

+

Type

+

Description

+

count

+

Integer

+

Number of returned records.

+

offset

+

Integer

+

Start of the next page, which is used for pagination. null: No more data.

+

total

+

Integer

+

Total number of records.

+

nextToken

+

Integer

+

Offset.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+

error_type

+

String

+

Error type.

+
+
+
+

Example Requests

Query time series objects by namespace and metric_name.

+
https://{Endpoint}/v2/{project_id}/series
+
+{
+  "series" : [ {
+    "namespace" : "PAAS.CONTAINER",
+    "metric_name" : "aom_process_cpu_usage"
+  } ]
+}
+
+

Example Responses

Status code: 200

+

OK: The request is successful.

+
{
+  "meta_data" : {
+    "count" : 1,
+    "offset" : null,
+    "total" : 1,
+    "nextToken" : 0
+  },
+  "series" : [ {
+    "namespace" : "PAAS.CONTAINER",
+    "metric_name" : "cpuUsage",
+    "unit" : "Percent",
+    "dimensions" : [ {
+      "name" : "appName",
+      "value" : "appValue"
+    } ]
+  } ]
+}
+

Status code: 400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+
{
+  "error_code" : "AOM.04007001",
+  "error_msg" : "please check request param",
+  "error_type" : "BAD_REQUEST"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK: The request is successful.

+

400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+

401

+

Unauthorized: The authentication information is incorrect or invalid.

+

403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+

500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+

503

+

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Monitoring
+
+
+ diff --git a/docs/aom/api-ref/ListServiceDiscoveryRules.html b/docs/aom/api-ref/ListServiceDiscoveryRules.html new file mode 100644 index 00000000..e99f138c --- /dev/null +++ b/docs/aom/api-ref/ListServiceDiscoveryRules.html @@ -0,0 +1,554 @@ + + +

Querying Existing Service Discovery Rules

+

Function

This API is used to query existing service discovery rules in the system.

+
+

URI

GET /v1/{project_id}/inv/servicediscoveryrules

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

No

+

String

+

Service discovery rule ID, which corresponds to a service discovery rule. If this parameter is left blank, all service discovery rules in the project are returned.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token obtained from IAM.

+

Content-Type

+

Yes

+

String

+

Content type, which is application/json.

+

Enumeration values:

+

  • application/json

    +
+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

appRules

+

Array of AppRules objects

+

Rule information.

+

errorCode

+

String

+

Response code. AOM_INVENTORY_2000000: Success response.

+

errorMessage

+

String

+

Response message.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 AppRules

Parameter

+

Type

+

Description

+

createTime

+

String

+

Creation time. When creating a service discovery rule, leave this parameter blank. When modifying a service discovery rule, enter the returned createTime.

+

Default: 1599098476654

+

enable

+

Boolean

+

Whether a rule is enabled. Values: true and false.

+

eventName

+

String

+

aom_inventory_rules_event Rule event name. For service discovery, the fixed value is aom_inventory_rules_event.

+

hostid

+

Array of strings

+

Host ID. Currently, this parameter is not used and can be left blank.

+

id

+

String

+

Rule ID. When creating a service discovery rule, leave this parameter blank. When modifying a service discovery rule, enter a rule ID.

+

name

+

String

+

Rule name, which contains a maximum of 64 characters. It must start with a lowercase letter but cannot end with a hyphen (-). Only digits, lowercase letters, and hyphens are allowed.

+

projectid

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+

spec

+

AppRulesSpec object

+

Rule details.

+

desc

+

String

+

Custom description

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 AppRulesSpec

Parameter

+

Type

+

Description

+

appType

+

String

+

Service type, which is used only for rule classification and UI display. You can enter any field. For example, enter Java or Python by technology stack, or enter collector or database by function.

+

attrList

+

Array of strings

+

Attribute list. Currently, this parameter is not used and can be left blank. Values: cmdLine and env.

+

detectLog

+

String

+

Whether to enable log collection. Values: true and false.

+

discoveryRule

+

Array of DiscoveryRule objects

+

Discovery rule. If the array contains multiple conditions, only the processes that meet all the conditions will be matched. If the value of checkType is cmdLine, set the value of checkMode to contain. checkContent is in the format of ["xxx"], indicating that the process must contain the xxx parameter. If the value of checkType is env, set the value of checkMode to contain. checkContent is in the format of ["k1","v1"], indicating that the process must contain the environment variable whose name is k1 and value is v1. If the value of checkType is scope, set the value of checkMode to equals. checkContent is in the format of ["hostId1","hostId2"], indicating that the rule takes effect only on specified nodes. If no nodes are specified, the rule applies to all nodes of the project.

+

isDefaultRule

+

String

+

Whether the rule is the default one. Values: true and false.

+

isDetect

+

String

+

Whether the scenario is a pre-check scenario. No rules will be saved in the pre-check scenario. This scenario is designed only to check whether a rule can detect node processes before it is delivered. Values: true and false.

+

logFileFix

+

Array of strings

+

Log file suffix. Values: log, trace, and out.

+

logPathRule

+

Array of LogPathRule objects

+

Log path configuration rule. If cmdLineHash is a fixed string, logs in the specified log path or log file are collected. Otherwise, only the files whose names end with .log or .trace are collected. If the value of nameType is cmdLineHash, args is in the format of ["00001"] and value is in the format of ["/xxx/xx.log"], indicating that the log path is /xxx/xx.log when the startup command is 00001.

+

nameRule

+

NameRule object

+

Naming rules for discovered services and applications.

+

priority

+

Integer

+

Rule priority. Value range: 1 to 9999. Default value: 9999.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 7 DiscoveryRule

Parameter

+

Type

+

Description

+

checkContent

+

Array of strings

+

Matched value.

+

checkMode

+

String

+

Match condition. Values: contain and equals.

+

checkType

+

String

+

Match type. Values: cmdLine, env, and scope.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 8 LogPathRule

Parameter

+

Type

+

Description

+

args

+

Array of strings

+

Command.

+

nameType

+

String

+

Value type, which can be cmdLineHash.

+

value

+

Array of strings

+

Log path.

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 NameRule

Parameter

+

Type

+

Description

+

appNameRule

+

Array of AppNameRule objects

+

Service name rule. If there are multiple objects in the array, the character strings extracted from these objects constitute the service name. If the value of nameType is cmdLine, args is in the format of ["start", "end"], indicating that the characters between start and end in the command are extracted.If the value of nameType is cmdLine, args is in the format of ["aa"], indicating that the environment variable named aa is extracted.If the value of nameType is str, args is in the format of ["fix"], indicating that the service name is suffixed with fix.If the value of nameType is cmdLineHash, args is in the format of ["0001"] and value is in the format of ["ser"], indicating that the service name is ser when the startup command is 0001.

+

applicationNameRule

+

Array of ApplicationNameRule objects

+

Application name rule.If the value of nameType is cmdLine, args is in the format of ["start", "end"], indicating that the characters between start and end in the command are extracted.If the value of nameType is cmdLine, args is in the format of ["aa"], indicating that the environment variable named aa is extracted.If the value of nameType is str, args is in the format of ["fix"], indicating that the service name is suffixed with fix.If the value of nameType is cmdLineHash, args is in the format of ["0001"] and value is in the format of ["ser"], indicating that the application name is ser when the startup command is 0001.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 10 AppNameRule

Parameter

+

Type

+

Description

+

nameType

+

String

+

Value type. Values: cmdLineHash, cmdLine, env, and str.

+

args

+

Array of strings

+

Input value.

+

value

+

Array of strings

+

Service name, which is mandatory only when the value of nameType is cmdLineHash.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 11 ApplicationNameRule

Parameter

+

Type

+

Description

+

nameType

+

String

+

Value type. Values: cmdLineHash, cmdLine, env, and str.

+

args

+

Array of strings

+

Input value.

+

value

+

Array of strings

+

Service name, which is mandatory only when the value of nameType is cmdLineHash.

+
+
+
+

Example Requests

Query the application discovery rule.

+
https://{endpoint}/v1/{project_id}/inv/servicediscoveryrules?id=********-6066-****-8cc7-********
+
+

Example Responses

Status code: 200

+

OK: The request is successful.

+
{
+  "appRules" : [ {
+    "createTime" : "1694705814424",
+    "enable" : true,
+    "name" : "icaaant",
+    "eventName" : "aom_inventory_rules_event",
+    "hostid" : [ ],
+    "id" : "********-6066-****-8cc7-********",
+    "projectid" : "684fc87a79d7xxxx22e62a7da95b",
+    "spec" : {
+      "detectLog" : "true",
+      "editable" : null,
+      "logPathRule" : [ ],
+      "priority" : 9999,
+      "attrList" : [ "cmdLine" ],
+      "nameRule" : {
+        "appNameRule" : [ {
+          "args" : [ "/opt/********* -DNFW=ica**nt" ],
+          "nameType" : "cmdLineHash",
+          "value" : [ "aicagentserver" ]
+        } ],
+        "applicationNameRule" : [ {
+          "args" : [ "/opt/*********** -DNFW=ica**nt" ],
+          "nameType" : "cmdLineHash",
+          "value" : [ "aica**nt" ]
+        } ]
+      },
+      "appType" : "",
+      "aom_metric_relabel_configs" : null,
+      "logFileFix" : [ "log", "trace", "out" ],
+      "isDetect" : "false",
+      "isDefaultRule" : null,
+      "dataSource" : null,
+      "discoveryRule" : [ {
+        "checkType" : "cmdLine",
+        "checkContent" : [ "-DNFW=ica**nt" ],
+        "checkMode" : "contain"
+      } ]
+    },
+    "desc" : "Custom description"
+  } ],
+  "errorMessage" : null,
+  "errorCode" : "SVCSTG.INV.2000000",
+  "id" : [ ]
+}
+

Status code: 404

+

Not Found: The requested resource could not be found. The client should not repeat this request without modification.

+
{
+  "appRules" : [ ],
+  "errorMessage" : "Inventory does not exists",
+  "errorCode" : "SVCSTG.INV.4040000",
+  "id" : [ ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK: The request is successful.

+

400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+

401

+

Unauthorized: The authentication information is incorrect or invalid.

+

403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+

404

+

Not Found: The requested resource could not be found. The client should not repeat this request without modification.

+

500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+

503

+

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Monitoring
+
+
+ diff --git a/docs/aom/api-ref/PushEvents.html b/docs/aom/api-ref/PushEvents.html new file mode 100644 index 00000000..1739250a --- /dev/null +++ b/docs/aom/api-ref/PushEvents.html @@ -0,0 +1,286 @@ + + +

Reporting Events and Alarms

+

Function

This API is used to report events and alarms of a user.

+
+

URI

PUT /v2/{project_id}/push/events

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

action

+

No

+

String

+

Requested action. clear: The alarm is to be cleared. If this parameter is not transferred or other values are transferred, the alarm is reported by default.

+

Enumeration values:

+

  • clear

    +
+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token obtained from IAM.

+

Content-Type

+

Yes

+

String

+

Content type, which is application/json.

+

Enumeration values:

+

  • application/json

    +
+

x-enterprise-prject-id

+

No

+

String

+

ID of the enterprise project to which the alarm belongs.

+
+
+ +
+ + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

events

+

Yes

+

Array of EventModel objects

+

Event or alarm details.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 EventModel

Parameter

+

Mandatory

+

Type

+

Description

+

starts_at

+

No

+

Long

+

Time when an event or alarm is generated (CST timestamp precise down to the millisecond).

+

ends_at

+

No

+

Long

+

Time when an event or alarm is cleared (CST timestamp precise down to the millisecond). 0: The event or alarm is not deleted.

+

timeout

+

No

+

Long

+

Duration (in milliseconds) at which an alarm is automatically cleared. For example, if an alarm needs to be automatically cleared in one minute, set this parameter to 60000. The default value is 3 days (that is, 3 days x 24 hours x 60 minutes x 1000 ms = 4,320,000 ms).

+

metadata

+

No

+

Map<String,String>

+

Details of an event or alarm. The value is a key-value pair. The following fields are mandatory:

+

  • event_name: event or alarm name, which is a string.

    +

  • event_severity: event severity, which is an enumerated value with string elements. Value: Critical, Major, Minor, or Info.

    +

  • event_type: event type, which is an enumerated value with string elements. Value: event or alarm.

    +

  • resource_provider: name of a cloud service corresponding to an event, which is a string.

    +

  • resource_type: resource type corresponding to an event, which is a string.

    +

  • resource_id: resource ID corresponding to an event, which is a string.

    +
+

annotations

+

No

+

Map<String,String>

+

Additional field for an event or alarm, which can be left blank.

+

attach_rule

+

No

+

Map<String,String>

+

Reserved field for an event or alarm, which can be left blank.

+

id

+

No

+

String

+

Event or alarm ID, which is automatically generated by the system.

+
+
+
+

Response Parameters

None

+
+

Example Requests

Report an alarm named "test".

+
https://{EndPoint}/v2/{project_id}/push/events
+
+{
+  "events" : [ {
+    "starts_at" : 1605232501000,
+    "timeout" : 60000,
+    "metadata" : {
+      "event_name" : "test",
+      "event_severity" : "Major",
+      "event_type" : "alarm",
+      "resource_provider" : "ecs",
+      "resource_type" : "vm",
+      "resource_id" : "ecs123"
+    },
+    "annotations" : {
+      "alarm_probableCause_zh_cn" : "Possible Causes",
+      "alarm_fix_suggestion_zh_cn" : "Suggestions",
+      "message" : "Alarm Details"
+    },
+    "attach_rule" : { }
+  } ]
+}
+
+

Example Responses

None

+
+

Status Codes

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

Status Code

+

Description

+

204

+

OK: The request is successful.

+

400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+

401

+

Unauthorized: The authentication information is incorrect or invalid.

+

403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+

500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+

503

+

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm
+
+
+ diff --git a/docs/aom/api-ref/ShowAlarmRule.html b/docs/aom/api-ref/ShowAlarmRule.html new file mode 100644 index 00000000..b22867be --- /dev/null +++ b/docs/aom/api-ref/ShowAlarmRule.html @@ -0,0 +1,491 @@ + + +

Querying a Threshold Rule

+

Function

This API is used to query a threshold rule.

+
+

URI

GET /v2/{project_id}/alarm-rules/{alarm_rule_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+

alarm_rule_id

+

Yes

+

String

+

Threshold rule ID.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token obtained from IAM.

+

Content-Type

+

Yes

+

String

+

Content type, which is application/json.

+

Enumeration values:

+

  • application/json

    +
+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

meta_data

+

MetaData object

+

Metadata, including pagination information.

+

thresholds

+

Array of QueryAlarmResult objects

+

Threshold rule list.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 4 MetaData

Parameter

+

Type

+

Description

+

count

+

Integer

+

Number of returned records.

+

start

+

String

+

Start of the next page, which is used for pagination. null: No more data.

+

total

+

Integer

+

Total number of records.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 QueryAlarmResult

Parameter

+

Type

+

Description

+

action_enabled

+

Boolean

+

Whether to enable notification.

+

alarm_actions

+

Array of strings

+

List of alarm notifications.

+

alarm_advice

+

String

+

Alarm clearance suggestion.

+

alarm_description

+

String

+

Threshold rule description.

+

alarm_level

+

String

+

Alarm severity.

+

alarm_rule_id

+

String

+

Threshold rule ID.

+

alarm_rule_name

+

String

+

Threshold rule name.

+

comparison_operator

+

String

+

Comparison operator.

+

dimensions

+

Array of Dimension objects

+

List of time series dimensions.

+

evaluation_periods

+

Integer

+

Interval.

+

id_turn_on

+

Boolean

+

Whether to enable the threshold rule.

+

insufficient_data_actions

+

Array of strings

+

List of insufficient data notifications.

+

metric_name

+

String

+

Time series name.

+

namespace

+

String

+

Time series objects' namespace.

+

ok_actions

+

Array of strings

+

List of normal status notifications.

+

period

+

Integer

+

Statistical period.

+

policy_name

+

String

+

Threshold rule name.

+

resources

+

Array of strings

+

Resource information (discarded).

+

state_reason

+

String

+

Cause description.

+

state_updated_timestamp

+

String

+

Time when the status was updated.

+

state_value

+

String

+

Service status.

+

statistic

+

String

+

Statistic.

+

threshold

+

String

+

Threshold value.

+

type

+

String

+

Threshold rule type.

+

unit

+

String

+

Threshold unit.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 Dimension

Parameter

+

Type

+

Description

+

name

+

String

+

Dimension name.

+

value

+

String

+

Dimension value.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+

error_type

+

String

+

Error type.

+

trace_id

+

String

+

Trace ID, which is used to search for logs and locate faults. If 2xx is returned, trace_id is empty. If 4xx, trace_id is not empty.

+
+
+
+

Example Requests

Obtain the details about the alarm rule whose ID is alarm_rule_id.

+
https://{Endpoint}/v2/{project_id}/alarm-rules/{alarm_rule_id}
+
+

Example Responses

Status code: 200

+

OK: The request is successful.

+
{
+  "meta_data" : {
+    "count" : 1,
+    "start" : null,
+    "total" : 1
+  },
+  "thresholds" : [ {
+    "action_enabled" : false,
+    "alarm_actions" : null,
+    "alarm_advice" : null,
+    "alarm_description" : null,
+    "alarm_level" : 3,
+    "alarm_rule_id" : 2137,
+    "alarm_rule_name" : "aom_rule",
+    "comparison_operator" : ">=",
+    "dimensions" : [ {
+      "name" : "appName"
+    }, {
+      "value" : "rhm-broker"
+    } ],
+    "evaluation_periods" : 1,
+    "id_turn_on" : true,
+    "insufficient_data_actions" : null,
+    "metric_name" : "cpuCoreLimit",
+    "namespace" : "PAAS.CONTAINER",
+    "ok_actions" : null,
+    "period" : 60000,
+    "policy_name" : "23,",
+    "resources" : [ ],
+    "state_reason" : null,
+    "state_updated_timestamp" : null,
+    "statistic" : "average",
+    "threshold" : 0,
+    "type" : "single,",
+    "unit" : "Core"
+  } ]
+}
+

Status code: 400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+
{
+  "error_code" : "AOM.02001AOM.02001SVCSTG_AMS_4000115",
+  "error_msg" : "please check request param",
+  "error_type" : "BAD_REQUEST",
+  "trace_id" : ""
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK: The request is successful.

+

400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+

401

+

Unauthorized: The authentication information is incorrect or invalid.

+

403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+

500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+

503

+

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Monitoring
+
+
+ diff --git a/docs/aom/api-ref/ShowMetricsData.html b/docs/aom/api-ref/ShowMetricsData.html new file mode 100644 index 00000000..ff5cb688 --- /dev/null +++ b/docs/aom/api-ref/ShowMetricsData.html @@ -0,0 +1,503 @@ + + +

Querying Monitoring Data

+

Function

This API is used to query monitoring data of metrics within a specified time period. You can specify a dimension or period to query.

+
+

URI

POST /v1/{project_id}/ams/metricdata

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

fillValue

+

No

+

String

+

Value filled for breakpoints in monitoring data. Default value: –1. –1: Breakpoints are filled with –1. 0: Breakpoints are filled with 0. null: Breakpoints are filled with null. average: Breakpoints are filled with the average value of the adjacent valid data. If there is no valid data, breakpoints are filled with null.

+

Default: -1

+

Enumeration values:

+

  • -1

    +

  • 0

    +

  • null

    +

  • average

    +
+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token obtained from IAM.

+

Content-Type

+

Yes

+

String

+

Content type, which is application/json.

+

Enumeration values:

+

  • application/json

    +
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

metrics

+

Yes

+

Array of MetricQueryMeritcParam objects

+

Metric list. A JSON array can contain up to 20 objects.

+

period

+

Yes

+

Integer

+

Granularity for monitoring data, which is an enumerated value. Values: 60: The data monitoring granularity is 1 minute. 300: The data monitoring granularity is 5 minutes. 900: The data monitoring granularity is 15 minutes. 3600: The data monitoring granularity is 1 hour.

+

statistics

+

Yes

+

Array of strings

+

Statistic. Values: maximum, minimum, sum, average, and sampleCount.

+

timerange

+

Yes

+

String

+

Time range specified to query data of the last N minutes when the client time is inconsistent with the server time. It can also be used to accurately query the data of a specified period.

+

Example:

+

  • -1.-1.60: indicates that the data of the latest 60 minutes is queried. This query is based on the server time regardless of the current client time.

    +

  • 1650852000000.1650852300000.5: indicates the five minutes from 10:00:00 to 10:05:00 on April 25, 2022 GMT+08:00.

    +
+

Format:

+

startTimeInMillis.endTimeInMillis.durationInMinutes

+

Parameter description:

+

  • startTimeInMillis: Start time of the query, in milliseconds. If this parameter is set to -1, the server calculates the start time as follows: endTimeInMillis – durationInMinutes x 60 x 1000. For example, -1.1650852300000.5 is equivalent to 1650852000000.1650852300000.5.

    +

  • endTimeInMillis: End time of the query, in milliseconds. If this parameter is set to -1, the server calculates the end time as follows: startTimeInMillis + durationInMinutes x 60 x 1000. If the calculated end time is later than the current system time, the current system time is used. For example, 1650852000000.-1.5 is equivalent to 1650852000000.1650852300000.5.

    +

  • durationInMinutes: Time span, in minutes. The value must be greater than 0 and greater than or equal to the result of "(endTimeInMillis – startTimeInMillis)/(60 x 1000) – 1". If both the start time and end time are set to -1, the system sets the end time to the current UTC time (in milliseconds) and calculates the start time as follows: endTimeInMillis – durationInMinutes x 60 x 1000. For example, -1.-1.60 indicates the latest 60 minutes.

    +
+

Constraint:

+

In a single request, the following condition must be met: durationInMinutes x 60/period ≤ 1440

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 MetricQueryMeritcParam

Parameter

+

Mandatory

+

Type

+

Description

+

dimensions

+

Yes

+

Array of Dimension objects

+

List of metric dimensions. Neither the array nor the name or value of any dimension in the array can be left blank.

+

metricName

+

Yes

+

String

+

Metric name. Length: 1 to 255 characters. Value range: cpuUsage, cpuCoreUsed, and other basic metrics provided by AOM. cpuUsage: CPU usage. cpuCoreUsed: used CPU cores. Custom metrics.

+

namespace

+

Yes

+

String

+

Metric namespace. Values: PAAS.CONTAINER: namespace of component, instance, process, and container metrics. PAAS.NODE: namespace of host, network, disk, and file system metrics. PAAS.SLA: namespace of SLA metrics. PAAS.AGGR: namespace of cluster metrics. CUSTOMMETRICS: default namespace of custom metrics.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 Dimension

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Dimension name.

+

value

+

Yes

+

String

+

Dimension value.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

errorCode

+

String

+

Response code.

+

errorMessage

+

String

+

Response message.

+

metrics

+

Array of MetricDataValue objects

+

Metric list.

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 MetricDataValue

Parameter

+

Type

+

Description

+

dataPoints

+

Array of MetricDataPoints objects

+

Key metric.

+

metric

+

MetricQueryMeritcParam object

+

Query parameters.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 9 MetricDataPoints

Parameter

+

Type

+

Description

+

statistics

+

Array of StatisticValue objects

+

Statistic.

+

timestamp

+

Long

+

Timestamp.

+

unit

+

String

+

Time series unit.

+
+
+ +
+ + + + + + + + + + + + + +
Table 10 StatisticValue

Parameter

+

Type

+

Description

+

statistic

+

String

+

Statistic.

+

value

+

Double

+

Statistical result.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 11 MetricQueryMeritcParam

Parameter

+

Type

+

Description

+

dimensions

+

Array of Dimension objects

+

List of metric dimensions. Neither the array nor the name or value of any dimension in the array can be left blank.

+

metricName

+

String

+

Metric name. Length: 1 to 255 characters. Value range: cpuUsage, cpuCoreUsed, and other basic metrics provided by AOM. cpuUsage: CPU usage. cpuCoreUsed: used CPU cores. Custom metrics.

+

namespace

+

String

+

Metric namespace. Values: PAAS.CONTAINER: namespace of component, instance, process, and container metrics. PAAS.NODE: namespace of host, network, disk, and file system metrics. PAAS.SLA: namespace of SLA metrics. PAAS.AGGR: namespace of cluster metrics. CUSTOMMETRICS: default namespace of custom metrics.

+
+
+ +
+ + + + + + + + + + + + + +
Table 12 Dimension

Parameter

+

Type

+

Description

+

name

+

String

+

Dimension name.

+

value

+

String

+

Dimension value.

+
+
+
+

Example Requests

Query the monitoring data of aom_process_cpu_usage in the PAAS.CONTAINER namespace in the last five minutes.

+
https://{Endpoint}/v1/{project_id}/ams/metricdata
+
+{
+  "metrics" : [ {
+    "dimensions" : [ {
+      "name" : "appName",
+      "value" : "aomApp"
+    } ],
+    "metricName" : "aom_process_cpu_usage",
+    "namespace" : "PAAS.CONTAINER"
+  } ],
+  "period" : 60,
+  "statistics" : [ "maximum", "minimum", "sum" ],
+  "timerange" : "-1.-1.5"
+}
+
+

Example Responses

Status code: 200

+

OK: The request is successful.

+
{
+  "errorCode" : "SVCSTG.AMS.2000",
+  "errorMessage" : "success",
+  "metrics" : [ {
+    "metric" : {
+      "namespace" : "PAAS.CONTAINER",
+      "metricName" : "aom_process_cpu_usage",
+      "dimensions" : [ {
+        "name" : "appName",
+        "value" : "aomApp"
+      } ]
+    },
+    "dataPoints" : [ {
+      "timestamp" : "1467892800000",
+      "unit" : "Percent",
+      "statistics" : [ {
+        "statistic" : "maximum",
+        "value" : "23"
+      } ]
+    } ]
+  } ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK: The request is successful.

+

400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+

401

+

Unauthorized: The authentication information is incorrect or invalid.

+

403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+

500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+

503

+

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Monitoring
+
+
+ diff --git a/docs/aom/api-ref/UpdateAlarmRule.html b/docs/aom/api-ref/UpdateAlarmRule.html new file mode 100644 index 00000000..ff23d2ad --- /dev/null +++ b/docs/aom/api-ref/UpdateAlarmRule.html @@ -0,0 +1,455 @@ + + +

Modifying a Threshold Rule

+

Function

This API is used to modify a threshold rule.

+
+

URI

PUT /v2/{project_id}/alarm-rules

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token obtained from IAM.

+

Content-Type

+

Yes

+

String

+

Content type, which is application/json.

+

Enumeration values:

+

  • application/json

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

Parameter

+

Mandatory

+

Type

+

Description

+

action_enabled

+

No

+

Boolean

+

Whether to enable notification.

+

alarm_actions

+

No

+

Array of strings

+

List of alarm notifications.

+

alarm_advice

+

No

+

String

+

Alarm clearance suggestion, which contains a maximum of 255 characters.

+

Minimum: 0

+

Maximum: 255

+

alarm_description

+

No

+

String

+

Threshold rule description, which contains a maximum of 1024 characters.

+

Minimum: 0

+

Maximum: 1024

+

alarm_level

+

Yes

+

Integer

+

Alarm severity. Values: 1 (critical), 2 (major), 3 (minor), and 4 (warning).

+

Enumeration values:

+

  • 1

    +

  • 2

    +

  • 3

    +

  • 4

    +
+

alarm_rule_name

+

Yes

+

String

+

Threshold rule name. Enter a maximum of 100 characters and do not start or end with a special character. Only letters, digits, underscores (_), and hyphens (-) are allowed.

+

comparison_operator

+

Yes

+

String

+

Comparison operator. Options: <: less than the threshold; >: greater than the threshold; <=: less than or equal to the threshold; >=: greater than or equal to the threshold.

+

Enumeration values:

+

  • <

    +

  • >

    +

  • <=

    +

  • >=

    +
+

dimensions

+

Yes

+

Array of Dimension objects

+

List of time series dimensions.

+

evaluation_periods

+

Yes

+

Integer

+

Interval at which data is calculated.

+

id_turn_on

+

No

+

Boolean

+

Whether to enable the threshold rule.

+

insufficient_data_actions

+

No

+

Array of strings

+

List of insufficient data notifications.

+

metric_name

+

Yes

+

String

+

Time series name. Length: 1 to 255 characters.

+

namespace

+

Yes

+

String

+

Namespace of time series objects.

+

ok_actions

+

No

+

Array of strings

+

List of normal status notifications.

+

period

+

Yes

+

Integer

+

Statistical period. Options: 60000: one minute; 300000: five minutes; 900000: 15 minutes; 3600000: one hour.

+

Enumeration values:

+

  • 60000

    +

  • 300000

    +

  • 900000

    +

  • 36000000

    +
+

statistic

+

Yes

+

String

+

Statistic.

+

Enumeration values:

+

  • maximum

    +

  • minimum

    +

  • average

    +

  • sum

    +

  • sampleCount

    +
+

threshold

+

Yes

+

String

+

Threshold.

+

unit

+

Yes

+

String

+

Time series unit.

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

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Dimension name.

+

value

+

Yes

+

String

+

Dimension value.

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

alarm_rule_id

+

Long

+

Threshold rule ID.

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code.

+

error_msg

+

String

+

Error message.

+

error_type

+

String

+

Error type.

+

trace_id

+

String

+

Trace ID, which is used to search for logs and locate faults. If 2xx is returned, trace_id is empty. If 4xx, trace_id is not empty.

+
+
+
+

Example Requests

Modify a threshold rule whose name is testaom, alarm severity is 3, metric name is cpuCoreLimit, and namespace is PAAS.CONTAINER.

+
https://{Endpoint}/v2/{project_id}/alarm-rules
+
+{
+  "action_enabled" : false,
+  "alarm_actions" : [ ],
+  "alarm_advice" : "",
+  "alarm_description" : "",
+  "alarm_level" : 3,
+  "alarm_rule_name" : "aom_rule",
+  "comparison_operator" : ">=",
+  "dimensions" : [ {
+    "name" : "appName",
+    "value" : "rhm-broker"
+  } ],
+  "evaluation_periods" : 1,
+  "insufficient_data_actions" : [ ],
+  "metric_name" : "cpuCoreLimit",
+  "namespace" : "PAAS.CONTAINER",
+  "ok_actions" : [ ],
+  "period" : 60000,
+  "statistic" : "average",
+  "threshold" : 0,
+  "unit" : "Core"
+}
+
+

Example Responses

Status code: 200

+

OK: The request is successful.

+
{
+  "alarm_rule_id" : 91307490000416600
+}
+

Status code: 400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+
{
+  "error_code" : "AOM.02001AOM.02001SVCSTG_AMS_4000115",
+  "error_msg" : "please check request param",
+  "error_type" : "BAD_REQUEST",
+  "trace_id" : ""
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK: The request is successful.

+

400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+

401

+

Unauthorized: The authentication information is incorrect or invalid.

+

403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+

500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+

503

+

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Monitoring
+
+
+ diff --git a/docs/aom/api-ref/aom_04_0000.html b/docs/aom/api-ref/aom_04_0000.html deleted file mode 100644 index 50452f7b..00000000 --- a/docs/aom/api-ref/aom_04_0000.html +++ /dev/null @@ -1,8 +0,0 @@ - - -

API Usage Guidelines

-

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 using JSON messages, with the media type represented by Application/json.

-

For details about how to use APIs, see API Usage Guidelines.

-
- diff --git a/docs/aom/api-ref/aom_04_0010.html b/docs/aom/api-ref/aom_04_0010.html new file mode 100644 index 00000000..05e95b07 --- /dev/null +++ b/docs/aom/api-ref/aom_04_0010.html @@ -0,0 +1,16 @@ + + +

API

+

+
+
+ +
+ diff --git a/docs/aom/api-ref/aom_04_0013.html b/docs/aom/api-ref/aom_04_0013.html new file mode 100644 index 00000000..4c7d2d30 --- /dev/null +++ b/docs/aom/api-ref/aom_04_0013.html @@ -0,0 +1,360 @@ + + +

Adding Monitoring Data

+

Function

This API is used to add one or more monitoring data records to a server.

+
+

URI

POST /v1/{project_id}/ams/report/metricdata

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

+
+
+
+

Request Parameters

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

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token obtained from IAM.

+

Content-Type

+

Yes

+

String

+

Content type, which is application/json.

+

Enumeration values:

+

  • application/json

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

Parameter

+

Mandatory

+

Type

+

Description

+

[items]

+

Yes

+

Array of MetricDataItem objects

+

Metric parameters.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 MetricDataItem

Parameter

+

Mandatory

+

Type

+

Description

+

collect_time

+

Yes

+

Long

+

Data collection time (UNIX timestamp, in ms), which ranges from the last 24 hours to the next 0.5 hour. The following requirement needs to be met: Current UTC time – Data collection time ≤ 24 hours, or Data collection time – Current UTC time ≤ 30 minutes If the data reporting time is earlier than 08:00 of the current day, only the data generated after 08:00 of the current day is displayed on the metric monitoring page.

+

metric

+

Yes

+

MetricItemInfo object

+

Metric details.

+

values

+

Yes

+

Array of ValueData objects

+

Metric value.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 MetricItemInfo

Parameter

+

Mandatory

+

Type

+

Description

+

dimensions

+

Yes

+

Array of Dimension2 objects

+

List of metric dimensions. A maximum of 50 dimensions are supported. Each dimension is in JSON format. The structure is as follows: dimension.name: 1–32 characters. dimension.value: 1–64 characters.

+

namespace

+

Yes

+

String

+

Metric namespace. It cannot contain colons (:). It must be in the format of "service.item". The value must contain 3 to 32 characters starting with a letter. Only letters, digits, and underscores (_) are allowed. In addition, "service" cannot be "PAAS".

+

Minimum: 3

+

Maximum: 32

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 Dimension2

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Dimension name.

+

Minimum: 1

+

Maximum: 32

+

value

+

Yes

+

String

+

Dimension value.

+

Minimum: 1

+

Maximum: 64

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 ValueData

Parameter

+

Mandatory

+

Type

+

Description

+

metric_name

+

Yes

+

String

+

Metric name. Length: 1 to 255 characters.

+

type

+

No

+

String

+

Data type. Values: int and float.

+

Enumeration values:

+

  • int

    +

  • float

    +
+

unit

+

No

+

String

+

Data unit. Length: up to 32 characters.

+

value

+

Yes

+

Double

+

Metric value, which must be of a valid numeric type.

+

Minimum: 0

+
+
+
+

Response Parameters

Status code: 200

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

Parameter

+

Type

+

Description

+

errorCode

+

String

+

Response code.

+

errorMessage

+

String

+

Response message.

+
+
+
+

Example Requests

Add a piece of monitoring data to the server. (In the following example, set "collect_time" to the latest timestamp.)

+
https://{Endpoint}/v1/{project_id}/ams/report/metricdata
+
+[ {
+  "metric" : {
+    "namespace" : "NOPAAS.ESC",
+    "dimensions" : [ {
+      "name" : "instance_id",
+      "value" : "instance-101"
+    } ]
+  },
+  "values" : [ {
+    "unit" : "percent",
+    "metric_name" : "cpu_util",
+    "type" : "int",
+    "value" : 35
+  } ],
+  "collect_time" : 1467787152000
+} ]
+
+

Example Responses

Status code: 200

+

OK: The request is successful.

+
{
+  "errorCode" : "SVCSTG_AMS_2000000",
+  "errorMessage" : "success"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

OK: The request is successful.

+

400

+

Bad Request: The request is invalid. The client should not repeat the request without modifications.

+

401

+

Unauthorized: The authentication information is incorrect or invalid.

+

403

+

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

+

500

+

Internal Server Error: The server is able to receive the request but unable to understand the request.

+

503

+

Service Unavailable: The requested service is invalid. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Monitoring
+
+
+ diff --git a/docs/aom/api-ref/aom_04_0018.html b/docs/aom/api-ref/aom_04_0018.html index 12c5a0d0..a068c335 100644 --- a/docs/aom/api-ref/aom_04_0018.html +++ b/docs/aom/api-ref/aom_04_0018.html @@ -1,7 +1,7 @@

Status Codes

-

Table 1 describes the status codes.

+

Table 1 describes status codes.

diff --git a/docs/aom/api-ref/aom_04_0020.html b/docs/aom/api-ref/aom_04_0020.html index 0848c465..0e19bc4a 100644 --- a/docs/aom/api-ref/aom_04_0020.html +++ b/docs/aom/api-ref/aom_04_0020.html @@ -2,13 +2,19 @@

Change History

-
Table 1 Status codes

Status Code
Table 1 Change history

Released On

+
- - + + + diff --git a/docs/aom/api-ref/aom_04_0022.html b/docs/aom/api-ref/aom_04_0022.html new file mode 100644 index 00000000..1ac294f7 --- /dev/null +++ b/docs/aom/api-ref/aom_04_0022.html @@ -0,0 +1,21 @@ + + +

Introduction

+

This section describes fine-grained permissions management for AOM. If your cloud account does not need individual IAM users, then you may skip over this section.

+

By default, new IAM users do not have any permissions assigned. You need to add a user to one or more groups, and assign permissions policies or roles to these groups. The user then inherits permissions from the groups it is a member of. This process is called authorization. After authorization, the user can perform specified operations on AOM.

+

You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.

+

Policy-based authorization is recommended if you want to allow or deny the access to an API.

+
+

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions can call the API successfully. For example, if an IAM user queries metrics using an API, the user must have been granted permissions that allow the aom:metric:get action.

+

Supported Actions

There are two kinds of policies: system-defined policies and custom policies. If the permissions preset in the system do not meet your requirements, you can create custom policies and apply these policies to user groups for refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:

+
  • Permissions: Defined by actions in a custom policy.
  • APIs: REST APIs that can be called in a custom policy.
  • Actions: Added to a custom policy to control permissions for specific operations.
  • IAM projects and enterprise projects: Type of projects for which an action will take effect. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect for IAM. Such policies will not take effect if they are assigned to user groups in Enterprise Management.
+

AOM supports the following actions that can be defined in custom policies:

+
  • Monitoring Actions: includes the actions supported by monitoring APIs, such as the APIs for querying metrics and monitoring data.
  • Log Actions: includes the actions supported by log APIs, such as the API for querying logs.
  • Alarm Actions: includes the actions supported by alarm APIs, such as the API for querying events and alarms.
+
+
+ + diff --git a/docs/aom/api-ref/aom_04_0045.html b/docs/aom/api-ref/aom_04_0045.html new file mode 100644 index 00000000..bec493d7 --- /dev/null +++ b/docs/aom/api-ref/aom_04_0045.html @@ -0,0 +1,42 @@ + + +

Monitoring

+

+
+ + diff --git a/docs/aom/api-ref/aom_04_0047.html b/docs/aom/api-ref/aom_04_0047.html new file mode 100644 index 00000000..90d67dba --- /dev/null +++ b/docs/aom/api-ref/aom_04_0047.html @@ -0,0 +1,16 @@ + + +

Log

+

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/aom/api-ref/aom_04_0061.html b/docs/aom/api-ref/aom_04_0061.html new file mode 100644 index 00000000..daa1c98e --- /dev/null +++ b/docs/aom/api-ref/aom_04_0061.html @@ -0,0 +1,17 @@ + + +

Permissions Policies and Supported Actions

+
+ + diff --git a/docs/aom/api-ref/aom_04_0062.html b/docs/aom/api-ref/aom_04_0062.html new file mode 100644 index 00000000..af6fa162 --- /dev/null +++ b/docs/aom/api-ref/aom_04_0062.html @@ -0,0 +1,171 @@ + + +

Monitoring Actions

+

√: supported; x: not supported

+
+ +
Table 1 Change History

Released On

Description

+

Change History

2022-09-29

+

2024-02-29

+		 +

2022-09-29
  • Deleted the description of auto scaling APIs.
  • Optimized the solution description for error codes.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Monitoring actions

Permissions

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Querying time series objects

+

POST /v2/{project_id}/series

+

aom:metric:list

+

√

+

×

+

Querying time series data

+

POST /v2/{project_id}/samples

+

aom:metric:list

+

√

+

×

+

Querying metrics

+

POST /v1/{project_id}/ams/metrics

+

aom:metric:get

+

√

+

×

+

Querying monitoring data

+

POST /v1/{project_id}/ams/metricdata

+

aom:metric:get

+

√

+

×

+

Adding or modifying a service discovery rule

+

PUT /v1/{project_id}/inv/servicediscoveryrules

+

aom:discoveryRule:set

+

√

+

×

+

Deleting a service discovery rule

+

DELETE /v1/{project_id}/inv/servicediscoveryrules

+

aom:discoveryRule:delete

+

√

+

×

+

Querying existing service discovery rules

+

GET /v1/{project_id}/inv/servicediscoveryrules

+

aom:discoveryRule:get

+

√

+

×

+

Adding a threshold rule

+

POST /v2/{project_id}/alarm-rules

+

aom:alarmRule:create

+

√

+

×

+

Querying the threshold rule list

+

GET /v2/{project_id}/alarm-rules

+

aom:alarmRule:get

+

√

+

×

+

Modifying a threshold rule

+

PUT /v2/{project_id}/alarm-rules

+

aom:alarmRule:set

+

√

+

×

+

Deleting a threshold rule

+

DELETE /v2/{project_id}/alarm-rules/{alarm_rule_id}

+

aom:alarmRule:delete

+

√

+

×

+

Querying a threshold rule

+

GET /v2/{project_id}/alarm-rules/{alarm_rule_id}

+

aom:alarmRule:get

+

√

+

×

+

Deleting threshold rules in batches

+

POST /v2/{project_id}/alarm-rules/delete

+

aom:alarmRule:delete

+

√

+

×

+
+
+ + + diff --git a/docs/aom/api-ref/aom_04_0064.html b/docs/aom/api-ref/aom_04_0064.html new file mode 100644 index 00000000..48d090a0 --- /dev/null +++ b/docs/aom/api-ref/aom_04_0064.html @@ -0,0 +1,39 @@ + + +

Log Actions

+

√: supported; x: not supported

+
+ +
+ + + + + + + + + + + + + +
Table 1 Log actions

Permissions

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Querying logs

+

POST /v1/{project_id}/als/action

+

aom:log:list

+

√

+

×

+
+
+
+ + diff --git a/docs/aom/api-ref/aom_04_0065.html b/docs/aom/api-ref/aom_04_0065.html new file mode 100644 index 00000000..64984a6d --- /dev/null +++ b/docs/aom/api-ref/aom_04_0065.html @@ -0,0 +1,61 @@ + + +

Alarm Actions

+

√: supported; x: not supported

+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Alarm actions

Permissions

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Querying events and alarms

+

POST /v2/{project_id}/events

+

aom:alarm:list

+

√

+

×

+

Counting events and alarms

+

POST /v2/{project_id}/events/statistic

+

aom:alarm:list

+

√

+

×

+

Reporting events and alarms

+

PUT /v2/{project_id}/push/events

+

aom:alarm:put

+

√

+

×

+
+
+
+ + diff --git a/docs/aom/api-ref/aom_04_0066.html b/docs/aom/api-ref/aom_04_0066.html index e9f48183..268bd1e7 100644 --- a/docs/aom/api-ref/aom_04_0066.html +++ b/docs/aom/api-ref/aom_04_0066.html @@ -6,6 +6,10 @@
  • Status Codes
    • +
  • Error Codes
    +
    • +
  • Obtaining an Account ID and Project ID
    +
  • Common Request Headers
  • Common Response Headers
    diff --git a/docs/aom/api-ref/aom_04_0079.html b/docs/aom/api-ref/aom_04_0079.html new file mode 100644 index 00000000..7dd81b04 --- /dev/null +++ b/docs/aom/api-ref/aom_04_0079.html @@ -0,0 +1,20 @@ + + +

    Alarm

    +

    +
    + + diff --git a/docs/aom/api-ref/aom_04_1010.html b/docs/aom/api-ref/aom_04_1010.html deleted file mode 100644 index 9e87b60f..00000000 --- a/docs/aom/api-ref/aom_04_1010.html +++ /dev/null @@ -1,13 +0,0 @@ - - -

    APIs

    -
    - - diff --git a/docs/aom/api-ref/aom_04_1011.html b/docs/aom/api-ref/aom_04_1011.html deleted file mode 100644 index 64f79822..00000000 --- a/docs/aom/api-ref/aom_04_1011.html +++ /dev/null @@ -1,410 +0,0 @@ - - -

    Querying Metrics

    -

    Function

    This API is used to query the metrics that can be monitored in the system. You can specify the namespace, metric name, dimension, resource ID (format: resType_resId), start position, and maximum number of returned records in pagination queries.

    -
    -

    URI

    POST /v2/{project_id}/ams/metrics?type={type}&limit={limit}&start={start}

    -

    Table 1 describes the parameters.

    - -
    - - - - - - - - - - - - - - - - - - - - - -
    Table 1 Parameters

    Parameter

    -

    Mandatory

    -

    Description

    -

    project_id

    -

    Yes

    -

    Project ID obtained from IAM. Generally, a project ID contains 32 characters.

    -

    type

    -

    No

    -

    Metric query mode. The information carried by metricItems in the request body is used to query metrics.

    -

    limit

    -

    No

    -

    Maximum number of returned records. Value range: 1–1000. Default value: 1000.

    -

    start

    -

    No

    -

    Start position of a pagination query. The value is a non-negative integer.

    -
    -
    -
    -

    Request

    Request parameters

    -

    Table 2 describes the request parameters.

    - -
    - - - - - - - - - - - - - -
    Table 2 Request parameter

    Parameter

    -

    Mandatory

    -

    Type

    -

    Value Range

    -

    Description

    -

    metricItems

    -

    No

    -

    Arrays

    -

    See Table 3.

    -

    If type (a URI parameter) is not inventory, the information carried by the array is used to query metrics.

    -
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 3 metricItems parameters

    Parameter

    -

    Mandatory

    -

    Type

    -

    Value Range

    -

    Description

    -

    namespace

    -

    Yes

    -

    String

    -

    PAAS.CONTAINER, PAAS.NODE, PAAS.SLA, PAAS.AGGR, CUSTOMMETRICS, and so on.

    -

    Metric namespace.

    -

    PAAS.CONTAINER: application metric.

    -

    PAAS.NODE: node metric.

    -

    PAAS.SLA: Service Level Agreement (SLA) metric.

    -

    PAAS.AGGR: cluster metric.

    -

    CUSTOMMETRICS: custom metric.

    -

    dimensions

    -

    No

    -

    Array

    -

    -

    -

    Metric dimension.

    -

    dimensions.name: dimension name, such as clusterName, clusterId, appName, appID, deploymentName, podName, podID, containerName, or containerID.

    -

    dimensions.value: dimension value, such as a specific application instance ID.

    -

    metricName

    -

    No

    -

    String

    -

    1–1000 characters.

    -

    Metric name.

    -
    -
    -

    Request headers

    -

    Table 4 describes the request headers.

    - -
    - - - - - - - - - - - - - -
    Table 4 Request headers

    Name

    -

    Mandatory

    -

    Description

    -

    X-Auth-Token

    -

    Yes

    -

    User token obtained from IAM.

    -

    Content-Type

    -

    Yes

    -

    Content type, which is application/json.

    -
    -
    -

    Example request

    -

    (Query by namespace+appName+clusterName)

    -
    /v2/{projectId}/ams/metrics
-{
-    "metricItems": [
-        {
-            "namespace": "PAAS.CONTAINER",
-            "dimensions":[
-                {
-                    "name":"appName",
-                    "value":"demo"
-                },
-                {
-                    "name":"clusterName",
-                    "value":"test"
-                }
-            ]
-        }
-    ]
-}
    -
    -

    Response

    Response parameters

    -

    Table 5 describes the response parameters.

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 5 Response parameters

    Parameter

    -

    Type

    -

    Description

    -

    errorCode

    -

    String

    -

    Response code. Example: AOM.0200, which indicates a success response.

    -

    errorMessage

    -

    String

    -

    Response message.

    -

    metrics

    -

    JSON array

    -

    List of metrics.

    -

    namespace

    -

    String

    -

    Namespace.

    -

    metricName

    -

    String

    -

    Metric name.

    -

    unit

    -

    String

    -

    Metric unit.

    -

    dimensions

    -

    JSON array

    -

    List of metric dimensions.

    -
    -
    -

    Example response

    -
    { 
-    "errorCode": "AOM.0200", 
-    "errorMessage": "success", 
-    "metrics": [{ 
-        "namespace": "abc", 
-        "metricName": "cpuUsage", 
-        "unit":"Percent", 
-        "dimensions": [{ 
-                    "name": "instance_id", 
-                    "value": "demo1" 
-        }]     
-    }] 
-}
    -
    -

    Status Code

    • Success response

      Table 6 describes the status code.

      - -
      - - - - - - - - - -
      Table 6 Status code

      Status Code

      -

      Message

      -

      Description

      -

      200

      -

      OK

      -

      The request has succeeded.

      -
      -
      -
    -
    • Error response

      Table 7 describes the status codes. For more information, see Status Codes.

      - -
      - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 7 Status codes

      Status Code

      -

      Message

      -

      Description

      -

      400

      -

      Bad Request

      -

      The request is invalid.

      -

      The client should not repeat the request without modifications.

      -

      401

      -

      Unauthorized

      -

      The authorization information provided by the client is incorrect or invalid.

      -

      403

      -

      Forbidden

      -

      The request is rejected.

      -

      The server has received the request and understood it, but the server is refusing to respond to it. The client should not repeat the request without modifications.

      -

      500

      -

      Internal Server Error

      -

      The server is able to receive the request but unable to understand the request.

      -

      503

      -

      Service Unavailable

      -

      The requested service is invalid.

      -

      The client should not repeat the request without modifications.

      -
      -
      -
    -
    -

    Error Code

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 8 Error codes

    Error Code

    -

    Message

    -

    Solution

    -

    AOM.0101

    -

    Invalid namespace.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0102

    -

    Invalid inventoryId.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0103

    -

    ProjectId is left blank.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0105

    -

    Invalid limit.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0106

    -

    Invalid start.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0109

    -

    Invalid metricName.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0501

    -

    The Cassandra session is null.

    -

    Contact technical support.

    -

    AOM.0502

    -

    The Cassandra execution is abnormal.

    -

    Contact technical support.

    -
    -
    -
    -
    -
    -
    -
    Parent topic: Monitoring APIs
    -
    -
    - diff --git a/docs/aom/api-ref/aom_04_1012.html b/docs/aom/api-ref/aom_04_1012.html deleted file mode 100644 index 64f5c507..00000000 --- a/docs/aom/api-ref/aom_04_1012.html +++ /dev/null @@ -1,431 +0,0 @@ - - -

    Querying Monitoring Data

    -

    Function

    This API is used to query monitoring data of metrics within a specified time period. You can specify a dimension or period to query data.

    -
    -

    URI

    POST /v2/{project_id}/ams/metricdata

    -

    Table 1 describes the parameters.

    - -
    - - - - - - - - - - - - - - - - - - - -
    Table 1 Parameters

    Parameter

    -

    Mandatory

    -

    Type

    -

    Value Range

    -

    Description

    -

    project_id

    -

    Yes

    -

    String

    -

    -

    -

    Project ID obtained from IAM. Generally, a project ID contains 32 characters.

    -

    fillValue

    -

    No

    -

    String

    -

    –1, 0, null, and average

    -

    Filled value for breakpoints in monitoring data. Default value: –1.

    -
    • –1: Breakpoints are filled with –1.
    • 0: Breakpoints are filled with 0.
    • null: Breakpoints are filled with null.
    • average: Breakpoints are filled with the average value of adjacent valid data. If there is no valid data, breakpoints are filled with null.
    -
    -
    -
    -

    Request

    Request parameters

    -

    Table 2 describes the request parameters.

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 2 Request parameters

    Parameter

    -

    Mandatory

    -

    Type

    -

    Value Range

    -

    Description

    -

    metrics

    -

    Yes

    -

    JSON array

    -

    A maximum of 20 metrics are supported. See Table 3.

    -

    List of metrics.

    -

    period

    -

    Yes

    -

    Integer

    -

    Enumerated value. Options:

    -
    • 60: The data monitoring granularity is 1 minute.
    • 300: The data monitoring granularity is 5 minutes.
    • 900: The data monitoring granularity is 15 minutes.
    • 3600: The data monitoring granularity is 1 hour.
    -

    Data monitoring granularity.

    -

    timerange

    -

    Yes

    -

    String

    -

    Format: start time (UTC, in ms).end time (UTC, in ms).number of minutes in the time period. When the start time and end time are –1, it indicates the latest N minutes. N indicates the time period by the granularity of minute.

    -

    Query time period. For example, –1.–1.5 indicates the last 5 minutes. 1501545600000.1501632000000.1440 indicates the fixed time period from 08:00:00 on August 1, 2017 to 08:00:00 on August 2, 2017.

    -
    NOTE:

    Time range/Period ≤ 1440

    -

    The timerange and period must use the same unit.

    -
    -

    statistics

    -

    Yes

    -

    JSON array

    -

    maximum, minimum, sum, average, or sampleCount.

    -

    Statistic.

    -
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 3 metrics parameters

    Parameter

    -

    Mandatory

    -

    Type

    -

    Value Range

    -

    Description

    -

    namespace

    -

    Yes

    -

    String

    -

    PAAS.CONTAINER, PAAS.NODE, PAAS.SLA, PAAS.AGGR, and CUSTOMMETRICS.

    -

    Metric namespace.

    -

    metricName

    -

    Yes

    -

    String

    -

    1–255 characters.

    -

    Metric name.

    -

    dimensions

    -

    Yes

    -

    JSON array

    -

    Neither the array nor the name/value of any dimension in the array can be left blank.

    -

    Metric dimension.

    -

    dimensions.name: dimension name. Example: appName.

    -

    dimensions.value: dimension value, such as a specific application name.

    -
    -
    -

    Request headers

    -

    Table 4 describes the request headers.

    - -
    - - - - - - - - - - - - - -
    Table 4 Request headers

    Name

    -

    Mandatory

    -

    Description

    -

    X-Auth-Token

    -

    Yes

    -

    User token obtained from IAM.

    -

    Content-Type

    -

    Yes

    -

    Content type, which is application/json.

    -
    -
    -

    Example request

    -
    { 
-    "metrics": [ 
-        { 
-            "namespace": "abc", 
-            "metricName": "def", 
-            "dimensions": [ 
-                { 
-                    "name": "instance_id", 
-                    "value": "demo1" 
-                } 
-            ] 
-        } 
-    ], 
-    "period": 60, 
-    "timerange": "-1.-1.5",//Last 5 minutes
-      "statistics": [ 
-        "maximum", 
-        "minimum", 
-        "sum" 
-    ] 
-}
    -
    -

    Response

    Response parameters

    -

    Table 5 describes the response parameters.

    - -
    - - - - - - - - - - - - - - - - - -
    Table 5 Response parameters

    Parameter

    -

    Type

    -

    Description

    -

    errorCode

    -

    String

    -

    Response code.

    -

    errorMessage

    -

    String

    -

    Response message.

    -

    metrics

    -

    JSON object

    -

    -

    -
    -
    -

    Example response

    -
    { 
-    "errorCode": "AOM.0200", 
-    "errorMessage": "success", 
-    "metrics": [{ 
-      "metric": { 
-        "namespace": "abc", 
-        "metricName": "def", 
-        "dimensions": [{ 
-          "name": "ghi", 
-          "value": "lmn" 
-        }] 
-      }, 
-      "dataPoints": [{ 
-        "timestamp": 1467892800000, 
-        "unit": "Percent", 
-        "statistics": [{ 
-          "statistic": "maximum", 
-          "value": 23 
-        }] 
-      }] 
-    }] 
-}
    -
    -

    Status Code

    • Success response

      Table 6 describes the status code.

      - -
      - - - - - - - - - -
      Table 6 Status code

      Status Code

      -

      Message

      -

      Description

      -

      200

      -

      OK

      -

      The request has succeeded.

      -
      -
      -
    -
    • Error response

      Table 7 describes the status codes. For more information, see Status Codes.

      - -
      - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 7 Status codes

      Status Code

      -

      Message

      -

      Description

      -

      400

      -

      Bad Request

      -

      The request is invalid.

      -

      The client should not repeat the request without modifications.

      -

      401

      -

      Unauthorized

      -

      The authorization information provided by the client is incorrect or invalid.

      -

      403

      -

      Forbidden

      -

      The request is rejected.

      -

      The server has received the request and understood it, but the server is refusing to respond to it. The client should not repeat the request without modifications.

      -

      500

      -

      Internal Server Error

      -

      The server is able to receive the request but unable to understand the request.

      -

      503

      -

      Service Unavailable

      -

      The requested service is invalid.

      -

      The client should not repeat the request without modifications.

      -
      -
      -
    -
    -

    Error Code

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 8 Error codes

    Error Code

    -

    Message

    -

    Solution

    -

    AOM.0101

    -

    Projectid is left blank.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0102

    -

    The metric data parameter is null.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0103

    -

    Invalid period.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0104

    -

    Invalid statistics.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0105

    -

    Invalid metrics.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0106

    -

    Invalid time range.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0107

    -

    The number of data points in a time range exceeds 1440.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0110

    -

    Invalid fillValue.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0500

    -

    Internal server error.

    -

    Contact technical support.

    -
    -
    -
    -
    -
    -
    -
    Parent topic: Monitoring APIs
    -
    -
    - diff --git a/docs/aom/api-ref/aom_04_1013.html b/docs/aom/api-ref/aom_04_1013.html deleted file mode 100644 index 37fc3c1c..00000000 --- a/docs/aom/api-ref/aom_04_1013.html +++ /dev/null @@ -1,429 +0,0 @@ - - -

    Adding Monitoring Data

    -

    Function

    This API is used to add one or more monitoring data records to a server.

    -
    -

    URI

    POST /v2/{project_id}/ams/report/metricdata

    -

    Table 1 describes the parameters.

    - -
    - - - - - - - - - -
    Table 1 Parameters

    Parameter

    -

    Mandatory

    -

    Description

    -

    project_id

    -

    Yes

    -

    Project ID obtained from IAM. Generally, a project ID contains 32 characters.

    -
    -
    -
    -

    Request

    Request parameters

    -

    Table 2 describes the request parameters.

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 2 Request parameters

    Parameter

    -

    Mandatory

    -

    Type

    -

    Value Range

    -

    Description

    -

    metric

    -

    Yes

    -

    JSON object

    -

    See Table 3.

    -

    Metric data.

    -

    values

    -

    Yes

    -

    JSON array

    -

    See Table 4.

    -

    -

    -

    collect_time

    -

    Yes

    -

    UNIX timestamp

    -

    UNIX timestamp, in ms.

    -

    Data collection time, which must meet the following requirement:

    -

    Current UTC time – Data collection time ≤ 24 hours, or Data collection time – Current UTC time ≤ 30 minutes

    -
    -
    - -
    - - - - - - - - - - - - - - - - - - - -
    Table 3 metric parameters

    Parameter

    -

    Mandatory

    -

    Type

    -

    Value Range

    -

    Description

    -

    namespace

    -

    Yes

    -

    String

    -

    Namespace, which must be in the format of service.item. The value must be 3 to 32 characters starting with a letter. Only letters, digits, and underscores (_) are allowed. In addition, service cannot start with PAAS or SYS.

    -

    Metric namespace.

    -

    dimensions

    -

    Yes

    -

    JSON array

    -

    Each dimension is a JSON object, and its structure is as follows:

    -

    dimension.name: 1–32 characters.

    -

    dimension.value: 1–64 characters.

    -

    List of metric dimensions.

    -
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 4 values parameters

    Parameter

    -

    Mandatory

    -

    Type

    -

    Value Range

    -

    Description

    -

    unit

    -

    No

    -

    String

    -

    -

    -

    Data unit.

    -

    metric_name

    -

    Yes

    -

    String

    -

    -

    -

    Metric name.

    -

    type

    -

    No

    -

    String

    -

    Integer or floating number

    -

    Data type.

    -

    value

    -

    Yes

    -

    Floating number

    -

    Valid numeral type.

    -

    Metric value.

    -
    -
    -

    Request headers

    -

    Table 5 describes the request headers.

    - -
    - - - - - - - - - - - - - -
    Table 5 Request headers

    Name

    -

    Mandatory

    -

    Description

    -

    X-Auth-Token

    -

    Yes

    -

    User token obtained from IAM.

    -

    Content-Type

    -

    Yes

    -

    Content type, which is application/json.

    -
    -
    -

    Example request

    -
    [ 
-    { 
-        "metric": { 
-            "namespace": "NOPAAS.ESC", 
-            "dimensions": [ 
-                { 
-                    "name": "instance_id", 
-                    "value": "instance-101" 
-                } 
-            ] 
-        }, 
-        "values": [ 
-            { 
-                "unit": "percent", 
-                "metric_name": "cpu_util", 
-                "type": "int", 
-                "value": 35 
-            } 
-        ], 
-        "collect_time": 1467787152000 
-    } 
-]
    -
    -

    Response

    Response parameters

    -

    Table 6 describes the response parameters.

    - -
    - - - - - - - - - - - - - -
    Table 6 Response parameters

    Parameter

    -

    Type

    -

    Description

    -

    errorCode

    -

    String

    -

    Response code.

    -

    errorMessage

    -

    String

    -

    Response message.

    -
    -
    -

    Example response

    -
    { 
-    "errorCode": "AOM.0200", 
-    "errorMessage": "success" 
-}
    -
    -

    Status Code

    • Success response

      Table 7 describes the status code.

      - -
      - - - - - - - - - -
      Table 7 Status code

      Status Code

      -

      Message

      -

      Description

      -

      200

      -

      OK

      -

      The request has succeeded.

      -
      -
      -
    -
    • Error response

      Table 8 describes the status codes. For more information, see Status Codes.

      - -
      - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 8 Status codes

      Status Code

      -

      Message

      -

      Description

      -

      400

      -

      Bad Request

      -

      The request is invalid.

      -

      The client should not repeat the request without modifications.

      -

      401

      -

      Unauthorized

      -

      The authorization information provided by the client is incorrect or invalid.

      -

      403

      -

      Forbidden

      -

      The request is rejected.

      -

      The server has received the request and understood it, but the server is refusing to respond to it. The client should not repeat the request without modifications.

      -

      500

      -

      Internal Server Error

      -

      The server is able to receive the request but unable to understand the request.

      -

      503

      -

      Service Unavailable

      -

      The requested service is invalid.

      -

      The client should not repeat the request without modifications.

      -
      -
      -
    -
    -

    Error Code

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 9 Error codes

    Error Code

    -

    Message

    -

    Solution

    -

    AOM.0001

    -

    Invalid request parameter.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0002

    -

    Invalid namespace.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0003

    -

    Dimensions are left blank.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0005

    -

    Invalid metric data type.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0006

    -

    The metric data value is left blank.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0007

    -

    Invalid name or value length in the dimension.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0008

    -

    The request exceeds 40 KB.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0009

    -

    A metric supports a maximum of 20 dimensions.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0010

    -

    Invalid collection time.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0500

    -

    Internal server error.

    -

    Contact technical support.

    -
    -
    -
    -
    -
    -
    -
    Parent topic: Monitoring APIs
    -
    -
    - diff --git a/docs/aom/api-ref/aom_04_1014.html b/docs/aom/api-ref/aom_04_1014.html deleted file mode 100644 index b924ba9b..00000000 --- a/docs/aom/api-ref/aom_04_1014.html +++ /dev/null @@ -1,518 +0,0 @@ - - -

    Adding a Threshold Rule

    -

    Function

    This API is used to add a threshold rule.

    -
    -

    URI

    POST /v2/{project_id}/ams/alarms

    -
    -

    Request

    Request parameters

    -

    Table 1 describes the request parameters.

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 1 Request parameters

    Parameter

    -

    Mandatory

    -

    Type

    -

    Value Range

    -

    Description

    -

    project_id

    -

    Yes

    -

    String

    -

    Non-null.

    -

    Project ID obtained from IAM. Generally, a project ID contains 32 characters.

    -

    statistic

    -

    Yes

    -

    String

    -

    maximum, minimum, average, sum, or sampleCount.

    -

    Statistic.

    -

    namespace

    -

    Yes

    -

    String

    -

    1–255 characters. Colons (:) are not allowed.

    -

    Namespace.

    -

    metricName

    -

    Yes

    -

    String

    -

    1–255 characters.

    -

    Metric name.

    -

    period

    -

    Yes

    -

    Integer

    -

    20000, 60000, 300000, 900000, 1800000, 3600000, 14400000, or 86400000

    -

    Statistical period.

    -

    alarmLevel

    -

    No

    -

    Integer

    -

    4, 3, 2, or 1

    -

    Alarm severity.

    -

    evaluationPeriods

    -

    Yes

    -

    Integer

    -

    4, 3, or 2

    -

    Number of consecutive periods.

    -

    comparisonOperator

    -

    Yes

    -

    String

    -

    >, >=, <, or <=

    -

    Comparison operator.

    -

    threshold

    -

    Yes

    -

    String

    -

    Non-null value that can be converted to a value of the double type. Once converted, the value cannot be null, or be a positive or negative infinity.

    -

    Threshold.

    -

    alarmName

    -

    Yes

    -

    String

    -

    1–255 characters. Special characters are not allowed.

    -

    Threshold name.

    -

    dimensions

    -

    Yes

    -

    List

    -

    Non-null; number of dimensions < 100

    -

    Metric dimension.

    -

    unit

    -

    No

    -

    String

    -

    Number of characters < 32

    -

    Metric unit.

    -

    actionEnabled

    -

    No

    -

    Boolean

    -

    -

    -

    Whether to enable the alarm function.

    -

    alarmActions

    -

    No

    -

    Array

    -

    Size ≤ 5

    -

    Alarm action.

    -

    alarmAdvice

    -

    No

    -

    String

    -

    Number of characters < 255

    -

    Suggestion.

    -

    alarmDescription

    -

    No

    -

    String

    -

    Number of characters < 255

    -

    Threshold rule description.

    -

    insufficientDataActions

    -

    No

    -

    Array

    -

    Size ≤ 5

    -

    Action to be taken when data is insufficient.

    -

    okActions

    -

    No

    -

    Array

    -

    Size ≤ 5

    -

    Recovery action.

    -
    -
    -

    Request headers

    -

    Table 2 describes the request headers.

    - -
    - - - - - - - - - - - - - -
    Table 2 Request headers

    Name

    -

    Mandatory

    -

    Description

    -

    X-Auth-Token

    -

    Yes

    -

    User token obtained from IAM.

    -

    Content-Type

    -

    Yes

    -

    Content type, which is application/json.

    -
    -
    -

    Example request

    -
    { 
-    "actionEnabled": false, 
-    "alarmActions": [], 
-    "alarmAdvice": "", 
-    "alarmDescription": "", 
-    "alarmLevel": 3, 
-    "alarmName": "aaaaaaaa", 
-    "comparisonOperator": ">=", 
-    "dimensions": [ 
-        { 
-            "name": "appName", 
-            "value": "rhm-broker" 
-        } 
-    ], 
-    "evaluationPeriods": 1, 
-    "insufficientDataActions": [], 
-    "metricName": "cpuCoreLimit", 
-    "namespace": "PAAS.CONTAINER", 
-    "okActions": [], 
-    "period": 60000, 
-    "statistic": "average", 
-    "threshold": 0, 
-    "unit": "Core" 
-}
    -
    -

    Response

    Response parameters

    -

    Table 3 describes the response parameters.

    - -
    - - - - - - - - - - - - - - - - - -
    Table 3 Response parameters

    Parameter

    -

    Type

    -

    Description

    -

    errorCode

    -

    String

    -

    Response code.

    -

    errorMessage

    -

    String

    -

    Response message.

    -

    alarmId

    -

    Long

    -

    Threshold rule code.

    -
    -
    -

    Example response

    -
    { 
-    "errorCode": "AOM.0200", 
-    "errorMessage": "success", 
-    "alarmId": 12345678 
-}
    -
    -

    Status Code

    • Success response

      Table 4 describes the status code.

      - -
      - - - - - - - - - -
      Table 4 Status code

      Status Code

      -

      Message

      -

      Description

      -

      200

      -

      OK

      -

      The request has succeeded.

      -
      -
      -
    -
    • Error response

      Table 5 describes the status codes. For more information, see Status Codes.

      - -
      - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 5 Status codes

      Status Code

      -

      Message

      -

      Description

      -

      400

      -

      Bad Request

      -

      The request is invalid.

      -

      The client should not repeat the request without modifications.

      -

      401

      -

      Unauthorized

      -

      The authorization information provided by the client is incorrect or invalid.

      -

      403

      -

      Forbidden

      -

      The request is rejected.

      -

      The server has received the request and understood it, but the server is refusing to respond to it. The client should not repeat the request without modifications.

      -

      500

      -

      Internal Server Error

      -

      The server is able to receive the request but unable to understand the request.

      -

      503

      -

      Service Unavailable

      -

      The requested service is invalid.

      -

      The client should not repeat the request without modifications.

      -
      -
      -
    -
    -

    Error Code

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 6 Error codes

    Error Code

    -

    Message

    -

    Solution

    -

    AOM.0101

    -

    Invalid alarm name.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0102

    -

    The threshold rule name already exists.

    -

    Use another name.

    -

    AOM.0103

    -

    Invalid alarm description.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0104

    -

    Invalid alarm threshold.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0105

    -

    Invalid alarm period.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0106

    -

    Invalid email list.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0107

    -

    The maximum number of threshold rules has been reached.

    -

    Contact technical support to expand the capacity.

    -

    AOM.0108

    -

    Invalid time range for alarm queries.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0109

    -

    Invalid project ID.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0115

    -

    Invalid request parameter.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0118

    -

    Invalid number of consecutive periods.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0119

    -

    Invalid alarm statistic.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0120

    -

    Invalid alarm comparison operator.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0121

    -

    The alarm does not exist.

    -

    Check whether the threshold rule exists.

    -

    AOM.0500

    -

    Internal server error.

    -

    Contact technical support.

    -
    -
    -
    -
    -
    -
    -
    Parent topic: Monitoring APIs
    -
    -
    - diff --git a/docs/aom/api-ref/aom_04_1015.html b/docs/aom/api-ref/aom_04_1015.html deleted file mode 100644 index 79fd6530..00000000 --- a/docs/aom/api-ref/aom_04_1015.html +++ /dev/null @@ -1,322 +0,0 @@ - - -

    Querying a Threshold Rule List

    -

    Function

    This API is used to query a threshold rule list.

    -
    -

    URI

    GET /v2/{project_id}/ams/alarms

    -
    -

    Request

    Request parameters

    -

    Table 1 describes the request parameters.

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 1 Request parameters

    Parameter

    -

    Mandatory

    -

    Type

    -

    Value Range

    -

    Description

    -

    project_id

    -

    Yes

    -

    String

    -

    -

    -

    Project ID obtained from IAM. Generally, a project ID contains 32 characters.

    -

    limit

    -

    No

    -

    Integer

    -

    (0,1000]

    -

    Value range: 1–1000. Default value: 1000.

    -

    Maximum number of returned records.

    -

    start

    -

    No

    -

    Integer

    -

    [0, (Maximum value of the int type – 1000)]

    -

    Pagination information.

    -
    -
    -

    Request headers

    -

    Table 2 describes the request headers.

    - -
    - - - - - - - - - - - - - -
    Table 2 Request headers

    Name

    -

    Mandatory

    -

    Description

    -

    X-Auth-Token

    -

    Yes

    -

    User token obtained from IAM.

    -

    Content-Type

    -

    Yes

    -

    Content type, which is application/json.

    -
    -
    -
    -

    Response

    Response parameters

    -

    Table 3 describes the response parameters.

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 3 Response parameters

    Parameter

    -

    Type

    -

    Description

    -

    errorCode

    -

    String

    -

    Response code.

    -

    errorMessage

    -

    String

    -

    Response message.

    -

    metaData

    -

    JSON object

    -

    Metadata, including pagination information.

    -

    metaData.count

    -

    Integer

    -

    Number of returned records.

    -

    metaData.total

    -

    Integer

    -

    Total number of records.

    -

    metaData.start

    -

    String

    -

    Start of the next page, which is used for pagination.

    -

    thresholds

    -

    JSON array

    -

    Threshold rule list.

    -
    -
    -

    Example response

    -
    { 
-    "errorCode": "AOM.0200", 
-    "errorMessage": "success", 
-    "metaData": { 
-      "count": 10, 
-      "start": null, 
-      "total": 100 
-    }, 
-    "thresholds":  
-    [ 
-    { 
-        "id": "2137", 
-        "alarmName": "aaaaaaaa", 
-        "alarmDescription": "", 
-        "actionEnabled": false, 
-        "okActions": [], 
-        "alarmActions": [], 
-        "insufficientDataActions": [], 
-        "stateValue": "alarm", 
-        "stateReason": "", 
-        "stateUpdatedTimestamp": null, 
-        "metricName": "cpuCoreLimit", 
-        "namespace": "PAAS.CONTAINER", 
-        "statistic": "average", 
-        "dimensions": [ 
-            { 
-                "name": "appName", 
-                "value": "rhm-broker" 
-            } 
-        ], 
-        "period": 60000, 
-        "evaluationPeriods": 1, 
-        "unit": "Core", 
-        "threshold": "0", 
-        "comparisonOperator": ">=", 
-        "alarmAdvice": "", 
-        "alarmLevel": 3 
-    } 
-    ] 
-}
    -
    -

    Status Code

    • Success response

      Table 4 describes the status code.

      - -
      - - - - - - - - - -
      Table 4 Status code

      Status Code

      -

      Message

      -

      Description

      -

      200

      -

      OK

      -

      The request has succeeded.

      -
      -
      -
    -
    • Error response

      Table 5 describes the status codes. For more information, see Status Codes.

      - -
      - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 5 Status codes

      Status Code

      -

      Message

      -

      Description

      -

      400

      -

      Bad Request

      -

      The request is invalid.

      -

      The client should not repeat the request without modifications.

      -

      401

      -

      Unauthorized

      -

      The authorization information provided by the client is incorrect or invalid.

      -

      403

      -

      Forbidden

      -

      The request is rejected.

      -

      The server has received the request and understood it, but the server is refusing to respond to it. The client should not repeat the request without modifications.

      -

      500

      -

      Internal Server Error

      -

      The server is able to receive the request but unable to understand the request.

      -

      503

      -

      Service Unavailable

      -

      The requested service is invalid.

      -

      The client should not repeat the request without modifications.

      -
      -
      -
    -
    -

    Error Code

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 6 Error codes

    Error Code

    -

    Message

    -

    Solution

    -

    AOM.0109

    -

    Invalid project ID.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0110

    -

    Invalid limit.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0111

    -

    Invalid start.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0501

    -

    The Cassandra session is null.

    -

    Contact technical support.

    -

    AOM.0502

    -

    The Cassandra execution is abnormal.

    -

    Contact technical support.

    -
    -
    -
    -
    -
    -
    -
    Parent topic: Monitoring APIs
    -
    -
    - diff --git a/docs/aom/api-ref/aom_04_1016.html b/docs/aom/api-ref/aom_04_1016.html deleted file mode 100644 index 98f24e81..00000000 --- a/docs/aom/api-ref/aom_04_1016.html +++ /dev/null @@ -1,263 +0,0 @@ - - -

    Querying a Threshold Rule

    -

    Function

    This API is used to query a threshold rule.

    -
    -

    URI

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

    -
    -

    Request

    Request parameters

    -

    Table 1 describes the request parameters.

    - -
    - - - - - - - - - - - - - - - - - - - -
    Table 1 Request parameters

    Parameter

    -

    Mandatory

    -

    Type

    -

    Value Range

    -

    Description

    -

    project_id

    -

    Yes

    -

    String

    -

    -

    -

    Project ID obtained from IAM. Generally, a project ID contains 32 characters.

    -

    alarm_id

    -

    Yes

    -

    String

    -

    Non-null value that can be converted to a value of the long type.

    -

    Threshold rule ID.

    -
    -
    -

    Request headers

    -

    Table 2 describes the request headers.

    - -
    - - - - - - - - - - - - - -
    Table 2 Request headers

    Name

    -

    Mandatory

    -

    Description

    -

    X-Auth-Token

    -

    Yes

    -

    User token obtained from IAM.

    -

    Content-Type

    -

    Yes

    -

    Content type, which is application/json.

    -
    -
    -
    -

    Response

    Response parameters

    -

    Table 3 describes the response parameters.

    - -
    - - - - - - - - - - - - - - - - - -
    Table 3 Response parameters

    Parameter

    -

    Type

    -

    Description

    -

    errorCode

    -

    String

    -

    Response code.

    -

    errorMessage

    -

    String

    -

    Response message.

    -

    thresholds

    -

    JSON array

    -

    Threshold rule list.

    -
    -
    -

    Example response

    -
    { 
-    "errorCode": "AOM.0200", 
-    "errorMessage": "success", 
-    "thresholds":  
-    [ 
-    { 
-        "id": "2137", 
-        "alarmName": "aaaaaaaa", 
-        "alarmDescription": "", 
-        "actionEnabled": false, 
-        "okActions": [], 
-        "alarmActions": [], 
-        "insufficientDataActions": [], 
-        "stateValue": "alarm", 
-        "stateReason": "", 
-        "stateUpdatedTimestamp": null, 
-        "metricName": "cpuCoreLimit", 
-        "namespace": "PAAS.CONTAINER", 
-        "statistic": "average", 
-        "dimensions": [ 
-            { 
-                "name": "appName", 
-                "value": "rhm-broker" 
-            } 
-        ], 
-        "period": 60000, 
-        "evaluationPeriods": 1, 
-        "unit": "Core", 
-        "threshold": "0", 
-        "comparisonOperator": ">=", 
-        "alarmAdvice": "", 
-        "alarmLevel": 3 
-    } 
-    ] 
-}
    -
    -

    Status Code

    • Success response

      Table 4 describes the status code.

      - -
      - - - - - - - - - -
      Table 4 Status code

      Status Code

      -

      Message

      -

      Description

      -

      200

      -

      OK

      -

      The request has succeeded.

      -
      -
      -
    -
    • Error response

      Table 5 describes the status codes. For more information, see Status Codes.

      - -
      - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 5 Status codes

      Status Code

      -

      Message

      -

      Description

      -

      400

      -

      Bad Request

      -

      The request is invalid.

      -

      The client should not repeat the request without modifications.

      -

      401

      -

      Unauthorized

      -

      The authorization information provided by the client is incorrect or invalid.

      -

      403

      -

      Forbidden

      -

      The request is rejected.

      -

      The server has received the request and understood it, but the server is refusing to respond to it. The client should not repeat the request without modifications.

      -

      500

      -

      Internal Server Error

      -

      The server is able to receive the request but unable to understand the request.

      -

      503

      -

      Service Unavailable

      -

      The requested service is invalid.

      -

      The client should not repeat the request without modifications.

      -
      -
      -
    -
    -

    Error Code

    -
    - - - - - - - - - - - - - - - - - -
    Table 6 Error codes

    Error Code

    -

    Message

    -

    Solution

    -

    AOM.0115

    -

    Invalid request parameter.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0501

    -

    The Cassandra session is null.

    -

    Contact technical support.

    -

    AOM.0502

    -

    The Cassandra execution is abnormal.

    -

    Contact technical support.

    -
    -
    -
    -
    -
    -
    -
    Parent topic: Monitoring APIs
    -
    -
    - diff --git a/docs/aom/api-ref/aom_04_1017.html b/docs/aom/api-ref/aom_04_1017.html deleted file mode 100644 index 3b56f6c3..00000000 --- a/docs/aom/api-ref/aom_04_1017.html +++ /dev/null @@ -1,227 +0,0 @@ - - -

    Deleting a Threshold Rule

    -

    Function

    This API is used to delete a threshold rule.

    -
    -

    URI

    DELETE /v2/{project_id}/ams/alarms/{alarm_id}

    -
    -

    Request

    Request parameters

    -

    Table 1 describes the request parameters.

    - -
    - - - - - - - - - - - - - - - - - - - -
    Table 1 Request parameters

    Parameter

    -

    Mandatory

    -

    Type

    -

    Value Range

    -

    Description

    -

    project_id

    -

    Yes

    -

    String

    -

    -

    -

    Project ID obtained from IAM. Generally, a project ID contains 32 characters.

    -

    alarm_id

    -

    Yes

    -

    String

    -

    Non-null value that can be converted to a value of the long type.

    -

    Threshold rule ID.

    -
    -
    -

    Request headers

    -

    Table 2 describes the request headers.

    - -
    - - - - - - - - - - - - - -
    Table 2 Request headers

    Name

    -

    Mandatory

    -

    Description

    -

    X-Auth-Token

    -

    Yes

    -

    User token obtained from IAM.

    -

    Content-Type

    -

    Yes

    -

    Content type, which is application/json.

    -
    -
    -

    Example request

    -
    /v2/{project_id}/ams/alarms/al1441967036681YkazZ0deN
    -
    -

    Response

    Response parameters

    -

    Table 3 describes the response parameters.

    - -
    - - - - - - - - - - - - - -
    Table 3 Response parameters

    Parameter

    -

    Type

    -

    Description

    -

    errorCode

    -

    String

    -

    Response code.

    -

    errorMessage

    -

    String

    -

    Response message.

    -
    -
    -

    Example response

    -
    {  
- "errorCode": "AOM.0200", 
- "errorMessage": "Delete Threshold [xxx] successfully ." 
-}
    -
    -

    Status Code

    • Success response

      Table 4 describes the status code.

      - -
      - - - - - - - - - -
      Table 4 Status code

      Status Code

      -

      Message

      -

      Description

      -

      200

      -

      OK

      -

      The request has succeeded.

      -
      -
      -
    -
    • Error response

      Table 5 describes the status codes. For more information, see Status Codes.

      - -
      - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 5 Status codes

      Status Code

      -

      Message

      -

      Description

      -

      400

      -

      Bad Request

      -

      The request is invalid.

      -

      The client should not repeat the request without modifications.

      -

      401

      -

      Unauthorized

      -

      The authorization information provided by the client is incorrect or invalid.

      -

      403

      -

      Forbidden

      -

      The request is rejected.

      -

      The server has received the request and understood it, but the server is refusing to respond to it. The client should not repeat the request without modifications.

      -

      500

      -

      Internal Server Error

      -

      The server is able to receive the request but unable to understand the request.

      -

      503

      -

      Service Unavailable

      -

      The requested service is invalid.

      -

      The client should not repeat the request without modifications.

      -
      -
      -
    -
    -

    Error Code

    -
    - - - - - - - - - - - - - - - - - -
    Table 6 Error codes

    Error Code

    -

    Message

    -

    Solution

    -

    AOM.0115

    -

    Invalid request parameter.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0501

    -

    The Cassandra session is null.

    -

    Contact technical support.

    -

    AOM.0502

    -

    The Cassandra execution is abnormal.

    -

    Contact technical support.

    -
    -
    -
    -
    -
    -
    -
    Parent topic: Monitoring APIs
    -
    -
    - diff --git a/docs/aom/api-ref/aom_04_1019.html b/docs/aom/api-ref/aom_04_1019.html deleted file mode 100644 index 09fc8c58..00000000 --- a/docs/aom/api-ref/aom_04_1019.html +++ /dev/null @@ -1,517 +0,0 @@ - - -

    Modifying a Threshold Rule

    -

    Function

    This API is used to modify a threshold rule.

    -
    -

    URI

    PUT /v2/{project_id}/ams/alarms

    -
    -

    Request

    Request parameters

    -

    Table 1 describes the request parameters.

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 1 Request parameters

    Parameter

    -

    Mandatory

    -

    Type

    -

    Value Range

    -

    Description

    -

    project_id

    -

    Yes

    -

    String

    -

    -

    -

    Project ID obtained from IAM. Generally, a project ID contains 32 characters.

    -

    statistic

    -

    Yes

    -

    String

    -

    maximum, minimum, average, sum, or sampleCount.

    -

    Statistic.

    -

    namespace

    -

    Yes

    -

    String

    -

    1–255 characters. Colons (:) are not allowed.

    -

    Namespace. The value transferred to the backend when a threshold rule is added will be used. The value transferred here will not replace that value.

    -

    metricName

    -

    Yes

    -

    String

    -

    1–255 characters.

    -

    Metric name. The value transferred to the backend when a threshold rule is added will be used. The value transferred here will not replace that value.

    -

    period

    -

    Yes

    -

    Integer

    -

    20000, 60000, 300000, 900000, 1800000, 3600000, 14400000, or 86400000

    -

    Statistical period.

    -

    alarmLevel

    -

    No

    -

    Integer

    -

    4, 3, 2, or 1

    -

    Alarm severity.

    -

    evaluationPeriods

    -

    Yes

    -

    Integer

    -

    4, 3, or 2

    -

    Number of consecutive periods.

    -

    comparisonOperator

    -

    Yes

    -

    String

    -

    >, >=, <, or <=

    -

    Comparison operator.

    -

    threshold

    -

    Yes

    -

    String

    -

    Non-null value that can be converted to a value of the double type. Once converted, the value cannot be null, or be a positive or negative infinity.

    -

    Threshold.

    -

    alarmName

    -

    Yes

    -

    String

    -

    1–255 characters. Special characters are not allowed.

    -

    Threshold name.

    -

    dimensions

    -

    Yes

    -

    List

    -

    Non-null; size < 100

    -

    Metric dimension. The value transferred to the backend when a threshold rule is added will be used. The value transferred here will not replace that value.

    -

    unit

    -

    No

    -

    String

    -

    Number of characters < 32

    -

    Metric unit. The value transferred to the backend when a threshold rule is added will be used. The value transferred here will not replace that value.

    -

    actionEnabled

    -

    No

    -

    Boolean

    -

    -

    -

    Whether to enable the alarm function.

    -

    alarmActions

    -

    No

    -

    Array

    -

    Size ≤ 5

    -

    Alarm action.

    -

    alarmAdvice

    -

    No

    -

    String

    -

    Number of characters < 255

    -

    Alarm suggestion. Leave this parameter blank.

    -

    alarmDescription

    -

    No

    -

    String

    -

    Number of characters < 255

    -

    Threshold rule description.

    -

    insufficientDataActions

    -

    No

    -

    Array

    -

    Size ≤ 5

    -

    Action to be taken when data is insufficient.

    -

    okActions

    -

    No

    -

    Array

    -

    Size ≤ 5

    -

    Recovery action.

    -
    -
    -

    Request headers

    -

    Table 2 describes the request headers.

    - -
    - - - - - - - - - - - - - -
    Table 2 Request headers

    Name

    -

    Mandatory

    -

    Description

    -

    X-Auth-Token

    -

    Yes

    -

    User token obtained from IAM.

    -

    Content-Type

    -

    Yes

    -

    Content type, which is application/json.

    -
    -
    -
    -

    Example request

    -
    {
-    "actionEnabled": false,
-    "alarmActions": [],
-    "alarmAdvice": "",
-    "alarmDescription": "",
-    "alarmLevel": 3,
-    "alarmName": "aaaaaaaa",
-    "comparisonOperator": ">=",
-    "dimensions": [
-        {
-            "name": "appName",
-            "value": "rhm-broker"
-        }
-    ],
-    "evaluationPeriods": 1,
-    "insufficientDataActions": [],
-    "metricName": "cpuCoreLimit",
-    "namespace": "PAAS.CONTAINER",
-    "okActions": [],
-    "period": 60000,
-    "statistic": "average",
-    "threshold": 0,
-    "unit": "Core"
-}
    -

    Response

    Response parameters

    -

    Table 3 describes the response parameters.

    - -
    - - - - - - - - - - - - - - - - - -
    Table 3 Response parameters

    Parameter

    -

    Type

    -

    Description

    -

    errorCode

    -

    String

    -

    Response code.

    -

    errorMessage

    -

    String

    -

    Response message.

    -

    alarmId

    -

    Long

    -

    Threshold rule code.

    -
    -
    -

    Example response

    -
    {
-    "errorCode": "AOM.0200",
-    "errorMessage": "success",
-    "alarmId": 12345678
-}
    -
    -

    Status Code

    • Success response

      Table 4 describes the status code.

      - -
      - - - - - - - - - -
      Table 4 Status code

      Status Code

      -

      Message

      -

      Description

      -

      200

      -

      OK

      -

      The request has succeeded.

      -
      -
      -
    • Error response

      Table 5 describes the status codes. For more information, see Status Codes.

      - -
      - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 5 Status codes

      Status Code

      -

      Message

      -

      Description

      -

      400

      -

      Bad Request

      -

      The request is invalid.

      -

      The client should not repeat the request without modifications.

      -

      401

      -

      Unauthorized

      -

      The authorization information provided by the client is incorrect or invalid.

      -

      403

      -

      Forbidden

      -

      The request is rejected.

      -

      The server has received the request and understood it, but the server is refusing to respond to it. The client should not repeat the request without modifications.

      -

      500

      -

      Internal Server Error

      -

      The server is able to receive the request but unable to understand the request.

      -

      503

      -

      Service Unavailable

      -

      The requested service is invalid.

      -

      The client should not repeat the request without modifications.

      -
      -
      -
    -
    -

    Error Code

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 6 Error codes

    Error Code

    -

    Message

    -

    Solution

    -

    AOM.0101

    -

    Invalid alarm name.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0102

    -

    The threshold rule name already exists.

    -

    Use another name.

    -

    AOM.0103

    -

    Invalid alarm description.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0104

    -

    Invalid alarm threshold.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0105

    -

    Invalid alarm period.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0106

    -

    Invalid email list.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0107

    -

    The maximum number of threshold rules has been reached.

    -

    Contact technical support to expand the capacity.

    -

    AOM.0108

    -

    Invalid time range for alarm queries.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0109

    -

    Invalid project ID.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0115

    -

    Invalid request parameter.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0118

    -

    Invalid number of consecutive periods.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0119

    -

    Invalid alarm statistic.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0120

    -

    Invalid alarm comparison operator.

    -

    Check whether the parameter meets requirements.

    -

    AOM.0121

    -

    The alarm does not exist.

    -

    Check whether the threshold rule exists.

    -

    AOM.0500

    -

    Internal server error.

    -

    Contact technical support.

    -
    -
    -
    -
    -
    -
    -
    Parent topic: Monitoring APIs
    -
    -
    - diff --git a/docs/aom/api-ref/aom_04_1034.html b/docs/aom/api-ref/aom_04_1034.html deleted file mode 100644 index 45fd08ea..00000000 --- a/docs/aom/api-ref/aom_04_1034.html +++ /dev/null @@ -1,573 +0,0 @@ - - -

    Querying Logs

    -

    Function

    This API is used to query logs by different dimensions such as cluster, IP address, or application.

    -
    -

    URI

    POST /v2/{project_id}/als/action?type=querylogs

    -

    Table 1 describes the parameters.

    - -
    - - - - - - - - - - - - - -
    Table 1 Parameters

    Parameter

    -

    Mandatory

    -

    Description

    -

    project_id

    -

    Yes

    -

    Project ID obtained from IAM. Generally, a project ID contains 32 characters.

    -

    type

    -

    Yes

    -

    Log API call mode. When the value is querylogs, this API is used to query logs.

    -
    -
    -
    -

    Request

    Request parameters

    -

    Table 2 describes the request parameters.

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 2 Request parameters

    Parameter

    -

    Mandatory

    -

    Type

    -

    Value Range

    -

    Description

    -

    Condition

    -

    Yes

    -

    String

    -

    {

    -

    "category": "app_log",

    -

    "searchKey":

    -

    {

    -

    "clusterId": "c693fa7c-54cd-11e8-8055-0255ac101e40",

    -

    "nameSpace": "",

    -

    "appName": "",

    -

    "podName": "",

    -

    "pathFile": "",

    -

    "hostIP":""

    -

    },

    -

    "keyWord": "",

    -

    "startTime": 1538970064983,

    -

    "endTime": 1538970364983,

    -

    "hideSyslog": 0

    -

    }

    -

    Condition in JSON format, which must be in the request body during calling.

    -

    category

    -

    Yes

    -

    String

    -

    app_log,node_log,custom_log

    -

    Log type:

    -
    • app_log: application log
    • node_log: host log
    • custom_log: log in a custom path
    -

    searchKey

    -

    Yes

    -

    JSON

    -

    -

    -

    Log filter criteria, which vary according to log sources.

    -

    clusterId

    -

    Yes

    -

    String

    -

    -

    -

    Cloud Container Engine (CCE) cluster ID.

    -

    nameSpace

    -

    No

    -

    String

    -

    -

    -

    CCE cluster namespace.

    -

    appName

    -

    No

    -

    String

    -

    -

    -

    Service name.

    -

    podName

    -

    No

    -

    String

    -

    -

    -

    Container pod name.

    -

    pathFile

    -

    No

    -

    String

    -

    -

    -

    Log file name.

    -

    hostIP

    -

    No

    -

    String

    -

    -

    -

    IP address of the VM where logs are located.

    -

    keyWord

    -

    No

    -

    String

    -

    -

    -
    1. Enter a keyword between two adjacent delimiters for exact search.
    2. Enter a keyword for fuzzy search. Example: RROR, ERRO?, *ROR*, ERR*, or ER*OR.
    3. Enter a phrase for exact search. Example: Start to refresh alm Statistic.
    4. Enter contents containing AND (&&) or OR (||) for search. Example: query&&logs or query||logs.
    -
    NOTE:

    Default delimiters:

    -

    , '";=()[]{}@&<>/:\n\t\r

    -
    -

    startTime

    -

    Yes

    -

    Long

    -

    -

    -

    Start time of the query (UTC, in ms).

    -

    endTime

    -

    Yes

    -

    Long

    -

    -

    -

    End time of the query (UTC, in ms).

    -

    hideSyslog

    -

    No

    -

    Integer

    -

    0 or 1

    -

    Whether to hide the system log (icagent\kubectl) during the query. 0 (default): Hide. 1: Not hide.

    -
    -
    -

    Request headers

    -

    Table 3 describes the request headers.

    - -
    - - - - - - - - - - - - - -
    Table 3 Request headers

    Name

    -

    Mandatory

    -

    Description

    -

    X-Auth-Token

    -

    Yes

    -

    User token obtained from IAM.

    -

    Content-Type

    -

    Yes

    -

    Content type, which is application/json.

    -
    -
    -

    Example request

    -
    Example 1 (Query application logs in a cluster)
    /v2/{project_id}/als/action?type=querylogs
-{  
-    "category": "app_log",    
-    "searchKey": 
-              {
-                "clusterId": "c693fa7c-54cd-11e8-8055-0255ac101e40",
-		"nameSpace" : "",
-		"appName" : "",
-		"podName" : "",
-		"pathFile" : "",
-		"hostIP" : ""
-              },
-    "keyWord": "",
-    "startTime": 1538970064983,
-    "endTime": 1538970364983,
-    "hideSyslog": 0
-}
    -
    -
    -

    Response

    Response parameters

    -

    Table 4 describes the response parameters.

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 4 Response parameters

    Parameter

    -

    Type

    -

    Description

    -

    errorCode

    -

    String

    -

    Response code. Example: AOM.0200, which indicates a success response.

    -

    errorMessage

    -

    String

    -

    Response message.

    -

    result

    -

    JSON object

    -

    Metadata, including total number of returned records and results.

    -

    total

    -

    Integer

    -

    Number of returned records.

    -

    data

    -

    JSON array

    -

    Data array.

    -

    category

    -

    String

    -

    Log type.

    -

    loghash

    -

    String

    -

    Hash value of the log source.

    -

    clusterId

    -

    String

    -

    Cloud Container Engine (CCE) cluster ID.

    -

    clusterName

    -

    String

    -

    CCE cluster name.

    -

    nameSpace

    -

    String

    -

    CCE cluster namespace.

    -

    podName

    -

    String

    -

    CCE container pod name.

    -

    appName

    -

    String

    -

    Service name.

    -

    serviceID

    -

    String

    -

    Service ID of an AOM resource.

    -

    containerName

    -

    String

    -

    CCE container name.

    -

    logContent

    -

    String

    -

    Source log data.

    -

    pathFile

    -

    String

    -

    Absolute path of a log file.

    -

    hostIP

    -

    String

    -

    IP address of the VM where log files are located.

    -

    hostId

    -

    String

    -

    ID of a host in a cluster.

    -

    hostName

    -

    String

    -

    Name of the VM where log files are located.

    -

    collectTime

    -

    String

    -

    Log collection time (UTC time, in ms).

    -

    lineNum

    -

    String

    -

    Sequence number of a log line.

    -

    logContentSize

    -

    String

    -

    Size of a single-line log.

    -
    -
    -

    Example response

    -
    { 
- "errorCode":"AOM.0200",
- "errorMessage":"Query data success",
- "result":"{\"total\":5000,
-            \"data\":[{\"category\":\"app\",
-            \"loghash\":\"496b2070d40a83c17f2625401af8a50aadc316f216771fbe38b94d31feaa30eb\",
-            \"clusterId\":\"c693fa7c-54cd-11e8-8055-0255ac101e40\",
-            \"clusterName\":\"aomdemo\",
-            \"nameSpace\":\"default\",
-            \"podName\":\"als0712-7c4875f884-q5wwp\",
-            \"appName\":\"als0712\",
-            \"serviceID\":\"\",
-            \"containerName\":\"container-0\",
-            \"logContent\":\"warn:2018/10/09 06:57:01 helloworld.go:108: the main process is running now.\\n\",
-            \"pathFile\":\"/var/paas/sys/log/apm/debug_erro.trace\",
-            \"hostIP\":\"192.168.0.133\",
-            \"hostId\":\"c11c7211-5a0b-4925-bef4-d078661299b0\",
-            \"hostName\":\"192.168.0.133\",
-            \"collectTime\":\"1539068233983\",
-            \"lineNum\":\"15390682339830002\",
-            \"logContentSize\":\"77\"
-                      }]
-            }"
-}
    -
    -

    Status Code

    • Success response

      Table 5 describes the status code.

      - -
      - - - - - - - - - -
      Table 5 Status code

      Status Code

      -

      Message

      -

      Description

      -

      200

      -

      OK

      -

      The request has succeeded.

      -
      -
      -
    -
    • Error response

      Table 6 describes the status codes. For more information, see Status Codes.

      - -
      - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 6 Status codes

      Status Code

      -

      Message

      -

      Description

      -

      400

      -

      Bad Request

      -

      The request is invalid.

      -

      The client should not repeat the request without modifications.

      -

      401

      -

      Unauthorized

      -

      The authorization information provided by the client is incorrect or invalid.

      -

      403

      -

      Forbidden

      -

      The request is rejected.

      -

      The server has received the request and understood it, but the server is refusing to respond to it. The client should not repeat the request without modifications.

      -

      500

      -

      Internal Server Error

      -

      The server is able to receive the request but unable to understand the request.

      -

      503

      -

      Service Unavailable

      -

      The requested service is invalid.

      -

      The client should not repeat the request without modifications.

      -
      -
      -
    -
    -

    Error Code

    -
    - - - - - - - - - - - - - - - - - -
    Table 7 Error codes

    Error Code

    -

    Message

    -

    Solution

    -

    AOM.0200

    -

    Data queried successfully.

    -

    -

    -

    AOM.0201

    -

    {XXX} is invalid.

    -
    NOTE:

    XXX indicates a specific parameter.

    -
    -

    Check whether the parameter meets requirements.

    -

    AOM.0203

    -

    No logs found.

    -

    Check whether the parameter meets requirements.

    -
    -
    -
    -
    -
    -
    -
    Parent topic: Log APIs
    -
    -
    - diff --git a/docs/aom/api-ref/aom_04_1045.html b/docs/aom/api-ref/aom_04_1045.html deleted file mode 100644 index ba956da2..00000000 --- a/docs/aom/api-ref/aom_04_1045.html +++ /dev/null @@ -1,29 +0,0 @@ - - -

    Monitoring APIs

    -
    - - diff --git a/docs/aom/api-ref/aom_04_1047.html b/docs/aom/api-ref/aom_04_1047.html deleted file mode 100644 index 316b85c2..00000000 --- a/docs/aom/api-ref/aom_04_1047.html +++ /dev/null @@ -1,15 +0,0 @@ - - -

    Log APIs

    -
    -
    - - -
    -
    Parent topic: APIs
    -
    -
    - diff --git a/docs/aom/api-ref/en-us_topic_0000001409328750.html b/docs/aom/api-ref/en-us_topic_0000001409328750.html new file mode 100644 index 00000000..27793a27 --- /dev/null +++ b/docs/aom/api-ref/en-us_topic_0000001409328750.html @@ -0,0 +1,12 @@ + + +

    Obtaining an Account ID and Project ID

    +

    When making API calls, you may need to enter the username, user ID, project name, and project ID in some URIs. You can obtain them on the My Credentials page.

    +
    1. Log in to the management console.
    2. Hover the cursor over your username in the upper right corner of the page, and choose My Credentials from the drop-down list.
    3. On the My Credentials page, view the username, user ID, project name, and project ID.
    +
    +
    +
    +
    Parent topic: Appendix
    +
    +
    + diff --git a/docs/aom/api-ref/en-us_topic_0000001409488734.html b/docs/aom/api-ref/en-us_topic_0000001409488734.html new file mode 100644 index 00000000..424865f6 --- /dev/null +++ b/docs/aom/api-ref/en-us_topic_0000001409488734.html @@ -0,0 +1,9 @@ + + +

    API Usage Guidelines

    +

    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 using JSON messages, with the media type represented by Application/json.

    +

    For details about how to use APIs, see API Usage Guidelines.

    +

    For details about metric description, see Metric Overview in the AOM User Guide.

    +
    + diff --git a/docs/aom/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/aom/api-ref/public_sys-resources/icon-arrowdn.gif index 84eec9be..37942803 100644 Binary files a/docs/aom/api-ref/public_sys-resources/icon-arrowdn.gif and b/docs/aom/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/aom/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/aom/api-ref/public_sys-resources/icon-arrowrt.gif index 39583d16..6aaaa11c 100644 Binary files a/docs/aom/api-ref/public_sys-resources/icon-arrowrt.gif and b/docs/aom/api-ref/public_sys-resources/icon-arrowrt.gif differ