Zookeeper
|
500
diff --git a/docs/ces/api-ref/ces_01_0054.html b/docs/ces/api-ref/ces_01_0054.html
index f6d1e3c2..e529ca3e 100644
--- a/docs/ces/api-ref/ces_01_0054.html
+++ b/docs/ces/api-ref/ces_01_0054.html
@@ -4,7 +4,7 @@
 Events in Event Monitoring come from operations on cloud service resources and are not collected by the Agent in Server Monitoring.
- Table 1 ECSEvent Source
+Table 1 Elastic Cloud Server (ECS)Event Source
|
Event Name
|
@@ -65,7 +65,7 @@
Services are interrupted.
|
|---|
-Start auto recovery
+ | Restart triggered due to hardware fault
|
startAutoRecovery
|
@@ -78,7 +78,7 @@
Services may be interrupted.
|
-Stop auto recovery
+ | Restart completed due to hardware failure
|
endAutoRecovery
|
@@ -86,7 +86,7 @@
The ECS was restored to be normal after the automatic migration.
|
-This event indicates that the ECS has been recovered and been working properly.
+ | This event indicates that the ECS has recovered and been working properly.
|
None
|
@@ -179,7 +179,7 @@
-AAD
+ | AAD
|
DDoS Attack Events
|
@@ -194,11 +194,50 @@
Services may be interrupted.
|
+Domain name scheduling event
+ |
+domainNameDispatchEvents
+ |
+Major
+ |
+The high-defense CNAME corresponding to the domain name is scheduled, and the domain name is resolved to another high-defense IP address.
+ |
+Pay attention to the workloads involving the domain name.
+ |
+Services are not affected.
+ |
+
+Blackhole event
+ |
+blackHoleEvents
+ |
+Major
+ |
+The attack traffic exceeds the purchased AAD protection threshold.
+ |
+A blackhole is canceled after 30 minutes by default. The actual blackhole duration is related to the blackhole triggering times and peak attack traffic on the current day. The maximum duration is 24 hours. If you need to permit access before a blackhole becomes ineffective, contact technical support.
+ |
+Services may be interrupted.
+ |
+
+Cancel Blackhole
+ |
+cancelBlackHole
+ |
+Informational
+ |
+The customer's AAD instance recovers from the black hole state.
+ |
+This is only a prompt and no action is required.
+ |
+Customer services recover.
+ |
+
Table 3 CBREvent Source
+Table 3 Cloud Backup and Recovery (CBR)Event Source
|
Event Name
|
@@ -208,7 +247,7 @@
Description
|
-Solution
+ | Solution
|
Impact
|
@@ -350,7 +389,7 @@
|---|
Table 4 RDS — resource exceptionEvent Source
+Table 4 Relational Database Service (RDS) — resource exceptionEvent Source
|
Event Name
|
@@ -400,9 +439,9 @@
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.
+ | The possible causes are as follows:
+The replication delay between the primary instance and the standby instance or a read replica is too long, which usually occurs when a large amount of data is being written to databases or a large transaction is being processed. During peak hours, data may be blocked.
+The network between the primary instance and the standby instance or a read replica is disconnected.
|
Submit a service ticket.
|
@@ -471,7 +510,7 @@
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.
+ | When the process exits abnormally, workloads are interrupted. In this case, RDS automatically restarts the database process and attempts to recover the workloads.
|
|---|
Instance storage full
@@ -790,7 +829,7 @@
|
The database supports only query operations.
|
-Contact the database technical support team.
+ | Submit a service ticket.
|
After the database becomes read-only, write operations cannot be processed.
|
@@ -803,7 +842,7 @@
The database supports both write and read operations.
|
-None.
+ | Submit a service ticket.
|
None.
|
@@ -812,7 +851,7 @@
Table 6 GaussDB(for openGauss)Event Source
+Table 6 GaussDBEvent Source
|
Event Name
|
@@ -822,13 +861,13 @@
Description
|
-Solution
+ | Solution
|
Impact
|
|---|
-GaussDB(for openGauss)
+ | GaussDB
|
Process status alarm
|
@@ -836,7 +875,7 @@
Major
|
-Key processes exit, including: CMS/CMA, ETCD, GTM, CN, or DN process.
+ | Key processes exit, including CMS/CMA, ETCD, GTM, CN, and DN processes.
|
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.
|
@@ -849,7 +888,7 @@
Major
|
-Key components do not respond, including: CMA, ETCD, GTM, CN, or DN component.
+ | Key components do not respond, including CMA, ETCD, GTM, CN, and DN components.
|
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.
|
@@ -929,7 +968,7 @@
Major
|
-GaussDB(for openGauss) provides an HA tool for automated or manual rectification of faults. After the fault is rectified, this event is reported.
+ | GaussDB(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.
|
@@ -955,7 +994,7 @@
Major
|
-GaussDB(for openGauss) provides an HA tool for automated or manual rectification of faults. After the fault is rectified, this event is reported.
+ | GaussDB(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.
|
diff --git a/docs/ces/api-ref/ces_03_0018.html b/docs/ces/api-ref/ces_03_0018.html
index cdc28b7c..732baa08 100644
--- a/docs/ces/api-ref/ces_03_0018.html
+++ b/docs/ces/api-ref/ces_03_0018.html
@@ -7,13 +7,13 @@
- API Version Management
-- Metric Management
+ - Metrics
-- Alarm Rule Management
+ - Alarm Rules
-- Monitoring Data Management
+ - Monitoring Data
-- Quota Management
+ - Quotas
- Event Monitoring
diff --git a/docs/ces/api-ref/ces_03_0022.html b/docs/ces/api-ref/ces_03_0022.html
index 06c24133..1d1b8551 100644
--- a/docs/ces/api-ref/ces_03_0022.html
+++ b/docs/ces/api-ref/ces_03_0022.html
@@ -1,6 +1,6 @@
-Metric Management
+Metrics
diff --git a/docs/ces/api-ref/ces_03_0023.html b/docs/ces/api-ref/ces_03_0023.html
index 62e7552b..a08d2fb3 100644
--- a/docs/ces/api-ref/ces_03_0023.html
+++ b/docs/ces/api-ref/ces_03_0023.html
@@ -1,7 +1,7 @@
Querying Metrics
- FunctionThis 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.
+ FunctionThis API is used to query metrics supported by Cloud Eye. You can specify the namespace, metric, dimension, sorting order, start records, and the maximum number of records when using this API to query metrics.
URIGET /V1.0/{project_id}/metrics
- Parameter description
@@ -315,7 +315,7 @@
diff --git a/docs/ces/api-ref/ces_03_0026.html b/docs/ces/api-ref/ces_03_0026.html
index 58353e18..72b59dda 100644
--- a/docs/ces/api-ref/ces_03_0026.html
+++ b/docs/ces/api-ref/ces_03_0026.html
@@ -1,13 +1,13 @@
- Alarm Rule Management
+ Alarm Rules
- Querying Alarm Rules
-- Querying an Alarm Rule
+ - Querying Details of an Alarm Rule
- Enabling or Disabling an Alarm Rule
diff --git a/docs/ces/api-ref/ces_03_0027.html b/docs/ces/api-ref/ces_03_0027.html
index 204998e2..b72cc101 100644
--- a/docs/ces/api-ref/ces_03_0027.html
+++ b/docs/ces/api-ref/ces_03_0027.html
@@ -1,7 +1,7 @@
Querying Alarm Rules
-FunctionThis 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.
+ FunctionThis API is used to query alarm rules. 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.
URIGET /V1.0/{project_id}/alarms
- Parameter description
@@ -214,7 +214,7 @@
update_time
|
-long
+ | Long
|
Specifies when the alarm status changed. The time is a UNIX timestamp and the unit is ms.
|
@@ -243,7 +243,7 @@
String
|
-Query the namespace of a service. For details, see Services Interconnected with Cloud Eye.
+ | Specifies the namespace of a service. For details, see Services Interconnected with Cloud Eye.
|
dimensions
@@ -369,7 +369,7 @@
|
String
|
-Specifies the data rollup method. The following methods are supported:
+ | Specifies the data rollup method, which can be
- average: Cloud Eye calculates the average value of metric data within a rollup period.
- max: Cloud Eye calculates the maximum value of metric data within a rollup period.
- min: Cloud Eye calculates the minimum value of metric data within a rollup period.
- sum: Cloud Eye calculates the sum of metric data within a rollup period.
- variance: Cloud Eye calculates the variance value of metric data within a rollup period.
|
@@ -377,7 +377,7 @@
String
|
-Specifies the alarm threshold operator, which can be >, =, <, ≥, or ≤.
+ | Specifies the alarm threshold operator, which can be >, =, <, >=, or <=.
|
value
@@ -402,6 +402,24 @@
| Specifies the number of consecutive occurrence times that the alarm policy was met. Supported range: 1 to 5
|
+suppress_duration
+ |
+Integer
+ |
+Specifies the interval for triggering an alarm if the alarm persists.
+Possible intervals are as follows:
+0: Cloud Eye triggers the alarm only once.
+300: Cloud Eye triggers the alarm every 5 minutes.
+600: Cloud Eye triggers the alarm every 10 minutes.
+900: Cloud Eye triggers the alarm every 15 minutes.
+1800: Cloud Eye triggers the alarm every 30 minutes.
+3600: Cloud Eye triggers the alarm every hour.
+10800: Cloud Eye triggers the alarm every 3 hours.
+21600: Cloud Eye triggers the alarm every 6 hours.
+43200: Cloud Eye triggers the alarm every 12 hours.
+86400: Cloud Eye triggers the alarm every day.
+ |
+
|
|---|
403 Forbidden
|
-You are forbidden to access the page requested.
+ | Access to the requested page is forbidden.
|
408 Request Timeout
@@ -575,7 +594,7 @@
diff --git a/docs/ces/api-ref/ces_03_0028.html b/docs/ces/api-ref/ces_03_0028.html
index ab00e551..0e6cb9c8 100644
--- a/docs/ces/api-ref/ces_03_0028.html
+++ b/docs/ces/api-ref/ces_03_0028.html
@@ -1,7 +1,7 @@
-Querying an Alarm Rule
-FunctionThis API is used to query an alarm rule based on the alarm rule ID.
+ Querying Details of an Alarm Rule
+ FunctionThis API is used to query details of an alarm rule based on its ID.
URIGET /V1.0/{project_id}/alarms/{alarm_id}
- Parameter description
@@ -142,7 +142,7 @@
|
update_time
|
-long
+ | Long
|
Specifies when the alarm status changed. The time is a UNIX timestamp and the unit is ms.
|
@@ -171,7 +171,7 @@
String
|
-Query the namespace of a service. For details, see Services Interconnected with Cloud Eye.
+ | Specifies the namespace of a service. For details, see Services Interconnected with Cloud Eye.
|
dimensions
@@ -297,7 +297,7 @@
|
String
|
-Specifies the data rollup method. The following methods are supported:
+ | Specifies the data rollup method, which can be
- average: Cloud Eye calculates the average value of metric data within a rollup period.
- max: Cloud Eye calculates the maximum value of metric data within a rollup period.
- min: Cloud Eye calculates the minimum value of metric data within a rollup period.
- sum: Cloud Eye calculates the sum of metric data within a rollup period.
- variance: Cloud Eye calculates the variance value of metric data within a rollup period.
|
@@ -305,7 +305,7 @@
String
|
-Specifies the alarm threshold operator, which can be >, =, <, ≥, or ≤.
+ | Specifies the alarm threshold operator, which can be >, =, <, >=, or <=.
|
value
@@ -330,6 +330,24 @@
| Specifies the number of consecutive occurrence times that the alarm policy was met. Supported range: 1 to 5
|
+suppress_duration
+ |
+Integer
+ |
+Specifies the interval for triggering an alarm if the alarm persists.
+Possible intervals are as follows:
+0: Cloud Eye triggers the alarm only once.
+300: Cloud Eye triggers the alarm every 5 minutes.
+600: Cloud Eye triggers the alarm every 10 minutes.
+900: Cloud Eye triggers the alarm every 15 minutes.
+1800: Cloud Eye triggers the alarm every 30 minutes.
+3600: Cloud Eye triggers the alarm every hour.
+10800: Cloud Eye triggers the alarm every 3 hours.
+21600: Cloud Eye triggers the alarm every 6 hours.
+43200: Cloud Eye triggers the alarm every 12 hours.
+86400: Cloud Eye triggers the alarm every day.
+ |
+
|
|---|
403 Forbidden
|
-You are forbidden to access the page requested.
+ | Access to the requested page is forbidden.
|
408 Request Timeout
@@ -438,7 +457,7 @@
diff --git a/docs/ces/api-ref/ces_03_0029.html b/docs/ces/api-ref/ces_03_0029.html
index 4449a319..8afd0100 100644
--- a/docs/ces/api-ref/ces_03_0029.html
+++ b/docs/ces/api-ref/ces_03_0029.html
@@ -120,7 +120,7 @@
diff --git a/docs/ces/api-ref/ces_03_0030.html b/docs/ces/api-ref/ces_03_0030.html
index f1e0cce7..6496dff5 100644
--- a/docs/ces/api-ref/ces_03_0030.html
+++ b/docs/ces/api-ref/ces_03_0030.html
@@ -92,7 +92,7 @@
diff --git a/docs/ces/api-ref/ces_03_0031.html b/docs/ces/api-ref/ces_03_0031.html
index a481177a..2660fd8e 100644
--- a/docs/ces/api-ref/ces_03_0031.html
+++ b/docs/ces/api-ref/ces_03_0031.html
@@ -123,7 +123,7 @@
|
No
|
-Arrays of objects
+ | Array of objects
|
Specifies the action to be triggered by an alarm.
An example structure is as follows:
@@ -137,7 +137,7 @@
|
No
|
-Arrays of objects
+ | Array of objects
|
Specifies the action to be triggered after the alarm is cleared.
Its structure is:
@@ -173,7 +173,7 @@
|
No
|
-Arrays of objects
+ | Array of objects
|
Specifies the metric dimension list. When resource_group_id is not used, dimensions is mandatory.
For details, see Table 4.
@@ -263,9 +263,9 @@
|
Yes
|
-Arrays of strings
+ | Array of strings
|
-Specifies the list of objects to be notified if the alarm status changes. You can configure up to 5 object IDs. You can obtain the topicUrn value from SMN in the following format: urn:smn:([a-z]|[A-Z]|[0-9]|\-){1,32}:([a-z]|[A-Z]|[0-9]){32}:([a-z]|[A-Z]|[0-9]|\-|\_){1,256}.
+ | Specifies the list of objects to be notified if the alarm status changes. You can add up to 5 object IDs. You can obtain the topicUrn value from SMN in the following format: urn:smn:([a-z]|[A-Z]|[0-9]|\-){1,32}:([a-z]|[A-Z]|[0-9]){32}:([a-z]|[A-Z]|[0-9]|\-|\_){1,256}.
If you set type to notification, you must specify notificationList. If you set type to autoscaling, you must set notificationList to [].
NOTE: - To make the AS alarm rules take effect, you must bind scaling policies. For details, see the Auto Scaling API Reference.
- If you set alarm_action_enabled to true, you must specify either alarm_actions or ok_actions. (You do not need to configure the deprecated parameter insufficientdata_actions.)
- If alarm_actions and ok_actions coexist, their notificationList must be the same. (You do not need to configure the deprecated parameter insufficientdata_actions.)
- The IDs in the list are strings.
@@ -299,9 +299,9 @@
|
Yes
|
-Arrays of objects
+ | Array of objects
|
-Specifies the list of objects to be notified if the alarm status changes. You can configure up to 5 object IDs. You can obtain the topicUrn value from SMN in the following format: urn:smn:([a-z]|[A-Z]|[0-9]|\-){1,32}:([a-z]|[A-Z]|[0-9]){32}:([a-z]|[A-Z]|[0-9]|\-|\_){1,256}.
+ | Specifies the list of objects to be notified if the alarm status changes. You can add up to 5 object IDs. You can obtain the topicUrn value from SMN in the following format: urn:smn:([a-z]|[A-Z]|[0-9]|\-){1,32}:([a-z]|[A-Z]|[0-9]){32}:([a-z]|[A-Z]|[0-9]|\-|\_){1,256}.
NOTE: If you set alarm_action_enabled to true, you must specify either alarm_actions or ok_actions. (You do not need to configure the deprecated parameter insufficientdata_actions.)
If alarm_actions and ok_actions coexist, their notificationList must be the same. (You do not need to configure the deprecated parameter insufficientdata_actions.)
@@ -349,7 +349,7 @@
|
String
|
-Specifies the operator of alarm thresholds.
+ | Specifies the alarm threshold operator.
Possible operators are >, =, <, >=, and <=.
|
@@ -382,11 +382,31 @@
Specifies the number of consecutive occurrence times that the alarm policy was met. Supported range: 1 to 5
|
+suppress_duration
+ |
+No
+ |
+Integer
+ |
+Specifies the interval for triggering an alarm if the alarm persists.
+Possible intervals are as follows:
+0: Cloud Eye triggers the alarm only once.
+300: Cloud Eye triggers the alarm every 5 minutes.
+600: Cloud Eye triggers the alarm every 10 minutes.
+900: Cloud Eye triggers the alarm every 15 minutes.
+1800: Cloud Eye triggers the alarm every 30 minutes.
+3600: Cloud Eye triggers the alarm every hour.
+10800: Cloud Eye triggers the alarm every 3 hours.
+21600: Cloud Eye triggers the alarm every 6 hours.
+43200: Cloud Eye triggers the alarm every 12 hours.
+86400: Cloud Eye triggers the alarm every day.
+ |
+
- Example request
{
+- Example request 1
Creating an alarm rule to monitor a metric {
"alarm_name": "alarm-rp0E",
"alarm_description": "",
"metric": {
@@ -423,6 +443,45 @@
}
]
}
+ - Example request 2
Creating an alarm rule to monitor an event
+{
+ "alarm_name": "alarm-test",
+ "metric": {
+ "namespace": "SYS.ECS",
+ "metric_name": "instance_resize_scheduled",
+ "dimensions": [
+ {
+ "name": "instance_id",
+ "value": "d53692e5-828b-495b-a5e2-a1b227f6034c"
+ }
+ ]
+ },
+ "condition": {
+ "comparison_operator": ">=",
+ "count": 1,
+ "filter": "average",
+ "period": 0,
+ "unit": "count",
+ "value": 1
+ },
+ "alarm_enabled": true,
+ "alarm_action_enabled": true,
+ "alarm_level": 2,
+ "alarm_type": "EVENT.SYS",
+ "alarm_actions": [
+ {
+ "type": "notification",
+ "notificationList": ["urn:smn:region:ce8476c174f94c6991ea7885e3380d99:sd"]
+ }
+ ],
+ "ok_actions": [
+ {
+ "type": "notification",
+ "notificationList": ["urn:smn:region:ce8476c174f94c6991ea7885e3380d99:sd"]
+ }
+ ]
+}
Response- Response parameters
@@ -503,7 +562,7 @@
Monitoring Data Management
+Monitoring Data
-- Querying Monitoring Data
+ - Querying Monitoring Data of a Metric
- Adding Monitoring Data
-- Querying Monitoring Data in Batches
+ - Querying Monitoring Data of Multiple Metrics
- Querying the Host Configuration
diff --git a/docs/ces/api-ref/ces_03_0033.html b/docs/ces/api-ref/ces_03_0033.html
index 91cf17f8..83c76b2e 100644
--- a/docs/ces/api-ref/ces_03_0033.html
+++ b/docs/ces/api-ref/ces_03_0033.html
@@ -1,7 +1,7 @@
-Querying Monitoring Data
-FunctionThis 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.
+ Querying Monitoring Data of a Metric
+ FunctionThis API is used to query the monitoring data of a specified metric at a specified granularity in a specified time range. You can specify the dimension of data to be queried.
URIGET /V1.0/{project_id}/metric-data?namespace={namespace}&metric_name={metric_name}&dim.{i}=key,value&from={from}&to={to}&period={period}&filter={filter}
- Parameter description
@@ -61,8 +61,8 @@
String
|
Specifies the start time of the query. The time is a UNIX timestamp and the unit is ms.
-Rollup aggregates the raw data generated within a period to the start time of the period. Therefore, if from and to are within a period, the query result will be empty due to the rollup failure. Set from to at least one period earlier than the current time.
-Take the 5-minute period as an example. If it is 10:35 now, the raw data generated between 10:30 and 10:35 will be aggregated to 10:30. Therefore, in this example, if period is 5 minutes, from should be 10:30.
+Rollup aggregates the raw data generated within a period to the start time of the period. If from and to are within a period, the query result will be empty due to the rollup failure. Set from to at least one period earlier than the current time.
+Take the 5-minute period as an example. If it is 10:35 now, the raw data generated between 10:30 and 10:35 will be aggregated to 10:30. In this example, if period is 5 minutes, from should be 10:30.
NOTE: Cloud Eye rounds up from based on the level of granularity required to perform the rollup.
|
@@ -85,7 +85,7 @@
Integer
|
Specifies how often Cloud Eye aggregates data, which can be
-- 1: Cloud Eye performs no aggregation and displays raw data.
+- 1: Cloud Eye displays raw data.
- 300: Cloud Eye aggregates data every 5 minutes.
- 1200: Cloud Eye aggregates data every 20 minutes.
- 3600: Cloud Eye aggregates data every 1 hour.
- 14400: Cloud Eye aggregates data every 4 hours.
- 86400: Cloud Eye aggregates data every 24 hours.
|
|
|---|
@@ -107,7 +107,7 @@
String
|
-A maximum of three metric dimensions are supported, and the dimensions are numbered from 0 in the dim.{i}=key,value format. key cannot exceed 32 characters and value cannot exceed 256 characters.
+ | A maximum of three metric dimensions are supported, and the dimensions are numbered from zero in the dim.{i}=key,value format. key cannot exceed 32 characters and value cannot exceed 256 characters.
The following dimensions are only examples. For details about whether multiple dimensions are supported, see the dimension description in the monitoring indicator description of each service.
Single dimension: dim.0=instance_id,i-12345
Multiple dimensions: dim.0=instance_id,i-12345&dim.1=instance_name,i-1234
@@ -155,52 +155,52 @@
|
Table 4 datapoints data structure descriptionParameter
+Table 4 datapoints data structure descriptionParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
average
|
-double
+ | Double
|
Specifies the average value of metric data within a rollup period.
|
max
|
-double
+ | Double
|
Specifies the maximum value of metric data within a rollup period.
|
min
|
-double
+ | Double
|
Specifies the minimum value of metric data within a rollup period.
|
sum
|
-double
+ | Double
|
Specifies the sum of metric data within a rollup period.
|
variance
|
-double
+ | Double
|
Specifies the variance of metric data within a rollup period.
|
timestamp
|
-long
+ | Long
|
Specifies when the metric is collected. It is a UNIX timestamp in milliseconds.
|
@@ -303,7 +303,7 @@
diff --git a/docs/ces/api-ref/ces_03_0034.html b/docs/ces/api-ref/ces_03_0034.html
index e0958ff5..31bdd961 100644
--- a/docs/ces/api-ref/ces_03_0034.html
+++ b/docs/ces/api-ref/ces_03_0034.html
@@ -1,7 +1,7 @@
-Querying Monitoring Data in Batches
-FunctionYou 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.
+ Querying Monitoring Data of Multiple Metrics
+ FunctionYou can query the monitoring data of specified metrics within a specified time range and at a specified granularity. You can query the monitoring data of up to 10 metrics in one batch.
URIPOST /V1.0/{project_id}/batch-query-metric-data
- Parameter description
@@ -27,11 +27,11 @@
Request - The size of a POST request cannot exceed 512 KB. Otherwise, the request will be denied.
- 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.
+If period is 300, the maximum interval between from and to is one 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 three days. If the interval between from and to is longer than three days, adjust the value of from to to - 3*24*3600*1000.
+If period is 3600, the maximum interval between from and to is 10 days. If the interval between from and to is longer than 10 days, adjust the value of from to to - 10*24*3600*1000.
+If period is 14400, the maximum interval between from and to is 30 days. If the interval between from and to is longer than 30 days, adjust the value of from to to - 30*24*3600*1000.
+If period is 86400, the maximum interval between from and to is 180 days. If the interval between from and to is longer than 180 days, adjust the value of from to to - 180*24*3600*1000.
- Request parameters
@@ -49,7 +49,7 @@
Yes
|
-Arrays of objects
+ | Array of objects
|
Specifies the metric data. The maximum length of the array is 10.
For details, see Table 3.
@@ -59,9 +59,9 @@
|
Yes
|
-long
+ | Long
|
-Specifies the start time of the query. The time is a UNIX timestamp and the unit is ms. Set from to at least one period earlier than the current time. Rollup aggregates the raw data generated within a period to the start time of the period. Therefore, if from and to are within a period, the query result will be empty due to the rollup failure. Set from to at least one period earlier than the current time. Take the 5-minute period as an example. If it is 10:35 now, the raw data generated between 10:30 and 10:35 will be aggregated to 10:30. Therefore, in this example, if period is 5 minutes, from should be 10:30.
+ | Specifies the start time of the query. The time is a UNIX timestamp and the unit is ms. Set from to at least one period earlier than the current time. Rollup aggregates the raw data generated within a period to the start time of the period. If from and to are within a period, the query result will be empty due to the rollup failure. Set from to at least one period earlier than the current time. Take the 5-minute period as an example. If it is 10:35 now, the raw data generated between 10:30 and 10:35 will be aggregated to 10:30. In this example, if period is 5 minutes, from should be 10:30.
NOTE: Cloud Eye rounds up from based on the level of granularity required to perform the rollup.
|
@@ -70,7 +70,7 @@
Yes
|
-long
+ | Long
|
Specifies the end time of the query. The time is a UNIX timestamp and the unit is ms. from must be earlier than to.
|
@@ -82,7 +82,7 @@
String
|
Specifies how often Cloud Eye aggregates data, which can be
-- 1: Cloud Eye performs no aggregation and displays raw data.
- 300: Cloud Eye aggregates data every 5 minutes.
- 1200: Cloud Eye aggregates data every 20 minutes.
- 3600: Cloud Eye aggregates data every 1 hour.
- 14400: Cloud Eye aggregates data every 4 hours.
- 86400: Cloud Eye aggregates data every 24 hours.
+- 1: Cloud Eye performs no aggregation and displays raw data.
- 300: Cloud Eye aggregates data every 5 minutes.
- 1200: Cloud Eye aggregates data every 20 minutes.
- 3600: Cloud Eye aggregates data every hour.
- 14400: Cloud Eye aggregates data every 4 hours.
- 86400: Cloud Eye aggregates data every 24 hours.
|
filter
@@ -100,13 +100,13 @@
|
Table 3 metrics data structure descriptionParameter
+Table 3 metrics data structure descriptionParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
@@ -124,10 +124,10 @@
Yes
|
-Arrays of objects
+ | Array of objects
|
-Specifies the list of the metric dimensions.
-Each dimension is a JSON object, and its structure is as follows:
+ | Specifies metric dimensions. dimensions is an array consisting of a maximum of four JSON objects.
+One dimension is a JSON object, and its structure is as follows:
{
"name": "instance_id",
"value": "33328f02-3814-422e-b688-bfdba93d4050"
@@ -148,13 +148,13 @@
|
Table 4 dimensions data structure descriptionParameter
+Table 4 dimensions data structure descriptionParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
@@ -271,7 +271,7 @@
Response- Response parameters
Table 5 Response parametersParameter
|
-Type
+ | Type
|
Description
|
@@ -279,7 +279,7 @@
|---|
metrics
|
-Arrays of objects
+ | Array of objects
|
Specifies the metric data.
For details, see Table 6.
@@ -289,11 +289,11 @@
|
Table 6 metrics data structure descriptionParameter
+Table 6 metrics data structure descriptionParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
@@ -306,9 +306,9 @@
datapoints
|
-Arrays of objects
+ | Array of objects
|
-Specifies the metric data list. Since Cloud Eye rounds up from based on the level of granularity for data query, datapoints may contain more data points than expected.
+ | Specifies the metric data list. Cloud Eye rounds up the value of from based on the selected granularity for data query, so datapoints may contain more data points than expected. Up to 3,000 data points can be returned.
For details, see Table 8.
|
@@ -321,7 +321,7 @@
dimensions
|
-Arrays of objects
+ | Array of objects
|
Specifies the list of metric dimensions.
Each dimension is a JSON object, and its structure is as follows:
@@ -343,11 +343,11 @@
|
Table 7 dimensions data structure descriptionParameter
+Table 7 dimensions data structure descriptionParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
@@ -371,52 +371,52 @@
Table 8 datapoints data structure descriptionParameter
+Table 8 datapoints data structure descriptionParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
average
|
-double
+ | Double
|
Specifies the average value of metric data within a rollup period.
|
max
|
-double
+ | Double
|
Specifies the maximum value of metric data within a rollup period.
|
min
|
-double
+ | Double
|
Specifies the minimum value of metric data within a rollup period.
|
sum
|
-double
+ | Double
|
Specifies the sum of metric data within a rollup period.
|
variance
|
-double
+ | Double
|
Specifies the variance of metric data within a rollup period.
|
timestamp
|
-long
+ | Long
|
Specifies when the metric is collected. It is a UNIX timestamp in milliseconds.
|
@@ -519,7 +519,7 @@
]
}
-Response example 3: The minimum proc_specified_count of the server whose instance_id is cd841102-f6b1-407d-a31f-235db796dcbb and proc is b28354b543375bfa94dabaeda722927f is displayed. {
+Response example 3: The minimum rds021_myisam_buf_usage of the server whose instance_id is cd841102-f6b1-407d-a31f-235db796dcbb and proc is b28354b543375bfa94dabaeda722927f is displayed. {
"metrics": [
{
"unit": "Ratio",
@@ -604,7 +604,7 @@
Querying the Host Configuration
-FunctionThis 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.
+ FunctionThis API is used to query the host configuration for a specified event type in a specified time range. You can specify the dimension of data to be queried.
This API is 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.
@@ -137,7 +137,7 @@
timestamp
|
-long
+ | Long
|
Specifies when the event is reported. It is a UNIX timestamp and the unit is ms.
|
@@ -221,7 +221,7 @@
diff --git a/docs/ces/api-ref/ces_03_0036.html b/docs/ces/api-ref/ces_03_0036.html
index 3c342993..e1c92d3e 100644
--- a/docs/ces/api-ref/ces_03_0036.html
+++ b/docs/ces/api-ref/ces_03_0036.html
@@ -1,6 +1,6 @@
-Quota Management
+Quotas
diff --git a/docs/ces/api-ref/ces_03_0037.html b/docs/ces/api-ref/ces_03_0037.html
index 2c9c4a29..9fb2501b 100644
--- a/docs/ces/api-ref/ces_03_0037.html
+++ b/docs/ces/api-ref/ces_03_0037.html
@@ -1,7 +1,7 @@
Querying Quotas
- FunctionThis API is used to query a resource quota and the used amount. The current resource refers to alarm rules only.
+ FunctionThis API is used to query the alarm rule quota and the number of alarm rules that have been created.
URIGET /V1.0/{project_id}/quotas
- Parameter description
@@ -178,7 +178,7 @@
diff --git a/docs/ces/api-ref/ces_03_0038.html b/docs/ces/api-ref/ces_03_0038.html
index 051e98d3..1af9a7a9 100644
--- a/docs/ces/api-ref/ces_03_0038.html
+++ b/docs/ces/api-ref/ces_03_0038.html
@@ -9,7 +9,7 @@
- Querying Events
- - Querying Monitoring Details of an Event
+ - Querying Details of an Event
diff --git a/docs/ces/api-ref/ces_03_0045.html b/docs/ces/api-ref/ces_03_0045.html
new file mode 100644
index 00000000..c268e8d6
--- /dev/null
+++ b/docs/ces/api-ref/ces_03_0045.html
@@ -0,0 +1,24 @@
+
+
+ Permissions Policies and Supported Actions
+
+
+
diff --git a/docs/ces/api-ref/ces_03_0046.html b/docs/ces/api-ref/ces_03_0046.html
new file mode 100644
index 00000000..634c33b1
--- /dev/null
+++ b/docs/ces/api-ref/ces_03_0046.html
@@ -0,0 +1,28 @@
+
+
+ Introduction
+ This chapter describes fine-grained permissions management for your Cloud Eye. If your account does not need individual IAM users, then you may skip over this chapter.
+ Policies: A type of fine-grained authorization mechanism that defines permissions required to perform operations on specific cloud resources under certain conditions. This mechanism allows for more flexible policy-based authorization, meeting requirements for secure access control. By default, new IAM users do not have any permissions assigned. You need to add a user to one or more groups, and assign permissions policies to these groups. The user then inherits permissions from the groups it is a member of. This process is called authorization. After authorization, the user can perform specified operations on Cloud Eye based on the permissions.
+ You can grant users permissions by using roles and policies. A policy consists of permissions for an entire service. Users with such a policy assigned are granted all of the permissions required for that service. Policies define API-based permissions for operations on specific resources, allowing for more fine-grained, secure access control of cloud resources.
+ If you want to allow or deny the access to an API, use policies for authorization.
+
+ An account has permissions to call all APIs. An IAM user under the account can call specific APIs only after being assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user queries the alarm rule list using an API, the user must have been granted permissions that allow the ces:alarms:list action.
+ Supported ActionsCloud Eye provides system-defined policies that can be directly used in IAM. You can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:
+ - Permissions: Defined by actions in a custom policy.
- Actions: Added to a custom policy to control permissions for specific operations.
- Related actions: Actions on which a specific action depends to take effect. When assigning permissions for the action to a user, you also need to assign permissions for the dependent actions.
- Authorization Scope: A custom policy can be applied to IAM projects or enterprise projects or both. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect for IAM. Such policies will not take effect if they are assigned to user groups in Enterprise Management.
- APIs: REST APIs that can be called in a custom policy
+ Cloud Eye supports the following actions that can be defined in custom policies:
+ √ indicates that the item is supported, and × indicates that the item is not supported.
+
+ Supported Actions of the API Version Management APIs
+ Supported Actions of the Metric Management API
+ Supported Actions of the Alarm Rule Management APIs
+ Supported Actions of the Monitoring Data Management APIs
+ Supported Actions of the Quota Management API
+ Supported Actions of the Event Monitoring API
+
+
+
+
diff --git a/docs/ces/api-ref/ces_03_0047.html b/docs/ces/api-ref/ces_03_0047.html
new file mode 100644
index 00000000..5c9f9368
--- /dev/null
+++ b/docs/ces/api-ref/ces_03_0047.html
@@ -0,0 +1,48 @@
+
+
+ Supported Actions of the API Version Management APIs
+
+ Permission
+ |
+API
+ |
+Action
+ |
+IAM Project
+ |
+Enterprise Project
+ |
+
|---|
+
+Query all API versions supported by Cloud Eye.
+ |
+GET /
+ |
+ces:versions:get
+ |
+√
+ |
+×
+ |
+
+Query a specified Cloud Eye API version.
+ |
+GET /{api_version}
+ |
+ces:versions:get
+ |
+√
+ |
+×
+ |
+
+
+
+
+
+
+
diff --git a/docs/ces/api-ref/ces_03_0048.html b/docs/ces/api-ref/ces_03_0048.html
new file mode 100644
index 00000000..324eec78
--- /dev/null
+++ b/docs/ces/api-ref/ces_03_0048.html
@@ -0,0 +1,37 @@
+
+
+ Supported Actions of the Metric Management API
+
+ Permission
+ |
+API
+ |
+Action
+ |
+IAM Project
+ |
+Enterprise Project
+ |
+
|---|
+
+Query the metric list. You can specify the namespace, metric name, dimension, sorting order, start records, and the maximum number of records when using this API to query metrics.
+ |
+GET /V1.0/{project_id}/metrics
+ |
+ces:metrics:list
+ |
+√
+ |
+×
+ |
+
+
+
+
+
+
+
diff --git a/docs/ces/api-ref/ces_03_0049.html b/docs/ces/api-ref/ces_03_0049.html
new file mode 100644
index 00000000..0c86b4f3
--- /dev/null
+++ b/docs/ces/api-ref/ces_03_0049.html
@@ -0,0 +1,81 @@
+
+
+ Supported Actions of the Alarm Rule Management APIs
+
+ Permission
+ |
+API
+ |
+Action
+ |
+IAM Project
+ |
+Enterprise Project
+ |
+
|---|
+
+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.
+ |
+GET /V1.0/{project_id}/alarms
+ |
+ces:alarms:list
+ |
+√
+ |
+√
+ |
+
+Query an alarm rule based on the alarm rule ID.
+ |
+GET /V1.0/{project_id}/alarms/{alarm_id}
+ |
+ces:alarms:get
+ |
+√
+ |
+√
+ |
+
+Enable or disable an alarm rule.
+ |
+PUT /V1.0/{project_id}/alarms/{alarm_id}/action
+ |
+ces:alarmsOnOff:put
+ |
+√
+ |
+√
+ |
+
+Delete an alarm rule.
+ |
+DELETE /V1.0/{project_id}/alarms/{alarm_id}
+ |
+ces:alarms:delete
+ |
+√
+ |
+√
+ |
+
+Create an alarm rule.
+ |
+POST /V1.0/{project_id}/alarms
+ |
+ces:alarms:create
+ |
+√
+ |
+√
+ |
+
+
+
+
+
+
+
diff --git a/docs/ces/api-ref/ces_03_0050.html b/docs/ces/api-ref/ces_03_0050.html
new file mode 100644
index 00000000..4dc12fdc
--- /dev/null
+++ b/docs/ces/api-ref/ces_03_0050.html
@@ -0,0 +1,59 @@
+
+
+ Supported Actions of the Monitoring Data Management APIs
+
+ Permission
+ |
+API
+ |
+Action
+ |
+IAM Project
+ |
+Enterprise Project
+ |
+
|---|
+
+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.
+ |
+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}
+ |
+ces:metricData:list
+ |
+√
+ |
+×
+ |
+
+Add one or more pieces of custom metric monitoring data to solve the problem that the system metrics cannot meet specific service requirements.
+ |
+POST /V1.0/{project_id}/metric-data
+ |
+ces:metricData:create
+ |
+√
+ |
+×
+ |
+
+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 to query the host configuration in the HANA scenario. In other scenarios, the host configuration cannot be queried with this API.)
+ |
+GET /V1.0/{project_id}/event-data
+ |
+ces:sapEventData:list
+ |
+√
+ |
+×
+ |
+
+
+
+
+
+
+
diff --git a/docs/ces/api-ref/ces_03_0051.html b/docs/ces/api-ref/ces_03_0051.html
new file mode 100644
index 00000000..3fbc9d9c
--- /dev/null
+++ b/docs/ces/api-ref/ces_03_0051.html
@@ -0,0 +1,37 @@
+
+
+ Supported Actions of the Quota Management API
+
+ Permission
+ |
+API
+ |
+Action
+ |
+IAM Project
+ |
+Enterprise Project
+ |
+
|---|
+
+Query a resource quota and the used amount. Currently, the resource refers to alarm rules only.
+ |
+GET /V1.0/{project_id}/quotas
+ |
+ces:quotas:get
+ |
+√
+ |
+×
+ |
+
+
+
+
+
+
+
diff --git a/docs/ces/api-ref/ces_03_0052.html b/docs/ces/api-ref/ces_03_0052.html
new file mode 100644
index 00000000..725ef8ce
--- /dev/null
+++ b/docs/ces/api-ref/ces_03_0052.html
@@ -0,0 +1,37 @@
+
+
+ Supported Actions of the Event Monitoring API
+
+ Permission
+ |
+API
+ |
+Action
+ |
+IAM Project
+ |
+Enterprise Project
+ |
+
|---|
+
+Report custom events.
+ |
+POST /V1.0/{project_id}/events
+ |
+ces:events:post
+ |
+√
+ |
+×
+ |
+
+
+
+
+
+
+
diff --git a/docs/ces/api-ref/ces_03_0057.html b/docs/ces/api-ref/ces_03_0057.html
index abcc60f2..88f709d7 100644
--- a/docs/ces/api-ref/ces_03_0057.html
+++ b/docs/ces/api-ref/ces_03_0057.html
@@ -1,12 +1,43 @@
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: - Log in to the management console.
- 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
+ScenariosA project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:
+
+
+ Obtain the Project ID by Calling an APIYou can obtain the project ID by calling the IAM API used to query project information based on the specified criteria.
+ The API used to obtain a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained from Regions and Endpoints.
+ The following is an example response. The value of id is the project ID.
+ {
+ "projects": [
+ {
+ "domain_id": "65ewtrgaggshhk1223245sghjlse684b",
+ "is_domain": false,
+ "parent_id": "65ewtrgaggshhk1223245sghjlse684b",
+ "name": "project_name",
+ "description": "",
+ "links": {
+ "next": null,
+ "previous": null,
+ "self": "https://www.example.com/v3/projects/a4adasfjljaaaakla12334jklga9sasfg"
+ },
+ "id": "a4adasfjljaaaakla12334jklga9sasfg",
+ "enabled": true
+ }
+ ],
+ "links": {
+ "next": null,
+ "previous": null,
+ "self": "https://www.example.com/v3/projects"
+ }
+}
+
+ Obtain a Project ID from the ConsoleA 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: - Log in to the management console.
- 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.
+
diff --git a/docs/ces/api-ref/ces_03_0059.html b/docs/ces/api-ref/ces_03_0059.html
index 50b1bd5d..7ff81be5 100644
--- a/docs/ces/api-ref/ces_03_0059.html
+++ b/docs/ces/api-ref/ces_03_0059.html
@@ -2,170 +2,267 @@
Services Interconnected with Cloud Eye
- Category
+Category
|
-Service
+ | Service
|
-Namespace
+ | Namespace
|
-Reference
+ | Dimension
+ |
+Reference
|
|---|
-Compute
+ | Compute
|
-Elastic Cloud Server
+ | Elastic Cloud Server
|
-SYS.ECS
+ | SYS.ECS
|
-Basic ECS metrics
+ | Key: instance_id
+Value: ECS ID
+ |
+Basic ECS metrics
|
-Bare Metal Server
+ | Bare Metal Server
|
-SERVICE.BMS
+ | SERVICE.BMS
|
-BMS Metrics Under OS Monitoring
+ | Key: instance_id
+Value: ECS ID
+ |
+BMS metrics (with the Agent installed)
|
-Auto Scaling
+ | Auto Scaling
|
-SYS.AS
+ | SYS.AS
|
-AS metrics
+ | Key: AutoScalingGroup
+Value: auto scaling group ID
+ |
+AS metrics
|
-Storage
+ | Storage
|
-Elastic Volume Service (attached to an ECS or BMS)
+ | Elastic Volume Service (attached to an ECS or BMS)
|
-SYS.EVS
+ | SYS.EVS
|
-EVS metrics
+ | Key: disk_name
+Value: server ID-drive letter (sda is the drive letter.)
+ |
+EVS metrics
|
-Scalable File Service
+ | Object Storage Service (OBS)
|
-SYS.SFS
+ | SYS.OBS
|
-SFS metrics
+ | Key: bucket_name
+Value: bucket name
+ |
+OBS metrics
|
-SFS Turbo
+ | Scalable File Service
|
-SYS.EFS
+ | SYS.SFS
|
-SFS Turbo metrics
+ | Key: share_id
+Value: SFS file system
+ |
+SFS metrics
|
-Cloud Backup and Recovery
+ | SFS Turbo
|
-SYS.CBR
+ | SYS.EFS
|
-CBR metrics
+ | Key: efs_instance_id
+Value: instance
+ |
+SFS Turbo metrics
|
-Network
+ | Cloud Backup and Recovery
|
-Elastic IP and bandwidth
+ | SYS.CBR
|
-SYS.VPC
+ |
+Vault: vault name/ID
|
-VPC metrics
+ | CBR metrics
|
-Elastic Load Balance
+ | Network
|
-SYS.ELB
+ | Elastic IP and bandwidth
|
-ELB metrics
+ | SYS.VPC
+ |
+- Key: publicip_id
Value: EIP ID
+ - Key: bandwidth_id
Value: bandwidth ID
+
+ |
+VPC metrics
|
-NAT Gateway
+ | Elastic Load Balance
|
-SYS.NAT
+ | SYS.ELB
|
-NAT Gateway metrics
+ |
+ |
+ELB metrics
|
-Security
+ | Direct Connect
|
-Web Application Firewall
+ | SYS.DCAAS
|
-SYS.WAF
+ | - Key: direct_connect_id
Value: connection
+ - Key: virtual_interface_id
Value: virtual interface
+
|
-WAF metrics
+ | Direct Connect metrics
|
-Application
+ | NAT Gateway
|
-Distributed Message Service
+ | SYS.NAT
|
-SYS.DMS
+ | - Key: nat_gateway_id
Value: NAT gateway ID
+
|
-DMS metrics
+ | NAT Gateway metrics
|
-Distributed Cache Service
+ | Security
|
-SYS.DCS
+ | Web Application Firewall
|
-DCS metrics
+ | SYS.WAF
+ |
+
+ |
+WAF metrics
|
-Database
+ | Application
|
-Relational Database Service
+ | Distributed Message Service
|
-SYS.RDS
+ | SYS.DMS
|
-RDS for MySQL metrics
+ | For details, see the information in the right column.
+ |
+DMS metrics
+ |
+
+Distributed Cache Service
+ |
+SYS.DCS
+ |
+
+
+ |
+DCS metrics
+ |
+
+Database
+ |
+Relational Database Service
+ |
+SYS.RDS
+ |
+For details, see the information in the right column.
+ |
+RDS for MySQL metrics
RDS for PostgreSQL metrics
RDS for SQL Server metrics
|
-Document Database Service
+ | Document Database Service
|
-SYS.DDS
+ | SYS.DDS
|
-DDS metrics
+ | - Key: mongodb_node_id
Value: DDS node ID
+
+
+ |
+DDS metrics
|
-GaussDB NoSQL
+ | GaussDB NoSQL
|
-SYS.NoSQL
+ | SYS.NoSQL
|
-GaussDB(for Cassandra) metrics
+ | For details, see the information in the right column.
+ |
+GaussDB(for Cassandra) metrics
|
-GaussDB(for MySQL)
+ | GaussDB(for MySQL)
|
-SYS.GAUSSDB
+ | SYS.GAUSSDB
|
-GaussDB(for MySQL) metrics
+ | For details, see the information in the right column.
+ |
+GaussDB(for MySQL) metrics
|
-GaussDB(for openGauss)
+ | GaussDB
|
-SYS.GAUSSDBV5
+ | SYS.GAUSSDBV5
|
-GaussDB(for MySQL) metrics
+ | For details, see the information in the right column.
+ |
+GaussDB metrics
|
-Data analysis
+ | Data analysis
|
-Data Warehouse Service
+ | Data Warehouse Service
|
-SYS.DWS
+ | SYS.DWS
|
-DWS metrics
+ |
+
+ |
+DWS metrics
|
-Cloud Search Service
+ | Cloud Search Service
|
-SYS.ES
+ | SYS.ES
|
-CSS metrics
+ | - Key: cluster_id
Values: Cluster ID
+
+ |
+CSS metrics
+ |
+
+Data Ingestion Service (DIS)
+ |
+SYS.DAYU
+ |
+Key: stream_id
+Value: real-time data ingestion
+ |
+DIS Metrics
|
diff --git a/docs/ces/api-ref/ces_03_0060.html b/docs/ces/api-ref/ces_03_0060.html
index e18f3491..472b1cec 100644
--- a/docs/ces/api-ref/ces_03_0060.html
+++ b/docs/ces/api-ref/ces_03_0060.html
@@ -27,7 +27,7 @@
2020-03-06
|
This release incorporates the following changes:
-
+
|
2019-08-31
diff --git a/docs/ces/api-ref/ces_03_0074.html b/docs/ces/api-ref/ces_03_0074.html
index c42f7f06..feaaf710 100644
--- a/docs/ces/api-ref/ces_03_0074.html
+++ b/docs/ces/api-ref/ces_03_0074.html
@@ -1,7 +1,7 @@
Querying Events
-FunctionThis API is used to query the events, including system events and custom events.
+ FunctionThis API is used to query events, including system events and custom events.
URIGET /V1.0/{project_id}/events
- Parameter description
diff --git a/docs/ces/api-ref/ces_03_0075.html b/docs/ces/api-ref/ces_03_0075.html
index e2ad7739..a5160486 100644
--- a/docs/ces/api-ref/ces_03_0075.html
+++ b/docs/ces/api-ref/ces_03_0075.html
@@ -1,7 +1,7 @@
-
Querying Monitoring Details of an Event
-FunctionThis API is used to query the event details based on the event name.
+ Querying Details of an Event
+ FunctionThis API is used to query details of an event based on the event name.
URIGET /V1.0/{project_id}/event/{event_name}
- Parameter description
@@ -40,7 +40,7 @@
|
Yes
|
-Specifies the event type. Possible types are EVENT.SYS (system event) and EVENT.CUSTOM (custom event).
+ | Specifies the event type. The value can be EVENT.SYS (system event) or EVENT.CUSTOM (custom event).
|
event_source
@@ -58,7 +58,7 @@
|
No
|
-Specifies the event severity. Possible severities are Critical, Major, Minor, and Info.
+ | Specifies the event severity. The value can be Critical, Major, Minor, or Info.
|
event_user
@@ -76,7 +76,7 @@
|
No
|
-Specifies the event status. Possible statuses are normal, warning, or incident.
+ | Specifies the event status. The value can be normal, warning, or incident.
|
from
@@ -94,8 +94,7 @@
|
No
|
-No
-Specifies the end time of the query. The time is a UNIX timestamp and the unit is ms. The from value must be smaller than the to value.
+ | Specifies the end time of the query. The time is a UNIX timestamp and the unit is ms. The from value must be smaller than the to value.
|
start
@@ -138,7 +137,7 @@
| event_name
|
-string
+ | String
|
No
|
@@ -147,11 +146,11 @@
event_type
|
-string
+ | String
|
No
|
-Specifies the event type. Possible types are EVENT.SYS (system event) and EVENT.CUSTOM (custom event).
+ | Specifies the event type. The value can be EVENT.SYS (system event) or EVENT.CUSTOM (custom event).
|
event_users
@@ -178,7 +177,7 @@
|
No
|
-Specifies details about one or more events.
+ | Specifies details of one or more events.
For details, see Table 3.
|
@@ -189,7 +188,7 @@
No
|
Specifies the number of metadata records in the query result.
-For details, see Table 5.
+For details, see Table 6.
|
@@ -208,7 +207,7 @@
event_name
|
-string
+ | String
|
Yes
|
@@ -217,7 +216,7 @@
event_source
|
-string
+ | String
|
No
|
@@ -226,7 +225,7 @@
time
|
-long
+ | Long
|
Yes
|
@@ -245,7 +244,7 @@
event_id
|
-string
+ | String
|
No
|
@@ -268,16 +267,16 @@
content
|
-string
+ | String
|
No
|
-Specifies the event content. Enter up to 4096 characters.
+ | Specifies the event content. Enter up to 4,096 characters.
|
group_id
|
-string
+ | String
|
No
|
@@ -286,7 +285,7 @@
resource_id
|
-string
+ | String
|
No
|
@@ -295,7 +294,7 @@
resource_name
|
-string
+ | String
|
No
|
@@ -304,27 +303,27 @@
event_state
|
-string
+ | String
|
No
|
Specifies the event status.
-Valid value can be normal, warning, or incident.
+The value can be normal, warning, or incident.
|
event_level
|
-string
+ | String
|
No
|
Specifies the event severity.
-Its value can be Critical, Major, Minor, or Info.
+The value can be Critical, Major, Minor, or Info.
|
event_user
|
-string
+ | String
|
No
|
@@ -333,35 +332,78 @@
event_type
|
-string
+ | String
|
No
|
Specifies the event type.
-Possible types are EVENT.SYS (system event) and EVENT.CUSTOM (custom event).
+The value can be EVENT.SYS (system event) or EVENT.CUSTOM (custom event).
+ |
+
+dimensions
+ |
+Array of objects
+ |
+No
+ |
+Specifies one or more resource dimensions.
+For details, see Table 5.
|
Table 5 meta_data data structure descriptionParameter
+Table 5 dimensions data structure descriptionParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-total
+ | name
|
-Integer
+ | String
|
-No
+ | No
|
-Specifies the total number of events.
+ | Specifies the dimension. For example, the ECS dimension is instance_id. For details about the dimension of each service, see the key column in Services Interconnected with Cloud Eye.
+ |
+
+value
+ |
+String
+ |
+No
+ |
+Specifies the dimension value, for example, an ECS ID.
+Enter 1 to 256 characters.
+ |
+
+
+
+ Table 6 meta_data data structure descriptionParameter
+ |
+Type
+ |
+Mandatory
+ |
+Description
+ |
+
|---|
+
+total
+ |
+Integer
+ |
+No
+ |
+Specifies the total number of events.
|
@@ -391,7 +433,13 @@
"event_state": "normal",
"event_level": "Minor",
"event_user": "",
- "event_type": "EVENT.SYS"
+ "event_type": "EVENT.SYS",
+ "dimensions": [
+ {
+ "name": "instance_id",
+ "value": "fddad01f-e3b6-420d-8fdc-a42451de7c34"
+ }
+ ]
}
},
{
@@ -407,7 +455,13 @@
"event_state": "normal",
"event_level": "Minor",
"event_user": "",
- "event_type": "EVENT.SYS"
+ "event_type": "EVENT.SYS",
+ "dimensions": [
+ {
+ "name": "instance_id",
+ "value": "fddad01f-e3b6-420d-8fdc-a42451de7c34"
+ }
+ ]
}
},
{
@@ -423,7 +477,13 @@
"event_state": "normal",
"event_level": "Minor",
"event_user": "",
- "event_type": "EVENT.SYS"
+ "event_type": "EVENT.SYS",
+ "dimensions": [
+ {
+ "name": "instance_id",
+ "value": "fddad01f-e3b6-420d-8fdc-a42451de7c34"
+ }
+ ]
}
}
],
diff --git a/docs/ces/api-ref/en-us_image_0218975120.png b/docs/ces/api-ref/en-us_image_0000001508295281.png
similarity index 100%
rename from docs/ces/api-ref/en-us_image_0218975120.png
rename to docs/ces/api-ref/en-us_image_0000001508295281.png
diff --git a/docs/ces/api-ref/en-us_topic_0032831274.html b/docs/ces/api-ref/en-us_topic_0032831274.html
index 13a0f67f..b83e10a9 100644
--- a/docs/ces/api-ref/en-us_topic_0032831274.html
+++ b/docs/ces/api-ref/en-us_topic_0032831274.html
@@ -88,7 +88,7 @@
Yes
|
-long
+ | Long
|
Specifies when the data was collected.
The time is UNIX timestamp (ms) format.
@@ -100,7 +100,7 @@
|
Yes
|
-double
+ | Double
|
Specifies the monitoring metric data to be added, which can be an integer or a floating point number.
|
@@ -322,7 +322,7 @@
diff --git a/docs/ces/api-ref/en-us_topic_0109034020.html b/docs/ces/api-ref/en-us_topic_0109034020.html
index e2716923..35fb6f26 100644
--- a/docs/ces/api-ref/en-us_topic_0109034020.html
+++ b/docs/ces/api-ref/en-us_topic_0109034020.html
@@ -38,21 +38,20 @@
-Array elements
+ | [Array element]
|
-Arrays of objects
+ | Array of EventItem objects
|
Yes
|
Specifies the event list.
-For details, see Table 3.
|
Table 3 Array elementsParameter
+Table 3 Parameter description of the EventItem fieldParameter
|
Mandatory
|
@@ -87,7 +86,7 @@
Yes
|
-long
+ | Long
|
Specifies when the event occurred, which is a UNIX timestamp (ms).
NOTE: Since there is a latency between the client and the server, the data timestamp to be inserted should be within the period that starts from 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.
@@ -99,7 +98,7 @@
|
Yes
|
-Arrays of objects
+ | Detail object
|
Specifies the event details.
For details, see Table 4.
@@ -125,7 +124,7 @@
|
String
|
-Specifies the event content. Enter up to 4096 characters.
+ | Specifies the event content. Enter up to 4,096 characters.
|
|---|
resource_id
@@ -147,7 +146,7 @@
|
String
|
-Specifies the resource name. Enter up to 128 characters, including letters, digits, underscores (_), and hyphens (-).
+ | Specifies the resource name. Enter up to 128 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
|
event_state
@@ -157,7 +156,7 @@
| String
|
Specifies the event status.
-Valid value can be normal, warning, or incident.
+The value can be normal, warning, or incident.
|
event_level
@@ -167,7 +166,7 @@
| String
|
Specifies the event severity.
-Its value can be Critical, Major, Minor, or Info.
+The value can be Critical, Major, Minor, or Info.
|
event_user
@@ -180,6 +179,16 @@
Enter up to 64 characters, including letters, digits, underscores (_), hyphens (-), slashes (/), and spaces.
|
+event_type
+ |
+No
+ |
+String
+ |
+Specifies the event type.
+Its value can be EVENT.SYS or EVENT.CUSTOM. EVENT.SYS indicates system events that cannot be reported by users. Only custom events can be reported.
+ |
+
|
|---|
Array elements
|
-Arrays of objects
+ | Array of objects
|
Specifies the event list.
For details, see Table 6.
diff --git a/docs/ces/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/ces/api-ref/public_sys-resources/icon-arrowdn.gif
index 84eec9be..37942803 100644
Binary files a/docs/ces/api-ref/public_sys-resources/icon-arrowdn.gif 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
index 39583d16..6aaaa11c 100644
Binary files a/docs/ces/api-ref/public_sys-resources/icon-arrowrt.gif and b/docs/ces/api-ref/public_sys-resources/icon-arrowrt.gif differ
| |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|