doc-exports/docs/ces/api-ref/CLASS.TXT.json
Youyuan, Pan 5bdbeeee8c Added event monitoring metrics in CES API Reference.
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Youyuan, Pan <panyouyuan@huawei.com>
Co-committed-by: Youyuan, Pan <panyouyuan@huawei.com>
2022-12-07 16:06:33 +00:00

290 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":"ces",
"title":"API Usage Guidelines",
"uri":"ces_03_0001.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":"ces",
"title":"API Description",
"uri":"ces_03_0018.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":"ces",
"title":"API Version Management",
"uri":"ces_03_0019.html",
"doc_type":"api",
"p_code":"2",
"code":"3"
},
{
"desc":"This API is used to query all API versions supported by Cloud Eye.GET /Example requestResponse parametersParameter descriptionParameterTypeDescriptionversionsArray of obj",
"product_code":"ces",
"title":"Querying All API Versions",
"uri":"ces_03_0020.html",
"doc_type":"api",
"p_code":"3",
"code":"4"
},
{
"desc":"This API is used to query a specified API version of Cloud Eye.GET /{api_version}Parameter descriptionParameter descriptionParameterMandatoryDescriptionapi_versionYesSpec",
"product_code":"ces",
"title":"Querying a Specified API Version",
"uri":"ces_03_0021.html",
"doc_type":"api",
"p_code":"3",
"code":"5"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"ces",
"title":"Metric Management",
"uri":"ces_03_0022.html",
"doc_type":"api",
"p_code":"2",
"code":"6"
},
{
"desc":"This API is used to query the metrics. You can specify the namespace, metric, dimension, sorting order, start records, and the maximum number of records when using this A",
"product_code":"ces",
"title":"Querying Metrics",
"uri":"ces_03_0023.html",
"doc_type":"api",
"p_code":"6",
"code":"7"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"ces",
"title":"Alarm Rule Management",
"uri":"ces_03_0026.html",
"doc_type":"api",
"p_code":"2",
"code":"8"
},
{
"desc":"This API is used to query the alarm rule list. You can specify the paging parameters to limit the number of query results displayed on a page. You can also set the sortin",
"product_code":"ces",
"title":"Querying Alarm Rules",
"uri":"ces_03_0027.html",
"doc_type":"api",
"p_code":"8",
"code":"9"
},
{
"desc":"This API is used to query an alarm rule based on the alarm rule ID.GET /V1.0/{project_id}/alarms/{alarm_id}Parameter descriptionParameter descriptionParameterMandatoryDes",
"product_code":"ces",
"title":"Querying an Alarm Rule",
"uri":"ces_03_0028.html",
"doc_type":"api",
"p_code":"8",
"code":"10"
},
{
"desc":"This API is used to enable or disable an alarm rule.PUT /V1.0/{project_id}/alarms/{alarm_id}/actionParameter descriptionParameter descriptionParameterMandatoryDescription",
"product_code":"ces",
"title":"Enabling or Disabling an Alarm Rule",
"uri":"ces_03_0029.html",
"doc_type":"api",
"p_code":"8",
"code":"11"
},
{
"desc":"This API is used to delete an alarm rule.DELETE /V1.0/{project_id}/alarms/{alarm_id}Parameter descriptionParameter descriptionParameterMandatoryDescriptionproject_idYesSp",
"product_code":"ces",
"title":"Deleting an Alarm Rule",
"uri":"ces_03_0030.html",
"doc_type":"api",
"p_code":"8",
"code":"12"
},
{
"desc":"This API is used to create an alarm rule.POST /V1.0/{project_id}/alarmsParameter descriptionParameter descriptionParameterMandatoryDescriptionproject_idYesSpecifies the p",
"product_code":"ces",
"title":"Creating an Alarm Rule",
"uri":"ces_03_0031.html",
"doc_type":"api",
"p_code":"8",
"code":"13"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"ces",
"title":"Monitoring Data Management",
"uri":"ces_03_0032.html",
"doc_type":"api",
"p_code":"2",
"code":"14"
},
{
"desc":"This API is used to query the monitoring data at a specified granularity for a specified metric in a specified period of time. You can specify the dimension of data to be",
"product_code":"ces",
"title":"Querying Monitoring Data",
"uri":"ces_03_0033.html",
"doc_type":"api",
"p_code":"14",
"code":"15"
},
{
"desc":"This API is used to add one or more pieces of custom metric monitoring data to solve the problem that the system metrics cannot meet specific service requirements.POST /V",
"product_code":"ces",
"title":"Adding Monitoring Data",
"uri":"en-us_topic_0032831274.html",
"doc_type":"api",
"p_code":"14",
"code":"16"
},
{
"desc":"You can query the monitoring data of specified metrics within a specified time range and specified granularities in batches. At present, you can query the monitoring data",
"product_code":"ces",
"title":"Querying Monitoring Data in Batches",
"uri":"ces_03_0034.html",
"doc_type":"api",
"p_code":"14",
"code":"17"
},
{
"desc":"This API is used to query the host configuration for a specified event type in a specified period of time. You can specify the dimension of data to be queried.This API is",
"product_code":"ces",
"title":"Querying the Host Configuration",
"uri":"ces_03_0035.html",
"doc_type":"api",
"p_code":"14",
"code":"18"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"ces",
"title":"Quota Management",
"uri":"ces_03_0036.html",
"doc_type":"api",
"p_code":"2",
"code":"19"
},
{
"desc":"This API is used to query a resource quota and the used amount. The current resource refers to alarm rules only.GET /V1.0/{project_id}/quotasParameter descriptionParamete",
"product_code":"ces",
"title":"Querying Quotas",
"uri":"ces_03_0037.html",
"doc_type":"api",
"p_code":"19",
"code":"20"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"ces",
"title":"Event Monitoring",
"uri":"ces_03_0038.html",
"doc_type":"api",
"p_code":"2",
"code":"21"
},
{
"desc":"An API for reporting custom events is provided, which helps you collect and report abnormal events or important change events to Cloud Eye.POST /V1.0/{project_id}/eventsP",
"product_code":"ces",
"title":"Reporting Events",
"uri":"en-us_topic_0109034020.html",
"doc_type":"api",
"p_code":"21",
"code":"22"
},
{
"desc":"This API is used to query the events, including system events and custom events.GET /V1.0/{project_id}/eventsParameter descriptionParameter descriptionParameterTypeMandat",
"product_code":"ces",
"title":"Querying Events",
"uri":"ces_03_0074.html",
"doc_type":"api",
"p_code":"21",
"code":"23"
},
{
"desc":"This API is used to query the event details based on the event name.GET /V1.0/{project_id}/event/{event_name}Parameter descriptionParameter descriptionParameterTypeMandat",
"product_code":"ces",
"title":"Querying Monitoring Details of an Event",
"uri":"ces_03_0075.html",
"doc_type":"api",
"p_code":"21",
"code":"24"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"ces",
"title":"Common Parameters",
"uri":"ces_03_0053.html",
"doc_type":"api",
"p_code":"",
"code":"25"
},
{
"desc":"NormalReturned ValueDescription200 OKThe results of GET and PUT operations are returned as expected.201 CreatedThe results of the POST operation are returned as expected.",
"product_code":"ces",
"title":"Status Codes",
"uri":"ces_03_0055.html",
"doc_type":"api",
"p_code":"25",
"code":"26"
},
{
"desc":"If an error occurs during API calling, the system returns error information. This section describes the error codes contained in the error information for Cloud Eye APIs.",
"product_code":"ces",
"title":"Error Codes",
"uri":"ErrorCode.html",
"doc_type":"api",
"p_code":"25",
"code":"27"
},
{
"desc":"A project ID needs to be specified in the URIs of some APIs. Therefore, you need to obtain the project ID before calling APIs. The following procedure describes how to ob",
"product_code":"ces",
"title":"Obtaining a Project ID",
"uri":"ces_03_0057.html",
"doc_type":"api",
"p_code":"25",
"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":"ces",
"title":"Appendix",
"uri":"ces_03_0058.html",
"doc_type":"api",
"p_code":"",
"code":"29"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"ces",
"title":"Services Interconnected with Cloud Eye",
"uri":"ces_03_0059.html",
"doc_type":"api",
"p_code":"29",
"code":"30"
},
{
"desc":"Events in Event Monitoring come from operations on cloud service resources and are not collected by the Agent in Server Monitoring.Once a physical host running ECSs break",
"product_code":"ces",
"title":"Events Supported by Event Monitoring",
"uri":"ces_01_0054.html",
"doc_type":"api",
"p_code":"29",
"code":"31"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"ces",
"title":"Change History",
"uri":"ces_03_0060.html",
"doc_type":"api",
"p_code":"",
"code":"32"
}
]