@alicloud/esa20240910 2.32.1 → 2.34.0

package/src/models/CreateVideoProcessingRequest.ts

@@ -4,52 +4,90 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateVideoProcessingRequest extends $dara.Model {
   /**
+   * @remarks
+   * Set custom end parameters for FLV files.
+   * 
    * @example
    * end
    */
   flvSeekEnd?: string;
   /**
+   * @remarks
+   * The custom start parameter for FLV files.
+   * 
    * @example
    * start
    */
   flvSeekStart?: string;
   /**
+   * @remarks
+   * FLV seeking. Valid values:
+   * 
+   * *   by_byte: seek by byte
+   * *   by_time: seek by time.
+   * 
    * @example
    * by_byte
    */
   flvVideoSeekMode?: string;
   /**
+   * @remarks
+   * Customize the mp4 end parameter.
+   * 
    * @example
    * end
    */
   mp4SeekEnd?: string;
   /**
+   * @remarks
+   * Customize the mp4 start parameter.
+   * 
    * @example
    * start
    */
   mp4SeekStart?: string;
   /**
+   * @remarks
+   * The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:
+   * 
+   * *   true: Match all incoming requests.
+   * *   Set the value to a custom expression, for example:(http.host eq "video.example.com"): Match the specified request.
+   * 
    * @example
    * (http.host eq \\"video.example.com\\")
    */
   rule?: string;
   /**
+   * @remarks
+   * Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Specifies whether to check the image used by the instance supports hot migration. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   ruleEnable?: string;
   /**
+   * @remarks
+   * The name of the scheduling rule. You do not need to set this parameter when you add global configuration.
+   * 
    * @example
    * rule_example
    */
   ruleName?: string;
   /**
+   * @remarks
+   * The order in which the rule is executed. A smaller value gives priority to the rule.
+   * 
    * @example
    * 1
    */
   sequence?: number;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -57,11 +95,20 @@ export class CreateVideoProcessingRequest extends $dara.Model {
    */
   siteId?: number;
   /**
+   * @remarks
+   * The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.
+   * 
    * @example
    * 1
    */
   siteVersion?: number;
   /**
+   * @remarks
+   * Video seeking. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */

package/src/models/CreateVideoProcessingResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateVideoProcessingResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The configuration ID.
+   * 
    * @example
    * 352816**********
    */
   configId?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * CB1A380B-09F0-41BB-280B-72F8FD6DA2FE
    */

package/src/models/DeleteHttpIncomingRequestHeaderModificationRuleRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteHttpIncomingRequestHeaderModificationRuleRequest extends $dara.Model {
   /**
    * @remarks
+   * The configuration ID. You can call the ListHttpIncomingRequestHeaderModificationRules operation to query the ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DeleteHttpIncomingRequestHeaderModificationRuleRequest extends $dar
   configId?: number;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DeleteHttpIncomingRequestHeaderModificationRuleResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteHttpIncomingRequestHeaderModificationRuleResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * C370DAF1-C838-4288-A1A0-9A87633D248E
    */

package/src/models/DeleteHttpIncomingResponseHeaderModificationRuleRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteHttpIncomingResponseHeaderModificationRuleRequest extends $dara.Model {
   /**
    * @remarks
+   * The configuration ID. You can call the ListHttpIncomingResponseHeaderModificationRules operation to query the ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DeleteHttpIncomingResponseHeaderModificationRuleRequest extends $da
   configId?: number;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DeleteHttpIncomingResponseHeaderModificationRuleResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteHttpIncomingResponseHeaderModificationRuleResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 15C66C7B-671A-4297-9187-2C4477247A74
    */

package/src/models/DeleteRoutineRouteRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteRoutineRouteRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the configuration. You can call the [ListSiteRoutes](https://help.aliyun.com/document_detail/2879631.html) operation to obtain the ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DeleteRoutineRouteRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DeleteRoutineRouteResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteRoutineRouteResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 0AEDAF20-4DDF-4165-8750-47FF9C1929C9
    */

package/src/models/DeleteUrlObservationRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteUrlObservationRequest extends $dara.Model {
   /**
    * @remarks
+   * The configuration ID, which can be obtained by calling the [ListUrlObservations](~~ListUrlObservations~~) operation.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DeleteUrlObservationRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DeleteVideoProcessingRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteVideoProcessingRequest extends $dara.Model {
   /**
    * @remarks
+   * The configuration ID. You can call the [ListVideoProcessings](~~ListVideoProcessings~~) operation to obtain the ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DeleteVideoProcessingRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DeleteVideoProcessingResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteVideoProcessingResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 6abd807e-ed2a-44de-ac54-ac38a62472e6
    */

package/src/models/DescribeEdgeContainerAppStatsRequest.ts

@@ -40,6 +40,9 @@ export class DescribeEdgeContainerAppStatsRequest extends $dara.Model {
    */
   startTime?: string;
   /**
+   * @remarks
+   * The tenant ID.
+   * 
    * @example
    * t-xxxx
    */

package/src/models/DescribeEdgeContainerAppStatsResponseBody.ts

@@ -79,12 +79,61 @@ export class DescribeEdgeContainerAppStatsResponseBodyPoints extends $dara.Model
 }
 
 export class DescribeEdgeContainerAppStatsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Average CPU limit ratio
+   * 
+   * @example
+   * 0.1
+   */
   cpuUsageSecondsQuotaRateAvg?: number;
+  /**
+   * @remarks
+   * Average number of CPU cores
+   * 
+   * @example
+   * 2
+   */
   cpuUsageSecondsTotalAvg?: number;
+  /**
+   * @remarks
+   * Average read IO
+   * 
+   * @example
+   * 0
+   */
   fsReadsBytesAvgAvg?: number;
+  /**
+   * @remarks
+   * Average write IO
+   * 
+   * @example
+   * 0
+   */
   fsWritesBytesAvgAvg?: number;
+  /**
+   * @remarks
+   * Average memory usage
+   * 
+   * @example
+   * 0.1
+   */
   memoryRssAvg?: number;
+  /**
+   * @remarks
+   * Average memory limit proportion
+   * 
+   * @example
+   * 1
+   */
   memoryRssQuotaRateAvg?: number;
+  /**
+   * @remarks
+   * Average PodReady rate
+   * 
+   * @example
+   * 100
+   */
   podReadyRateAvg?: number;
   points?: DescribeEdgeContainerAppStatsResponseBodyPoints[];
   /**

package/src/models/DescribeSiteLogsRequest.ts

@@ -4,22 +4,37 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeSiteLogsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The end of the time range to query.
+   * 
+   * The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
+   * 
+   * >  The end time must be later than the start time.
+   * 
    * @example
    * 2022-11-06T17:00:00Z
    */
   endTime?: string;
   /**
+   * @remarks
+   * The page number. Pages start from page 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page. Default value: 300. Valid values: 1 to 1000.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
    * @remarks
+   * The ID of the website. You can call the ListSites operation to obtain.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -27,6 +42,11 @@ export class DescribeSiteLogsRequest extends $dara.Model {
    */
   siteId?: number;
   /**
+   * @remarks
+   * The beginning of the time range to query.
+   * 
+   * The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
+   * 
    * @example
    * 2022-11-06T16:00:00Z
    */

package/src/models/DescribeSiteLogsResponseBody.ts

@@ -4,26 +4,43 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeSiteLogsResponseBodySiteLogDetailsLogInfos extends $dara.Model {
   /**
+   * @remarks
+   * The end time.
+   * 
    * @example
    * 2022-11-06T17:00:00Z
    */
   endTime?: string;
   /**
+   * @remarks
+   * The name of the log file.
+   * 
    * @example
    * example.com_2022_11_07_000000_020000.gz.xxxxxx
    */
   logName?: string;
   /**
+   * @remarks
+   * The log path.
+   * 
+   * >  Take note of the Expires field (expiration timestamp) in this parameter. If the log download URL expires, you must reobtain the URL.
+   * 
    * @example
    * example.aliyundoc.com /v1.l1cache/105252530/example.com/2022_11_07/example.com_2022_11_07_000000_020000.gz.xxxxxx?Expires=1636963354&OSSAccessKeyId=LTAIviCc6zy8****&Signature=u0V6foRfZniHE8i%2BHUdxGOhZsK****
    */
   logPath?: string;
   /**
+   * @remarks
+   * The size of the log file. Unit: bytes.
+   * 
    * @example
    * 438304768
    */
   logSize?: number;
   /**
+   * @remarks
+   * The create time.
+   * 
    * @example
    * 2022-11-06T16:00:00Z
    */
@@ -59,16 +76,25 @@ export class DescribeSiteLogsResponseBodySiteLogDetailsLogInfos extends $dara.Mo
 
 export class DescribeSiteLogsResponseBodySiteLogDetailsPageInfos extends $dara.Model {
   /**
+   * @remarks
+   * The page number returned.
+   * 
    * @example
    * 1
    */
   pageIndex?: number;
   /**
+   * @remarks
+   * The number of entries per page. Default value: **300**. Valid values: **1 to 1000**.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The total number of entries returned.
+   * 
    * @example
    * 47
    */
@@ -100,18 +126,35 @@ export class DescribeSiteLogsResponseBodySiteLogDetailsPageInfos extends $dara.M
 
 export class DescribeSiteLogsResponseBodySiteLogDetails extends $dara.Model {
   /**
+   * @remarks
+   * The total number of entries returned on the current page.
+   * 
    * @example
    * 300
    */
   logCount?: number;
+  /**
+   * @remarks
+   * The details of the website log files.
+   */
   logInfos?: DescribeSiteLogsResponseBodySiteLogDetailsLogInfos[];
+  /**
+   * @remarks
+   * Pagination information.
+   */
   pageInfos?: DescribeSiteLogsResponseBodySiteLogDetailsPageInfos;
   /**
+   * @remarks
+   * The website ID.
+   * 
    * @example
    * 123456***
    */
   siteId?: number;
   /**
+   * @remarks
+   * The website name.
+   * 
    * @example
    * example.com
    */
@@ -154,12 +197,16 @@ export class DescribeSiteLogsResponseBodySiteLogDetails extends $dara.Model {
 export class DescribeSiteLogsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * 0AEDAF20-4DDF-4165-8750-47FF9C1929C9
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The information about the website log files.
+   */
   siteLogDetails?: DescribeSiteLogsResponseBodySiteLogDetails[];
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeSiteTimeSeriesDataRequest.ts

@@ -3,8 +3,17 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeSiteTimeSeriesDataRequestFields extends $dara.Model {
+  /**
+   * @remarks
+   * Query dimension.
+   */
   dimension?: string[];
   /**
+   * @remarks
+   * Query metric value.
+   * 
+   * > For specific dimensions, see [Data Analysis Field Description](https://help.aliyun.com/document_detail/2878520.html).
+   * 
    * @example
    * Traffic
    */
@@ -37,26 +46,50 @@ export class DescribeSiteTimeSeriesDataRequestFields extends $dara.Model {
 
 export class DescribeSiteTimeSeriesDataRequest extends $dara.Model {
   /**
+   * @remarks
+   * The end time for obtaining data.
+   * 
+   * The date format follows ISO8601 notation and uses UTC+0 time, in the format yyyy-MM-ddTHH:mm:ssZ.
+   * 
+   * > The end time must be later than the start time.
+   * 
    * @example
    * 2023-04-09T16:00:00Z
    */
   endTime?: string;
   /**
    * @remarks
+   * Query metrics.
+   * 
    * This parameter is required.
    */
   fields?: DescribeSiteTimeSeriesDataRequestFields[];
   /**
+   * @remarks
+   * The time granularity for querying data, in seconds.
+   * 
+   * Depending on the maximum time span of a single query, this parameter supports values of 60 (1 minute), 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For details, see the **Supported Query Time Granularities**.
+   * 
    * @example
    * 300
    */
   interval?: string;
   /**
+   * @remarks
+   * Site ID. Obtain the site ID by calling the [ListSites](~~ListSites~~) interface.
+   * 
+   * If this parameter is empty, user-level data will be queried.
+   * 
    * @example
    * 1150376036*****
    */
   siteId?: string;
   /**
+   * @remarks
+   * The start time for obtaining data.
+   * 
+   * The date format follows ISO8601 notation and uses UTC+0 time, in the format yyyy-MM-ddTHH:mm:ssZ.
+   * 
    * @example
    * 2023-04-08T16:00:00Z
    */