diff --git a/docs/ces/api-ref/ALL_META.TXT.json b/docs/ces/api-ref/ALL_META.TXT.json new file mode 100644 index 000000000..6e9f6bc7d --- /dev/null +++ b/docs/ces/api-ref/ALL_META.TXT.json @@ -0,0 +1,322 @@ +[ + { + "uri":"ces_03_0001.html", + "product_code":"ces", + "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", + "title":"API Usage Guidelines", + "githuburl":"" + }, + { + "uri":"ces_03_0018.html", + "product_code":"ces", + "code":"2", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"API Description", + "title":"API Description", + "githuburl":"" + }, + { + "uri":"ces_03_0019.html", + "product_code":"ces", + "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":"API Version Management", + "title":"API Version Management", + "githuburl":"" + }, + { + "uri":"ces_03_0020.html", + "product_code":"ces", + "code":"4", + "des":"This API is used to query all API versions supported by Cloud Eye.GET /Example requestResponse parametersParameter descriptionParameterTypeDescriptionversionsArray of obj", + "doc_type":"api", + "kw":"Querying All API Versions,API Version Management,API Reference", + "title":"Querying All API Versions", + "githuburl":"" + }, + { + "uri":"ces_03_0021.html", + "product_code":"ces", + "code":"5", + "des":"This API is used to query a specified API version of Cloud Eye.GET /{api_version}Parameter descriptionParameter descriptionParameterMandatoryDescriptionapi_versionYesSpec", + "doc_type":"api", + "kw":"Querying a Specified API Version,API Version Management,API Reference", + "title":"Querying a Specified API Version", + "githuburl":"" + }, + { + "uri":"ces_03_0022.html", + "product_code":"ces", + "code":"6", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Metric Management", + "title":"Metric Management", + "githuburl":"" + }, + { + "uri":"ces_03_0023.html", + "product_code":"ces", + "code":"7", + "des":"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", + "doc_type":"api", + "kw":"Querying Metrics,Metric Management,API Reference", + "title":"Querying Metrics", + "githuburl":"" + }, + { + "uri":"ces_03_0026.html", + "product_code":"ces", + "code":"8", + "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 Rule Management", + "title":"Alarm Rule Management", + "githuburl":"" + }, + { + "uri":"ces_03_0027.html", + "product_code":"ces", + "code":"9", + "des":"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", + "doc_type":"api", + "kw":"Querying Alarm Rules,Alarm Rule Management,API Reference", + "title":"Querying Alarm Rules", + "githuburl":"" + }, + { + "uri":"ces_03_0028.html", + "product_code":"ces", + "code":"10", + "des":"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", + "doc_type":"api", + "kw":"Querying an Alarm Rule,Alarm Rule Management,API Reference", + "title":"Querying an Alarm Rule", + "githuburl":"" + }, + { + "uri":"ces_03_0029.html", + "product_code":"ces", + "code":"11", + "des":"This API is used to enable or disable an alarm rule.PUT /V1.0/{project_id}/alarms/{alarm_id}/actionParameter descriptionParameter descriptionParameterMandatoryDescription", + "doc_type":"api", + "kw":"Enabling or Disabling an Alarm Rule,Alarm Rule Management,API Reference", + "title":"Enabling or Disabling an Alarm Rule", + "githuburl":"" + }, + { + "uri":"ces_03_0030.html", + "product_code":"ces", + "code":"12", + "des":"This API is used to delete an alarm rule.DELETE /V1.0/{project_id}/alarms/{alarm_id}Parameter descriptionParameter descriptionParameterMandatoryDescriptionproject_idYesSp", + "doc_type":"api", + "kw":"Deleting an Alarm Rule,Alarm Rule Management,API Reference", + "title":"Deleting an Alarm Rule", + "githuburl":"" + }, + { + "uri":"ces_03_0031.html", + "product_code":"ces", + "code":"13", + "des":"This API is used to create an alarm rule.POST /V1.0/{project_id}/alarmsParameter descriptionParameter descriptionParameterMandatoryDescriptionproject_idYesSpecifies the p", + "doc_type":"api", + "kw":"Creating an Alarm Rule,Alarm Rule Management,API Reference", + "title":"Creating an Alarm Rule", + "githuburl":"" + }, + { + "uri":"ces_03_0032.html", + "product_code":"ces", + "code":"14", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Monitoring Data Management", + "title":"Monitoring Data Management", + "githuburl":"" + }, + { + "uri":"ces_03_0033.html", + "product_code":"ces", + "code":"15", + "des":"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", + "doc_type":"api", + "kw":"Querying Monitoring Data,Monitoring Data Management,API Reference", + "title":"Querying Monitoring Data", + "githuburl":"" + }, + { + "uri":"en-us_topic_0032831274.html", + "product_code":"ces", + "code":"16", + "des":"This API is used to add one or more pieces of custom metric monitoring data to solve the problem that the system metrics cannot meet specific service requirements.POST /V", + "doc_type":"api", + "kw":"Adding Monitoring Data,Monitoring Data Management,API Reference", + "title":"Adding Monitoring Data", + "githuburl":"" + }, + { + "uri":"ces_03_0034.html", + "product_code":"ces", + "code":"17", + "des":"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", + "doc_type":"api", + "kw":"Querying Monitoring Data in Batches,Monitoring Data Management,API Reference", + "title":"Querying Monitoring Data in Batches", + "githuburl":"" + }, + { + "uri":"ces_03_0035.html", + "product_code":"ces", + "code":"18", + "des":"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", + "doc_type":"api", + "kw":"Querying the Host Configuration,Monitoring Data Management,API Reference", + "title":"Querying the Host Configuration", + "githuburl":"" + }, + { + "uri":"ces_03_0036.html", + "product_code":"ces", + "code":"19", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Quota Management", + "title":"Quota Management", + "githuburl":"" + }, + { + "uri":"ces_03_0037.html", + "product_code":"ces", + "code":"20", + "des":"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", + "doc_type":"api", + "kw":"Querying Quotas,Quota Management,API Reference", + "title":"Querying Quotas", + "githuburl":"" + }, + { + "uri":"ces_03_0038.html", + "product_code":"ces", + "code":"21", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Event Monitoring", + "title":"Event Monitoring", + "githuburl":"" + }, + { + "uri":"en-us_topic_0109034020.html", + "product_code":"ces", + "code":"22", + "des":"An API for reporting custom events is provided, which helps you collect and report abnormal events or important change events to Cloud Eye.POST /V1.0/{project_id}/eventsP", + "doc_type":"api", + "kw":"Reporting Events,Event Monitoring,API Reference", + "title":"Reporting Events", + "githuburl":"" + }, + { + "uri":"ces_03_0074.html", + "product_code":"ces", + "code":"23", + "des":"This API is used to query the events, including system events and custom events.GET /V1.0/{project_id}/eventsParameter descriptionParameter descriptionParameterTypeMandat", + "doc_type":"api", + "kw":"Querying Events,Event Monitoring,API Reference", + "title":"Querying Events", + "githuburl":"" + }, + { + "uri":"ces_03_0075.html", + "product_code":"ces", + "code":"24", + "des":"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", + "doc_type":"api", + "kw":"Querying Monitoring Details of an Event,Event Monitoring,API Reference", + "title":"Querying Monitoring Details of an Event", + "githuburl":"" + }, + { + "uri":"ces_03_0053.html", + "product_code":"ces", + "code":"25", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Common Parameters", + "title":"Common Parameters", + "githuburl":"" + }, + { + "uri":"ces_03_0055.html", + "product_code":"ces", + "code":"26", + "des":"NormalReturned ValueDescription200 OKThe results of GET and PUT operations are returned as expected.201 CreatedThe results of the POST operation are returned as expected.", + "doc_type":"api", + "kw":"Status Codes,Common Parameters,API Reference", + "title":"Status Codes", + "githuburl":"" + }, + { + "uri":"ErrorCode.html", + "product_code":"ces", + "code":"27", + "des":"If an error occurs during API calling, the system returns error information. This section describes the error codes contained in the error information for Cloud Eye APIs.", + "doc_type":"api", + "kw":"Error Codes,Common Parameters,API Reference", + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"ces_03_0057.html", + "product_code":"ces", + "code":"28", + "des":"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", + "doc_type":"api", + "kw":"Obtaining a Project ID,Common Parameters,API Reference", + "title":"Obtaining a Project ID", + "githuburl":"" + }, + { + "uri":"ces_03_0058.html", + "product_code":"ces", + "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", + "title":"Appendix", + "githuburl":"" + }, + { + "uri":"ces_03_0059.html", + "product_code":"ces", + "code":"30", + "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":"Services Interconnected with Cloud Eye,Appendix,API Reference", + "title":"Services Interconnected with Cloud Eye", + "githuburl":"" + }, + { + "uri":"ces_01_0054.html", + "product_code":"ces", + "code":"31", + "des":"Events in Event Monitoring come from operations on cloud service resources and are not collected by the Agent in Server Monitoring.Once a physical host running ECSs break", + "doc_type":"api", + "kw":"Events Supported by Event Monitoring,Appendix,API Reference", + "title":"Events Supported by Event Monitoring", + "githuburl":"" + }, + { + "uri":"ces_03_0060.html", + "product_code":"ces", + "code":"32", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Change History,API Reference", + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/ces/api-ref/CLASS.TXT.json b/docs/ces/api-ref/CLASS.TXT.json new file mode 100644 index 000000000..e6688b5bf --- /dev/null +++ b/docs/ces/api-ref/CLASS.TXT.json @@ -0,0 +1,290 @@ +[ + { + "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" + } +] \ No newline at end of file diff --git a/docs/ces/api-ref/ErrorCode.html b/docs/ces/api-ref/ErrorCode.html new file mode 100644 index 000000000..45e8d38d6 --- /dev/null +++ b/docs/ces/api-ref/ErrorCode.html @@ -0,0 +1,312 @@ + + +

Error Codes

+

Function

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.

+
+

Example Response

{
+    "code": 400,
+    "element": "Bad Request",
+    "message": "The system received a request which cannot be recognized",
+    "details": {
+        "details": "Some content in message body is not correct",
+        "code": "ces.0014"
+    }
+}
+
+

Glossary

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

Glossary

+

Description

+

Cloud Eye

+

Cloud Eye

+

Built-in metric

+

Each service has its own built-in metrics and dimensions. For example, an ECS (SYS.ECS) supports cpu_util.

+

Metric

+

A metric consists of the namespace, dimension (optional), and metric name. A metric name solely does not identify any object.

+
+
+
+

Error Code Description

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

Module

+

HTTP Status Code

+

Error Code

+

Error Code Description

+

Error Message

+

Measure

+

Cloud Eye

+

500

+

ces.0007

+

Internal service error

+

Internal service error.

+

Contact technical support.

+

API

+

400

+

ces.0001

+

The request content cannot be empty.

+

The content must be specified.

+

Specify the request content.

+

400

+

ces.0003

+

The project ID is left blank or is incorrect.

+

The tenant ID is left blank or incorrect.

+

Add or use the correct tenant ID.

+

400

+

ces.0004

+

The API version is not specified.

+

The API version must be specified.

+

Specify the API version in the request URL.

+

400

+

ces.0005

+

The API version is incorrect.

+

The API version is incorrect.

+

Use the correct API version.

+

400

+

ces.0006

+

The paging address is incorrect.

+

The paging address is incorrect.

+

Use correct pagination information.

+

403

+

ces.0009

+

System metrics cannot be added.

+

Adding SYS metric is not allowed

+

Use correct rights to add metrics.

+

403

+

ces.0010

+

System metrics cannot be deleted.

+

Deleting SYS metric is not allowed

+

Use correct rights to delete metrics.

+

400

+

ces.0011

+

The request is invalid.

+

The request is invalid.

+

Check the request.

+

400

+

ces.0013

+

The URL parameter is invalid or does not exist.

+

The URL parameter is invalid or does not exist.

+

Check the URL parameter.

+

400

+

ces.0014

+

Some content in the message body is correct.

+

Some content in message body is not correct.

+

Check the request body parameters.

+

401

+

ces.0015

+

Authentication fails or valid authentication information is not provided.

+

Authentication fails or the authentication information is not provided.

+

Check whether the user name or password (or AK or SK) for obtaining the token is correct.

+

404

+

ces.0016

+

The requested resource does not exist.

+

The requested resource does not exist.

+

Check whether the requested resource exists.

+

403

+

ces.0017

+

The authentication information is incorrect or the service invoker does not have sufficient rights.

+

The authentication information is incorrect or the service invoker does not have sufficient rights.

+

Check whether the user name or password (or AK or SK) or the user rights for obtaining the token are correct.

+

Cassandra

+

500

+

ces.0008

+

Database error

+

Database error.

+

Contact technical support.

+

Kafka

+

500

+

ces.0012

+

The message queue is abnormal or is not ready.

+

The message queue is abnormal or is not ready.

+

Contact technical support.

+

Zookeeper

+

500

+

ces.0021

+

Internal locking error

+

Internal locking error

+

Contact technical support.

+

Blueflood

+

500

+

ces.0019

+

The metric processing engine is abnormal.

+

The metric processing engine is abnormal.

+

Contact technical support.

+

Alarm

+

400

+

ces.0002

+

The alarm ID cannot be left blank.

+

The alarm ID must be specified.

+

Specify the alarm ID.

+

403

+

ces.0018

+

The number of alarm rules created exceeds the quota.

+

The number of alarms exceeds the quota

+

Apply for a higher alarm quota.

+

400

+

ces.0028

+

The metric and notification type do not match when an alarm rule is created.

+

The metric does not support the alarm action type.

+

Modify the metric or notification type according to the parameter description to make them match.

+
+
+
+
+
+
+
Parent topic: Common Parameters
+
+
+ diff --git a/docs/ces/api-ref/PARAMETERS.txt b/docs/ces/api-ref/PARAMETERS.txt new file mode 100644 index 000000000..6da8d5f07 --- /dev/null +++ b/docs/ces/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/ces/api-ref/ces_01_0054.html b/docs/ces/api-ref/ces_01_0054.html new file mode 100644 index 000000000..f6d1e3c27 --- /dev/null +++ b/docs/ces/api-ref/ces_01_0054.html @@ -0,0 +1,1130 @@ + + +

Events Supported by Event Monitoring

+

Events in Event Monitoring come from operations on cloud service resources and are not collected by the Agent in Server Monitoring.

+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 ECS

Event Source

+

Event Name

+

Event ID

+

Event Severity

+

Description

+

Solution

+

Impact

+

ECS

+

Delete ECS

+

deleteServer

+

Major

+

The ECS was deleted

+
  • on the management console.
  • by calling APIs.
+

Check whether the deletion was performed intentionally by a user.

+

Services are interrupted.

+

Reboot ECS

+

rebootServer

+

Minor

+

The ECS was restarted

+
  • on the management console.
  • by calling APIs.
+

Check whether the restart was performed intentionally by a user.

+
  • Deploy service applications in HA mode.
  • After the ECS starts up, check whether services recover.
+

Services are interrupted.

+

Resize ECS

+

resizeServer

+

Minor

+

The ECS was resized

+
  • on the management console.
  • by calling APIs.
+
  • Check whether the operation was performed by a user.
  • Deploy service applications in HA mode.
  • After the ECS is resized, check whether services have recovered.
+

Services are interrupted.

+

Start auto recovery

+

startAutoRecovery

+

Major

+

ECSs on a faulty host would be automatically migrated to another properly-running host. During the migration, the ECSs was restarted.

+

Wait for the event to end and check whether services are affected.

+

Services may be interrupted.

+

Stop auto recovery

+

endAutoRecovery

+

Major

+

The ECS was restored to be normal after the automatic migration.

+

This event indicates that the ECS has been recovered and been working properly.

+

None

+

Auto recovery timeout (being processed on the backend)

+

faultAutoRecovery

+

Major

+

Migrating the ECS to a normal host timed out.

+

Migrate services to other ECSs.

+

Services are interrupted.

+

Improper ECS running

+

vmIsRunningImproperly

+

Major

+

The ECS was faulty or the ECS NIC was abnormal.

+

Deploy service applications in HA mode.

+

After the fault is rectified, check whether services recover.

+

Services are interrupted.

+

Improper ECS running recovered

+

vmIsRunningImproperlyRecovery

+

Major

+

The ECS was restored to the normal status.

+

Wait for the ECS status to become normal and check whether services are affected.

+

None

+

VM faults caused by host process exceptions

+

VMFaultsByHostProcessExceptions

+

Critical

+

The processes of the host accommodating the ECS were abnormal.

+

Contact O&M personnel.

+

The ECS is faulty.

+

Restarted GuestOS

+

RestartGuestOS

+

Minor

+

The guest OS was restarted.

+

Contact O&M personnel.

+

Services may be interrupted.

+
+
+

Once a physical host running ECSs breaks down, the ECSs are automatically migrated to a functional physical host. During the migration, the ECSs will be restarted.

+
+ +
+ + + + + + + + + + + + + + + + + +
Table 2 Advanced Anti-DDoS (AAD)

Event Source

+

Event Name

+

Event ID

+

Event Severity

+

Description

+

Solution

+

Impact

+

AAD

+

DDoS Attack Events

+

ddosAttackEvents

+

Major

+

A DDoS attack occurs in the AAD protected lines.

+

Judge the impact on services based on the attack traffic and attack type. If the attack traffic exceeds your purchased elastic bandwidth, change to another line or increase your bandwidth.

+

Services may be interrupted.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 CBR

Event Source

+

Event Name

+

Event ID

+

Event Severity

+

Description

+

Solution

+

Impact

+

CBR

+

Failed to create the backup.

+

backupFailed

+

Critical

+

The backup failed to be created.

+

Manually create a backup or contact customer service.

+

Data loss may occur.

+

Failed to restore the resource using a backup.

+

restorationFailed

+

Critical

+

The resource failed to be restored using a backup.

+

Restore the resource using another backup or contact customer service.

+

Data loss may occur.

+

Failed to delete the backup.

+

backupDeleteFailed

+

Critical

+

The backup failed to be deleted.

+

Try again later or contact customer service.

+

Charging may be abnormal.

+

Failed to delete the vault.

+

vaultDeleteFailed

+

Critical

+

The vault failed to be deleted.

+

Try again later or contact technical support.

+

Charging may be abnormal.

+

Replication failure

+

replicationFailed

+

Critical

+

The backup failed to be replicated.

+

Try again later or contact technical support.

+

Data loss may occur.

+

The backup is created successfully.

+

backupSucceeded

+

Major

+

The backup was created.

+

None

+

None

+

Resource restoration using a backup succeeded.

+

restorationSucceeded

+

Major

+

The resource was restored using a backup.

+

Check whether the data is successfully restored.

+

None

+

The backup is deleted successfully.

+

backupDeletionSucceeded

+

Major

+

The backup was deleted.

+

None

+

None

+

The vault is deleted successfully.

+

vaultDeletionSucceeded

+

Major

+

The vault was deleted.

+

None

+

None

+

Replication success

+

replicationSucceeded

+

Major

+

The backup was replicated successfully.

+

None

+

None

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 RDS — resource exception

Event Source

+

Event Name

+

Event ID

+

Event Severity

+

Description

+

Solution

+

Impact

+

RDS

+

Full backup failure

+

fullBackupFailed

+

Major

+

A single full backup failure does not affect the files that have been successfully backed up, but prolong the incremental backup time during the point-in-time restore (PITR).

+

Create a manual backup again.

+

Backup failed.

+

Primary/standby switchover or failover

+

PrimaryStandbySwitched

+

Major

+

This event is reported when a primary/standby switchover or a failover is triggered.

+
  1. After the switchover or failover is complete, check whether workloads are restored. If workloads are not restored, contact SRE engineers.
  2. Ignore the event if you have performed a switchover.
  3. If the failover is triggered by a node fault, contact the SRE engineers.
+

Downtime occurs during the switchover.

+

Replication status abnormal

+

abnormalReplicationStatus

+

Major

+

The possible causes are as follows:

+

The replication delay between the primary and standby instances is too long, which usually occurs when a large amount of data is written to databases or a large transaction is processed. During peak hours, data may be blocked.

+

The network between the primary and standby instances is disconnected.

+

Submit a service ticket.

+

Your applications are not affected because this event does not interrupt data read and write.

+

Replication status recovered

+

replicationStatusRecovered

+

Major

+

The replication delay between the primary and standby instances is within the normal range, or the network connection between them has restored.

+

No action is required.

+

None

+

DB instance faulty

+

faultyDBInstance

+

Major

+

A single or primary DB instance was faulty due to a disaster or a server failure.

+

Check whether an automated backup policy has been configured for the DB instance and submit a service ticket.

+

The database service may be unavailable.

+

DB instance recovered

+

DBInstanceRecovered

+

Major

+

RDS rebuilds the standby DB instance with its high availability. After the instance is rebuilt, this event will be reported.

+

No action is required.

+

None

+

Failure of changing single DB instance to primary/standby

+

singleToHaFailed

+

Major

+

A fault occurs when RDS is creating the standby DB instance or configuring replication between the primary and standby DB instances. The fault may occur because resources are insufficient in the data center where the standby DB instance is located.

+

Submit a service ticket.

+

Your applications are not affected because this event does not interrupt data read and write of the DB instance.

+

Database process restarted

+

DatabaseProcessRestarted

+

Major

+

The database process is stopped due to insufficient memory or high load.

+

Log in to the Cloud Eye console. Check whether the memory usage increases sharply, the CPU usage is too high for a long time, or the storage space is insufficient. You can increase the CPU and memory specifications or optimize the service logic.

+

Downtime occurs. When this happens, RDS automatically restarts the database process and attempts to recover the workloads.

+

Instance storage full

+

instanceDiskFull

+

Major

+

Generally, the cause is that the data space usage is too high.

+

Scale up the instance.

+

The DB instance becomes read-only because the storage space is full, and data cannot be written to the database.

+

Instance storage full recovered

+

instanceDiskFullRecovered

+

Major

+

The instance disk is recovered.

+

No action is required.

+

Cancel the read-only state of the instance and resume write operations.

+

Read replica promotion failure

+

activeStandBySwitchFailed

+

Major

+

The read replica fails to be promoted to the primary DB instance due to network or server failures. The original primary DB instance takes over workloads quickly.

+

Submit a service ticket.

+

The read replica fails to be promoted to the primary DB instance.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 GaussDB(for MySQL)

Event Source

+

Event Name

+

Event ID

+

Event Severity

+

Description

+

Solution

+

Impact

+

GaussDB(for MySQL)

+

Incremental backup failure

+

TaurusIncrementalBackupInstanceFailed

+

Major

+

The network between the instance and the management plane (or the OBS) is disconnected, or the backup environment created for the instance is abnormal.

+

Submit a service ticket.

+

Backup jobs fail.

+

Read replica creation failure

+

addReadonlyNodesFailed

+

Major

+

The quota is insufficient or underlying resources are exhausted.

+

Check the read replica quota. Release resources and create read replicas again.

+

Read replicas fail to be created.

+

DB instance creation failure

+

createInstanceFailed

+

Major

+

The instance quota or underlying resources are insufficient.

+

Check the instance quota. Release resources and create instances again.

+

DB instances fail to be created.

+

Read replica promotion failure

+

activeStandBySwitchFailed

+

Major

+

The read replica fails to be promoted to the primary node due to network or server failures. The original primary node takes over services quickly.

+

Submit a service ticket.

+

The read replica fails to be promoted to the primary node.

+

Instance specifications change failure

+

flavorAlterationFailed

+

Major

+

The quota is insufficient or underlying resources are exhausted.

+

Submit a service ticket.

+

Instance specifications fail to be changed.

+

Faulty DB instance

+

TaurusInstanceRunningStatusAbnormal

+

Major

+

The instance process is faulty or the communications between the instance and the DFV storage are abnormal.

+

Submit a service ticket.

+

Services may be affected.

+

DB instance recovered

+

TaurusInstanceRunningStatusRecovered

+

Major

+

The instance is recovered.

+

Observe the service running status.

+

None

+

Faulty node

+

TaurusNodeRunningStatusAbnormal

+

Major

+

The node process is faulty or the communications between the node and the DFV storage are abnormal.

+

Observe the instance and service running statuses.

+

A read replica may be promoted to the primary node.

+

Node recovered

+

TaurusNodeRunningStatusRecovered

+

Major

+

The node is recovered.

+

Observe the service running status.

+

None

+

Read replica deletion failure

+

TaurusDeleteReadOnlyNodeFailed

+

Major

+

The communications between the management plane and the read replica are abnormal or the VM fails to be deleted from IaaS.

+

Submit a service ticket.

+

Read replicas fail to be deleted.

+

Password reset failure

+

TaurusResetInstancePasswordFailed

+

Major

+

The communications between the management plane and the instance are abnormal or the instance is abnormal.

+

Check the instance status and try again. If the fault persists, submit a service ticket.

+

Passwords fail to be reset for instances.

+

DB instance reboot failure

+

TaurusRestartInstanceFailed

+

Major

+

The network between the management plane and the instance is abnormal or the instance is abnormal.

+

Check the instance status and try again. If the fault persists, submit a service ticket.

+

Instances fail to be rebooted.

+

Restoration to new DB instance failure

+

TaurusRestoreToNewInstanceFailed

+

Major

+

The instance quota is insufficient, underlying resources are exhausted, or the data restoration logic is incorrect.

+

If the new instance fails to be created, check the instance quota, release resources, and try to restore to a new instance again. In other cases, submit a service ticket.

+

Backup data fails to be restored to new instances.

+

EIP binding failure

+

TaurusBindEIPToInstanceFailed

+

Major

+

The binding task fails.

+

Submit a service ticket.

+

EIPs fail to be bound to instances.

+

EIP unbinding failure

+

TaurusUnbindEIPFromInstanceFailed

+

Major

+

The unbinding task fails.

+

Submit a service ticket.

+

EIPs fail to be unbound from instances.

+

Parameter modification failure

+

TaurusUpdateInstanceParameterFailed

+

Major

+

The network between the management plane and the instance is abnormal or the instance is abnormal.

+

Check the instance status and try again. If the fault persists, submit a service ticket.

+

Instance parameters fail to be modified.

+

Parameter template application failure

+

TaurusApplyParameterGroupToInstanceFailed

+

Major

+

The network between the management plane and instances is abnormal or the instances are abnormal.

+

Check the instance status and try again. If the fault persists, submit a service ticket.

+

Parameter templates fail to be applied to instances.

+

Full backup failure

+

TaurusBackupInstanceFailed

+

Major

+

The network between the instance and the management plane (or the OBS) is disconnected, or the backup environment created for the instance is abnormal.

+

Submit a service ticket.

+

Backup jobs fail.

+

Primary/standby failover

+

TaurusActiveStandbySwitched

+

Major

+

When the network, physical machine, or database of the primary node is faulty, the system promotes a read replica to primary based on the failover priority to ensure service continuity.

+
  1. Check whether the service is running properly.
  2. Check whether an alarm is generated, indicating that the read replica failed to be promoted to primary.
+

During the failover, database connection is interrupted for a short period of time. After the failover is complete, you can reconnect to the database.

+

Database read-only

+

NodeReadonlyMode

+

Major

+

The database supports only query operations.

+

Contact the database technical support team.

+

After the database becomes read-only, write operations cannot be processed.

+

Database read/write

+

NodeReadWriteMode

+

Major

+

The database supports both write and read operations.

+

None.

+

None.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 GaussDB(for openGauss)

Event Source

+

Event Name

+

Event ID

+

Event Severity

+

Description

+

Solution

+

Impact

+

GaussDB(for openGauss)

+

Process status alarm

+

ProcessStatusAlarm

+

Major

+

Key processes exit, including: CMS/CMA, ETCD, GTM, CN, or DN process.

+

Wait until the process is automatically recovered or a primary/standby failover is automatically performed. Check whether services are recovered. If no, contact SRE engineers.

+

If processes on primary nodes are faulty, services are interrupted and then rolled back. If processes on standby nodes are faulty, services are not affected.

+

Component status alarm

+

ComponentStatusAlarm

+

Major

+

Key components do not respond, including: CMA, ETCD, GTM, CN, or DN component.

+

Wait until the process is automatically recovered or a primary/standby failover is automatically performed. Check whether services are recovered. If no, contact SRE engineers.

+

If processes on primary nodes do not respond, neither do the services. If processes on standby nodes are faulty, services are not affected.

+

Cluster status alarm

+

ClusterStatusAlarm

+

Major

+

The cluster status is abnormal. For example, the cluster is read-only; majority of ETCDs are faulty; or the cluster resources are unevenly distributed.

+

Contact SRE engineers.

+

If the cluster status is read-only, only read services are processed.

+

If the majority of ETCDs are fault, the cluster is unavailable.

+

If resources are unevenly distributed, the instance performance and reliability deteriorate.

+

Hardware resource alarm

+

HardwareResourceAlarm

+

Major

+

A major hardware fault occurs in the instance, such as disk damage or GTM network fault.

+

Contact SRE engineers.

+

Some or all services are affected.

+

Status transition alarm

+

StateTransitionAlarm

+

Major

+

The following events occur in the instance: DN build failure, forcible DN promotion, primary/standby DN switchover/failover, or primary/standby GTM switchover/failover.

+

Wait until the fault is automatically rectified and check whether services are recovered. If no, contact SRE engineers.

+

Some services are interrupted.

+

Other abnormal alarm

+

OtherAbnormalAlarm

+

Major

+

Disk usage threshold alarm

+

Focus on service changes and scale up storage space as needed.

+

If the used storage space exceeds the threshold, storage space cannot be scaled up.

+

Faulty DB instance

+

TaurusInstanceRunningStatusAbnormal

+

Major

+

This event is a key alarm event and is reported when an instance is faulty due to a disaster or a server failure.

+

Submit a service ticket.

+

The database service may be unavailable.

+

DB instance recovered

+

TaurusInstanceRunningStatusRecovered

+

Major

+

GaussDB(for openGauss) provides an HA tool for automated or manual rectification of faults. After the fault is rectified, this event is reported.

+

No further action is required.

+

None

+

Faulty DB node

+

TaurusNodeRunningStatusAbnormal

+

Major

+

This event is a key alarm event and is reported when a database node is faulty due to a disaster or a server failure.

+

Check whether the database service is available and submit a service ticket.

+

The database service may be unavailable.

+

DB node recovered

+

TaurusNodeRunningStatusRecovered

+

Major

+

GaussDB(for openGauss) provides an HA tool for automated or manual rectification of faults. After the fault is rectified, this event is reported.

+

No further action is required.

+

None

+

DB instance creation failure

+

GaussDBV5CreateInstanceFailed

+

Major

+

Instances fail to be created because the quota is insufficient or underlying resources are exhausted.

+

Release the instances that are no longer used and try to provision them again, or submit a service ticket to adjust the quota.

+

DB instances cannot be created.

+

Node adding failure

+

GaussDBV5ExpandClusterFailed

+

Major

+

The underlying resources are insufficient.

+

Submit a service ticket. The O&M personnel will coordinate resources in the background, and then you delete the node that failed to be added and add a new node.

+

None

+

Storage scale-up failure

+

GaussDBV5EnlargeVolumeFailed

+

Major

+

The underlying resources are insufficient.

+

Submit a service ticket. The O&M personnel will coordinate resources in the background and then you scale up the storage space again.

+

Services may be interrupted.

+

Reboot failure

+

GaussDBV5RestartInstanceFailed

+

Major

+

The network is abnormal.

+

Retry the reboot operation or submit a service ticket to the O&M personnel.

+

The database service may be unavailable.

+

Full backup failure

+

GaussDBV5FullBackupFailed

+

Major

+

The backup files fail to be exported or uploaded.

+

Submit a service ticket to the O&M personnel.

+

Data cannot be backed up.

+

Differential backup failure

+

GaussDBV5DifferentialBackupFailed

+

Major

+

The backup files fail to be exported or uploaded.

+

Submit a service ticket to the O&M personnel.

+

Data cannot be backed up.

+

Backup deletion failure

+

GaussDBV5DeleteBackupFailed

+

Major

+

This function does not need to be implemented.

+

N/A

+

N/A

+

EIP binding failure

+

GaussDBV5BindEIPFailed

+

Major

+

The EIP is bound to another resource.

+

Submit a service ticket to the O&M personnel.

+

The instance cannot be accessed from the Internet.

+

EIP unbinding failure

+

GaussDBV5UnbindEIPFailed

+

Major

+

The network is faulty or EIP is abnormal.

+

Unbind the IP address again or submit a service ticket to the O&M personnel.

+

IP addresses may be residual.

+

Parameter template application failure

+

GaussDBV5ApplyParamFailed

+

Major

+

Modifying a parameter template times out.

+

Modify the parameter template again.

+

None

+

Parameter modification failure

+

GaussDBV5UpdateInstanceParamGroupFailed

+

Major

+

Modifying a parameter template times out.

+

Modify the parameter template again.

+

None

+

Backup and restoration failure

+

GaussDBV5RestoreFromBcakupFailed

+

Major

+

The underlying resources are insufficient or backup files fail to be downloaded.

+

Submit a service ticket.

+

The database service may be unavailable during the restoration failure.

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0001.html b/docs/ces/api-ref/ces_03_0001.html new file mode 100644 index 000000000..f80d33188 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0001.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 by using JSON messages, with media type represented by Application/json.

+

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

+

An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For example, the endpoint of the eu-de region is ces.eu-de.otc.t-systems.com. For the endpoints of all services, see Regions and Endpoints.

+
+ diff --git a/docs/ces/api-ref/ces_03_0018.html b/docs/ces/api-ref/ces_03_0018.html new file mode 100644 index 000000000..cdc28b7c9 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0018.html @@ -0,0 +1,22 @@ + + +

API Description

+

+
+
+ +
+ diff --git a/docs/ces/api-ref/ces_03_0019.html b/docs/ces/api-ref/ces_03_0019.html new file mode 100644 index 000000000..d34eb31e7 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0019.html @@ -0,0 +1,18 @@ + + +

API Version Management

+

+
+
+ + +
+
Parent topic: API Description
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0020.html b/docs/ces/api-ref/ces_03_0020.html new file mode 100644 index 000000000..2ec65a866 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0020.html @@ -0,0 +1,190 @@ + + +

Querying All API Versions

+

Function

This API is used to query all API versions supported by Cloud Eye.

+
+

URI

GET /

+
+

Request

Example request

+
GET https://{Cloud Eye endpoint}/
+
+

Response

+
+

Returned Values

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: API Version Management
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0021.html b/docs/ces/api-ref/ces_03_0021.html new file mode 100644 index 000000000..691573f79 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0021.html @@ -0,0 +1,209 @@ + + +

Querying a Specified API Version

+

Function

This API is used to query a specified API version of Cloud Eye.

+
+

URI

GET /{api_version}

+ + +
+

Request

None

+
+

Response

+
+

Returned Values

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: API Version Management
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0022.html b/docs/ces/api-ref/ces_03_0022.html new file mode 100644 index 000000000..06c241336 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0022.html @@ -0,0 +1,16 @@ + + +

Metric Management

+

+
+
+ + +
+
Parent topic: API Description
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0023.html b/docs/ces/api-ref/ces_03_0023.html new file mode 100644 index 000000000..62e7552bf --- /dev/null +++ b/docs/ces/api-ref/ces_03_0023.html @@ -0,0 +1,321 @@ + + +

Querying Metrics

+

Function

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 API to query metrics.

+
+

URI

GET /V1.0/{project_id}/metrics

+ +
+

Request

None

+
+

Response

+
+

Returned Values

+
+

Error Codes

See Error Codes.

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

Alarm Rule Management

+

+
+
+ + +
+
Parent topic: API Description
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0027.html b/docs/ces/api-ref/ces_03_0027.html new file mode 100644 index 000000000..204998e2a --- /dev/null +++ b/docs/ces/api-ref/ces_03_0027.html @@ -0,0 +1,581 @@ + + +

Querying Alarm Rules

+

Function

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 sorting order of query results.

+
+

URI

GET /V1.0/{project_id}/alarms

+ + +
+

Request

None

+
+

Response

+
+

Returned Values

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm Rule Management
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0028.html b/docs/ces/api-ref/ces_03_0028.html new file mode 100644 index 000000000..ab00e5518 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0028.html @@ -0,0 +1,444 @@ + + +

Querying an Alarm Rule

+

Function

This API is used to query an alarm rule based on the alarm rule ID.

+
+

URI

GET /V1.0/{project_id}/alarms/{alarm_id}

+ + +
+

Request

None

+
+

Response

+
+

Returned Values

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm Rule Management
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0029.html b/docs/ces/api-ref/ces_03_0029.html new file mode 100644 index 000000000..4449a319f --- /dev/null +++ b/docs/ces/api-ref/ces_03_0029.html @@ -0,0 +1,126 @@ + + +

Enabling or Disabling an Alarm Rule

+

Function

This API is used to enable or disable an alarm rule.

+
+

URI

PUT /V1.0/{project_id}/alarms/{alarm_id}/action

+ + +
+

Request

+ +
+

Response

The response has no message body.

+
+

Returned Values

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm Rule Management
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0030.html b/docs/ces/api-ref/ces_03_0030.html new file mode 100644 index 000000000..f1e0cce79 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0030.html @@ -0,0 +1,98 @@ + + +

Deleting an Alarm Rule

+

Function

This API is used to delete an alarm rule.

+
+

URI

DELETE /V1.0/{project_id}/alarms/{alarm_id}

+ + +
+

Request

The request has no message body.

+
+

Response

The response has no message body.

+
+

Returned Values

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm Rule Management
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0031.html b/docs/ces/api-ref/ces_03_0031.html new file mode 100644 index 000000000..a481177a5 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0031.html @@ -0,0 +1,509 @@ + + +

Creating an Alarm Rule

+

Function

This API is used to create an alarm rule.

+
+

URI

POST /V1.0/{project_id}/alarms

+ + +
+

Request

+ +
+

Response

+ +
+

Returned Values

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Alarm Rule Management
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0032.html b/docs/ces/api-ref/ces_03_0032.html new file mode 100644 index 000000000..ee6a30988 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0032.html @@ -0,0 +1,22 @@ + + +

Monitoring Data Management

+

+
+
+ + +
+
Parent topic: API Description
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0033.html b/docs/ces/api-ref/ces_03_0033.html new file mode 100644 index 000000000..91cf17f89 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0033.html @@ -0,0 +1,309 @@ + + +

Querying Monitoring Data

+

Function

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 queried.

+
+

URI

GET /V1.0/{project_id}/metric-data?namespace={namespace}&metric_name={metric_name}&dim.{i}=key,value&from={from}&to={to}&period={period}&filter={filter}

+ + +
+

Request

None

+
+

Response

+
+

Returned Values

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Monitoring Data Management
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0034.html b/docs/ces/api-ref/ces_03_0034.html new file mode 100644 index 000000000..e0958ff53 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0034.html @@ -0,0 +1,610 @@ + + +

Querying Monitoring Data in Batches

+

Function

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 of a maximum of 10 metrics in batches.

+
+

URI

POST /V1.0/{project_id}/batch-query-metric-data

+ +
+

Request

  1. The size of a POST request cannot exceed 512 KB. Otherwise, the request will be denied.
  2. The default maximum query intervals of different periods are different.

    If period is 1, the maximum interval between from and to is 4 hours. If the interval between from and to is longer than 4 hours, adjust the value of from to to - 4*3600*1000.

    +

    If period is 300, the maximum interval between from and to is 1 day. If the interval between from and to is longer than 1 day, adjust the value of from to to - 24*3600*1000.

    +

    If period is 1200, the maximum interval between from and to is 3 days. If the interval between from and to is longer than three days, adjust the value of from to to - 3*24*3600*1000.

    +

    If period is 3600, the maximum interval between from and to is 10 days. If the interval between from and to is longer than 10 days, adjust the value of from to to - 10*24*3600*1000.

    +

    If period is 14400, the maximum interval between from and to is 30 days. If the interval between from and to is longer than 30 days, adjust the value of from to to - 30*24*3600*1000.

    +

    If period is 86400, the maximum interval between from and to is 180 days. If the interval between from and to is longer than 180 days, adjust the value of from to to - 180*24*3600*1000.

    +
+
+ + +
+

Response

+ +
+

Returned Values

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Monitoring Data Management
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0035.html b/docs/ces/api-ref/ces_03_0035.html new file mode 100644 index 000000000..9f16ca3fe --- /dev/null +++ b/docs/ces/api-ref/ces_03_0035.html @@ -0,0 +1,227 @@ + + +

Querying the Host Configuration

+

Function

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 provided for SAP Monitor in the HANA scenario to query the host configuration. In other scenarios, the host configuration cannot be queried with this API.

+
+
+

URI

GET /V1.0/{project_id}/event-data

+ + +
+

Request

None

+
+

Response

+
+

Returned Values

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Monitoring Data Management
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0036.html b/docs/ces/api-ref/ces_03_0036.html new file mode 100644 index 000000000..3c342993f --- /dev/null +++ b/docs/ces/api-ref/ces_03_0036.html @@ -0,0 +1,16 @@ + + +

Quota Management

+

+
+
+ + +
+
Parent topic: API Description
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0037.html b/docs/ces/api-ref/ces_03_0037.html new file mode 100644 index 000000000..2c9c4a295 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0037.html @@ -0,0 +1,184 @@ + + +

Querying Quotas

+

Function

This API is used to query a resource quota and the used amount. The current resource refers to alarm rules only.

+
+

URI

GET /V1.0/{project_id}/quotas

+ +
+

Request

None

+
+

Response

+
+

Returned Values

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Quota Management
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0038.html b/docs/ces/api-ref/ces_03_0038.html new file mode 100644 index 000000000..051e98d31 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0038.html @@ -0,0 +1,20 @@ + + +

Event Monitoring

+

+
+
+ + +
+
Parent topic: API Description
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0053.html b/docs/ces/api-ref/ces_03_0053.html new file mode 100644 index 000000000..f1fefa14a --- /dev/null +++ b/docs/ces/api-ref/ces_03_0053.html @@ -0,0 +1,16 @@ + + +

Common Parameters

+

+
+
+ +
+ diff --git a/docs/ces/api-ref/ces_03_0055.html b/docs/ces/api-ref/ces_03_0055.html new file mode 100644 index 000000000..a202ad6b9 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0055.html @@ -0,0 +1,121 @@ + + +

Status Codes

+
+
+
+
+
Parent topic: Common Parameters
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0057.html b/docs/ces/api-ref/ces_03_0057.html new file mode 100644 index 000000000..abcc60f21 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0057.html @@ -0,0 +1,15 @@ + + +

Obtaining a Project ID

+
A project ID needs to be specified in the URIs of some APIs. Therefore, you need to obtain the project ID before calling APIs. The following procedure describes how to obtain a project ID:
  1. Log in to the management console.
  2. Click the username and select My Credentials from the drop-down list.

    On the My Credentials page, view project IDs in the project list.

    +
    Figure 1 Viewing project IDs
    +

    In multi-project scenarios, expand the region, and obtain your sub-project ID from the Project ID column.

    +
+
+
+
+
+
Parent topic: Common Parameters
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0058.html b/docs/ces/api-ref/ces_03_0058.html new file mode 100644 index 000000000..5a6ba3eb4 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0058.html @@ -0,0 +1,14 @@ + + +

Appendix

+

+
+
+ +
+ diff --git a/docs/ces/api-ref/ces_03_0059.html b/docs/ces/api-ref/ces_03_0059.html new file mode 100644 index 000000000..50b1bd5db --- /dev/null +++ b/docs/ces/api-ref/ces_03_0059.html @@ -0,0 +1,180 @@ + + +

Services Interconnected with Cloud Eye

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

Category

+

Service

+

Namespace

+

Reference

+

Compute

+

Elastic Cloud Server

+

SYS.ECS

+

Basic ECS metrics

+

Bare Metal Server

+

SERVICE.BMS

+

BMS Metrics Under OS Monitoring

+

Auto Scaling

+

SYS.AS

+

AS metrics

+

Storage

+

Elastic Volume Service (attached to an ECS or BMS)

+

SYS.EVS

+

EVS metrics

+

Scalable File Service

+

SYS.SFS

+

SFS metrics

+

SFS Turbo

+

SYS.EFS

+

SFS Turbo metrics

+

Cloud Backup and Recovery

+

SYS.CBR

+

CBR metrics

+

Network

+

Elastic IP and bandwidth

+

SYS.VPC

+

VPC metrics

+

Elastic Load Balance

+

SYS.ELB

+

ELB metrics

+

NAT Gateway

+

SYS.NAT

+

NAT Gateway metrics

+

Security

+

Web Application Firewall

+

SYS.WAF

+

WAF metrics

+

Application

+

Distributed Message Service

+

SYS.DMS

+

DMS metrics

+

Distributed Cache Service

+

SYS.DCS

+

DCS metrics

+

Database

+

Relational Database Service

+

SYS.RDS

+

RDS for MySQL metrics

+

RDS for PostgreSQL metrics

+

RDS for SQL Server metrics

+

Document Database Service

+

SYS.DDS

+

DDS metrics

+

GaussDB NoSQL

+

SYS.NoSQL

+

GaussDB(for Cassandra) metrics

+

GaussDB(for MySQL)

+

SYS.GAUSSDB

+

GaussDB(for MySQL) metrics

+

GaussDB(for openGauss)

+

SYS.GAUSSDBV5

+

GaussDB(for MySQL) metrics

+

Data analysis

+

Data Warehouse Service

+

SYS.DWS

+

DWS metrics

+

Cloud Search Service

+

SYS.ES

+

CSS metrics

+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0060.html b/docs/ces/api-ref/ces_03_0060.html new file mode 100644 index 000000000..e18f3491e --- /dev/null +++ b/docs/ces/api-ref/ces_03_0060.html @@ -0,0 +1,188 @@ + + +

Change History

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

Released On

+

Description

+

2022-10-10

+

This release incorporates the following change:

+

Added section "Events Supported by Event Monitoring".

+

2021-02-19

+

Accepted for RM-3379.

+

2020-08-15

+

Accepted for RM-389.

+

2020-03-06

+

This release incorporates the following changes:

+ +

2019-08-31

+

This release incorporates the following change:

+

Added Event Monitoring.

+

2019-03-30

+

This release incorporates the following changes:

+
  • Changed Virtual Private Cloud (VPC) to Elastic IP (EIP) and Bandwidth in section "Elastic IP (EIP) and Bandwidth Monitoring Metrics."
  • Optimized the Distributed Message Service (DMS) metrics.
+

2018-12-30

+

This release incorporates the following changes:

+
  • Optimized Elastic Cloud Server (ECS) metrics, including the names of disk metrics.
  • Optimized Elastic Volume Service (EVS) disk metrics.
  • Optimized the names of Relational Database Service (RDS) metrics.
+

Added

+

Interconnected with Document Database Service (DDS).

+

2018-09-30

+

This release incorporates the following changes:

+ +

2018-08-30

+

This release incorporates the following change:

+

Interconnected with Cloud Search Service (CSS).

+

2018-06-30

+

This release incorporates the following change:

+

Added metrics for the enhanced load balancer and enhanced load balancer listener.

+

2018-05-30

+

This release incorporates the following change:

+

Accepted in OTC 3.1.

+

2018-03-30

+

This release incorporates the following change:

+

Added Virtual Private Cloud (VPC) traffic metrics.

+

2018-02-28

+

This release incorporates the following change:

+

Updated Virtual Private Cloud (VPC) metrics.

+

2017-12-30

+

This release incorporates the following changes:

+
  • Added the API for creating alarm rules.
  • Optimized descriptions of error codes.
+

2017-11-30

+

This release incorporates the following change:

+

Added Auto Scaling (AS) metrics.

+

2017-10-30

+

This release incorporates the following changes:

+
  • Optimized the descriptions of Distributed Message Service (DMS) metrics.
  • Added Scalable File Service (SFS) metrics.
+

2017-10-09

+

This release incorporates the following change:

+

Added the API for querying the host configuration.

+

2017-07-30

+
This release incorporates the following changes:
  • Added descriptions for Distributed Cache Service (DCS) metrics.
  • Added descriptions for API Gateway metrics.
  • Marked the section about querying followed metrics as deprecated.
+
+

2017-05-26

+

This release incorporates the following change:

+

Added Distributed Message Service (DMS) metrics.

+

2017-04-28

+

This release incorporates the following change:

+

Added Virtual Private Cloud (VPC) traffic metrics.

+

2017-02-27

+

This release incorporates the following change:

+

Added the setting description for the from parameter.

+

2016-12-30

+

This release incorporates the following change:

+

Added Relational Database Service (RDS) metrics.

+

2016-10-29

+

This release incorporates the following change:

+

Added Elastic Load Balance (ELB) metrics.

+

2016-10-19

+

This release incorporates the following change:

+

Deleted Resource Template Service (RTS) metrics.

+

2016-9-30

+

This release incorporates the following change:

+

Added Resource Template Service (RTS) metrics.

+

2016-8-25

+

This release incorporates the following changes:

+
  • Added the Cloud Container Engine (CCE), Relational Database Service (RDS), and Domain Name Service (DNS) services in Regions and Endpoints.
  • Added Elastic Cloud Server (ECS) metrics.
  • Added Relational Database Service (RDS) metrics.
+

2016-07-30

+

This release incorporates the following changes:

+
  • Modified the document contents to make the contents display by open API functions.
  • Added the interface for querying an alarm rule.
  • Added the interfaces for enabling, disabling, and deleting alarm rules.
  • Added the interface for adding monitoring data.
  • Added descriptions for Relational Database Service (RDS) metrics.
+

2016-04-14

+

This release incorporates the following changes:

+
  • Modified parameter descriptions in URL in Service Usage.
  • Modified steps for invoking interfaces in Token Authentication.
+

2016-03-09

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0074.html b/docs/ces/api-ref/ces_03_0074.html new file mode 100644 index 000000000..c42f7f060 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0074.html @@ -0,0 +1,294 @@ + + +

Querying Events

+

Function

This API is used to query the events, including system events and custom events.

+
+

URI

GET /V1.0/{project_id}/events

+ +
+

Request

None

+
+

Response

+ +
+ + + + + + + + + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

events

+

Array of Events objects

+

No

+

Specifies one or more pieces of event data.

+

For details, see Table 3.

+

meta_data

+

MetaData object

+

No

+

Specifies the number of metadata records in the query result.

+

For details, see Table 4.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 events field description

Parameter

+

Type

+

Mandatory

+

Description

+

event_name

+

String

+

No

+

Specifies the event name.

+

event_type

+

String

+

No

+

Specifies the event type.

+

event_count

+

Integer

+

No

+

Specifies the number of occurrences of this event within the specified query time range.

+

latest_occur_time

+

Long

+

No

+

Specifies when the event last occurred.

+

latest_event_source

+

String

+

No

+

Specifies the event source. If the event is a system event, the value is the namespace of each service. To view the namespace of each service, see Services Interconnected with Cloud Eye.

+

If the event is a custom event, the event source is defined by the user.

+
+
+ +
+ + + + + + + + + + + +
Table 4 meta_data data structure description

Parameter

+

Type

+

Mandatory

+

Description

+

total

+

Integer

+

No

+

Specifies the total number of events.

+
+
+
+ +

Returned Values

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Event Monitoring
+
+
+ diff --git a/docs/ces/api-ref/ces_03_0075.html b/docs/ces/api-ref/ces_03_0075.html new file mode 100644 index 000000000..e2ad77391 --- /dev/null +++ b/docs/ces/api-ref/ces_03_0075.html @@ -0,0 +1,491 @@ + + +

Querying Monitoring Details of an Event

+

Function

This API is used to query the event details based on the event name.

+
+

URI

GET /V1.0/{project_id}/event/{event_name}

+ +
+

Request

None

+
+

Response

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

event_name

+

string

+

No

+

Specifies the event name. The name can be a system event name or a custom event name.

+

event_type

+

string

+

No

+

Specifies the event type. Possible types are EVENT.SYS (system event) and EVENT.CUSTOM (custom event).

+

event_users

+

Array of strings

+

No

+

Specifies the name of the user who reports the event. It can also be a project ID.

+

event_sources

+

Array of strings

+

No

+

Specifies the event source. If the event is a system event, the source is the namespace of each service. To view the namespace of each service, see Services Interconnected with Cloud Eye. If the event is a custom event, the event source is defined by the user.

+

event_info

+

Array of objects

+

No

+

Specifies details about one or more events.

+

For details, see Table 3.

+

meta_data

+

MetaData object

+

No

+

Specifies the number of metadata records in the query result.

+

For details, see Table 5.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 event_info data structure description

Parameter

+

Type

+

Mandatory

+

Description

+

event_name

+

string

+

Yes

+

Specifies the event name. Start with a letter. Enter 1 to 64 characters. Only letters, digits, and underscores (_) are allowed.

+

event_source

+

string

+

No

+

Specifies the event source in the format of service.item. service and item each must start with a letter and contain 3 to 32 characters, including only letters, digits, and underscores (_).

+

time

+

long

+

Yes

+

Specifies when the event occurred, which is a UNIX timestamp (ms). Since there is a latency between the client and the server, the data timestamp to be inserted should be within the period that starts from one hour before the current time plus 20s to 10 minutes after the current time minus 20s. In this way, the timestamp will be inserted to the database without being affected by the latency.

+

detail

+

Detail object

+

Yes

+

Specifies the event details.

+

For details, see Table 4.

+

event_id

+

string

+

No

+

Specifies the event ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 detail data structure description

Parameter

+

Type

+

Mandatory

+

Description

+

content

+

string

+

No

+

Specifies the event content. Enter up to 4096 characters.

+

group_id

+

string

+

No

+

Specifies the resource group the event belongs to. This ID must be an existing resource group ID.

+

resource_id

+

string

+

No

+

Specifies the resource ID, which can contain a maximum of 128 characters.

+

resource_name

+

string

+

No

+

Specifies the resource name, which can contain a maximum of 128 characters.

+

event_state

+

string

+

No

+

Specifies the event status.

+

Valid value can be normal, warning, or incident.

+

event_level

+

string

+

No

+

Specifies the event severity.

+

Its value can be Critical, Major, Minor, or Info.

+

event_user

+

string

+

No

+

Specifies the event user. Enter up to 64 characters.

+

event_type

+

string

+

No

+

Specifies the event type.

+

Possible types are EVENT.SYS (system event) and EVENT.CUSTOM (custom event).

+
+
+ +
+ + + + + + + + + + + +
Table 5 meta_data data structure description

Parameter

+

Type

+

Mandatory

+

Description

+

total

+

Integer

+

No

+

Specifies the total number of events.

+
+
+
+ +

Returned Values

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Event Monitoring
+
+
+ diff --git a/docs/ces/api-ref/en-us_image_0218975120.png b/docs/ces/api-ref/en-us_image_0218975120.png new file mode 100644 index 000000000..ec3abb85c Binary files /dev/null and b/docs/ces/api-ref/en-us_image_0218975120.png differ diff --git a/docs/ces/api-ref/en-us_topic_0032831274.html b/docs/ces/api-ref/en-us_topic_0032831274.html new file mode 100644 index 000000000..13a0f67f9 --- /dev/null +++ b/docs/ces/api-ref/en-us_topic_0032831274.html @@ -0,0 +1,328 @@ + + +

Adding Monitoring Data

+

Function

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.

+
+

URI

POST /V1.0/{project_id}/metric-data

+ +
+

Request

  1. The size of a POST request cannot exceed 512 KB. Otherwise, the request will be denied.
  2. The period for sending POST requests must be shorter than the minimum aggregation period. Otherwise, the aggregated data will be noncontinuous. For example, if the aggregation period is 5 minutes and the POST request sending period is 7 minutes, the data will be aggregated every 10 minutes, rather than 5 minutes.
  3. Timestamp (collect_time) in the POST request body value must be within the period that starts from three days before the current time to 10 minutes after the current time. If it is not in this range, you are not allowed to insert the metric data.
+
+ + +
+

Response

The response has no message body.

+
+

Returned Values

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Monitoring Data Management
+
+
+ diff --git a/docs/ces/api-ref/en-us_topic_0109034020.html b/docs/ces/api-ref/en-us_topic_0109034020.html new file mode 100644 index 000000000..e2716923f --- /dev/null +++ b/docs/ces/api-ref/en-us_topic_0109034020.html @@ -0,0 +1,339 @@ + + +

Reporting Events

+

Function

An API for reporting custom events is provided, which helps you collect and report abnormal events or important change events to Cloud Eye.

+
+

URI

POST /V1.0/{project_id}/events

+ +
+

Request

+ +
+

Response

+ +
+

Returned Values

+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Event Monitoring
+
+
+ diff --git a/docs/ces/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/ces/api-ref/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 000000000..60f607621 Binary files /dev/null and b/docs/ces/api-ref/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/ces/api-ref/public_sys-resources/commonltr.css b/docs/ces/api-ref/public_sys-resources/commonltr.css new file mode 100644 index 000000000..c5480b0ab --- /dev/null +++ b/docs/ces/api-ref/public_sys-resources/commonltr.css @@ -0,0 +1 @@ +body{font-size:10pt;font-family:Arial;margin:1.5em;border-top:2pt;padding-top:1em;padding-bottom:2em}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:.6em;margin-bottom:.6em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.figcap{font-size:10pt}img{margin-top:.3em}.figdesc{font-style:normal}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.fignone{font-size:10pt;margin-top:8pt;margin-bottom:8pt}.familylinks{margin-top:1.5em;margin-bottom:1em}.ullinks{list-style-type:none}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-top:.6em;margin-bottom:.6em}.reltasks{margin-top:.6em;margin-bottom:.6em}.relref{margin-top:.6em;margin-bottom:.6em}.relinfo{margin-top:.6em;margin-bottom:.6em}.breadcrumb{font-size:smaller;margin-bottom:.6em}.prereq{margin-left:20px}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.topictitle1{margin-top:0;margin-bottom:1em;font-size:14pt;color:#007af4}.topictitle2{margin-top:1pc;margin-bottom:.45em;font-size:1.17em;color:#007af4}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-size:1.17em;font-weight:bold;color:#007af4}.topictitle4{margin-top:.83em;font-size:1.17em;font-weight:bold}.topictitle5{font-size:1.17em;font-weight:bold}.topictitle6{font-size:1.17em;font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:1em;color:black;font-size:10.5pt;font-weight:bold;color:#007af4;overflow:auto}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}.sectiontitle2contents:link{color:#007af4}.sectiontitle2contents:visited{color:#800080}.note{margin-top:1em;margin-bottom:1em;background-color:#ffc}.notetitle{font-weight:bold}.notelisttitle{font-weight:bold}.tip{margin-top:1em;margin-bottom:1em;background-color:#ffc}.tiptitle{font-weight:bold}.fastpath{margin-top:1em;margin-bottom:1em;background-color:#ffc}.fastpathtitle{font-weight:bold}.important{margin-top:1em;margin-bottom:1em;background-color:#ffc}.importanttitle{font-weight:bold}.remember{margin-top:1em;margin-bottom:1em;background-color:#ffc}.remembertitle{font-weight:bold}.restriction{margin-top:1em;margin-bottom:1em;background-color:#ffc}.restrictiontitle{font-weight:bold}.attention{margin-top:1em;margin-bottom:1em;background-color:#ffc}.attentiontitle{font-weight:bold}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;background-color:#ffc}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;background-color:#ffc}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;background-color:#ffc}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;background-color:#ffc}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}ol{margin-top:1em;margin-bottom:1em;margin-left:2.4em;padding-left:0}ul{margin-top:1em;margin-bottom:1em;margin-left:2.0em;padding-left:0}ol ul{list-style:disc}ul ul{list-style:square}ol ul ul{list-style:square}ol ul{list-style-type:disc}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}.firstcol{font-weight:bold}th{background-color:#cfcfcf}table{margin-top:8pt;margin-bottom:12pt;width:100%}table caption{margin-top:8pt;text-align:left}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:.3em;margin-bottom:.3em}.substepexpand{margin-top:.3em;margin-bottom:.3em}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}.hrcopyright{color:#3f4e5d;margin-top:18pt}.hwcopyright{text-align:center}.comment{margin:2px 2px 2px 2px;font-family:Arial;font-size:10pt;background-color:#bfb;color:#000}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowncontext{display:none}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdowncollapsetable{border:0}.dropdowncollapsetable .dropdowncontext{display:none}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}pre{font-size:10pt;font-weight:normal;margin-left:9;margin-top:2;margin-bottom:2}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0} \ No newline at end of file diff --git a/docs/ces/api-ref/public_sys-resources/commonltr_print.css b/docs/ces/api-ref/public_sys-resources/commonltr_print.css new file mode 100644 index 000000000..a59823141 --- /dev/null +++ b/docs/ces/api-ref/public_sys-resources/commonltr_print.css @@ -0,0 +1 @@ +body{font-size:12.0pt;margin:1.5em;margin-left:1.6cm}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:1em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.covertable{border:0;width:100% cellpadding:8pt;cellspacing:8pt}.cover_productname{font-size:15.0pt;font-family:"Arial"}.cover_manualtitle{font-size:24.0pt;font-weight:bold;font-family:"Arial"}.cover_manualsubtitle{font-size:18.0pt;font-weight:bold;font-family:"Arial"}.cover_heading{font-size:12.0pt;font-weight:bold;font-family:"Arial"}.cover_text{font-size:9.0pt;font-family:"Arial"}.tocheading,.heading1,.topictitle1{margin-top:40.0pt;margin-right:0;margin-bottom:20.0pt;margin-left:-1cm;text-align:left;border:0;border-bottom:solid windowtext .5pt;font-size:22.0pt;font-family:"Arial";font-weight:bold}.topictitlenumber1{font-size:72.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle2{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Arial";font-weight:bold}.topictitle3{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:16.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle4{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:14.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle5{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.blocklabel,.topictitle6{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.sectiontitle{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:-1cm;text-indent:0;font-size:13.0pt;font-family:"Arial";font-weight:bold}.tocentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Book Antiqua";font-weight:bold}.tocentry2{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry3{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry4{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry5{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tofentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.totentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.indexheading{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.indexentry1{margin-top:4pt;margin-right:0;margin-bottom:0;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Times New Roman"}.indexentry2{margin-top:0;margin-right:0;margin-bottom:0;margin-left:24.0pt;line-height:12.0pt;font-size:12.0pt}.indexentry3{margin-top:0;margin-right:0;margin-bottom:0;margin-left:48pt;line-height:12.0pt;font-size:12.0pt}.figurenumber{font-weight:bold}.tablenumber{font-weight:bold}.familylinks{margin-top:1.5em;margin-bottom:1em}.figcap{font-size:11.0pt}.tablecap{font-size:11.0pt}.figdesc{font-style:normal}.fignone{margin-top:8.0pt}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.ullinks{margin-left:0;list-style-type:none}.ulchildlink{margin-top:1em;margin-bottom:1em}.olchildlink{margin-top:1em;margin-bottom:1em;margin-left:1em}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-left:1cm;margin-top:1em;margin-bottom:1em}.reltasks{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relref{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relinfo{margin-top:1em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-left:0}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}table .note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.notetitle{font-weight:bold;font-size:11.0pt}.notelisttitle{font-weight:bold}table .tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.tiptitle{font-weight:bold;font-size:11.0pt}table .fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.fastpathtitle{font-weight:bold;font-size:11.0pt}table .important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.importanttitle{font-weight:bold;font-size:11.0pt}table .remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.remembertitle{font-weight:bold;font-size:11.0pt}table .restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.restrictiontitle{font-weight:bold;font-size:11.0pt}table .attention{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.attention{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}.attentiontitle{font-weight:bold}table .danger{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .notice{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .warning{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .caution{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}table caption{margin-top:8pt;text-align:left;font-weight:bold}.tablenoborder{margin-top:8pt}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}.firstcol{font-weight:bold}th{background-color:#cfcfcf}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:1em;margin-bottom:1em}.substepexpand{margin-top:1em;margin-bottom:1em}table{margin-top:8pt;margin-bottom:10.0pt;width:100%}thead{font-size:10.0pt;font-family:"Book Antiqua";font-weight:bold}tbody{font-size:11.0pt}ol{margin-top:1em;margin-bottom:1em;margin-left:1.7em;-webkit-padding-start:0}ul{margin-top:1em;margin-bottom:1em;margin-left:1.2em;-webkit-padding-start:0}ol ul{list-style:disc}ul ul{list-style:square}ol ol{list-style-type:lower-alpha}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre{font-size:10.0pt;border-width:2px;padding:2px;margin-top:5px;margin-bottom:5px;white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.prefacesectiontitle1{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Book Antiqua";font-weight:bold;overflow:auto}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}.hrcopyright{color:#3f4e5d;margin-top:18pt;margin-left:-1cm}.hwcopyright{text-align:center;font-family:Arial;margin-left:-1cm} \ No newline at end of file diff --git a/docs/ces/api-ref/public_sys-resources/commonrtl.css b/docs/ces/api-ref/public_sys-resources/commonrtl.css new file mode 100644 index 000000000..f261da752 --- /dev/null +++ b/docs/ces/api-ref/public_sys-resources/commonrtl.css @@ -0,0 +1,2 @@ +/*! Copyright (c) Huawei Technologies Co., Ltd. 2020-2022. All rights reserved. */.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式 +*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre} \ No newline at end of file diff --git a/docs/ces/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/ces/api-ref/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 000000000..47a9c7235 Binary files /dev/null and b/docs/ces/api-ref/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/ces/api-ref/public_sys-resources/delta.gif b/docs/ces/api-ref/public_sys-resources/delta.gif new file mode 100644 index 000000000..0d1b1f674 Binary files /dev/null and b/docs/ces/api-ref/public_sys-resources/delta.gif differ diff --git a/docs/ces/api-ref/public_sys-resources/deltaend.gif b/docs/ces/api-ref/public_sys-resources/deltaend.gif new file mode 100644 index 000000000..cc7da0fc8 Binary files /dev/null and b/docs/ces/api-ref/public_sys-resources/deltaend.gif differ diff --git a/docs/ces/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/ces/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 000000000..84eec9be2 Binary files /dev/null and b/docs/ces/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/ces/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/ces/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 000000000..39583d168 Binary files /dev/null and b/docs/ces/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/ces/api-ref/public_sys-resources/icon-caution.gif b/docs/ces/api-ref/public_sys-resources/icon-caution.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/ces/api-ref/public_sys-resources/icon-caution.gif differ diff --git a/docs/ces/api-ref/public_sys-resources/icon-danger.gif b/docs/ces/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/ces/api-ref/public_sys-resources/icon-danger.gif differ diff --git a/docs/ces/api-ref/public_sys-resources/icon-huawei.gif b/docs/ces/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 000000000..a31d60f89 Binary files /dev/null and b/docs/ces/api-ref/public_sys-resources/icon-huawei.gif differ diff --git a/docs/ces/api-ref/public_sys-resources/icon-note.gif b/docs/ces/api-ref/public_sys-resources/icon-note.gif new file mode 100644 index 000000000..31be2b039 Binary files /dev/null and b/docs/ces/api-ref/public_sys-resources/icon-note.gif differ diff --git a/docs/ces/api-ref/public_sys-resources/icon-notice.gif b/docs/ces/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 000000000..409070650 Binary files /dev/null and b/docs/ces/api-ref/public_sys-resources/icon-notice.gif differ diff --git a/docs/ces/api-ref/public_sys-resources/icon-tip.gif b/docs/ces/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 000000000..c47bae05c Binary files /dev/null and b/docs/ces/api-ref/public_sys-resources/icon-tip.gif differ diff --git a/docs/ces/api-ref/public_sys-resources/icon-warning.gif b/docs/ces/api-ref/public_sys-resources/icon-warning.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/ces/api-ref/public_sys-resources/icon-warning.gif differ diff --git a/docs/ces/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/ces/api-ref/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 000000000..57a0e1f53 Binary files /dev/null and b/docs/ces/api-ref/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/ces/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/ces/api-ref/public_sys-resources/notice_3.0-en-us.png new file mode 100644 index 000000000..fa4b64990 Binary files /dev/null and b/docs/ces/api-ref/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/ces/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/ces/api-ref/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 000000000..def5c3565 Binary files /dev/null and b/docs/ces/api-ref/public_sys-resources/warning_3.0-en-us.png differ