doc-exports/docs/aom/api-ref/CLASS.TXT.json
Liu, Siying a5523910b0 AOM API 20230612 version
Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com>
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>
2024-03-25 12:19:25 +00:00

317 lines
11 KiB
JSON

[
{
"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":"en-us_topic_0000001409488734.html",
"doc_type":"api",
"p_code":"",
"code":"1"
},
{
"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":"API",
"uri":"aom_04_0010.html",
"doc_type":"api",
"p_code":"",
"code":"2"
},
{
"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",
"uri":"aom_04_0045.html",
"doc_type":"api",
"p_code":"2",
"code":"3"
},
{
"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 Time Series Objects",
"uri":"ListSeries.html",
"doc_type":"api",
"p_code":"3",
"code":"4"
},
{
"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 Time Series Data",
"uri":"ListSample.html",
"doc_type":"api",
"p_code":"3",
"code":"5"
},
{
"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":"Querying Metrics",
"uri":"ListMetricItems.html",
"doc_type":"api",
"p_code":"3",
"code":"6"
},
{
"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":"Querying Monitoring Data",
"uri":"ShowMetricsData.html",
"doc_type":"api",
"p_code":"3",
"code":"7"
},
{
"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":"Adding Monitoring Data",
"uri":"aom_04_0013.html",
"doc_type":"api",
"p_code":"3",
"code":"8"
},
{
"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":"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 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":"Deleting a Service Discovery Rule",
"uri":"DeleteserviceDiscoveryRules.html",
"doc_type":"api",
"p_code":"3",
"code":"10"
},
{
"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":"Querying Existing Service Discovery Rules",
"uri":"ListServiceDiscoveryRules.html",
"doc_type":"api",
"p_code":"3",
"code":"11"
},
{
"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":"Adding a Threshold Rule",
"uri":"AddAlarmRule.html",
"doc_type":"api",
"p_code":"3",
"code":"12"
},
{
"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":"ListLogItems.html",
"doc_type":"api",
"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.",
"product_code":"aom",
"title":"Appendix",
"uri":"aom_04_0066.html",
"doc_type":"api",
"p_code":"",
"code":"29"
},
{
"desc":"Table 1 describes status codes.",
"product_code":"aom",
"title":"Status Codes",
"uri":"aom_04_0018.html",
"doc_type":"api",
"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.",
"product_code":"aom",
"title":"Common Request Headers",
"uri":"aom_04_0008.html",
"doc_type":"api",
"p_code":"29",
"code":"33"
},
{
"desc":"A response usually contains the following headers:",
"product_code":"aom",
"title":"Common Response Headers",
"uri":"aom_04_0009.html",
"doc_type":"api",
"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.",
"product_code":"aom",
"title":"Change History",
"uri":"aom_04_0020.html",
"doc_type":"api",
"p_code":"",
"code":"35"
}
]