@alicloud/cms20190101 2.0.8 → 2.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/client.ts CHANGED
@@ -5471,6 +5471,7 @@ export class DescribeAlertLogListResponse extends $tea.Model {
5471
5471
  }
5472
5472
 
5473
5473
  export class DescribeAlertingMetricRuleResourcesRequest extends $tea.Model {
5474
+ alertBeforeTime?: string;
5474
5475
  dimensions?: string;
5475
5476
  groupId?: string;
5476
5477
  namespace?: string;
@@ -5480,6 +5481,7 @@ export class DescribeAlertingMetricRuleResourcesRequest extends $tea.Model {
5480
5481
  ruleId?: string;
5481
5482
  static names(): { [key: string]: string } {
5482
5483
  return {
5484
+ alertBeforeTime: 'AlertBeforeTime',
5483
5485
  dimensions: 'Dimensions',
5484
5486
  groupId: 'GroupId',
5485
5487
  namespace: 'Namespace',
@@ -5492,6 +5494,7 @@ export class DescribeAlertingMetricRuleResourcesRequest extends $tea.Model {
5492
5494
 
5493
5495
  static types(): { [key: string]: any } {
5494
5496
  return {
5497
+ alertBeforeTime: 'string',
5495
5498
  dimensions: 'string',
5496
5499
  groupId: 'string',
5497
5500
  namespace: 'string',
@@ -22857,6 +22860,31 @@ export class DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaSMS e
22857
22860
  }
22858
22861
  }
22859
22862
 
22863
+ export class DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaSiteMonitorBrowser extends $tea.Model {
22864
+ quotaLimit?: number;
22865
+ quotaPackage?: number;
22866
+ quotaUsed?: number;
22867
+ static names(): { [key: string]: string } {
22868
+ return {
22869
+ quotaLimit: 'QuotaLimit',
22870
+ quotaPackage: 'QuotaPackage',
22871
+ quotaUsed: 'QuotaUsed',
22872
+ };
22873
+ }
22874
+
22875
+ static types(): { [key: string]: any } {
22876
+ return {
22877
+ quotaLimit: 'number',
22878
+ quotaPackage: 'number',
22879
+ quotaUsed: 'number',
22880
+ };
22881
+ }
22882
+
22883
+ constructor(map?: { [key: string]: any }) {
22884
+ super(map);
22885
+ }
22886
+ }
22887
+
22860
22888
  export class DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaSiteMonitorEcsProbe extends $tea.Model {
22861
22889
  quotaLimit?: number;
22862
22890
  quotaPackage?: number;
@@ -22882,6 +22910,31 @@ export class DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaSiteM
22882
22910
  }
22883
22911
  }
22884
22912
 
22913
+ export class DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaSiteMonitorMobile extends $tea.Model {
22914
+ quotaLimit?: number;
22915
+ quotaPackage?: number;
22916
+ quotaUsed?: number;
22917
+ static names(): { [key: string]: string } {
22918
+ return {
22919
+ quotaLimit: 'QuotaLimit',
22920
+ quotaPackage: 'QuotaPackage',
22921
+ quotaUsed: 'QuotaUsed',
22922
+ };
22923
+ }
22924
+
22925
+ static types(): { [key: string]: any } {
22926
+ return {
22927
+ quotaLimit: 'number',
22928
+ quotaPackage: 'number',
22929
+ quotaUsed: 'number',
22930
+ };
22931
+ }
22932
+
22933
+ constructor(map?: { [key: string]: any }) {
22934
+ super(map);
22935
+ }
22936
+ }
22937
+
22885
22938
  export class DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaSiteMonitorOperatorProbe extends $tea.Model {
22886
22939
  quotaLimit?: number;
22887
22940
  quotaPackage?: number;
@@ -22942,7 +22995,9 @@ export class DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuota exte
22942
22995
  logMonitor?: DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaLogMonitor;
22943
22996
  phone?: DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaPhone;
22944
22997
  SMS?: DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaSMS;
22998
+ siteMonitorBrowser?: DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaSiteMonitorBrowser;
22945
22999
  siteMonitorEcsProbe?: DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaSiteMonitorEcsProbe;
23000
+ siteMonitorMobile?: DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaSiteMonitorMobile;
22946
23001
  siteMonitorOperatorProbe?: DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaSiteMonitorOperatorProbe;
22947
23002
  siteMonitorTask?: DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaSiteMonitorTask;
22948
23003
  suitInfo?: string;
@@ -22957,7 +23012,9 @@ export class DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuota exte
22957
23012
  logMonitor: 'LogMonitor',
22958
23013
  phone: 'Phone',
22959
23014
  SMS: 'SMS',
23015
+ siteMonitorBrowser: 'SiteMonitorBrowser',
22960
23016
  siteMonitorEcsProbe: 'SiteMonitorEcsProbe',
23017
+ siteMonitorMobile: 'SiteMonitorMobile',
22961
23018
  siteMonitorOperatorProbe: 'SiteMonitorOperatorProbe',
22962
23019
  siteMonitorTask: 'SiteMonitorTask',
22963
23020
  suitInfo: 'SuitInfo',
@@ -22975,7 +23032,9 @@ export class DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuota exte
22975
23032
  logMonitor: DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaLogMonitor,
22976
23033
  phone: DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaPhone,
22977
23034
  SMS: DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaSMS,
23035
+ siteMonitorBrowser: DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaSiteMonitorBrowser,
22978
23036
  siteMonitorEcsProbe: DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaSiteMonitorEcsProbe,
23037
+ siteMonitorMobile: DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaSiteMonitorMobile,
22979
23038
  siteMonitorOperatorProbe: DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaSiteMonitorOperatorProbe,
22980
23039
  siteMonitorTask: DescribeMonitorResourceQuotaAttributeResponseBodyResourceQuotaSiteMonitorTask,
22981
23040
  suitInfo: 'string',
@@ -26926,8 +26985,7 @@ export default class Client extends OpenApi {
26926
26985
  }
26927
26986
 
26928
26987
  /**
26929
- * The ID of the application group to which the alert template is applied.
26930
- * For more information about how to query the ID of an application group, see [DescribeMonitorGroups](~~115032~~).
26988
+ * In this example, the `700****` alert template is applied to the `123456` application group. For the generated alert rule, the ID is `applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****`, and the name is `test123`.
26931
26989
  *
26932
26990
  * @param request ApplyMetricRuleTemplateRequest
26933
26991
  * @param runtime runtime options for this request RuntimeOptions
@@ -26986,8 +27044,7 @@ export default class Client extends OpenApi {
26986
27044
  }
26987
27045
 
26988
27046
  /**
26989
- * The ID of the application group to which the alert template is applied.
26990
- * For more information about how to query the ID of an application group, see [DescribeMonitorGroups](~~115032~~).
27047
+ * In this example, the `700****` alert template is applied to the `123456` application group. For the generated alert rule, the ID is `applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****`, and the name is `test123`.
26991
27048
  *
26992
27049
  * @param request ApplyMetricRuleTemplateRequest
26993
27050
  * @return ApplyMetricRuleTemplateResponse
@@ -26998,7 +27055,7 @@ export default class Client extends OpenApi {
26998
27055
  }
26999
27056
 
27000
27057
  /**
27001
- * The extended options of the protocol that is used by the site monitoring task. The options vary based on the protocol.
27058
+ * This topic provides an example on how to create a site monitoring task named `HangZhou_ECS1`. The URL that is monitored by the task is `https://www.aliyun.com` and the type of the task is `HTTP`. The returned result shows that the site monitoring task is created. The name of the site monitoring task is `HangZhou_ECS1` and the task ID is `679fbe4f-b80b-4706-91b2-5427b43e****`.
27002
27059
  *
27003
27060
  * @param request BatchCreateInstantSiteMonitorRequest
27004
27061
  * @param runtime runtime options for this request RuntimeOptions
@@ -27029,7 +27086,7 @@ export default class Client extends OpenApi {
27029
27086
  }
27030
27087
 
27031
27088
  /**
27032
- * The extended options of the protocol that is used by the site monitoring task. The options vary based on the protocol.
27089
+ * This topic provides an example on how to create a site monitoring task named `HangZhou_ECS1`. The URL that is monitored by the task is `https://www.aliyun.com` and the type of the task is `HTTP`. The returned result shows that the site monitoring task is created. The name of the site monitoring task is `HangZhou_ECS1` and the task ID is `679fbe4f-b80b-4706-91b2-5427b43e****`.
27033
27090
  *
27034
27091
  * @param request BatchCreateInstantSiteMonitorRequest
27035
27092
  * @return BatchCreateInstantSiteMonitorResponse
@@ -27345,9 +27402,8 @@ export default class Client extends OpenApi {
27345
27402
  }
27346
27403
 
27347
27404
  /**
27348
- * Specifies whether the application group automatically subscribes to event notifications. If events whose severity level is critical or warning occur on resources in an application group, CloudMonitor sends alert notifications. Valid values:
27349
- * * true: The application group automatically subscribes to event notifications.
27350
- * * false (default value): The application group does not automatically subscribe to event notifications.
27405
+ * This operation is available for Elastic Compute Service (ECS), ApsaraDB RDS, and Server Load Balancer (SLB).
27406
+ * This topic provides an example to show how to create an application group for resources whose tag key is `ecs_instance`. In this example, the alert contact group of the application group is `ECS_Group`.
27351
27407
  *
27352
27408
  * @param request CreateDynamicTagGroupRequest
27353
27409
  * @param runtime runtime options for this request RuntimeOptions
@@ -27406,9 +27462,8 @@ export default class Client extends OpenApi {
27406
27462
  }
27407
27463
 
27408
27464
  /**
27409
- * Specifies whether the application group automatically subscribes to event notifications. If events whose severity level is critical or warning occur on resources in an application group, CloudMonitor sends alert notifications. Valid values:
27410
- * * true: The application group automatically subscribes to event notifications.
27411
- * * false (default value): The application group does not automatically subscribe to event notifications.
27465
+ * This operation is available for Elastic Compute Service (ECS), ApsaraDB RDS, and Server Load Balancer (SLB).
27466
+ * This topic provides an example to show how to create an application group for resources whose tag key is `ecs_instance`. In this example, the alert contact group of the application group is `ECS_Group`.
27412
27467
  *
27413
27468
  * @param request CreateDynamicTagGroupRequest
27414
27469
  * @return CreateDynamicTagGroupResponse
@@ -27419,7 +27474,7 @@ export default class Client extends OpenApi {
27419
27474
  }
27420
27475
 
27421
27476
  /**
27422
- * The details of the alert rules.
27477
+ * This topic provides an example to show how to create an alert rule for the `cpu_total` metric of Elastic Compute Service (ECS) in the `123456` application group. The ID of the alert rule is `456789`. The name of the alert rule is `ECS_Rule1`. The alert level is `Critical`. The statistical method is `Average`. The comparison operator is `GreaterThanOrEqualToThreshold`. The alert threshold is `90`. The number of alert retries is `3`. The response shows that the alert rule named `ECS_Rule1` is created.
27423
27478
  *
27424
27479
  * @param request CreateGroupMetricRulesRequest
27425
27480
  * @param runtime runtime options for this request RuntimeOptions
@@ -27454,7 +27509,7 @@ export default class Client extends OpenApi {
27454
27509
  }
27455
27510
 
27456
27511
  /**
27457
- * The details of the alert rules.
27512
+ * This topic provides an example to show how to create an alert rule for the `cpu_total` metric of Elastic Compute Service (ECS) in the `123456` application group. The ID of the alert rule is `456789`. The name of the alert rule is `ECS_Rule1`. The alert level is `Critical`. The statistical method is `Average`. The comparison operator is `GreaterThanOrEqualToThreshold`. The alert threshold is `90`. The number of alert retries is `3`. The response shows that the alert rule named `ECS_Rule1` is created.
27458
27513
  *
27459
27514
  * @param request CreateGroupMetricRulesRequest
27460
27515
  * @return CreateGroupMetricRulesResponse
@@ -27584,9 +27639,8 @@ export default class Client extends OpenApi {
27584
27639
  }
27585
27640
 
27586
27641
  /**
27587
- * Indicates whether the call was successful. Valid values:
27588
- * * true: The call was successful.
27589
- * * false: The call failed.
27642
+ * ## Prerequisites
27643
+ * Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).
27590
27644
  *
27591
27645
  * @param request CreateHybridMonitorNamespaceRequest
27592
27646
  * @param runtime runtime options for this request RuntimeOptions
@@ -27625,9 +27679,8 @@ export default class Client extends OpenApi {
27625
27679
  }
27626
27680
 
27627
27681
  /**
27628
- * Indicates whether the call was successful. Valid values:
27629
- * * true: The call was successful.
27630
- * * false: The call failed.
27682
+ * ## Prerequisites
27683
+ * Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).
27631
27684
  *
27632
27685
  * @param request CreateHybridMonitorNamespaceRequest
27633
27686
  * @return CreateHybridMonitorNamespaceResponse
@@ -27638,8 +27691,10 @@ export default class Client extends OpenApi {
27638
27691
  }
27639
27692
 
27640
27693
  /**
27641
- * The Log Service projects.
27642
- * Valid values of N: 1 to 25.
27694
+ * # Prerequisites
27695
+ * Simple Log Service is activated. A project and a Logstore are created in Simple Log Service. For more information, see [Getting Started](~~54604~~).
27696
+ * # Description
27697
+ * In this example, a Logstore group named `Logstore_test` is created. The region ID is `cn-hangzhou`. The project is `aliyun-project`. The Logstore is `Logstore-ECS`. The response shows that the Logstore group is created.
27643
27698
  *
27644
27699
  * @param request CreateHybridMonitorSLSGroupRequest
27645
27700
  * @param runtime runtime options for this request RuntimeOptions
@@ -27678,8 +27733,10 @@ export default class Client extends OpenApi {
27678
27733
  }
27679
27734
 
27680
27735
  /**
27681
- * The Log Service projects.
27682
- * Valid values of N: 1 to 25.
27736
+ * # Prerequisites
27737
+ * Simple Log Service is activated. A project and a Logstore are created in Simple Log Service. For more information, see [Getting Started](~~54604~~).
27738
+ * # Description
27739
+ * In this example, a Logstore group named `Logstore_test` is created. The region ID is `cn-hangzhou`. The project is `aliyun-project`. The Logstore is `Logstore-ECS`. The response shows that the Logstore group is created.
27683
27740
  *
27684
27741
  * @param request CreateHybridMonitorSLSGroupRequest
27685
27742
  * @return CreateHybridMonitorSLSGroupResponse
@@ -27690,7 +27747,9 @@ export default class Client extends OpenApi {
27690
27747
  }
27691
27748
 
27692
27749
  /**
27693
- * The dimension based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL.
27750
+ * ## Prerequisites
27751
+ * * Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).
27752
+ * * If you want to create a metric for logs imported from Log Service, make sure that you have activated Log Service and created a project and a Logstore. For more information, see [Getting Started](~~54604~~).
27694
27753
  *
27695
27754
  * @param request CreateHybridMonitorTaskRequest
27696
27755
  * @param runtime runtime options for this request RuntimeOptions
@@ -27765,7 +27824,9 @@ export default class Client extends OpenApi {
27765
27824
  }
27766
27825
 
27767
27826
  /**
27768
- * The dimension based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL.
27827
+ * ## Prerequisites
27828
+ * * Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).
27829
+ * * If you want to create a metric for logs imported from Log Service, make sure that you have activated Log Service and created a project and a Logstore. For more information, see [Getting Started](~~54604~~).
27769
27830
  *
27770
27831
  * @param request CreateHybridMonitorTaskRequest
27771
27832
  * @return CreateHybridMonitorTaskResponse
@@ -28033,7 +28094,7 @@ export default class Client extends OpenApi {
28033
28094
  }
28034
28095
 
28035
28096
  /**
28036
- * The name of the application group.
28097
+ * In this example, the application group named `ECS_Group` is created.
28037
28098
  *
28038
28099
  * @param request CreateMonitorGroupRequest
28039
28100
  * @param runtime runtime options for this request RuntimeOptions
@@ -28068,7 +28129,7 @@ export default class Client extends OpenApi {
28068
28129
  }
28069
28130
 
28070
28131
  /**
28071
- * The name of the application group.
28132
+ * In this example, the application group named `ECS_Group` is created.
28072
28133
  *
28073
28134
  * @param request CreateMonitorGroupRequest
28074
28135
  * @return CreateMonitorGroupResponse
@@ -28141,8 +28202,8 @@ export default class Client extends OpenApi {
28141
28202
  }
28142
28203
 
28143
28204
  /**
28144
- * The abbreviation of the Alibaba Cloud service name.
28145
- * To obtain the abbreviation of an Alibaba Cloud service name, call the [DescribeProjectMeta](~~114916~~) operation. The `metricCategory` tag in the `Labels` response parameter indicates the abbreviation of the Alibaba Cloud service name.
28205
+ * You can add a maximum of 1,000 instances to an application group at a time. You can add a maximum of 3,000 instances of an Alibaba Cloud service to an application group. The total number of instances that you can add to an application group is unlimited.
28206
+ * In this example, an Elastic Compute Service (ECS) instance in the `China (Hangzhou)` region is added to the `3607****` application group. The instance ID is `i-2ze26xj5wwy12****` and the instance name is `test-instance-ecs`.
28146
28207
  *
28147
28208
  * @param request CreateMonitorGroupInstancesRequest
28148
28209
  * @param runtime runtime options for this request RuntimeOptions
@@ -28177,8 +28238,8 @@ export default class Client extends OpenApi {
28177
28238
  }
28178
28239
 
28179
28240
  /**
28180
- * The abbreviation of the Alibaba Cloud service name.
28181
- * To obtain the abbreviation of an Alibaba Cloud service name, call the [DescribeProjectMeta](~~114916~~) operation. The `metricCategory` tag in the `Labels` response parameter indicates the abbreviation of the Alibaba Cloud service name.
28241
+ * You can add a maximum of 1,000 instances to an application group at a time. You can add a maximum of 3,000 instances of an Alibaba Cloud service to an application group. The total number of instances that you can add to an application group is unlimited.
28242
+ * In this example, an Elastic Compute Service (ECS) instance in the `China (Hangzhou)` region is added to the `3607****` application group. The instance ID is `i-2ze26xj5wwy12****` and the instance name is `test-instance-ecs`.
28182
28243
  *
28183
28244
  * @param request CreateMonitorGroupInstancesRequest
28184
28245
  * @return CreateMonitorGroupInstancesResponse
@@ -28189,7 +28250,8 @@ export default class Client extends OpenApi {
28189
28250
  }
28190
28251
 
28191
28252
  /**
28192
- * The type of the policy. Valid value: PauseNotify.
28253
+ * If the policy is valid, no alert notifications are sent for the application group.
28254
+ * This topic describes how to create the `PauseNotify` policy to pause alert notifications for the `7301****` application group. The StartTime parameter is set to `1622949300000` and the EndTime parameter is set to `1623208500000`. This indicates that the policy is valid from `2021-06-06 11:15:00 UTC+8` to `2021-06-09 11:15:00 UTC+8`.
28193
28255
  *
28194
28256
  * @param request CreateMonitorGroupNotifyPolicyRequest
28195
28257
  * @param runtime runtime options for this request RuntimeOptions
@@ -28232,7 +28294,8 @@ export default class Client extends OpenApi {
28232
28294
  }
28233
28295
 
28234
28296
  /**
28235
- * The type of the policy. Valid value: PauseNotify.
28297
+ * If the policy is valid, no alert notifications are sent for the application group.
28298
+ * This topic describes how to create the `PauseNotify` policy to pause alert notifications for the `7301****` application group. The StartTime parameter is set to `1622949300000` and the EndTime parameter is set to `1623208500000`. This indicates that the policy is valid from `2021-06-06 11:15:00 UTC+8` to `2021-06-09 11:15:00 UTC+8`.
28236
28299
  *
28237
28300
  * @param request CreateMonitorGroupNotifyPolicyRequest
28238
28301
  * @return CreateMonitorGroupNotifyPolicyResponse
@@ -28738,9 +28801,8 @@ export default class Client extends OpenApi {
28738
28801
  }
28739
28802
 
28740
28803
  /**
28741
- * Indicates whether the call was successful. Valid values:
28742
- * * true: The call was successful.
28743
- * * false: The call failed.
28804
+ * > If a metric import task is created for metrics in a namespace, you cannot delete the namespace unless you delete the task first.
28805
+ * This topic provides an example on how to delete a namespace named `aliyun`. The response shows that the namespace is deleted.
28744
28806
  *
28745
28807
  * @param request DeleteHybridMonitorNamespaceRequest
28746
28808
  * @param runtime runtime options for this request RuntimeOptions
@@ -28771,9 +28833,8 @@ export default class Client extends OpenApi {
28771
28833
  }
28772
28834
 
28773
28835
  /**
28774
- * Indicates whether the call was successful. Valid values:
28775
- * * true: The call was successful.
28776
- * * false: The call failed.
28836
+ * > If a metric import task is created for metrics in a namespace, you cannot delete the namespace unless you delete the task first.
28837
+ * This topic provides an example on how to delete a namespace named `aliyun`. The response shows that the namespace is deleted.
28777
28838
  *
28778
28839
  * @param request DeleteHybridMonitorNamespaceRequest
28779
28840
  * @return DeleteHybridMonitorNamespaceResponse
@@ -29583,9 +29644,7 @@ export default class Client extends OpenApi {
29583
29644
  }
29584
29645
 
29585
29646
  /**
29586
- * Indicates whether the call was successful. Valid values:
29587
- * * true: The call was successful.
29588
- * * false: The call failed.
29647
+ * This topic provides an example to show how to query the alert logs of Elastic Compute Service (ECS) based on the `product` dimension.
29589
29648
  *
29590
29649
  * @param request DescribeAlertLogListRequest
29591
29650
  * @param runtime runtime options for this request RuntimeOptions
@@ -29680,9 +29739,7 @@ export default class Client extends OpenApi {
29680
29739
  }
29681
29740
 
29682
29741
  /**
29683
- * Indicates whether the call was successful. Valid values:
29684
- * * true: The call was successful.
29685
- * * false: The call failed.
29742
+ * This topic provides an example to show how to query the alert logs of Elastic Compute Service (ECS) based on the `product` dimension.
29686
29743
  *
29687
29744
  * @param request DescribeAlertLogListRequest
29688
29745
  * @return DescribeAlertLogListResponse
@@ -29882,7 +29939,7 @@ export default class Client extends OpenApi {
29882
29939
  }
29883
29940
 
29884
29941
  /**
29885
- * The name of the custom event.
29942
+ * > This operation counts the number of times that a custom event occurred for each service.
29886
29943
  *
29887
29944
  * @param request DescribeCustomEventCountRequest
29888
29945
  * @param runtime runtime options for this request RuntimeOptions
@@ -29933,7 +29990,7 @@ export default class Client extends OpenApi {
29933
29990
  }
29934
29991
 
29935
29992
  /**
29936
- * The name of the custom event.
29993
+ * > This operation counts the number of times that a custom event occurred for each service.
29937
29994
  *
29938
29995
  * @param request DescribeCustomEventCountRequest
29939
29996
  * @return DescribeCustomEventCountResponse
@@ -29997,8 +30054,7 @@ export default class Client extends OpenApi {
29997
30054
  }
29998
30055
 
29999
30056
  /**
30000
- * The ID of the application group.
30001
- * For more information, see [DescribeMonitorGroups](~~115032~~).
30057
+ * > You can call the DescribeMetricList operation to query the metrics of a cloud service. For more information, see [DescribeMetricList](~~51936~~).
30002
30058
  *
30003
30059
  * @param request DescribeCustomMetricListRequest
30004
30060
  * @param runtime runtime options for this request RuntimeOptions
@@ -30049,8 +30105,7 @@ export default class Client extends OpenApi {
30049
30105
  }
30050
30106
 
30051
30107
  /**
30052
- * The ID of the application group.
30053
- * For more information, see [DescribeMonitorGroups](~~115032~~).
30108
+ * > You can call the DescribeMetricList operation to query the metrics of a cloud service. For more information, see [DescribeMetricList](~~51936~~).
30054
30109
  *
30055
30110
  * @param request DescribeCustomMetricListRequest
30056
30111
  * @return DescribeCustomMetricListResponse
@@ -30061,8 +30116,7 @@ export default class Client extends OpenApi {
30061
30116
  }
30062
30117
 
30063
30118
  /**
30064
- * The HTTP status code.
30065
- * > The status code 200 indicates that the call was successful.
30119
+ * This topic provides an example to show how to query tag rules that are related to `tagkey1`. The sample responses indicate that two tag rules are found. The rule IDs are `1536df65-a719-429d-8813-73cc40d7****` and `56e8cebb-b3d7-4a91-9880-78a8c84f****`.
30066
30120
  *
30067
30121
  * @param request DescribeDynamicTagRuleListRequest
30068
30122
  * @param runtime runtime options for this request RuntimeOptions
@@ -30113,8 +30167,7 @@ export default class Client extends OpenApi {
30113
30167
  }
30114
30168
 
30115
30169
  /**
30116
- * The HTTP status code.
30117
- * > The status code 200 indicates that the call was successful.
30170
+ * This topic provides an example to show how to query tag rules that are related to `tagkey1`. The sample responses indicate that two tag rules are found. The rule IDs are `1536df65-a719-429d-8813-73cc40d7****` and `56e8cebb-b3d7-4a91-9880-78a8c84f****`.
30118
30171
  *
30119
30172
  * @param request DescribeDynamicTagRuleListRequest
30120
30173
  * @return DescribeDynamicTagRuleListResponse
@@ -30216,7 +30269,7 @@ export default class Client extends OpenApi {
30216
30269
  }
30217
30270
 
30218
30271
  /**
30219
- * The error message.
30272
+ * This topic provides an example to show how to query the details of an event-triggered alert rule named `testRule`.
30220
30273
  *
30221
30274
  * @param request DescribeEventRuleTargetListRequest
30222
30275
  * @param runtime runtime options for this request RuntimeOptions
@@ -30247,7 +30300,7 @@ export default class Client extends OpenApi {
30247
30300
  }
30248
30301
 
30249
30302
  /**
30250
- * The error message.
30303
+ * This topic provides an example to show how to query the details of an event-triggered alert rule named `testRule`.
30251
30304
  *
30252
30305
  * @param request DescribeEventRuleTargetListRequest
30253
30306
  * @return DescribeEventRuleTargetListResponse
@@ -30324,7 +30377,7 @@ export default class Client extends OpenApi {
30324
30377
  }
30325
30378
 
30326
30379
  /**
30327
- * The ID of the application group.
30380
+ * You can create a process monitoring task to monitor all or the specified Elastic Compute Service (ECS) instances in an application group and set alert rules for the process monitoring task.
30328
30381
  *
30329
30382
  * @param request DescribeGroupMonitoringAgentProcessRequest
30330
30383
  * @param runtime runtime options for this request RuntimeOptions
@@ -30367,7 +30420,7 @@ export default class Client extends OpenApi {
30367
30420
  }
30368
30421
 
30369
30422
  /**
30370
- * The ID of the application group.
30423
+ * You can create a process monitoring task to monitor all or the specified Elastic Compute Service (ECS) instances in an application group and set alert rules for the process monitoring task.
30371
30424
  *
30372
30425
  * @param request DescribeGroupMonitoringAgentProcessRequest
30373
30426
  * @return DescribeGroupMonitoringAgentProcessResponse
@@ -30378,7 +30431,7 @@ export default class Client extends OpenApi {
30378
30431
  }
30379
30432
 
30380
30433
  /**
30381
- * The ID of the availability monitoring task.
30434
+ * This topic provides an example to show how to query all the availability monitoring tasks of your Alibaba Cloud account. The sample responses indicate that the account has one availability monitoring task named `ecs_instance`.
30382
30435
  *
30383
30436
  * @param request DescribeHostAvailabilityListRequest
30384
30437
  * @param runtime runtime options for this request RuntimeOptions
@@ -30429,7 +30482,7 @@ export default class Client extends OpenApi {
30429
30482
  }
30430
30483
 
30431
30484
  /**
30432
- * The ID of the availability monitoring task.
30485
+ * This topic provides an example to show how to query all the availability monitoring tasks of your Alibaba Cloud account. The sample responses indicate that the account has one availability monitoring task named `ecs_instance`.
30433
30486
  *
30434
30487
  * @param request DescribeHostAvailabilityListRequest
30435
30488
  * @return DescribeHostAvailabilityListResponse
@@ -30440,7 +30493,8 @@ export default class Client extends OpenApi {
30440
30493
  }
30441
30494
 
30442
30495
  /**
30443
- * The tag key.
30496
+ * ## Prerequisites
30497
+ * Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).
30444
30498
  *
30445
30499
  * @param request DescribeHybridMonitorDataListRequest
30446
30500
  * @param runtime runtime options for this request RuntimeOptions
@@ -30487,7 +30541,8 @@ export default class Client extends OpenApi {
30487
30541
  }
30488
30542
 
30489
30543
  /**
30490
- * The tag key.
30544
+ * ## Prerequisites
30545
+ * Hybrid Cloud Monitoring is activated. For more information, see [Activate Hybrid Cloud Monitoring](~~250773~~).
30491
30546
  *
30492
30547
  * @param request DescribeHybridMonitorDataListRequest
30493
30548
  * @return DescribeHybridMonitorDataListResponse
@@ -30498,13 +30553,7 @@ export default class Client extends OpenApi {
30498
30553
  }
30499
30554
 
30500
30555
  /**
30501
- * The data retention period. Valid values:
30502
- * * cms.s1.large: Data is stored for 15 days.
30503
- * * cms.s1.xlarge: Data is stored for 32 days.
30504
- * * cms.s1.2xlarge: Data is stored for 63 days.
30505
- * * cms.s1.3xlarge: Data is stored for 93 days.
30506
- * * cms.s1.6xlarge: Data is stored for 185 days.
30507
- * * cms.s1.12xlarge: Data is stored for 376 days.
30556
+ * In this example, all namespaces within the current account are queried. The response shows that the current account has only one namespace named `aliyun-test`.
30508
30557
  *
30509
30558
  * @param request DescribeHybridMonitorNamespaceListRequest
30510
30559
  * @param runtime runtime options for this request RuntimeOptions
@@ -30551,13 +30600,7 @@ export default class Client extends OpenApi {
30551
30600
  }
30552
30601
 
30553
30602
  /**
30554
- * The data retention period. Valid values:
30555
- * * cms.s1.large: Data is stored for 15 days.
30556
- * * cms.s1.xlarge: Data is stored for 32 days.
30557
- * * cms.s1.2xlarge: Data is stored for 63 days.
30558
- * * cms.s1.3xlarge: Data is stored for 93 days.
30559
- * * cms.s1.6xlarge: Data is stored for 185 days.
30560
- * * cms.s1.12xlarge: Data is stored for 376 days.
30603
+ * In this example, all namespaces within the current account are queried. The response shows that the current account has only one namespace named `aliyun-test`.
30561
30604
  *
30562
30605
  * @param request DescribeHybridMonitorNamespaceListRequest
30563
30606
  * @return DescribeHybridMonitorNamespaceListResponse
@@ -30762,12 +30805,9 @@ export default class Client extends OpenApi {
30762
30805
  }
30763
30806
 
30764
30807
  /**
30765
- * The statistical period of the metric.
30766
- * Valid values: 15, 60, 900, and 3600.
30767
- * Unit: seconds.
30768
- * >
30769
- * * If this parameter is not specified, monitoring data is queried based on the period in which metric values are reported.
30770
- * * For more information about the statistical period of a metric that is specified by the `MetricName` parameter, see [Appendix 1: Metrics](~~163515~~).
30808
+ * ## Limits
30809
+ * Each API operation can be called up to 10 times per second. An Alibaba Cloud account and the RAM users within the account share the quota.
30810
+ * > Different from [DescribeMetricList](~~51936~~), the DescribeMetricData operation provides statistical features. You can set the `Dimension` parameter to {"instanceId": "i-abcdefgh12****"} to aggregate all data of your Alibaba Cloud account. This topic provides an example to show how to query the monitoring data of the `cpu_idle` metric for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`.
30771
30811
  *
30772
30812
  * @param request DescribeMetricDataRequest
30773
30813
  * @param runtime runtime options for this request RuntimeOptions
@@ -30826,12 +30866,9 @@ export default class Client extends OpenApi {
30826
30866
  }
30827
30867
 
30828
30868
  /**
30829
- * The statistical period of the metric.
30830
- * Valid values: 15, 60, 900, and 3600.
30831
- * Unit: seconds.
30832
- * >
30833
- * * If this parameter is not specified, monitoring data is queried based on the period in which metric values are reported.
30834
- * * For more information about the statistical period of a metric that is specified by the `MetricName` parameter, see [Appendix 1: Metrics](~~163515~~).
30869
+ * ## Limits
30870
+ * Each API operation can be called up to 10 times per second. An Alibaba Cloud account and the RAM users within the account share the quota.
30871
+ * > Different from [DescribeMetricList](~~51936~~), the DescribeMetricData operation provides statistical features. You can set the `Dimension` parameter to {"instanceId": "i-abcdefgh12****"} to aggregate all data of your Alibaba Cloud account. This topic provides an example to show how to query the monitoring data of the `cpu_idle` metric for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`.
30835
30872
  *
30836
30873
  * @param request DescribeMetricDataRequest
30837
30874
  * @return DescribeMetricDataResponse
@@ -30932,8 +30969,9 @@ export default class Client extends OpenApi {
30932
30969
  }
30933
30970
 
30934
30971
  /**
30935
- * The name of the metric.
30936
- * For more information about metric names, see [Appendix 1: Metrics](~~163515~~).
30972
+ * ## Limits
30973
+ * Each API operation can be called up to 50 times per second. An Alibaba Cloud account and the RAM users within the account share the quota.
30974
+ * >This topic provides an example to show how to query the monitoring data of the `cpu_idle` metric for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. The returned result indicates that the monitoring data for the instance `i-abcdefgh12****` of the account `120886317861****` is queried at an interval of 60 seconds. The maximum, minimum, and average values of the metric are 100, 93.1, and 99.52.
30937
30975
  *
30938
30976
  * @param request DescribeMetricListRequest
30939
30977
  * @param runtime runtime options for this request RuntimeOptions
@@ -30996,8 +31034,9 @@ export default class Client extends OpenApi {
30996
31034
  }
30997
31035
 
30998
31036
  /**
30999
- * The name of the metric.
31000
- * For more information about metric names, see [Appendix 1: Metrics](~~163515~~).
31037
+ * ## Limits
31038
+ * Each API operation can be called up to 50 times per second. An Alibaba Cloud account and the RAM users within the account share the quota.
31039
+ * >This topic provides an example to show how to query the monitoring data of the `cpu_idle` metric for Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. The returned result indicates that the monitoring data for the instance `i-abcdefgh12****` of the account `120886317861****` is queried at an interval of 60 seconds. The maximum, minimum, and average values of the metric are 100, 93.1, and 99.52.
31001
31040
  *
31002
31041
  * @param request DescribeMetricListRequest
31003
31042
  * @return DescribeMetricListResponse
@@ -31008,8 +31047,7 @@ export default class Client extends OpenApi {
31008
31047
  }
31009
31048
 
31010
31049
  /**
31011
- * The namespace of the service.
31012
- * For more information, see [Appendix 1: Metrics](~~163515~~).
31050
+ * This operation is usually used with DescribeMetricList and DescribeMetricLast. For more information, see [DescribeMetricList](~~51936~~) and [DescribeMetricLast](~~51939~~).
31013
31051
  *
31014
31052
  * @param request DescribeMetricMetaListRequest
31015
31053
  * @param runtime runtime options for this request RuntimeOptions
@@ -31056,8 +31094,7 @@ export default class Client extends OpenApi {
31056
31094
  }
31057
31095
 
31058
31096
  /**
31059
- * The namespace of the service.
31060
- * For more information, see [Appendix 1: Metrics](~~163515~~).
31097
+ * This operation is usually used with DescribeMetricList and DescribeMetricLast. For more information, see [DescribeMetricList](~~51936~~) and [DescribeMetricLast](~~51939~~).
31061
31098
  *
31062
31099
  * @param request DescribeMetricMetaListRequest
31063
31100
  * @return DescribeMetricMetaListResponse
@@ -31236,7 +31273,9 @@ export default class Client extends OpenApi {
31236
31273
  }
31237
31274
 
31238
31275
  /**
31239
- * The parameters of the alert callback. The parameters are in the JSON format.
31276
+ * ## Limit
31277
+ * This operation supports only Message Service (MNS) resources.
31278
+ * >This topic provides an example on how to query the resources that are associated with an alert rule whose ID is `ae06917_75a8c43178ab66****`.
31240
31279
  *
31241
31280
  * @param request DescribeMetricRuleTargetsRequest
31242
31281
  * @param runtime runtime options for this request RuntimeOptions
@@ -31267,7 +31306,9 @@ export default class Client extends OpenApi {
31267
31306
  }
31268
31307
 
31269
31308
  /**
31270
- * The parameters of the alert callback. The parameters are in the JSON format.
31309
+ * ## Limit
31310
+ * This operation supports only Message Service (MNS) resources.
31311
+ * >This topic provides an example on how to query the resources that are associated with an alert rule whose ID is `ae06917_75a8c43178ab66****`.
31271
31312
  *
31272
31313
  * @param request DescribeMetricRuleTargetsRequest
31273
31314
  * @return DescribeMetricRuleTargetsResponse
@@ -31278,7 +31319,7 @@ export default class Client extends OpenApi {
31278
31319
  }
31279
31320
 
31280
31321
  /**
31281
- * The operation that you want to perform. Set the value to DescribeMetricRuleTemplateAttribute.
31322
+ * This topic provides an example to show how to query the details of an alert template whose ID is `70****`.
31282
31323
  *
31283
31324
  * @param request DescribeMetricRuleTemplateAttributeRequest
31284
31325
  * @param runtime runtime options for this request RuntimeOptions
@@ -31313,7 +31354,7 @@ export default class Client extends OpenApi {
31313
31354
  }
31314
31355
 
31315
31356
  /**
31316
- * The operation that you want to perform. Set the value to DescribeMetricRuleTemplateAttribute.
31357
+ * This topic provides an example to show how to query the details of an alert template whose ID is `70****`.
31317
31358
  *
31318
31359
  * @param request DescribeMetricRuleTemplateAttributeRequest
31319
31360
  * @return DescribeMetricRuleTemplateAttributeResponse
@@ -31921,7 +31962,8 @@ export default class Client extends OpenApi {
31921
31962
  }
31922
31963
 
31923
31964
  /**
31924
- * The operation that you want to perform. Set the value to DescribeMonitoringAgentProcesses.
31965
+ * > Before you call this operation, call the CreateMonitoringAgentProcess operation to create processes. For more information, see [CreateMonitoringAgentProcess](~~114951~~~).
31966
+ * This topic provides an example of how to query the processes of the `i-hp3hl3cx1pbahzy8****` instance. The response indicates the details of the `NGINX` and `HTTP` processes.
31925
31967
  *
31926
31968
  * @param request DescribeMonitoringAgentProcessesRequest
31927
31969
  * @param runtime runtime options for this request RuntimeOptions
@@ -31952,7 +31994,8 @@ export default class Client extends OpenApi {
31952
31994
  }
31953
31995
 
31954
31996
  /**
31955
- * The operation that you want to perform. Set the value to DescribeMonitoringAgentProcesses.
31997
+ * > Before you call this operation, call the CreateMonitoringAgentProcess operation to create processes. For more information, see [CreateMonitoringAgentProcess](~~114951~~~).
31998
+ * This topic provides an example of how to query the processes of the `i-hp3hl3cx1pbahzy8****` instance. The response indicates the details of the `NGINX` and `HTTP` processes.
31956
31999
  *
31957
32000
  * @param request DescribeMonitoringAgentProcessesRequest
31958
32001
  * @return DescribeMonitoringAgentProcessesResponse
@@ -32031,7 +32074,7 @@ export default class Client extends OpenApi {
32031
32074
  }
32032
32075
 
32033
32076
  /**
32034
- * The operation that you want to perform. Set the value to DescribeProductResourceTagKeyList.
32077
+ * > If a tag is attached to multiple cloud resources in the region, the key of the tag is returned only once.
32035
32078
  *
32036
32079
  * @param request DescribeProductResourceTagKeyListRequest
32037
32080
  * @param runtime runtime options for this request RuntimeOptions
@@ -32062,7 +32105,7 @@ export default class Client extends OpenApi {
32062
32105
  }
32063
32106
 
32064
32107
  /**
32065
- * The operation that you want to perform. Set the value to DescribeProductResourceTagKeyList.
32108
+ * > If a tag is attached to multiple cloud resources in the region, the key of the tag is returned only once.
32066
32109
  *
32067
32110
  * @param request DescribeProductResourceTagKeyListRequest
32068
32111
  * @return DescribeProductResourceTagKeyListResponse
@@ -32145,7 +32188,7 @@ export default class Client extends OpenApi {
32145
32188
  }
32146
32189
 
32147
32190
  /**
32148
- * The operation that you want to perform. Set the value to DescribeSiteMonitorAttribute.
32191
+ * This topic provides an example on how to query the details of a site monitoring task whose ID is `cc641dff-c19d-45f3-ad0a-818a0c4f****`. The returned result indicates that the task name is `test123`, the URL that is monitored by the task is `https://aliyun.com`, and the name of the carrier is `Alibaba`.
32149
32192
  *
32150
32193
  * @param request DescribeSiteMonitorAttributeRequest
32151
32194
  * @param runtime runtime options for this request RuntimeOptions
@@ -32180,7 +32223,7 @@ export default class Client extends OpenApi {
32180
32223
  }
32181
32224
 
32182
32225
  /**
32183
- * The operation that you want to perform. Set the value to DescribeSiteMonitorAttribute.
32226
+ * This topic provides an example on how to query the details of a site monitoring task whose ID is `cc641dff-c19d-45f3-ad0a-818a0c4f****`. The returned result indicates that the task name is `test123`, the URL that is monitored by the task is `https://aliyun.com`, and the name of the carrier is `Alibaba`.
32184
32227
  *
32185
32228
  * @param request DescribeSiteMonitorAttributeRequest
32186
32229
  * @return DescribeSiteMonitorAttributeResponse
@@ -32306,7 +32349,7 @@ export default class Client extends OpenApi {
32306
32349
  }
32307
32350
 
32308
32351
  /**
32309
- * The content of the HTTP request.
32352
+ * This topic provides an example on how to query all the site monitoring tasks of your Alibaba Cloud account. In this example, the returned result indicates that the Alibaba Cloud account has one site monitoring task named `HanZhou_ECS2`.
32310
32353
  *
32311
32354
  * @param request DescribeSiteMonitorListRequest
32312
32355
  * @param runtime runtime options for this request RuntimeOptions
@@ -32357,7 +32400,7 @@ export default class Client extends OpenApi {
32357
32400
  }
32358
32401
 
32359
32402
  /**
32360
- * The content of the HTTP request.
32403
+ * This topic provides an example on how to query all the site monitoring tasks of your Alibaba Cloud account. In this example, the returned result indicates that the Alibaba Cloud account has one site monitoring task named `HanZhou_ECS2`.
32361
32404
  *
32362
32405
  * @param request DescribeSiteMonitorListRequest
32363
32406
  * @return DescribeSiteMonitorListResponse
@@ -32477,6 +32520,13 @@ export default class Client extends OpenApi {
32477
32520
  return await this.describeSiteMonitorQuotaWithOptions(request, runtime);
32478
32521
  }
32479
32522
 
32523
+ /**
32524
+ * This topic provides an example to show how to query the statistics of the `Availability` metric for a site monitoring task whose ID is `ef4cdc8b-9dc7-43e7-810e-f950e56c****`. The result indicates that the availability rate of the site is `100%`.
32525
+ *
32526
+ * @param request DescribeSiteMonitorStatisticsRequest
32527
+ * @param runtime runtime options for this request RuntimeOptions
32528
+ * @return DescribeSiteMonitorStatisticsResponse
32529
+ */
32480
32530
  async describeSiteMonitorStatisticsWithOptions(request: DescribeSiteMonitorStatisticsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeSiteMonitorStatisticsResponse> {
32481
32531
  Util.validateModel(request);
32482
32532
  let query = { };
@@ -32513,6 +32563,12 @@ export default class Client extends OpenApi {
32513
32563
  return $tea.cast<DescribeSiteMonitorStatisticsResponse>(await this.callApi(params, req, runtime), new DescribeSiteMonitorStatisticsResponse({}));
32514
32564
  }
32515
32565
 
32566
+ /**
32567
+ * This topic provides an example to show how to query the statistics of the `Availability` metric for a site monitoring task whose ID is `ef4cdc8b-9dc7-43e7-810e-f950e56c****`. The result indicates that the availability rate of the site is `100%`.
32568
+ *
32569
+ * @param request DescribeSiteMonitorStatisticsRequest
32570
+ * @return DescribeSiteMonitorStatisticsResponse
32571
+ */
32516
32572
  async describeSiteMonitorStatistics(request: DescribeSiteMonitorStatisticsRequest): Promise<DescribeSiteMonitorStatisticsResponse> {
32517
32573
  let runtime = new $Util.RuntimeOptions({ });
32518
32574
  return await this.describeSiteMonitorStatisticsWithOptions(request, runtime);
@@ -32588,7 +32644,7 @@ export default class Client extends OpenApi {
32588
32644
  }
32589
32645
 
32590
32646
  /**
32591
- * The operation that you want to perform. Set the value to DescribeSystemEventCount.
32647
+ * This topic provides an example on how to query the number of times that a system event occurred for Elastic Compute Service (`ECS`). The returned result indicates that the number of times that the specified system event occurred is 3.
32592
32648
  *
32593
32649
  * @param request DescribeSystemEventCountRequest
32594
32650
  * @param runtime runtime options for this request RuntimeOptions
@@ -32651,7 +32707,7 @@ export default class Client extends OpenApi {
32651
32707
  }
32652
32708
 
32653
32709
  /**
32654
- * The operation that you want to perform. Set the value to DescribeSystemEventCount.
32710
+ * This topic provides an example on how to query the number of times that a system event occurred for Elastic Compute Service (`ECS`). The returned result indicates that the number of times that the specified system event occurred is 3.
32655
32711
  *
32656
32712
  * @param request DescribeSystemEventCountRequest
32657
32713
  * @return DescribeSystemEventCountResponse
@@ -32778,7 +32834,7 @@ export default class Client extends OpenApi {
32778
32834
  }
32779
32835
 
32780
32836
  /**
32781
- * The operation that you want to perform. Set the value to DescribeTagValueList.
32837
+ * This topic provides an example of how to query the tag values corresponding to `tagKey1`. The return results are `tagValue1` and `tagValue2`.
32782
32838
  *
32783
32839
  * @param request DescribeTagValueListRequest
32784
32840
  * @param runtime runtime options for this request RuntimeOptions
@@ -32817,7 +32873,7 @@ export default class Client extends OpenApi {
32817
32873
  }
32818
32874
 
32819
32875
  /**
32820
- * The operation that you want to perform. Set the value to DescribeTagValueList.
32876
+ * This topic provides an example of how to query the tag values corresponding to `tagKey1`. The return results are `tagValue1` and `tagValue2`.
32821
32877
  *
32822
32878
  * @param request DescribeTagValueListRequest
32823
32879
  * @return DescribeTagValueListResponse
@@ -33180,9 +33236,8 @@ export default class Client extends OpenApi {
33180
33236
  }
33181
33237
 
33182
33238
  /**
33183
- * Indicates whether the call was successful. Valid values:
33184
- * * true: The call was successful.
33185
- * * false: The call failed.
33239
+ * ## Prerequisites
33240
+ * The Cloud Assistant client is installed on an ECS instance. For more information about how to install the Cloud Assistant client, see [Overview](~~64601~~).
33186
33241
  *
33187
33242
  * @param request InstallMonitoringAgentRequest
33188
33243
  * @param runtime runtime options for this request RuntimeOptions
@@ -33221,9 +33276,8 @@ export default class Client extends OpenApi {
33221
33276
  }
33222
33277
 
33223
33278
  /**
33224
- * Indicates whether the call was successful. Valid values:
33225
- * * true: The call was successful.
33226
- * * false: The call failed.
33279
+ * ## Prerequisites
33280
+ * The Cloud Assistant client is installed on an ECS instance. For more information about how to install the Cloud Assistant client, see [Overview](~~64601~~).
33227
33281
  *
33228
33282
  * @param request InstallMonitoringAgentRequest
33229
33283
  * @return InstallMonitoringAgentResponse
@@ -33395,9 +33449,7 @@ export default class Client extends OpenApi {
33395
33449
  }
33396
33450
 
33397
33451
  /**
33398
- * Indicates whether the call was successful. Valid values:
33399
- * * true: The call was successful.
33400
- * * false: The call failed.
33452
+ * This topic provides an example on how to change the data retention period of the `aliyun` namespace to `cms.s1.2xlarge`. The response shows that the namespace is modified.
33401
33453
  *
33402
33454
  * @param request ModifyHybridMonitorNamespaceRequest
33403
33455
  * @param runtime runtime options for this request RuntimeOptions
@@ -33436,9 +33488,7 @@ export default class Client extends OpenApi {
33436
33488
  }
33437
33489
 
33438
33490
  /**
33439
- * Indicates whether the call was successful. Valid values:
33440
- * * true: The call was successful.
33441
- * * false: The call failed.
33491
+ * This topic provides an example on how to change the data retention period of the `aliyun` namespace to `cms.s1.2xlarge`. The response shows that the namespace is modified.
33442
33492
  *
33443
33493
  * @param request ModifyHybridMonitorNamespaceRequest
33444
33494
  * @return ModifyHybridMonitorNamespaceResponse
@@ -33449,8 +33499,7 @@ export default class Client extends OpenApi {
33449
33499
  }
33450
33500
 
33451
33501
  /**
33452
- * The Log Service projects.
33453
- * Valid values of N: 1 to 25.
33502
+ * In this example, a Logstore group named `Logstore_test` is modified. The Logstore of the `aliyun-project` project in the `cn-hangzhou` region is changed to `Logstore-aliyun-all`. The response shows that the Logstore group is modified.
33454
33503
  *
33455
33504
  * @param request ModifyHybridMonitorSLSGroupRequest
33456
33505
  * @param runtime runtime options for this request RuntimeOptions
@@ -33489,8 +33538,7 @@ export default class Client extends OpenApi {
33489
33538
  }
33490
33539
 
33491
33540
  /**
33492
- * The Log Service projects.
33493
- * Valid values of N: 1 to 25.
33541
+ * In this example, a Logstore group named `Logstore_test` is modified. The Logstore of the `aliyun-project` project in the `cn-hangzhou` region is changed to `Logstore-aliyun-all`. The response shows that the Logstore group is modified.
33494
33542
  *
33495
33543
  * @param request ModifyHybridMonitorSLSGroupRequest
33496
33544
  * @return ModifyHybridMonitorSLSGroupResponse
@@ -33632,9 +33680,7 @@ export default class Client extends OpenApi {
33632
33680
  }
33633
33681
 
33634
33682
  /**
33635
- * Indicates whether the call was successful. Valid values:
33636
- * * true: The call was successful.
33637
- * * false: The call failed.
33683
+ * This topic provides an example on how to modify an alert template whose version is `1` and ID is `123456`. The alert level is changed to `Critical`. The statistical method is changed to `Average`. The alert threshold comparator is changed to `GreaterThanOrEqualToThreshold`. The alert threshold is changed to `90`. The number of alert retries is changed to `3`. The response shows that the alert template is modified.
33638
33684
  *
33639
33685
  * @param request ModifyMetricRuleTemplateRequest
33640
33686
  * @param runtime runtime options for this request RuntimeOptions
@@ -33681,9 +33727,7 @@ export default class Client extends OpenApi {
33681
33727
  }
33682
33728
 
33683
33729
  /**
33684
- * Indicates whether the call was successful. Valid values:
33685
- * * true: The call was successful.
33686
- * * false: The call failed.
33730
+ * This topic provides an example on how to modify an alert template whose version is `1` and ID is `123456`. The alert level is changed to `Critical`. The statistical method is changed to `Average`. The alert threshold comparator is changed to `GreaterThanOrEqualToThreshold`. The alert threshold is changed to `90`. The number of alert retries is changed to `3`. The response shows that the alert template is modified.
33687
33731
  *
33688
33732
  * @param request ModifyMetricRuleTemplateRequest
33689
33733
  * @return ModifyMetricRuleTemplateResponse
@@ -33914,7 +33958,7 @@ export default class Client extends OpenApi {
33914
33958
  }
33915
33959
 
33916
33960
  /**
33917
- * The operation that you want to perform. Set the value to PutContactGroup.
33961
+ * This topic provides an example on how to create an alert contact group named `ECS_Group`.
33918
33962
  *
33919
33963
  * @param request PutContactGroupRequest
33920
33964
  * @param runtime runtime options for this request RuntimeOptions
@@ -33957,7 +34001,7 @@ export default class Client extends OpenApi {
33957
34001
  }
33958
34002
 
33959
34003
  /**
33960
- * The operation that you want to perform. Set the value to PutContactGroup.
34004
+ * This topic provides an example on how to create an alert contact group named `ECS_Group`.
33961
34005
  *
33962
34006
  * @param request PutContactGroupRequest
33963
34007
  * @return PutContactGroupResponse
@@ -33997,7 +34041,7 @@ export default class Client extends OpenApi {
33997
34041
  }
33998
34042
 
33999
34043
  /**
34000
- * The operation that you want to perform. Set the value to PutCustomEventRule.
34044
+ * Before you call this operation, call the PutCustomEvent operation to report the monitoring data of the custom event. For more information, see [PutCustomEvent](~~115012~~).
34001
34045
  *
34002
34046
  * @param request PutCustomEventRuleRequest
34003
34047
  * @param runtime runtime options for this request RuntimeOptions
@@ -34068,7 +34112,7 @@ export default class Client extends OpenApi {
34068
34112
  }
34069
34113
 
34070
34114
  /**
34071
- * The operation that you want to perform. Set the value to PutCustomEventRule.
34115
+ * Before you call this operation, call the PutCustomEvent operation to report the monitoring data of the custom event. For more information, see [PutCustomEvent](~~115012~~).
34072
34116
  *
34073
34117
  * @param request PutCustomEventRuleRequest
34074
34118
  * @return PutCustomEventRuleResponse
@@ -34079,11 +34123,7 @@ export default class Client extends OpenApi {
34079
34123
  }
34080
34124
 
34081
34125
  /**
34082
- * The dimensions that specify the resources whose monitoring data you want to query. Valid values of N: 1 to 21.
34083
- * Set the value to a collection of key-value pairs. Format:`{"Key":"Value"}`.
34084
- * The key or value must be 1 to 64 bytes in length. Excessive characters are truncated.
34085
- * The key or value can contain letters, digits, periods (.), hyphens (-), underscores (\\_), forward slashes (/), and backslashes (\\\\).
34086
- * > Dimensions must be formatted as a JSON string in a specified order.
34126
+ * > We recommend that you call the [PutHybridMonitorMetricData](~~383455~~) operation of Hybrid Cloud Monitoring to report monitoring data.
34087
34127
  *
34088
34128
  * @param request PutCustomMetricRequest
34089
34129
  * @param runtime runtime options for this request RuntimeOptions
@@ -34114,11 +34154,7 @@ export default class Client extends OpenApi {
34114
34154
  }
34115
34155
 
34116
34156
  /**
34117
- * The dimensions that specify the resources whose monitoring data you want to query. Valid values of N: 1 to 21.
34118
- * Set the value to a collection of key-value pairs. Format:`{"Key":"Value"}`.
34119
- * The key or value must be 1 to 64 bytes in length. Excessive characters are truncated.
34120
- * The key or value can contain letters, digits, periods (.), hyphens (-), underscores (\\_), forward slashes (/), and backslashes (\\\\).
34121
- * > Dimensions must be formatted as a JSON string in a specified order.
34157
+ * > We recommend that you call the [PutHybridMonitorMetricData](~~383455~~) operation of Hybrid Cloud Monitoring to report monitoring data.
34122
34158
  *
34123
34159
  * @param request PutCustomMetricRequest
34124
34160
  * @return PutCustomMetricResponse
@@ -34129,7 +34165,7 @@ export default class Client extends OpenApi {
34129
34165
  }
34130
34166
 
34131
34167
  /**
34132
- * The operation that you want to perform. Set the value to PutCustomMetricRule.
34168
+ * Before you call this operation, call the PutCustomMetric operation to report custom monitoring data. For more information, see [PutCustomMetric](~~115004~~).
34133
34169
  *
34134
34170
  * @param request PutCustomMetricRuleRequest
34135
34171
  * @param runtime runtime options for this request RuntimeOptions
@@ -34220,7 +34256,7 @@ export default class Client extends OpenApi {
34220
34256
  }
34221
34257
 
34222
34258
  /**
34223
- * The operation that you want to perform. Set the value to PutCustomMetricRule.
34259
+ * Before you call this operation, call the PutCustomMetric operation to report custom monitoring data. For more information, see [PutCustomMetric](~~115004~~).
34224
34260
  *
34225
34261
  * @param request PutCustomMetricRuleRequest
34226
34262
  * @return PutCustomMetricRuleResponse
@@ -34231,7 +34267,8 @@ export default class Client extends OpenApi {
34231
34267
  }
34232
34268
 
34233
34269
  /**
34234
- * The ID of the application group to which the event-triggered alert rule belongs.
34270
+ * If the specified rule name does not exist, an event-triggered alert rule is created. If the specified rule name exists, the specified event-triggered alert rule is modified.
34271
+ * In this example, the `myRuleName` alert rule is created for the `ecs` cloud service.
34235
34272
  *
34236
34273
  * @param request PutEventRuleRequest
34237
34274
  * @param runtime runtime options for this request RuntimeOptions
@@ -34286,7 +34323,8 @@ export default class Client extends OpenApi {
34286
34323
  }
34287
34324
 
34288
34325
  /**
34289
- * The ID of the application group to which the event-triggered alert rule belongs.
34326
+ * If the specified rule name does not exist, an event-triggered alert rule is created. If the specified rule name exists, the specified event-triggered alert rule is modified.
34327
+ * In this example, the `myRuleName` alert rule is created for the `ecs` cloud service.
34290
34328
  *
34291
34329
  * @param request PutEventRuleRequest
34292
34330
  * @return PutEventRuleResponse
@@ -34623,7 +34661,7 @@ export default class Client extends OpenApi {
34623
34661
  }
34624
34662
 
34625
34663
  /**
34626
- * The name of the log field that is used for matching in the filter condition. Valid values of N: 1 to 10.
34664
+ * In the example of this topic, the `cpu_total` log monitoring metric is created. The response shows that the log monitoring metric is created and the metric ID is `16****`.
34627
34665
  *
34628
34666
  * @param request PutLogMonitorRequest
34629
34667
  * @param runtime runtime options for this request RuntimeOptions
@@ -34702,7 +34740,7 @@ export default class Client extends OpenApi {
34702
34740
  }
34703
34741
 
34704
34742
  /**
34705
- * The name of the log field that is used for matching in the filter condition. Valid values of N: 1 to 10.
34743
+ * In the example of this topic, the `cpu_total` log monitoring metric is created. The response shows that the log monitoring metric is created and the metric ID is `16****`.
34706
34744
  *
34707
34745
  * @param request PutLogMonitorRequest
34708
34746
  * @return PutLogMonitorResponse
@@ -34713,9 +34751,8 @@ export default class Client extends OpenApi {
34713
34751
  }
34714
34752
 
34715
34753
  /**
34716
- * Indicates whether the call was successful. Valid values:
34717
- * * true: The call was successful.
34718
- * * false: The call failed.
34754
+ * ## Limit
34755
+ * This operation supports only Message Service (MNS) resources.
34719
34756
  *
34720
34757
  * @param request PutMetricRuleTargetsRequest
34721
34758
  * @param runtime runtime options for this request RuntimeOptions
@@ -34750,9 +34787,8 @@ export default class Client extends OpenApi {
34750
34787
  }
34751
34788
 
34752
34789
  /**
34753
- * Indicates whether the call was successful. Valid values:
34754
- * * true: The call was successful.
34755
- * * false: The call failed.
34790
+ * ## Limit
34791
+ * This operation supports only Message Service (MNS) resources.
34756
34792
  *
34757
34793
  * @param request PutMetricRuleTargetsRequest
34758
34794
  * @return PutMetricRuleTargetsResponse
@@ -34953,9 +34989,7 @@ export default class Client extends OpenApi {
34953
34989
  }
34954
34990
 
34955
34991
  /**
34956
- * Indicates whether the call was successful. Valid values:
34957
- * * true: The call was successful.
34958
- * * false: The call failed.
34992
+ * This topic provides an example on how to create a threshold-triggered alert rule for the `cpu_total` metric of the `i-uf6j91r34rnwawoo****` instance that belongs to Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. In this example, the alert contact group of the alert rule is `ECS_Group`, the name of the alert rule is `test123`, and the ID of the alert rule is `a151cd6023eacee2f0978e03863cc1697c89508****`. The statistical method for Critical-level alerts is `Average`, the comparison operator for Critical-level alerts is `GreaterThanOrEqualToThreshold`, the threshold for Critical-level alerts is `90`, and the consecutive number of times for which the metric value is measured before a Critical-level alert is triggered is `3`.
34959
34993
  *
34960
34994
  * @param request PutResourceMetricRulesRequest
34961
34995
  * @param runtime runtime options for this request RuntimeOptions
@@ -34986,9 +35020,7 @@ export default class Client extends OpenApi {
34986
35020
  }
34987
35021
 
34988
35022
  /**
34989
- * Indicates whether the call was successful. Valid values:
34990
- * * true: The call was successful.
34991
- * * false: The call failed.
35023
+ * This topic provides an example on how to create a threshold-triggered alert rule for the `cpu_total` metric of the `i-uf6j91r34rnwawoo****` instance that belongs to Elastic Compute Service (ECS). The namespace of ECS is `acs_ecs_dashboard`. In this example, the alert contact group of the alert rule is `ECS_Group`, the name of the alert rule is `test123`, and the ID of the alert rule is `a151cd6023eacee2f0978e03863cc1697c89508****`. The statistical method for Critical-level alerts is `Average`, the comparison operator for Critical-level alerts is `GreaterThanOrEqualToThreshold`, the threshold for Critical-level alerts is `90`, and the consecutive number of times for which the metric value is measured before a Critical-level alert is triggered is `3`.
34992
35024
  *
34993
35025
  * @param request PutResourceMetricRulesRequest
34994
35026
  * @return PutResourceMetricRulesResponse
@@ -35032,8 +35064,7 @@ export default class Client extends OpenApi {
35032
35064
  }
35033
35065
 
35034
35066
  /**
35035
- * The name of the cloud service.
35036
- * > For information about the system events supported by Cloud Monitor for Alibaba Cloud services, see [System events](~~167388~~).
35067
+ * This operation is used to test whether a system event can be triggered as expected. You can call this operation to simulate a system event and check whether an expected response is returned after an alert is triggered by the system event.
35037
35068
  *
35038
35069
  * @param request SendDryRunSystemEventRequest
35039
35070
  * @param runtime runtime options for this request RuntimeOptions
@@ -35076,8 +35107,7 @@ export default class Client extends OpenApi {
35076
35107
  }
35077
35108
 
35078
35109
  /**
35079
- * The name of the cloud service.
35080
- * > For information about the system events supported by Cloud Monitor for Alibaba Cloud services, see [System events](~~167388~~).
35110
+ * This operation is used to test whether a system event can be triggered as expected. You can call this operation to simulate a system event and check whether an expected response is returned after an alert is triggered by the system event.
35081
35111
  *
35082
35112
  * @param request SendDryRunSystemEventRequest
35083
35113
  * @return SendDryRunSystemEventResponse
@@ -35088,7 +35118,7 @@ export default class Client extends OpenApi {
35088
35118
  }
35089
35119
 
35090
35120
  /**
35091
- * The operation that you want to perform. Set the value to UninstallMonitoringAgent.
35121
+ * > This API operation is not applicable to ECS instances. To uninstall the agent from an ECS instance, see [Install and uninstall the Cloud Monitor agent](~~183482~~).
35092
35122
  *
35093
35123
  * @param request UninstallMonitoringAgentRequest
35094
35124
  * @param runtime runtime options for this request RuntimeOptions
@@ -35119,7 +35149,7 @@ export default class Client extends OpenApi {
35119
35149
  }
35120
35150
 
35121
35151
  /**
35122
- * The operation that you want to perform. Set the value to UninstallMonitoringAgent.
35152
+ * > This API operation is not applicable to ECS instances. To uninstall the agent from an ECS instance, see [Install and uninstall the Cloud Monitor agent](~~183482~~).
35123
35153
  *
35124
35154
  * @param request UninstallMonitoringAgentRequest
35125
35155
  * @return UninstallMonitoringAgentResponse