@alicloud/cms20190101 4.0.8 → 4.0.10

package/src/models/PutLogMonitorRequest.ts

@@ -15,7 +15,7 @@ export class PutLogMonitorRequestAggregates extends $dara.Model {
   alias?: string;
   /**
    * @remarks
-   * The name of the field to be aggregated. Valid values of N: 1 to 10.
+   * The name of the original field for aggregation. Valid values of N: 1 to 10.
    * 
    * This parameter is required.
    * 
@@ -25,16 +25,15 @@ export class PutLogMonitorRequestAggregates extends $dara.Model {
   fieldName?: string;
   /**
    * @remarks
-   * The function that is used to aggregate log data within a statistical period. Valid values of N: 1 to 10. Valid values:
-   * 
-   * *   count: counts the number.
-   * *   sum: calculates the total value.
-   * *   avg: calculates the average value.
-   * *   max: calculates the maximum value.
-   * *   min: calculates the minimum value.
-   * *   countps: calculates the number of values of the specified field divided by the total number of seconds within a statistical period.
-   * *   sumps: calculates the sum of the values of the specified field divided by the total number of seconds within a statistical period.
-   * *   distinct: calculates the number of unique values of the specified field within a statistical period.
+   * The statistical method used to aggregate log data within a statistical period. Valid values of N: 1 to 10. Valid values:
+   * - count: counts the number of occurrences.
+   * - sum: calculates the sum.
+   * - avg: calculates the average.
+   * - max: returns the maximum value.
+   * - min: returns the minimum value.
+   * - countps: calculates the average count per second for the specified field within the statistical period.
+   * - sumps: calculates the average sum per second for the specified field within the statistical period.
+   * - distinct: counts the number of occurrences of the specified field after deduplication within the statistical period.
    * 
    * This parameter is required.
    * 
@@ -70,7 +69,7 @@ export class PutLogMonitorRequestAggregates extends $dara.Model {
 export class PutLogMonitorRequestGroupbys extends $dara.Model {
   /**
    * @remarks
-   * The alias of the dimension based on which the data is grouped. Valid values of N: 1 to 10.
+   * The alias of the Group By field. Valid values of N: 1 to 10.
    * 
    * @example
    * CPUUtilization
@@ -78,7 +77,7 @@ export class PutLogMonitorRequestGroupbys extends $dara.Model {
   alias?: string;
   /**
    * @remarks
-   * The name of the field that is specified as the dimension. Valid values of N: 1 to 10.
+   * The name of the Group By field. Valid values of N: 1 to 10.
    * 
    * @example
    * cpu
@@ -110,7 +109,7 @@ export class PutLogMonitorRequestGroupbys extends $dara.Model {
 export class PutLogMonitorRequestValueFilter extends $dara.Model {
   /**
    * @remarks
-   * The name of the log field that is used for matching in the filter condition. Valid values of N: 1 to 10.
+   * The name of the log field to match. Valid values of N: 1 to 10.
    * 
    * @example
    * lh_source
@@ -118,14 +117,13 @@ export class PutLogMonitorRequestValueFilter extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The method that is used to match the field value. Valid values of N: 1 to 10. Valid values:
-   * 
-   * *   `contain`: contains
-   * *   `notContain`: does not contain
-   * *   `>`: greater than
-   * *   `<`: less than
-   * *   `>=`: greater than or equal to
-   * *   `<=`: less than or equal to
+   * The matching method for the field value. Valid values of N: 1 to 10. Valid values:
+   * - `contain`: contains.
+   * - `notContain`: does not contain.
+   * - `>`: greater than.
+   * - `<`: less than.
+   * - `>=`: greater than or equal to.
+   * - `<=`: less than or equal to.
    * 
    * @example
    * contain
@@ -133,7 +131,7 @@ export class PutLogMonitorRequestValueFilter extends $dara.Model {
   operator?: string;
   /**
    * @remarks
-   * The field value to be matched in the filter condition. Valid values of N: 1 to 10.
+   * The value of the log field to match. Valid values of N: 1 to 10.
    * 
    * @example
    * test
@@ -167,7 +165,7 @@ export class PutLogMonitorRequestValueFilter extends $dara.Model {
 export class PutLogMonitorRequest extends $dara.Model {
   /**
    * @remarks
-   * The aggregation logic.
+   * The aggregate function definitions.
    * 
    * This parameter is required.
    */
@@ -182,7 +180,7 @@ export class PutLogMonitorRequest extends $dara.Model {
   groupId?: string;
   /**
    * @remarks
-   * The dimension based on which the data is grouped. This parameter is equivalent to the GROUP BY clause in SQL statements. If no dimension is specified, all data is aggregated based on the aggregate function.
+   * The dimensions used for spatial aggregation. This is equivalent to the Group By clause in SQL, which groups monitoring data by specified dimensions. If no dimension is specified, all monitoring data is aggregated based on the aggregate function.
    */
   groupbys?: PutLogMonitorRequestGroupbys[];
   /**
@@ -195,15 +193,17 @@ export class PutLogMonitorRequest extends $dara.Model {
   logId?: string;
   /**
    * @remarks
-   * The extended field. The extended field allows you to perform basic operations on the aggregation results.
+   * The extended field. The extended field provides arithmetic operations on the results of the statistical methods.
+   * 
+   * For example, if you configure the total number of HTTP status code requests (TotalNumber) and the number of requests with HTTP status codes greater than 499 (5xxNumber) in the statistical methods, you can use the extended field to calculate the server error rate: 5xxNumber/TotalNumber*100.
    * 
-   * For example, you have calculated TotalNumber and 5XXNumber by aggregating the data. TotalNumber indicates the total number of HTTP requests, and 5XXNumber indicates the number of HTTP requests whose status code is greater than 499. You can calculate the server error rate by adding the following formula to the extended field: 5XXNumber/TotalNumber\\*100.
+   * JSON format: {"extend":{"errorPercent":"5xxNumber/TotalNumber*100"}}. Field description:
    * 
-   * JSON format: {"extend":{"errorPercent":"5XXNumber/TotalNumber\\*100"}}. Description:
+   * - extend: required.
    * 
-   * *   extend: required.
-   * *   errorPercent: the alias of the field generated in the calculation result. You can specify the alias as needed.
-   * *   5XXNumber/TotalNumber\\*100: the calculation expression.
+   * - errorPercent: the alias of the new field generated from the calculation result. You can specify a custom name. 
+   * 
+   * - errorPercent: the calculation expression for existing fields.
    * 
    * @example
    * {"extend":{"errorPercent":"5XXNumber/TotalNumber*100"}}
@@ -211,7 +211,7 @@ export class PutLogMonitorRequest extends $dara.Model {
   metricExpress?: string;
   /**
    * @remarks
-   * The metric name. For more information about the metrics for cloud services, see [Appendix 1: Metrics](https://help.aliyun.com/document_detail/163515.html).
+   * The metric name. For information about the metrics supported by CloudMonitor for Alibaba Cloud services, see [Cloud service monitoring metrics](https://help.aliyun.com/document_detail/163515.html).
    * 
    * This parameter is required.
    * 
@@ -222,7 +222,7 @@ export class PutLogMonitorRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The name of the Simple Log Service Logstore.
+   * The name of the Log Service Logstore.
    * 
    * This parameter is required.
    * 
@@ -232,7 +232,7 @@ export class PutLogMonitorRequest extends $dara.Model {
   slsLogstore?: string;
   /**
    * @remarks
-   * The name of the Simple Log Service project.
+   * The name of the Log Service project.
    * 
    * This parameter is required.
    * 
@@ -242,7 +242,7 @@ export class PutLogMonitorRequest extends $dara.Model {
   slsProject?: string;
   /**
    * @remarks
-   * The region in which the Simple Log Service project resides.
+   * The region where the Log Service project resides.
    * 
    * This parameter is required.
    * 
@@ -252,7 +252,7 @@ export class PutLogMonitorRequest extends $dara.Model {
   slsRegionId?: string;
   /**
    * @remarks
-   * The size of the tumbling window for calculation. Unit: seconds. CloudMonitor performs aggregation for each tumbling window.
+   * The tumbling window size for pre-aggregation. Unit: seconds. CloudMonitor performs an aggregation calculation on the data at the specified interval.
    * 
    * @example
    * 60,300
@@ -268,17 +268,18 @@ export class PutLogMonitorRequest extends $dara.Model {
   unit?: string;
   /**
    * @remarks
-   * The condition that is used to filter logs. The ValueFilter and ValueFilterRelation parameters are used in pair. The filter condition is equivalent to the WHERE clause in SQL statements. If no filter condition is specified, all logs are processed. For example, logs contain the Level and Error fields. If you need to calculate the number of times that logs of the Error level appear every minute, you can set the filter condition to Level=Error and count the number of logs that meet this condition.
+   * The filter rules, used together with ValueFilterRelation. This is equivalent to the Where clause in SQL. If this parameter is not specified, all data is processed. For example, if the log contains Level and Error fields and you want to count the number of Error occurrences per minute, you can define the statistical method to sum the Level field with the condition Level=Error.
    */
   valueFilter?: PutLogMonitorRequestValueFilter[];
   /**
    * @remarks
-   * The logical operator that is used between log filter conditions. Valid values:
+   * The logical operator used to combine log filter conditions. Valid values:
+   * 
+   * - and
    * 
-   * *   and
-   * *   or
+   * - or
    * 
-   * >  The ValueFilterRelation and `ValueFilter.N.Key` parameters must be used in pair.
+   * > This parameter must be used together with `ValueFilter.N.Key`.
    * 
    * This parameter is required.
    * 

package/src/models/PutLogMonitorResponseBody.ts

@@ -7,7 +7,7 @@ export class PutLogMonitorResponseBody extends $dara.Model {
    * @remarks
    * The HTTP status code.
    * 
-   * >  The status code 200 indicates that the request was successful.
+   * > 200 indicates success.
    * 
    * @example
    * 200
@@ -23,10 +23,11 @@ export class PutLogMonitorResponseBody extends $dara.Model {
   logId?: string;
   /**
    * @remarks
-   * The returned message.
+   * The returned message. Results:
    * 
-   * *   If the request was successful, `successful` is returned.
-   * *   If the request failed, an error message is returned. Example: `alias of aggreate must be set value.`
+   * - If the operation is successful, `successful` is returned.
+   * 
+   * - If the operation fails, an error message is returned, such as `alias of aggreate must be set value.`.
    * 
    * @example
    * successful
@@ -42,10 +43,11 @@ export class PutLogMonitorResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * Indicates whether the operation is successful. Valid values:
+   * 
+   * - true: The operation is successful.
    * 
-   * *   true
-   * *   false
+   * - false: The operation failed.
    * 
    * @example
    * true

package/src/models/PutMetricRuleTargetsRequest.ts

@@ -5,37 +5,35 @@ import * as $dara from '@darabonba/typescript';
 export class PutMetricRuleTargetsRequestTargets extends $dara.Model {
   /**
    * @remarks
-   * The Alibaba Cloud Resource Name (ARN) of the resource. Simple Message Queue (formerly MNS) (SMQ), Auto Scaling, Simple Log Service, and Function Compute are supported.
+   * The Alibaba Cloud Resource Name (ARN) of the resource. Simple Message Queue (formerly MNS), elastic scaling (ESS), Simple Log Service (SLS), and Function Compute (FC) are supported.
    * 
-   * The following part describes the ARN of SMQ and the parameters in the ARN:
+   * The following section describes the ARN parameter metric description for Simple Message Queue (formerly MNS):
    * 
-   * `acs:mns:{regionId}:{userId}:/{Resource type}/{Resource name}/message`.
+   * `acs:mns:{regionId}:{userId}:/{Resource type}/{Resource name}/message`
    * 
-   * *   {regionId}: the region ID of the SMQ queue or topic.
+   * - {regionId}: the region where the MSMQ or topic of Simple Message Queue (formerly MNS) resides.
+   * - {userId}: the Alibaba Cloud account that owns the resource.
+   * - {Resource type}: the type of the resource that accepts alert notifications. Valid values:
    * 
-   * *   {userId}: the ID of the Alibaba Cloud account that owns the resource.
+   *   - **queues**: queue.
+   *   - **topics**: topic.
    * 
-   * *   {Resource type}: the type of the resource for which alerts are triggered. Valid values:
+   * - {Resource name}: the name of the resource.
    * 
-   *     *   **queues**
-   *     *   **topics**
+   *   - If the resource type is **queues**, the resource name is the queue name.
+   *   - If the resource type is **topics**, the resource name is the topic name.
    * 
-   * *   {Resource name}: the resource name.
-   * 
-   *     *   If the resource type is **queues**, the resource name is the queue name.
-   *     *   If the resource type is **topics**, the resource name is the topic name.
-   * 
-   * ARN of Auto Scaling:
+   * ARN for elastic scaling:
    * 
    * acs:ess:{regionId}:{userId}:scalingGroupId/{Scaling group ID}:scalingRuleId/{Scaling rule ID}
    * 
-   * ARN of Simple Log Service:
+   * ARN for Simple Log Service:
    * 
    * acs:log:{regionId}:{userId}:project/{Project name}/logstore/{Logstore name}
    * 
-   * ARN of Function Compute:
+   * ARN for Function Compute:
    * 
-   * acs:fc:{regionId}:{userId}:services/{Service name}/functions/{Function name}
+   * acs:fc:{regionId}:{userId}:services/{Service name}/functions/{Function name}.
    * 
    * This parameter is required.
    * 
@@ -45,9 +43,9 @@ export class PutMetricRuleTargetsRequestTargets extends $dara.Model {
   arn?: string;
   /**
    * @remarks
-   * The ID of the resource for which alerts are triggered.
+   * The ID of the alert trigger target.
    * 
-   * For more information about how to obtain the ID of the resource for which alerts are triggered, see [DescribeMetricRuleTargets](https://help.aliyun.com/document_detail/121592.html).
+   * For information about how to obtain the alert trigger target ID, see [DescribeMetricRuleTargets](https://help.aliyun.com/document_detail/121592.html).
    * 
    * This parameter is required.
    * 
@@ -57,7 +55,7 @@ export class PutMetricRuleTargetsRequestTargets extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The parameters of the alert callback. The parameters are in the JSON format.
+   * The JSON-formatted parameters of the alert callback.
    * 
    * @example
    * {"customField1":"value1","customField2":"$.name"}
@@ -67,9 +65,9 @@ export class PutMetricRuleTargetsRequestTargets extends $dara.Model {
    * @remarks
    * The alert level. Valid values:
    * 
-   * *   INFO
-   * *   WARN
-   * *   CRITICAL
+   * - INFO: information.
+   * - WARN: warning.
+   * - CRITICAL: critical.
    * 
    * @example
    * ["INFO", "WARN", "CRITICAL"]
@@ -108,7 +106,7 @@ export class PutMetricRuleTargetsRequest extends $dara.Model {
    * @remarks
    * The ID of the alert rule.
    * 
-   * For information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](https://help.aliyun.com/document_detail/114941.html).
+   * For information about how to obtain the alert rule ID, see [DescribeMetricRuleList](https://help.aliyun.com/document_detail/114941.html).
    * 
    * This parameter is required.
    * 

package/src/models/PutMetricRuleTargetsResponseBody.ts

@@ -3,49 +3,8 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class PutMetricRuleTargetsResponseBodyFailDataTargetsTarget extends $dara.Model {
-  /**
-   * @remarks
-   * The ARN of the resource. Format: `acs:{Service name abbreviation}:{regionId}:{userId}:/{Resource type}/{Resource name}/message`. SMQ, Auto Scaling, Simple Log Service, and Function Compute are supported. Example: `acs:mns:cn-hangzhou:120886317861****:/queues/test123/message`. The following part describes the ARN of SMQ and the parameters in the ARN:
-   * 
-   * *   {Service name abbreviation}: mns.
-   * 
-   * *   {userId}: the ID of the Alibaba Cloud account.
-   * 
-   * *   {regionId}: the region ID of the SMQ queue or topic.
-   * 
-   * *   {Resource type}: the type of the resource for which alerts are triggered. Valid values:
-   * 
-   *     *   **queues**
-   *     *   **topics**
-   * 
-   * *   {Resource name}: the resource name.
-   * 
-   *     *   If the resource type is **queues**, the resource name is the queue name.
-   *     *   If the resource type is **topics**, the resource name is the topic name.
-   * 
-   * @example
-   * acs:mns:cn-hangzhou:111:/queues/test/message
-   */
   arn?: string;
-  /**
-   * @remarks
-   * The ID of the resource for which alerts are triggered.
-   * 
-   * @example
-   * 1
-   */
   id?: string;
-  /**
-   * @remarks
-   * The alert level. Valid values:
-   * 
-   * *   INFO
-   * *   WARN
-   * *   CRITICAL
-   * 
-   * @example
-   * ["INFO", "WARN", "CRITICAL"]
-   */
   level?: string;
   static names(): { [key: string]: string } {
     return {
@@ -99,10 +58,6 @@ export class PutMetricRuleTargetsResponseBodyFailDataTargets extends $dara.Model
 }
 
 export class PutMetricRuleTargetsResponseBodyFailData extends $dara.Model {
-  /**
-   * @remarks
-   * The information about the resources for which alerts are triggered.
-   */
   targets?: PutMetricRuleTargetsResponseBodyFailDataTargets;
   static names(): { [key: string]: string } {
     return {
@@ -133,7 +88,7 @@ export class PutMetricRuleTargetsResponseBody extends $dara.Model {
    * @remarks
    * The HTTP status code.
    * 
-   * >  The status code 200 indicates that the request was successful.
+   * > The value 200 indicates success.
    * 
    * @example
    * 200
@@ -141,12 +96,12 @@ export class PutMetricRuleTargetsResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The failed data.
+   * The list of failures.
    */
   failData?: PutMetricRuleTargetsResponseBodyFailData;
   /**
    * @remarks
-   * The error message returned.
+   * The error message.
    * 
    * @example
    * The request processing has failed due to some unknown error.
@@ -162,10 +117,11 @@ export class PutMetricRuleTargetsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * Indicates whether the operation was successful. Valid values:
+   * 
+   * - true: successful.
    * 
-   * *   true: The request was successful.
-   * *   false: The request failed.
+   * - false: failed.
    * 
    * @example
    * true

package/src/models/PutMonitorGroupDynamicRuleRequest.ts

@@ -7,10 +7,13 @@ export class PutMonitorGroupDynamicRuleRequestGroupRulesFilters extends $dara.Mo
    * @remarks
    * The method that is used to filter instances. Valid values of N: 1 to 3. Valid values:
    * 
-   * *   contains: contains
-   * *   notContains: does not contain
-   * *   startWith: starts with a prefix
-   * *   endWith: ends with a suffix
+   * - contains: contains
+   * 
+   * - notContains: does not contain
+   * 
+   * - startWith: starts with a prefix
+   * 
+   * - endWith: ends with a suffix
    * 
    * This parameter is required.
    * 
@@ -70,9 +73,11 @@ export class PutMonitorGroupDynamicRuleRequestGroupRules extends $dara.Model {
    * @remarks
    * The cloud service to which the alert rule is applied. Valid values of N: 1 to 3. Valid values:
    * 
-   * *   ecs: Elastic Compute Service (ECS)
-   * *   rds: ApsaraDB RDS
-   * *   slb: Server Load Balancer (SLB)
+   * - ecs: Elastic Compute Service (ECS)
+   * 
+   * - rds: ApsaraDB RDS
+   * 
+   * - slb: Server Load Balancer (SLB)
    * 
    * This parameter is required.
    * 
@@ -84,8 +89,9 @@ export class PutMonitorGroupDynamicRuleRequestGroupRules extends $dara.Model {
    * @remarks
    * The logical operator used between conditional expressions in the alert rule. Valid values of N: 1 to 3. Valid values:
    * 
-   * *   and: The instances that meet all the conditional expressions are automatically added to the application group.
-   * *   or: The instances that meet one of the conditional expressions are automatically added to the application group.
+   * - and: The instances that meet all the conditional expressions are automatically added to the application group.
+   * 
+   * - or: The instances that meet one of the conditional expressions are automatically added to the application group.
    * 
    * This parameter is required.
    * 
@@ -150,8 +156,9 @@ export class PutMonitorGroupDynamicRuleRequest extends $dara.Model {
    * @remarks
    * The mode for creating the alert rule. Valid values:
    * 
-   * *   true: creates asynchronously
-   * *   false (default): creates synchronously
+   * - true: creates asynchronously
+   * 
+   * - false (default): creates synchronously
    * 
    * @example
    * false

package/src/models/PutMonitorGroupDynamicRuleResponseBody.ts

@@ -33,8 +33,9 @@ export class PutMonitorGroupDynamicRuleResponseBody extends $dara.Model {
    * @remarks
    * Indicates whether the request was successful. Valid values:
    * 
-   * *   true
-   * *   false
+   * - true
+   * 
+   * - false
    * 
    * @example
    * true

package/src/models/PutMonitoringConfigRequest.ts

@@ -15,8 +15,9 @@ export class PutMonitoringConfigRequest extends $dara.Model {
    * @remarks
    * Specifies whether to automatically install the CloudMonitor agent on new ECS instances. Valid values:
    * 
-   * *   true (default): The CloudMonitor agent is automatically installed on new ECS instances.
-   * *   false: The CloudMonitor agent is not automatically installed on new ECS instances.
+   * - true (default): The CloudMonitor agent is automatically installed on new ECS instances.
+   * 
+   * - false: The CloudMonitor agent is not automatically installed on new ECS instances.
    * 
    * @example
    * true

package/src/models/PutMonitoringConfigResponseBody.ts

@@ -7,7 +7,7 @@ export class PutMonitoringConfigResponseBody extends $dara.Model {
    * @remarks
    * The HTTP status code.
    * 
-   * >  The status code 200 indicates that the request was successful.
+   * > The status code 200 indicates that the request was successful.
    * 
    * @example
    * 200
@@ -33,8 +33,9 @@ export class PutMonitoringConfigResponseBody extends $dara.Model {
    * @remarks
    * Indicates whether the request was successful. Valid values:
    * 
-   * *   true
-   * *   false
+   * - true
+   * 
+   * - false
    * 
    * @example
    * true