@alicloud/cms20190101 4.0.9 → 4.0.10

package/src/models/PutCustomMetricRuleRequest.ts

@@ -5,14 +5,19 @@ import * as $dara from '@darabonba/typescript';
 export class PutCustomMetricRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The operator that is used to compare the metric value with the threshold. Valid values:
+   * The comparison operator for the threshold. Valid values:
    * 
-   * *   `>=`
-   * *   `=`
-   * *   `<=`
-   * *   `>`
-   * *   `<`
-   * *   `!=`
+   * - `>=`
+   * 
+   * - `=`
+   * 
+   * - `<=`
+   * 
+   * - `>`
+   * 
+   * - `<`
+   * 
+   * - `!=`.
    * 
    * This parameter is required.
    * 
@@ -22,7 +27,7 @@ export class PutCustomMetricRuleRequest extends $dara.Model {
   comparisonOperator?: string;
   /**
    * @remarks
-   * The alert contact groups. Separate multiple alert contact groups with commas (,).
+   * The alert contact group. Separate multiple alert contact groups with commas (,).
    * 
    * This parameter is required.
    * 
@@ -32,7 +37,7 @@ export class PutCustomMetricRuleRequest extends $dara.Model {
   contactGroups?: string;
   /**
    * @remarks
-   * The period of time during which the alert rule is effective. Valid values: 00:00 to 23:59.
+   * The effective time range of the alert rule. Valid values: 00:00-23:59.
    * 
    * @example
    * 00:00-23:59
@@ -40,12 +45,15 @@ export class PutCustomMetricRuleRequest extends $dara.Model {
   effectiveInterval?: string;
   /**
    * @remarks
-   * The subject of the alert notification email.
+   * The subject of the alert email.
+   * 
+   * @example
+   * ECS instance
    */
   emailSubject?: string;
   /**
    * @remarks
-   * The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.
+   * The number of alert retries.
    * 
    * This parameter is required.
    * 
@@ -57,7 +65,7 @@ export class PutCustomMetricRuleRequest extends $dara.Model {
    * @remarks
    * The ID of the application group to which the custom monitoring data belongs.
    * 
-   * >  The value 0 indicates that the reported custom monitoring data does not belong to an application group.
+   * > A value of 0 indicates that the reported custom monitoring data does not belong to any application group.
    * 
    * @example
    * 7378****
@@ -66,10 +74,9 @@ export class PutCustomMetricRuleRequest extends $dara.Model {
   /**
    * @remarks
    * The alert level. Valid values:
-   * 
-   * *   CRITICAL
-   * *   WARN
-   * *   INFO
+   * - CRITICAL: critical.
+   * - WARN: warning.
+   * - INFO: information.
    * 
    * This parameter is required.
    * 
@@ -81,7 +88,7 @@ export class PutCustomMetricRuleRequest extends $dara.Model {
    * @remarks
    * The metric name.
    * 
-   * >  For more information about how to obtain the metric name, see [DescribeCustomMetricList](https://help.aliyun.com/document_detail/115005.html).
+   * > For more information about how to obtain the metric name, see [DescribeCustomMetricList](https://help.aliyun.com/document_detail/115005.html).
    * 
    * This parameter is required.
    * 
@@ -91,7 +98,7 @@ export class PutCustomMetricRuleRequest extends $dara.Model {
   metricName?: string;
   /**
    * @remarks
-   * The cycle that is used to aggregate custom monitoring data. Unit: seconds Set the value to an integral multiple of 60. The original reporting cycle of custom monitoring data is used by default.
+   * The aggregation period of the custom monitoring data. Unit: seconds. Set the value to 60 or a multiple of 60. Default value: the original reporting period of the custom monitoring data.
    * 
    * @example
    * 300
@@ -99,7 +106,7 @@ export class PutCustomMetricRuleRequest extends $dara.Model {
   period?: string;
   /**
    * @remarks
-   * The custom monitoring data to which the alert rule applies. The value includes the application group ID to which the custom monitoring data belongs and the dimension to which the metric belongs.
+   * The custom monitoring data to which the alert rule applies. The value consists of the application group ID to which the custom monitoring data belongs and the dimensions of the metric.
    * 
    * This parameter is required.
    * 
@@ -111,7 +118,7 @@ export class PutCustomMetricRuleRequest extends $dara.Model {
    * @remarks
    * The ID of the alert rule.
    * 
-   * >  You can specify an existing ID to modify the corresponding alert rule or specify a new ID to create an alert rule.
+   * > If the alert rule ID already exists, the alert rule is modified. If the alert rule ID does not exist, an alert rule is created.
    * 
    * This parameter is required.
    * 
@@ -129,9 +136,9 @@ export class PutCustomMetricRuleRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Default value: 86400, which is equivalent to one day.
+   * The mute for period. Unit: seconds. Default value: 86400 (1 day).
    * 
-   * >  Only one alert notification is sent during each mute period even if the metric value exceeds the alert threshold several times.
+   * > If the monitoring data continuously exceeds the alert threshold, only one alert notification is sent within each mute for period.
    * 
    * @example
    * 86400
@@ -139,7 +146,7 @@ export class PutCustomMetricRuleRequest extends $dara.Model {
   silenceTime?: number;
   /**
    * @remarks
-   * The method used to calculate the metric value based on which alerts are triggered.
+   * The statistical method for alerts.
    * 
    * This parameter is required.
    * 
@@ -159,7 +166,7 @@ export class PutCustomMetricRuleRequest extends $dara.Model {
   threshold?: string;
   /**
    * @remarks
-   * The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.
+   * The alert callback URL. An HTTP POST request is sent to the specified URL when an alert is triggered.
    * 
    * @example
    * https://www.aliyun.com

package/src/models/PutCustomMetricRuleResponseBody.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class PutCustomMetricRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * 状态码。
    * 
-   * >  The status code 200 indicates that the request was successful.
+   * > 200表示成功。
    * 
    * @example
    * 200
@@ -15,7 +15,7 @@ export class PutCustomMetricRuleResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The returned message. If the request was successful, the return value is null. If the request failed, an error message is returned.
+   * 返回信息。接口调用成功时，返回为空；接口调用失败时，返回失败原因。
    * 
    * @example
    * ComparisonOperator is mandatory for this action.
@@ -23,7 +23,7 @@ export class PutCustomMetricRuleResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The request ID.
+   * 请求ID。
    * 
    * @example
    * 65D50468-ECEF-48F1-A6E1-D952E89D9432
@@ -31,10 +31,11 @@ export class PutCustomMetricRuleResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * 操作是否成功。取值：
    * 
-   * *   true
-   * *   false
+   * - true：成功。
+   * 
+   * - false：失败。
    * 
    * @example
    * true

package/src/models/PutEventRuleRequest.ts

@@ -5,32 +5,57 @@ import * as $dara from '@darabonba/typescript';
 export class PutEventRuleRequestEventPattern extends $dara.Model {
   /**
    * @remarks
-   * The keyword that is used to filter events. If the content of an event contains the specified keyword, an alert is automatically triggered.
+   * The keyword for event filtering. When the event content contains this keyword, an alert is automatically triggered.
    * 
    * @example
    * Stopping
    */
   customFilters?: string;
   /**
+   * @remarks
+   * The type of the Event-triggered Alert Rule. Valid values of N: 1 to 50. Valid values:
+   * 
+   * - StatusNotification: fault notification.
+   * 
+   * - Exception: exception.
+   * 
+   * - Maintenance: O&M.
+   * 
+   * - \\*: unlimited.
+   * 
    * @example
    * Exception
    */
   eventTypeList?: string[];
   /**
+   * @remarks
+   * The level of the Event-triggered Alert Rule. Valid values of N: 1 to 50. Valid values:
+   * 
+   * - CRITICAL: critical.
+   * 
+   * - WARN: warning.
+   * 
+   * - INFO: information.
+   * 
+   * - \\*: all levels.
+   * 
    * @example
    * CRITICAL
    */
   levelList?: string[];
   /**
+   * @remarks
+   * The name of the Event-triggered Alert Rule. Valid values of N: 1 to 50.
+   * 
    * @example
    * Agent_Status_Stopped
    */
   nameList?: string[];
   /**
    * @remarks
-   * The type of the cloud service. Valid values of N: 1 to 50.
+   * The Alibaba Cloud service type. Valid values of N: 1 to 50.
    * 
-   * >  You can call the DescribeSystemEventMetaList operation to query the cloud services that support event-triggered alerts. For more information, see [DescribeSystemEventMetaList](https://help.aliyun.com/document_detail/114972.html).
+   * >For information about the Alibaba Cloud services supported by Event-triggered Alert Rules, see [DescribeSystemEventMetaList](https://help.aliyun.com/document_detail/114972.html).
    * 
    * This parameter is required.
    * 
@@ -40,15 +65,17 @@ export class PutEventRuleRequestEventPattern extends $dara.Model {
   product?: string;
   /**
    * @remarks
-   * The SQL condition that is used to filter events. If the content of an event meets the specified SQL condition, an alert is automatically triggered.
-   * 
-   * >  The syntax of SQL event filtering is consistent with the query syntax of Log Service.
+   * The SQL filter for events. When the event content meets the SQL condition, an alert is automatically triggered.
+   * > The syntax of the SQL event filter is consistent with the query syntax of Simple Log Service (SLS).
    * 
    * @example
    * 192.168.XX.XX and Executed
    */
   SQLFilter?: string;
   /**
+   * @remarks
+   * The status of the Event-triggered Alert Rule. Valid values of N: 1 to 50.
+   * 
    * @example
    * Failed
    */
@@ -101,20 +128,25 @@ export class PutEventRuleRequestEventPattern extends $dara.Model {
 export class PutEventRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The description of the event-triggered alert rule.
+   * The description of the Event-triggered Alert Rule.
+   * 
+   * @example
+   * Event alert test
    */
   description?: string;
   /**
    * @remarks
+   * The pattern of the Event-triggered Alert Rule.
+   * 
    * This parameter is required.
    */
   eventPattern?: PutEventRuleRequestEventPattern[];
   /**
    * @remarks
-   * The type of the event-triggered alert rule. Valid values:
+   * The type of the Event-triggered Alert Rule. Valid values:
    * 
-   * *   SYSTEM: system event-triggered alert rule
-   * *   CUSTOM: custom event-triggered alert rule
+   * - SYSTEM: system event.
+   * - CUSTOM: custom event.
    * 
    * @example
    * SYSTEM
@@ -122,7 +154,7 @@ export class PutEventRuleRequest extends $dara.Model {
   eventType?: string;
   /**
    * @remarks
-   * The ID of the application group to which the event-triggered alert rule belongs.
+   * The ID of the application group to which the Event-triggered Alert Rule belongs.
    * 
    * @example
    * 7378****
@@ -131,7 +163,7 @@ export class PutEventRuleRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The name of the event-triggered alert rule.
+   * The name of the Event-triggered Alert Rule.
    * 
    * This parameter is required.
    * 
@@ -141,7 +173,7 @@ export class PutEventRuleRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The mute period during which new alerts are not sent even if the trigger conditions are met. Unit: seconds.
+   * The mute period. Unit: seconds.
    * 
    * @example
    * 86400
@@ -149,10 +181,10 @@ export class PutEventRuleRequest extends $dara.Model {
   silenceTime?: number;
   /**
    * @remarks
-   * The status of the event-triggered alert rule. Valid values:
+   * The status of the Event-triggered Alert Rule. Valid values:
    * 
-   * *   ENABLED: enabled
-   * *   DISABLED: disabled
+   * - ENABLED: enabled.
+   * - DISABLED: disabled.
    * 
    * @example
    * ENABLED

package/src/models/PutEventRuleResponseBody.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class PutEventRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP status code.
+   * The status code.
    * 
-   * >  The status code 200 indicates that the call was successful.
+   * >A value of 200 indicates success.
    * 
    * @example
    * 200
@@ -15,7 +15,7 @@ export class PutEventRuleResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The number of event-triggered alert rules that were created or modified.
+   * The number of rows affected when the Event-triggered Alert Rule is created or modified.
    * 
    * @example
    * 1
@@ -31,7 +31,7 @@ export class PutEventRuleResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 0B47C47B-E68A-4429-BB23-370E91889C7D
@@ -39,10 +39,11 @@ export class PutEventRuleResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the call was successful. Valid values:
+   * Indicates whether the operation was successful. Valid values:
    * 
-   * *   true: The call was successful.
-   * *   false: The call failed.
+   * - true: The operation was successful.
+   * 
+   * - false: The operation failed.
    * 
    * @example
    * true

package/src/models/PutEventRuleTargetsRequest.ts

@@ -6,11 +6,14 @@ export class PutEventRuleTargetsRequestContactParameters extends $dara.Model {
   /**
    * @remarks
    * The name of the alert contact group. Valid values of N: 1 to 5.
+   * 
+   * @example
+   * Default alert contact group
    */
   contactGroupName?: string;
   /**
    * @remarks
-   * The ID of the recipient that receives alert notifications. Valid values of N: 1 to 5.
+   * The unique identifier of the rule target. Valid values of N: 1 to 5.
    * 
    * @example
    * 2
@@ -18,12 +21,20 @@ export class PutEventRuleTargetsRequestContactParameters extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The alert notification methods. Valid values of N: 1 to 5. Valid values:
+   * The alert notification level. Valid values of N: 1 to 5. Valid values:
+   * 
+   * <props="china">- 2: phone call, text message, DingTalk, and email
+   * 
+   * <props="china">- 3: text message, DingTalk, and email
+   * 
+   * <props="china">- 4: DingTalk and email
    * 
-   * 4: Alert notifications are sent by using DingTalk and emails.
+   * <props="intl">4: DingTalk and email
+   * 
+   * <props="partner">4: DingTalk and email.
    * 
    * @example
-   * 3
+   * 4
    */
   level?: string;
   static names(): { [key: string]: string } {
@@ -62,7 +73,7 @@ export class PutEventRuleTargetsRequestFcParameters extends $dara.Model {
   functionName?: string;
   /**
    * @remarks
-   * The ID of the recipient that receives alert notifications. Valid values of N: 1 to 5.
+   * The unique identifier of the rule target. Valid values of N: 1 to 5.
    * 
    * @example
    * 1
@@ -70,7 +81,7 @@ export class PutEventRuleTargetsRequestFcParameters extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The region where Function Compute is deployed. Valid values of N: 1 to 5.
+   * The region where the Function Compute service resides. Valid values of N: 1 to 5.
    * 
    * @example
    * cn-hangzhou
@@ -78,7 +89,7 @@ export class PutEventRuleTargetsRequestFcParameters extends $dara.Model {
   region?: string;
   /**
    * @remarks
-   * The name of the Function Compute service. Valid values of N: 1 to 5.
+   * The service name of the Function Compute service. Valid values of N: 1 to 5.
    * 
    * @example
    * fc-test
@@ -114,7 +125,7 @@ export class PutEventRuleTargetsRequestFcParameters extends $dara.Model {
 export class PutEventRuleTargetsRequestMnsParameters extends $dara.Model {
   /**
    * @remarks
-   * The ID of the recipient that receives alert notifications. Valid values of N: 1 to 5.
+   * The unique identifier of the rule target. Valid values of N: 1 to 5.
    * 
    * @example
    * 3
@@ -122,7 +133,7 @@ export class PutEventRuleTargetsRequestMnsParameters extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The name of the SMQ queue. Valid values of N: 1 to 5.
+   * The name of the queue. Valid values of N: 1 to 5.
    * 
    * @example
    * queue1
@@ -130,7 +141,7 @@ export class PutEventRuleTargetsRequestMnsParameters extends $dara.Model {
   queue?: string;
   /**
    * @remarks
-   * The region for SMQ. Valid values of N: 1 to 5.
+   * The region where Simple Message Queue (formerly MNS) resides. Valid values of N: 1 to 5.
    * 
    * @example
    * cn-hangzhou
@@ -138,7 +149,7 @@ export class PutEventRuleTargetsRequestMnsParameters extends $dara.Model {
   region?: string;
   /**
    * @remarks
-   * The SMQ topic.
+   * The topic of Simple Message Queue (formerly MNS).
    * 
    * @example
    * topic_sample
@@ -182,18 +193,18 @@ export class PutEventRuleTargetsRequestOpenApiParameters extends $dara.Model {
   action?: string;
   /**
    * @remarks
-   * The Alibaba Cloud Resource Name (ARN) of the resource. Valid values of N: 1 to 5. Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Fields:
-   * 
-   * *   Service: the code of a cloud service
-   * *   Region: the region ID
-   * *   Account: the ID of an Alibaba Cloud account
-   * *   ResourceType: the resource type
-   * *   ResourceId: the resource ID
+   * The Alibaba Cloud Resource Name (ARN) of the resource. Valid values of N: 1 to 5.
+   * Format: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. The fields are described as follows:
+   *   - Service: the Alibaba Cloud service.
+   *   - Region: the region ID.
+   *   - Account: the Alibaba Cloud account ID.
+   *   - ResourceType: the resource type.
+   *   - ResourceId: the resource ID.
    */
   arn?: string;
   /**
    * @remarks
-   * The ID of the recipient that receives alert notifications sent by an API callback.
+   * The unique identifier of the API callback notification method.
    * 
    * @example
    * 3
@@ -201,7 +212,7 @@ export class PutEventRuleTargetsRequestOpenApiParameters extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The parameters of the alert callback. Specify the parameters in the JSON format.
+   * The JSON-formatted parameters of the alert callback.
    * 
    * @example
    * {"customField1":"value1","customField2":"$.name"}
@@ -209,7 +220,7 @@ export class PutEventRuleTargetsRequestOpenApiParameters extends $dara.Model {
   jsonParams?: string;
   /**
    * @remarks
-   * The ID of the cloud service to which the API operation belongs.
+   * The ID of the Alibaba Cloud service to which the API belongs.
    * 
    * @example
    * log
@@ -225,7 +236,7 @@ export class PutEventRuleTargetsRequestOpenApiParameters extends $dara.Model {
   region?: string;
   /**
    * @remarks
-   * The name of the role.
+   * The role name.
    * 
    * @example
    * MyRole
@@ -233,7 +244,7 @@ export class PutEventRuleTargetsRequestOpenApiParameters extends $dara.Model {
   role?: string;
   /**
    * @remarks
-   * The version of the API.
+   * The API version.
    * 
    * @example
    * 2019-01-01
@@ -277,7 +288,7 @@ export class PutEventRuleTargetsRequestOpenApiParameters extends $dara.Model {
 export class PutEventRuleTargetsRequestSlsParameters extends $dara.Model {
   /**
    * @remarks
-   * The ID of the recipient that receives alert notifications. Valid values of N: 1 to 5.
+   * The unique identifier of the rule target. Valid values of N: 1 to 5.
    * 
    * @example
    * 5
@@ -285,7 +296,7 @@ export class PutEventRuleTargetsRequestSlsParameters extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The name of the Simple Log Service Logstore. Valid values of N: 1 to 5.
+   * The Logstore of Simple Log Service. Valid values of N: 1 to 5.
    * 
    * @example
    * testlogstore
@@ -293,7 +304,7 @@ export class PutEventRuleTargetsRequestSlsParameters extends $dara.Model {
   logStore?: string;
   /**
    * @remarks
-   * The name of the Simple Log Service project. Valid values of N: 1 to 5.
+   * The project of Simple Log Service. Valid values of N: 1 to 5.
    * 
    * @example
    * testproject
@@ -301,7 +312,7 @@ export class PutEventRuleTargetsRequestSlsParameters extends $dara.Model {
   project?: string;
   /**
    * @remarks
-   * The region where Simple Log Service is deployed. Valid values of N: 1 to 5.
+   * The region where Simple Log Service resides. Valid values of N: 1 to 5.
    * 
    * @example
    * cn-hangzhou
@@ -337,7 +348,7 @@ export class PutEventRuleTargetsRequestSlsParameters extends $dara.Model {
 export class PutEventRuleTargetsRequestWebhookParameters extends $dara.Model {
   /**
    * @remarks
-   * The ID of the recipient that receives alert notifications. Valid values of N: 1 to 5.
+   * The unique identifier of the rule target. Valid values of N: 1 to 5.
    * 
    * @example
    * 4
@@ -345,9 +356,9 @@ export class PutEventRuleTargetsRequestWebhookParameters extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The HTTP request method. Valid values of N: 1 to 5.
+   * The request method of the HTTP callback. Valid values of N: 1 to 5.
    * 
-   * Valid values: GET and POST.
+   * Only GET and POST are supported.
    * 
    * @example
    * GET
@@ -355,11 +366,11 @@ export class PutEventRuleTargetsRequestWebhookParameters extends $dara.Model {
   method?: string;
   /**
    * @remarks
-   * The name of the protocol. Valid values of N: 1 to 5. Valid values:
+   * The protocol name. Valid values of N: 1 to 5. Valid values:
    * 
-   * *   http
-   * *   telnet
-   * *   ping
+   * - http
+   * - telnet
+   * - ping.
    * 
    * @example
    * http
@@ -403,22 +414,22 @@ export class PutEventRuleTargetsRequestWebhookParameters extends $dara.Model {
 export class PutEventRuleTargetsRequest extends $dara.Model {
   /**
    * @remarks
-   * The information about the alert contact groups that receive alert notifications.
+   * The alert contact group notification method.
    */
   contactParameters?: PutEventRuleTargetsRequestContactParameters[];
   /**
    * @remarks
-   * The information about the recipients in Function Compute.
+   * The Function Compute notification method.
    */
   fcParameters?: PutEventRuleTargetsRequestFcParameters[];
   /**
    * @remarks
-   * The notifications of Simple Message Queue (formerly MNS) (SMQ).
+   * The Simple Message Queue (formerly MNS) notification method.
    */
   mnsParameters?: PutEventRuleTargetsRequestMnsParameters[];
   /**
    * @remarks
-   * The parameters of API callback notification.
+   * The list of API callback notification parameters.
    */
   openApiParameters?: PutEventRuleTargetsRequestOpenApiParameters[];
   regionId?: string;
@@ -434,12 +445,12 @@ export class PutEventRuleTargetsRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The information about the recipients in Simple Log Service.
+   * The Simple Log Service notification method.
    */
   slsParameters?: PutEventRuleTargetsRequestSlsParameters[];
   /**
    * @remarks
-   * The information about the callback URLs that are used to receive alert notifications.
+   * The URL callback notification method.
    */
   webhookParameters?: PutEventRuleTargetsRequestWebhookParameters[];
   static names(): { [key: string]: string } {