@alicloud/esa20240910 2.33.0 → 2.34.1

package/src/models/GetVideoProcessingRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GetVideoProcessingRequest extends $dara.Model {
   /**
    * @remarks
+   * The configuration ID. You can call the [ListVideoProcessings](~~ListVideoProcessings~~) operation to obtain the configuration ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class GetVideoProcessingRequest 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/GetVideoProcessingResponseBody.ts

@@ -4,71 +4,125 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetVideoProcessingResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The configuration ID.
+   * 
    * @example
    * 35281609698****
    */
   configId?: number;
   /**
+   * @remarks
+   * The type of the configuration. Valid values:
+   * 
+   * *   global: global configuration.
+   * *   rule: rule configuration.
+   * 
    * @example
    * global
    */
   configType?: string;
   /**
+   * @remarks
+   * The custom end parameter 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 request ID.
+   * 
    * @example
    * CB1A380B-09F0-41BB-A198-72F8FD6DA2FE
    */
   requestId?: string;
   /**
+   * @remarks
+   * The rule content.
+   * 
    * @example
    * (http.host eq \\"video.example.com\\")
    */
   rule?: string;
   /**
+   * @remarks
+   * Indicates whether the rule is enabled. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   ruleEnable?: string;
   /**
+   * @remarks
+   * The name of the scaling rule.
+   * 
    * @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 version number of the website configurations.
+   * 
    * @example
    * 1
    */
   siteVersion?: number;
   /**
+   * @remarks
+   * Video seeking. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */

package/src/models/ListCertificatesByRecordRequest.ts

@@ -3,20 +3,41 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListCertificatesByRecordRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to return the certificate details. 0 indicates that the certificate details are not returned. 1 indicates that the certificate details are returned.
+   * 
+   * @example
+   * 1
+   */
   detail?: boolean;
   /**
    * @remarks
+   * The record name.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * www.example.com
    */
   recordName?: string;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
+   * 
    * This parameter is required.
    * 
    * @example
    * 1234567890123
    */
   siteId?: number;
+  /**
+   * @remarks
+   * Specifies whether to return only valid certificates. 0 indicates that all matched certificates are returned. 1 indicates that only valid certificates are returned.
+   * 
+   * @example
+   * 1
+   */
   validOnly?: boolean;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListCertificatesByRecordResponseBody.ts

@@ -4,75 +4,145 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListCertificatesByRecordResponseBodyResultCertificates extends $dara.Model {
   /**
+   * @remarks
+   * The certificate ID on Certificate Management Service.
+   * 
    * @example
    * 30000137
    */
   casId?: string;
   /**
+   * @remarks
+   * The Common Name of the certificate.
+   * 
    * @example
    * www.example.com
    */
   commonName?: string;
   /**
+   * @remarks
+   * The creation time.
+   * 
    * @example
    * 2023-02-28 06:17:11
    */
   createTime?: string;
   /**
+   * @remarks
+   * The SHA-256 fingerprint of the certificate.
+   * 
    * @example
    * 1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66
    */
   fingerprintSha256?: string;
+  /**
+   * @remarks
+   * The ID of the certificate.
+   * 
+   * @example
+   * babab022c5e9b27bf9c64d7f4b1667f4
+   */
   id?: string;
   /**
+   * @remarks
+   * The certificate authority (CA) that issued the certificate.
+   * 
    * @example
    * GlobalSign nv-sa
    */
   issuer?: string;
   /**
+   * @remarks
+   * The Common Name of the certificate issuer.
+   * 
    * @example
    * GlobalSign Organization Validation CA - SHA256 - G3
    */
   issuerCN?: string;
+  /**
+   * @remarks
+   * The certificate name.
+   * 
+   * @example
+   * yourCertName
+   */
   name?: string;
   /**
+   * @remarks
+   * The time when the certificate expires.
+   * 
    * @example
    * 2024-02-28 06:17:11
    */
   notAfter?: string;
   /**
+   * @remarks
+   * The time when the certificate takes effect.
+   * 
    * @example
    * 2023-02-28 06:17:11
    */
   notBefore?: string;
   /**
+   * @remarks
+   * The public key algorithm of the certificate.
+   * 
    * @example
    * RSA
    */
   pubAlg?: string;
+  /**
+   * @remarks
+   * The region where the certificate is stored.
+   * 
+   * @example
+   * cn-hangzhou
+   */
   region?: string;
   /**
+   * @remarks
+   * The Subject Alternative Name (SAN) of the certificate.
+   * 
    * @example
    * www.example.com,*.example.com
    */
   SAN?: string;
   /**
+   * @remarks
+   * The serial number of the certificate.
+   * 
    * @example
    * baba39055622c008b90285a8838ed09a
    */
   serialNumber?: string;
   /**
+   * @remarks
+   * The signature algorithm of the certificate.
+   * 
    * @example
    * SHA256-RSA
    */
   sigAlg?: string;
+  /**
+   * @remarks
+   * The status of the certificate.
+   * 
+   * @example
+   * OK
+   */
   status?: string;
   /**
+   * @remarks
+   * The type of the SSL certificate. Valid values:
+   * 
    * @example
    * free
    */
   type?: string;
   /**
+   * @remarks
+   * The update time.
+   * 
    * @example
    * 2023-02-28 06:17:11
    */
@@ -133,10 +203,42 @@ export class ListCertificatesByRecordResponseBodyResultCertificates extends $dar
 }
 
 export class ListCertificatesByRecordResponseBodyResult extends $dara.Model {
+  /**
+   * @remarks
+   * The number of certificates that are being requested.
+   * 
+   * @example
+   * 1
+   */
   applylingCount?: number;
+  /**
+   * @remarks
+   * The certificates that match the specified records.
+   */
   certificates?: ListCertificatesByRecordResponseBodyResultCertificates[];
+  /**
+   * @remarks
+   * The number of certificates that match the specified records.
+   * 
+   * @example
+   * 3
+   */
   count?: number;
+  /**
+   * @remarks
+   * The name of the record.
+   * 
+   * @example
+   * www.example.com
+   */
   recordName?: string;
+  /**
+   * @remarks
+   * Certificate configuration status. Possible values: none; configured; applying; failed.
+   * 
+   * @example
+   * none
+   */
   status?: string;
   static names(): { [key: string]: string } {
     return {
@@ -171,10 +273,42 @@ export class ListCertificatesByRecordResponseBodyResult extends $dara.Model {
 }
 
 export class ListCertificatesByRecordResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 65C66B7B-671A-8297-9187-2R5477247B76
+   */
   requestId?: string;
+  /**
+   * @remarks
+   * The queried certificates.
+   */
   result?: ListCertificatesByRecordResponseBodyResult[];
+  /**
+   * @remarks
+   * The website ID,
+   * 
+   * @example
+   * 1234567890123
+   */
   siteId?: number;
+  /**
+   * @remarks
+   * The website name.
+   * 
+   * @example
+   * example.com
+   */
   siteName?: string;
+  /**
+   * @remarks
+   * The total number of records that you specified.
+   * 
+   * @example
+   * 12
+   */
   totalCount?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListEsaipinfoRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListESAIPInfoRequest extends $dara.Model {
   /**
    * @remarks
+   * You can enter IPv4 or IPv6 addresses. Separate multiple IP addresses with commas (,). You can enter up to 20 IP addresses at a time.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListEsaipinfoResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListESAIPInfoResponseBodyContent extends $dara.Model {
   /**
+   * @remarks
+   * Whether the IP address in the parameter belongs to ESA POPs.
+   * 
+   * *   **true**
+   * *   **false**
+   * 
    * @example
    * true
    */
   cdnIp?: string;
   /**
+   * @remarks
+   * The IP addresses.
+   * 
    * @example
    * 27.129.167.239
    */
@@ -37,8 +46,17 @@ export class ListESAIPInfoResponseBodyContent extends $dara.Model {
 }
 
 export class ListESAIPInfoResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The objects that are returned.
+   */
   content?: ListESAIPInfoResponseBodyContent[];
   /**
+   * @remarks
+   * The request ID.
+   * 
+   * Example D03F9502-6653-127C-8A5F-0647197\\*\\*\\*\\*\\*
+   * 
    * @example
    * 36af3fcc-43d0-441c-86b1-428951dc8225
    */

package/src/models/ListHttpIncomingRequestHeaderModificationRulesRequest.ts

@@ -4,32 +4,52 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListHttpIncomingRequestHeaderModificationRulesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The configuration ID. You can call the ListHttpIncomingRequestHeaderModificationRules operation to query the ID.
+   * 
    * @example
    * 424371770570752
    */
   configId?: number;
   /**
+   * @remarks
+   * The configuration type to query. Valid values:
+   * 
+   * *   global: global configurations.
+   * *   rule: rule configurations.
+   * 
    * @example
    * rule
    */
   configType?: string;
   /**
+   * @remarks
+   * The page number. Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page. Maximum value: 500. Default value: 500.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The rule name.
+   * 
    * @example
    * rule_example
    */
   ruleName?: string;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -37,6 +57,9 @@ export class ListHttpIncomingRequestHeaderModificationRulesRequest extends $dara
    */
   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
    * 0
    */

package/src/models/ListHttpIncomingRequestHeaderModificationRulesResponseBody.ts

@@ -4,21 +4,40 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListHttpIncomingRequestHeaderModificationRulesResponseBodyConfigsRequestHeaderModification extends $dara.Model {
   /**
+   * @remarks
+   * The name of the request header.
+   * 
    * @example
    * headerName
    */
   name?: string;
   /**
+   * @remarks
+   * The action. Valid values:
+   * 
+   * *   add: adds a response header.
+   * *   del: deletes a response header.
+   * *   modify: modifies a response header.
+   * 
    * @example
    * add
    */
   operation?: string;
   /**
+   * @remarks
+   * The type of the value. Valid values:
+   * 
+   * *   static
+   * *   dynamic
+   * 
    * @example
    * static
    */
   type?: string;
   /**
+   * @remarks
+   * The value of the request header.
+   * 
    * @example
    * headerValue
    */
@@ -52,37 +71,71 @@ export class ListHttpIncomingRequestHeaderModificationRulesResponseBodyConfigsRe
 
 export class ListHttpIncomingRequestHeaderModificationRulesResponseBodyConfigs extends $dara.Model {
   /**
+   * @remarks
+   * The configuration ID.
+   * 
    * @example
    * 429422870243328
    */
   configId?: number;
   /**
+   * @remarks
+   * The type of the configuration. Valid values:
+   * 
+   * *   global: global configurations.
+   * *   rule: rule configurations.
+   * 
    * @example
    * rule
    */
   configType?: string;
+  /**
+   * @remarks
+   * The configurations of modifying request headers. You can add, delete, or modify a request header.
+   */
   requestHeaderModification?: ListHttpIncomingRequestHeaderModificationRulesResponseBodyConfigsRequestHeaderModification[];
   /**
+   * @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. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   ruleEnable?: string;
   /**
+   * @remarks
+   * The rule name. 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 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
    * 0
    */
@@ -126,28 +179,47 @@ export class ListHttpIncomingRequestHeaderModificationRulesResponseBodyConfigs e
 }
 
 export class ListHttpIncomingRequestHeaderModificationRulesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The configuration list of the incoming HTTP request header modification.
+   */
   configs?: ListHttpIncomingRequestHeaderModificationRulesResponseBodyConfigs[];
   /**
+   * @remarks
+   * The number of the returned page. Default value: **1**.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page. Default value: 500. Valid values: 1 to 500.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 7FB6EBC8-8849-5FC6-890E-3A761A5CD42D
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * 10
    */
   totalCount?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 1
    */