@alicloud/esa20240910 2.33.0 → 2.34.1

package/src/models/DescribeSiteTimeSeriesDataResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeSiteTimeSeriesDataResponseBodyDataDetailData extends $dara.Model {
   /**
+   * @remarks
+   * Start timestamp of the time slice.
+   * 
    * @example
    * 2023-04-08T16:00:00Z
    */
   timeStamp?: string;
   /**
+   * @remarks
+   * Value.
+   * 
    * @example
    * 123
    */
@@ -37,18 +43,31 @@ export class DescribeSiteTimeSeriesDataResponseBodyDataDetailData extends $dara.
 }
 
 export class DescribeSiteTimeSeriesDataResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * Returned data.
+   */
   detailData?: DescribeSiteTimeSeriesDataResponseBodyDataDetailData[];
   /**
+   * @remarks
+   * Query dimension.
+   * 
    * @example
    * ALL
    */
   dimensionName?: string;
   /**
+   * @remarks
+   * Query dimension value.
+   * 
    * @example
    * ALL
    */
   dimensionValue?: string;
   /**
+   * @remarks
+   * Query metric value.
+   * 
    * @example
    * Traffic
    */
@@ -85,26 +104,41 @@ export class DescribeSiteTimeSeriesDataResponseBodyData extends $dara.Model {
 
 export class DescribeSiteTimeSeriesDataResponseBodySummarizedData extends $dara.Model {
   /**
+   * @remarks
+   * The aggregation method used.
+   * 
    * @example
    * sum
    */
   aggMethod?: string;
   /**
+   * @remarks
+   * The dimension of the aggregated data being queried.
+   * 
    * @example
    * ALL
    */
   dimensionName?: string;
   /**
+   * @remarks
+   * The value of the aggregated dimension being queried.
+   * 
    * @example
    * ALL
    */
   dimensionValue?: string;
   /**
+   * @remarks
+   * The value of the aggregated metric being queried.
+   * 
    * @example
    * Traffic
    */
   fieldName?: string;
   /**
+   * @remarks
+   * The aggregated value.
+   * 
    * @example
    * 12345
    */
@@ -139,32 +173,59 @@ export class DescribeSiteTimeSeriesDataResponseBodySummarizedData extends $dara.
 }
 
 export class DescribeSiteTimeSeriesDataResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Returned data.
+   */
   data?: DescribeSiteTimeSeriesDataResponseBodyData[];
   /**
+   * @remarks
+   * The end time for fetching the data.
+   * 
+   * The date format follows ISO8601 notation and uses UTC+0, formatted as yyyy-MM-ddTHH:mm:ssZ.
+   * 
    * @example
    * 2023-04-09T16:00:00Z
    */
   endTime?: string;
   /**
+   * @remarks
+   * The granularity of the data, in seconds.
+   * 
    * @example
    * 300
    */
   interval?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE7****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The sampling rate, in %.
+   * 
    * @example
    * 100
    */
   samplingRate?: number;
   /**
+   * @remarks
+   * The start time for fetching the data.
+   * 
+   * The date format follows ISO8601 notation and uses UTC+0, formatted as yyyy-MM-ddTHH:mm:ssZ.
+   * 
    * @example
    * 2023-04-08T16:00:00Z
    */
   startTime?: string;
+  /**
+   * @remarks
+   * Aggregated query data.
+   */
   summarizedData?: DescribeSiteTimeSeriesDataResponseBodySummarizedData[];
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeSiteTimeSeriesDataShrinkRequest.ts

@@ -4,26 +4,50 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeSiteTimeSeriesDataShrinkRequest 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.
    */
   fieldsShrink?: string;
   /**
+   * @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
    */

package/src/models/DescribeSiteTopDataRequest.ts

@@ -3,8 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeSiteTopDataRequestFields extends $dara.Model {
+  /**
+   * @remarks
+   * The dimensions at which you want to query data.
+   */
   dimension?: string[];
   /**
+   * @remarks
+   * The metric name.
+   * 
    * @example
    * Traffic
    */
@@ -37,27 +44,56 @@ export class DescribeSiteTopDataRequestFields extends $dara.Model {
 
 export class DescribeSiteTopDataRequest extends $dara.Model {
   /**
+   * @remarks
+   * The end of the time range to query.
+   * 
+   * Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
+   * 
+   * >  The end time must be later than the start time.
+   * 
    * @example
    * 2023-04-09T16:00:00Z
    */
   endTime?: string;
   /**
    * @remarks
+   * The metrics to query.
+   * 
    * This parameter is required.
    */
   fields?: DescribeSiteTopDataRequestFields[];
   /**
+   * @remarks
+   * The time interval between the data entries to return. Unit: seconds.
+   * 
    * @example
    * 300
    */
   interval?: string;
+  /**
+   * @remarks
+   * The number of top-ranking data entries to query.
+   * 
+   * @example
+   * 5
+   */
   limit?: string;
   /**
+   * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
+   * 
+   * If you do not specify this parameter, the system returns data by account.
+   * 
    * @example
    * 1150376036*****
    */
   siteId?: string;
   /**
+   * @remarks
+   * The beginning of the time range to query.
+   * 
+   * Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
+   * 
    * @example
    * 2023-04-08T16:00:00Z
    */

package/src/models/DescribeSiteTopDataResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeSiteTopDataResponseBodyDataDetailData extends $dara.Model {
   /**
+   * @remarks
+   * The dimension value.
+   * 
    * @example
    * ALL
    */
   dimensionValue?: string;
   /**
+   * @remarks
+   * The queried numeric value.
+   * 
    * @example
    * 123
    */
@@ -37,13 +43,23 @@ export class DescribeSiteTopDataResponseBodyDataDetailData extends $dara.Model {
 }
 
 export class DescribeSiteTopDataResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The returned data.
+   */
   detailData?: DescribeSiteTopDataResponseBodyDataDetailData[];
   /**
+   * @remarks
+   * The dimension at which data was queried.
+   * 
    * @example
    * ALL
    */
   dimensionName?: string;
   /**
+   * @remarks
+   * The metric name.
+   * 
    * @example
    * Traffic
    */
@@ -77,23 +93,43 @@ export class DescribeSiteTopDataResponseBodyData extends $dara.Model {
 }
 
 export class DescribeSiteTopDataResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned data.
+   */
   data?: DescribeSiteTopDataResponseBodyData[];
   /**
+   * @remarks
+   * The end of the time range during which data was queried.
+   * 
+   * The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
+   * 
    * @example
    * 2023-04-09T16:00:00Z
    */
   endTime?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 35C66C7B-671H-4297-9187-2C447724****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The sampling rate.
+   * 
    * @example
    * 100
    */
   samplingRate?: number;
   /**
+   * @remarks
+   * The beginning of the time range during which data was queried.
+   * 
+   * The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
+   * 
    * @example
    * 2023-04-08T16:00:00Z
    */

package/src/models/DescribeSiteTopDataShrinkRequest.ts

@@ -4,27 +4,56 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeSiteTopDataShrinkRequest extends $dara.Model {
   /**
+   * @remarks
+   * The end of the time range to query.
+   * 
+   * Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
+   * 
+   * >  The end time must be later than the start time.
+   * 
    * @example
    * 2023-04-09T16:00:00Z
    */
   endTime?: string;
   /**
    * @remarks
+   * The metrics to query.
+   * 
    * This parameter is required.
    */
   fieldsShrink?: string;
   /**
+   * @remarks
+   * The time interval between the data entries to return. Unit: seconds.
+   * 
    * @example
    * 300
    */
   interval?: string;
+  /**
+   * @remarks
+   * The number of top-ranking data entries to query.
+   * 
+   * @example
+   * 5
+   */
   limit?: string;
   /**
+   * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
+   * 
+   * If you do not specify this parameter, the system returns data by account.
+   * 
    * @example
    * 1150376036*****
    */
   siteId?: string;
   /**
+   * @remarks
+   * The beginning of the time range to query.
+   * 
+   * Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
+   * 
    * @example
    * 2023-04-08T16:00:00Z
    */

package/src/models/DescribeUrlObservationDataRequest.ts

@@ -4,22 +4,45 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeUrlObservationDataRequest extends $dara.Model {
   /**
+   * @remarks
+   * The platform of the device. If the parameter is left empty, all devices are queried.
+   * 
+   * *   PC
+   * *   Mobile
+   * 
    * @example
    * PC
    */
   clientPlatform?: string;
   /**
+   * @remarks
+   * The end of the time range to query.
+   * 
+   * Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The time must be in UTC.
+   * 
    * @example
    * 2023-04-19T15:59:59Z
    */
   endTime?: string;
   /**
+   * @remarks
+   * The metric data that is detected.
+   * 
+   * *   TTFB: Measures the time between when a resource initiates a request and when the first byte of the response starts to arrive.
+   * *   FCP: Measures the time between when the page is loaded and when any part of the page\\"s content is rendered on the screen.
+   * *   LCP: Reports the rendering time of the largest image or text block visible in the viewport.
+   * *   CLS: A metric that measures the maximum layout mutation score for every unexpected layout change that occurs throughout the life of the page.
+   * *   INP: Measures the responsiveness of the page, or how long it takes for the page to respond to user input in a visible way.
+   * *   FID: Measures the time between when the user first interacts with the page and when the browser is actually able to start processing the event handler in response to that interaction.
+   * 
    * @example
    * TTFB
    */
   metric?: string;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -27,11 +50,19 @@ export class DescribeUrlObservationDataRequest extends $dara.Model {
    */
   siteId?: string;
   /**
+   * @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
    * 2023-04-08T16:00:00Z
    */
   startTime?: string;
   /**
+   * @remarks
+   * The URL of the web page to monitor.
+   * 
    * @example
    * example.com/test
    */

package/src/models/DescribeUrlObservationDataResponseBody.ts

@@ -4,46 +4,73 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeUrlObservationDataResponseBodyUrlDetailData extends $dara.Model {
   /**
+   * @remarks
+   * Measures the maximum layout mutation score for every unexpected layout change that occurs throughout the life of the page.
+   * 
    * @example
    * 0.5
    */
   CLS?: number;
   /**
+   * @remarks
+   * The platform of the device.
+   * 
    * @example
    * PC
    */
   clientPlatform?: string;
   /**
+   * @remarks
+   * The country or region to which the IP address belongs.
+   * 
    * @example
    * CN
    */
   country?: string;
   /**
+   * @remarks
+   * Measures the time between when the page is loaded and when any part of the page\\"s content is rendered on the screen. Unit: ms.
+   * 
    * @example
    * 123
    */
   FCP?: number;
   /**
+   * @remarks
+   * Measures the time between when the user first interacts with the page and when the browser is actually able to start processing an event handler in response to that interaction. Unit: ms.
+   * 
    * @example
    * 123
    */
   FID?: number;
   /**
+   * @remarks
+   * Measures the responsiveness of the page, or how long it takes for the page to respond to user input visibly. Unit: ms.
+   * 
    * @example
    * 123
    */
   INP?: number;
   /**
+   * @remarks
+   * Reports the rendering time of the largest image or text block visible in the viewport. Unit: ms.
+   * 
    * @example
    * 123
    */
   LCP?: number;
   /**
+   * @remarks
+   * This metric measures the time between when a resource initiates a request and when the first byte of the response starts to arrive. Unit: ms.
+   * 
    * @example
    * 123
    */
   TTFB?: number;
   /**
+   * @remarks
+   * The URL of the web page to monitor.
+   * 
    * @example
    * example.com/test
    */
@@ -87,20 +114,35 @@ export class DescribeUrlObservationDataResponseBodyUrlDetailData extends $dara.M
 
 export class DescribeUrlObservationDataResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The end of the time range during which data was queried.
+   * 
+   * Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The time must be in UTC.
+   * 
    * @example
    * 2023-04-19T15:59:59Z
    */
   endTime?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 0AEDAF20-4DDF-4165-8750-47FF9C1929C9
    */
   requestId?: string;
   /**
+   * @remarks
+   * The create time. The time is in the yyyy-MM-ddTHH:mm:ssZ format.
+   * 
    * @example
    * 2022-11-06T16:00:00Z
    */
   startTime?: string;
+  /**
+   * @remarks
+   * The objects that are returned.
+   */
   urlDetailData?: DescribeUrlObservationDataResponseBodyUrlDetailData[];
   static names(): { [key: string]: string } {
     return {

package/src/models/GetCrossBorderOptimizationRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GetCrossBorderOptimizationRequest extends $dara.Model {
   /**
    * @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/GetCrossBorderOptimizationResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetCrossBorderOptimizationResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Whether to enable Chinese mainland network access optimization. By default, it is disabled. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   enable?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * CF521A24-633F-5350-A6A5-42AD503D0D20
    */

package/src/models/GetEdgeContainerAppResourceReserveRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetEdgeContainerAppResourceReserveRequest extends $dara.Model {
   /**
+   * @remarks
+   * The application ID, which can be obtained by calling the [ListEdgeContainerApps](~~ListEdgeContainerApps~~) operation.
+   * 
    * @example
    * app-88068867578379****
    */