@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/UpdatePageRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdatePageRequest extends $dara.Model {
   /**
    * @remarks
-   * The Base64-encoded content of the error page. The content type is specified by the Content-Type field.
+   * The Base64-encoded content for the response page, corresponding to the specified `ContentType`.
    * 
    * This parameter is required.
    * 
@@ -15,10 +15,11 @@ export class UpdatePageRequest extends $dara.Model {
   content?: string;
   /**
    * @remarks
-   * The Content-Type field in the HTTP header. Valid values:
+   * The value for the Content-Type HTTP header. Examples:
    * 
-   * *   text/html
-   * *   application/json
+   * - text/html
+   * 
+   * - application/json
    * 
    * This parameter is required.
    * 
@@ -28,7 +29,7 @@ export class UpdatePageRequest extends $dara.Model {
   contentType?: string;
   /**
    * @remarks
-   * The description of the custom error page.
+   * The description of the custom response page.
    * 
    * This parameter is required.
    * 
@@ -38,7 +39,7 @@ export class UpdatePageRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The ID of the custom error page, which can be obtained by calling the [ListPages](https://help.aliyun.com/document_detail/2850223.html) operation.
+   * The ID of the custom response page. Retrieve this ID by calling the [ListPages](https://help.aliyun.com/document_detail/2850223.html) API.
    * 
    * This parameter is required.
    * 
@@ -48,7 +49,7 @@ export class UpdatePageRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The name of the custom error page.
+   * The name of the custom response page.
    * 
    * This parameter is required.
    * 

package/src/models/UpdatePageResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdatePageResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 36af3fcc-43d0-441c-86b1-428951dc8225

package/src/models/UpdatePageShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdatePageShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The Base64-encoded content of the error page. The content type is specified by the Content-Type field.
+   * The Base64-encoded content for the response page, corresponding to the specified `ContentType`.
    * 
    * This parameter is required.
    * 
@@ -15,10 +15,11 @@ export class UpdatePageShrinkRequest extends $dara.Model {
   content?: string;
   /**
    * @remarks
-   * The Content-Type field in the HTTP header. Valid values:
+   * The value for the Content-Type HTTP header. Examples:
    * 
-   * *   text/html
-   * *   application/json
+   * - text/html
+   * 
+   * - application/json
    * 
    * This parameter is required.
    * 
@@ -28,7 +29,7 @@ export class UpdatePageShrinkRequest extends $dara.Model {
   contentType?: string;
   /**
    * @remarks
-   * The description of the custom error page.
+   * The description of the custom response page.
    * 
    * This parameter is required.
    * 
@@ -38,7 +39,7 @@ export class UpdatePageShrinkRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The ID of the custom error page, which can be obtained by calling the [ListPages](https://help.aliyun.com/document_detail/2850223.html) operation.
+   * The ID of the custom response page. Retrieve this ID by calling the [ListPages](https://help.aliyun.com/document_detail/2850223.html) API.
    * 
    * This parameter is required.
    * 
@@ -48,7 +49,7 @@ export class UpdatePageShrinkRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The name of the custom error page.
+   * The name of the custom response page.
    * 
    * This parameter is required.
    * 

package/src/models/UpdatePerformanceDataCollectionRequest.ts

@@ -5,6 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class UpdatePerformanceDataCollectionRequest extends $dara.Model {
   /**
    * @remarks
+   * Enables or disables Performance Data Collection. Valid values:
+   * 
+   * - `on`: Enables the Feature.
+   * 
+   * - `off`: Disables the Feature.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +19,8 @@ export class UpdatePerformanceDataCollectionRequest extends $dara.Model {
   enable?: string;
   /**
    * @remarks
+   * The ID of the Site. You can get this ID by calling the [ListSites](~~ListSites~~) API.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/UpdatePerformanceDataCollectionResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdatePerformanceDataCollectionResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * CB1A380B-09F0-41BB-280B-72F8FD6DA2FE

package/src/models/UpdateRatePlanSpecRequest.ts

@@ -5,39 +5,77 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateRatePlanSpecRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to enable auto payment.
+   * Specifies whether to enable automatic payment.
    * 
    * @example
    * true
    */
   autoPay?: boolean;
   /**
+   * @remarks
+   * The billing type. Valid values:
+   * - PREPAY: Subscription.
+   * - POSTPAY: Pay-as-you-go.
+   * 
    * @example
    * PREPAY
    */
   chargeType?: string;
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * xcdn-91fknmb80f0g
    */
   instanceId?: string;
   /**
    * @remarks
-   * The specification update type. Valid values:
-   * 
-   * *   DOWNGRADE
-   * *   UPGRADE
+   * The type of specification change. Valid values:
+   * - UPGRADE: Upgrade.
    * 
    * @example
    * UPGRADE
    */
   orderType?: string;
   /**
+   * @remarks
+   * The code of the target plan.
+   * 
+   * Alibaba Cloud China Website (www.aliyun.com)
+   * 
+   * - Free Edition: entranceplan
+   * - Basic Edition: basicplan
+   * - Standard Edition: standardplan
+   * - Premium Edition: advancedplan
+   * 
+   * Alibaba Cloud International Website (www.alibabacloud.com)
+   * 
+   * - Entrance: entranceplan
+   * - Pro: standardplan
+   * - Premium: advancedpla.
+   * 
    * @example
    * entranceplan
    */
   targetPlanCode?: string;
   /**
+   * @remarks
+   * The name of the target plan.
+   * 
+   * Alibaba Cloud China Website (www.aliyun.com)
+   * 
+   * - Free Edition: entranceplan
+   * - Basic Edition: basic
+   * - Standard Edition: medium
+   * - Premium Edition: high
+   * 
+   * Alibaba Cloud International Website (www.alibabacloud.com)
+   * 
+   * - Entrance: entranceplan_intl
+   * - Pro: basicplan_intl
+   * - Premium: vipplan_intl.
+   * 
    * @example
    * basic
    */

package/src/models/UpdateRatePlanSpecResponseBody.ts

@@ -4,18 +4,24 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateRatePlanSpecResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * xcdn-as23ds***
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The order ID.
+   * 
    * @example
    * 2223332122***
    */
   orderId?: string;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * 30423A7F-A83D-1E24-B80E-86DD25790758

package/src/models/UpdateRecordRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateRecordRequestAuthConf extends $dara.Model {
   /**
    * @remarks
-   * The access key of the account to which the origin server belongs. This parameter is required when the SourceType is OSS, and AuthType is private_same_account, or when the SourceType is S3 and AuthType is private.
+   * The access key for the account that owns the origin. This is required for private, cross-account access to OSS origins, and for S3 origins where the authentication type is **private**.
    * 
    * @example
    * VIxuvJSA2S03f******kp208dy5w7
@@ -13,11 +13,13 @@ export class UpdateRecordRequestAuthConf extends $dara.Model {
   accessKey?: string;
   /**
    * @remarks
-   * The authentication type of the origin server. Different origins support different authentication types. The type of origin refers to the SourceType parameter in this operation. If the type of origin is OSS or S3, you must specify the authentication type of the origin. Valid values:
+   * The origin authentication type. This parameter is required when the **SourceType** is **OSS** or **S3**. Supported authentication types vary depending on the origin type. Valid values:
    * 
-   * *   **public**: public read. Select this value when the origin type is OSS or S3 and the origin access is public read.
-   * *   **private**: private read. Select this value when the origin type is S3 and the origin access is private read.
-   * *   **private_same_account**: private read under the same account. Select this value when the origin type is OSS, the origins belong to the same Alibaba Cloud account, and the origins have private read access.
+   * - **public**: Public read. Use for publicly readable OSS or S3 origins.
+   * 
+   * - **private**: Private read. Use for private S3 origins.
+   * 
+   * - **private_same_account**: Private read within the same account. Use for private OSS origins accessed from the same Alibaba Cloud account.
    * 
    * @example
    * private
@@ -25,12 +27,13 @@ export class UpdateRecordRequestAuthConf extends $dara.Model {
   authType?: string;
   /**
    * @remarks
-   * The version of the signature algorithm. This parameter is required when the origin type is S3 and AuthType is private. The following two types are supported:
+   * The region where the origin is located. This parameter is required when the origin type is S3. You can find the region ID on the official S3 website.
+   * 
+   * - **v2**
    * 
-   * *   **v2**
-   * *   **v4**
+   * - **v4**
    * 
-   * If you leave this parameter empty, the default value v4 is used.
+   * If you do not specify a value, it defaults to v4.
    * 
    * @example
    * v2
@@ -38,7 +41,7 @@ export class UpdateRecordRequestAuthConf extends $dara.Model {
   region?: string;
   /**
    * @remarks
-   * The secret access key of the account to which the origin server belongs. This parameter is required when the SourceType is OSS, and AuthType is private_same_account, or when the SourceType is S3 and AuthType is private.
+   * The secret key for the account that owns the origin. This is required for private, cross-account access to OSS origins, and for S3 origins where the authentication type is **private**.
    * 
    * @example
    * u0Nkg5gBK*******QF5wvKMM504JUHt
@@ -46,7 +49,7 @@ export class UpdateRecordRequestAuthConf extends $dara.Model {
   secretKey?: string;
   /**
    * @remarks
-   * The region of the origin. If the origin type is S3, you must specify this value. You can get the region information from the official website of S3.
+   * The signing algorithm version. This parameter is required when the origin type is S3 and the authentication type is **private**. Supported versions: v2 and v4. If this parameter is not specified, the default value is v4.
    * 
    * @example
    * us-east-1
@@ -84,7 +87,7 @@ export class UpdateRecordRequestAuthConf extends $dara.Model {
 export class UpdateRecordRequestData extends $dara.Model {
   /**
    * @remarks
-   * The encryption algorithm used for the record, specified within the range from 0 to 255. This parameter is required when you add CERT or SSHFP records.
+   * The encryption algorithm specified in the record. The value must be an integer from **0 to 255**. This parameter is required for CERT and SSHFP records.
    * 
    * @example
    * 0
@@ -92,7 +95,7 @@ export class UpdateRecordRequestData extends $dara.Model {
   algorithm?: number;
   /**
    * @remarks
-   * The public key of the certificate. This parameter is required when you add CERT, SMIMEA, or TLSA records.
+   * The public key certificate data for the record. This parameter is required for CERT, SMIMEA, and TLSA records.
    * 
    * @example
    * dGVzdGFkYWxrcw==
@@ -100,7 +103,7 @@ export class UpdateRecordRequestData extends $dara.Model {
   certificate?: string;
   /**
    * @remarks
-   * The public key fingerprint of the record. This parameter is required when you add a SSHFP record.
+   * The public key fingerprint for the record. This parameter is required for SSHFP records.
    * 
    * @example
    * abcdef1234567890
@@ -108,7 +111,7 @@ export class UpdateRecordRequestData extends $dara.Model {
   fingerprint?: string;
   /**
    * @remarks
-   * The flag bit of the record. The Flag for a CAA record indicates its priority and how it is processed, specified within the range of 0 to 255. This parameter is required when you add a CAA record.
+   * The flag for the record. For a CAA record, this flag indicates its priority and handling behavior. The value must be an integer from **0 to 255**. This parameter is required for CAA records.
    * 
    * @example
    * 128
@@ -116,7 +119,7 @@ export class UpdateRecordRequestData extends $dara.Model {
   flag?: number;
   /**
    * @remarks
-   * The public key identification for the record, specified within the range of 0 to 65,535. This parameter is required when you add a CAA record.
+   * The public key identifier for the record. The value must be an integer from **0 to 65535**. This parameter is required for CERT records.
    * 
    * @example
    * 0
@@ -124,7 +127,7 @@ export class UpdateRecordRequestData extends $dara.Model {
   keyTag?: number;
   /**
    * @remarks
-   * The algorithm policy used to match or validate the certificate, specified within the range 0 to 255. This parameter is required when you add SMIMEA or TLSA records.
+   * The algorithm policy used to match or validate the certificate. The value must be an integer from **0 to 255**. This parameter is required for SMIMEA and TLSA records.
    * 
    * @example
    * 0
@@ -132,7 +135,7 @@ export class UpdateRecordRequestData extends $dara.Model {
   matchingType?: number;
   /**
    * @remarks
-   * The port of the record, specified within the range of 0 to 65,535. This parameter is required when you add an SRV record.
+   * The port number for the record. The value must be an integer from **0 to 65535**. This parameter is required for SRV records.
    * 
    * @example
    * 0
@@ -140,7 +143,7 @@ export class UpdateRecordRequestData extends $dara.Model {
   port?: number;
   /**
    * @remarks
-   * The priority of the record, specified within the range of 0 to 65,535. A smaller value indicates a higher priority. This parameter is required when you add MX, SRV, and URI records.
+   * The record\\"s priority. The value must be an integer from **0 to 65535**, where a lower value indicates higher priority. This parameter is required for MX, SRV, and URI records.
    * 
    * @example
    * 10
@@ -148,7 +151,7 @@ export class UpdateRecordRequestData extends $dara.Model {
   priority?: number;
   /**
    * @remarks
-   * The type of certificate or public key, specified within the range of 0 to 255. This parameter is required when you add SMIMEA or TLSA records.
+   * The type of certificate or public key specified in the record. The value must be an integer from **0 to 255**. This parameter is required for SMIMEA and TLSA records.
    * 
    * @example
    * 0
@@ -156,7 +159,7 @@ export class UpdateRecordRequestData extends $dara.Model {
   selector?: number;
   /**
    * @remarks
-   * The label of the record. The Tag of a CAA record indicate its specific type and usage. This parameter is required when you add a CAA record.
+   * The tag for the record. For a CAA record, the tag specifies the record\\"s type and purpose. This parameter is required for CAA records.
    * 
    * @example
    * issue
@@ -164,7 +167,7 @@ export class UpdateRecordRequestData extends $dara.Model {
   tag?: string;
   /**
    * @remarks
-   * The certificate type of the record (in CERT records), or the public key type (in SSHFP records). This parameter is required when you add CERT or SSHFP records.
+   * The certificate type for a CERT record, or the public key type for an SSHFP record. This parameter is required for CERT and SSHFP records.
    * 
    * @example
    * 0
@@ -172,7 +175,7 @@ export class UpdateRecordRequestData extends $dara.Model {
   type?: number;
   /**
    * @remarks
-   * The usage identifier of the record, specified within the range of 0 to 255. This parameter is required when you add SMIMEA or TLSA records.
+   * The usage identifier for the record. The value must be an integer from **0 to 255**. This parameter is required for SMIMEA and TLSA records.
    * 
    * @example
    * 0
@@ -180,16 +183,23 @@ export class UpdateRecordRequestData extends $dara.Model {
   usage?: number;
   /**
    * @remarks
-   * The record value or part of the record content. This parameter is required when you add A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, and URI records. It has different meanings based on different types of records:
+   * The value of the record or part of its content. This parameter is required for A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, and URI records. The meaning of this parameter varies by record type:
+   * 
+   * - **A/AAAA**: The target IP address. To specify multiple IP addresses, separate them with a comma (,). At least one IPv4 address is required.
+   * 
+   * - **CNAME**: The target domain name.
+   * 
+   * - **NS**: The name server for the domain.
+   * 
+   * - **MX**: A valid domain name for the target mail server.
+   * 
+   * - **TXT**: A valid text string.
+   * 
+   * - **CAA**: A valid domain name for the certificate authority.
    * 
-   * *   **A/AAAA**: the IP address(es). Separate multiple IPs with commas (,). You must have at least one IPv4 address.
-   * *   **CNAME**: the target domain name.
-   * *   **NS**: the name servers for the domain name.
-   * *   **MX**: a valid domain name of the target mail server.
-   * *   **TXT**: a valid text string.
-   * *   **CAA**: a valid domain name of the certificate authority.
-   * *   **SRV**: a valid domain name of the target host.
-   * *   **URI**: a valid URI string.
+   * - **SRV**: A valid domain name for the target host.
+   * 
+   * - **URI**: A valid URI string.
    * 
    * @example
    * example.com
@@ -197,7 +207,7 @@ export class UpdateRecordRequestData extends $dara.Model {
   value?: string;
   /**
    * @remarks
-   * The weight of the record, specified within the range of 0 to 65,535. This parameter is required when you add SRV or URI records.
+   * The weight of the record. The value must be an integer from **0 to 65535**. This parameter is required for SRV and URI records.
    * 
    * @example
    * 0
@@ -253,16 +263,18 @@ export class UpdateRecordRequestData extends $dara.Model {
 export class UpdateRecordRequest extends $dara.Model {
   /**
    * @remarks
-   * The origin authentication information of the CNAME record.
+   * The origin authentication settings for the CNAME record.
    */
   authConf?: UpdateRecordRequestAuthConf;
   /**
    * @remarks
-   * The business scenario of the record for acceleration. Leave the parameter empty if your record is not proxied. Valid values:
+   * The use case for proxy acceleration. Omit this parameter if proxy acceleration is disabled. Valid values:
+   * 
+   * - **video_image**: Video and images.
+   * 
+   * - **api**: APIs.
    * 
-   * *   **video_image**: video and image.
-   * *   **api**: API.
-   * *   **web**: web page.
+   * - **web**: Web pages.
    * 
    * @example
    * web
@@ -270,7 +282,7 @@ export class UpdateRecordRequest extends $dara.Model {
   bizName?: string;
   /**
    * @remarks
-   * The comments of the record.
+   * A comment for the record.
    * 
    * @example
    * This is a remark.
@@ -278,7 +290,7 @@ export class UpdateRecordRequest extends $dara.Model {
   comment?: string;
   /**
    * @remarks
-   * The DNS record information. The format of this field varies based on the record type. For more information, see [Add DNS records](https://www.alibabacloud.com/help/doc-detail/2708761.html).
+   * The DNS data for the record. The required content varies based on the record type. For more information, see <props="china">[Documentation](https://help.aliyun.com/document_detail/2708761.html)<props="intl">[Documentation](https://www.alibabacloud.com/help/doc-detail/2708761.html).
    * 
    * This parameter is required.
    * 
@@ -290,21 +302,25 @@ export class UpdateRecordRequest extends $dara.Model {
   data?: UpdateRecordRequestData;
   /**
    * @remarks
-   * The origin host policy. This policy takes effect when the record type is CNAME. You can set the policy in two modes:
+   * The origin HOST policy. This policy, which applies only to CNAME records, determines the value of the `HOST` header in requests sent to the origin. Valid values:
    * 
-   * *   **follow_hostname**: match the requested domain name.
-   * *   **follow_origin_domain**: match the origin\\"s domain name.
+   * - **follow_hostname**: Follows the host record.
+   * 
+   * - **follow_origin_domain**: Follows the origin domain name.
    * 
    * @example
    * follow_origin_domain
    */
   hostPolicy?: string;
+  httpPorts?: string;
+  httpsPorts?: string;
   /**
    * @remarks
-   * Specifies whether to proxy the record. Only CNAME and A/AAAA records can be proxied. Valid values:
+   * Indicates whether to enable proxy acceleration for the record. Only CNAME and A/AAAA records support proxy acceleration. Valid values:
+   * 
+   * - **true**: Enables proxy acceleration.
    * 
-   * *   **true**
-   * *   **false**
+   * - **false**: Disables proxy acceleration.
    * 
    * @example
    * true
@@ -312,7 +328,7 @@ export class UpdateRecordRequest extends $dara.Model {
   proxied?: boolean;
   /**
    * @remarks
-   * The record ID, which can be obtained by calling [ListRecords](https://help.aliyun.com/document_detail/2850265.html).
+   * The record ID. Call the [ListRecords](https://help.aliyun.com/document_detail/2850265.html) operation to get this ID.
    * 
    * This parameter is required.
    * 
@@ -322,15 +338,19 @@ export class UpdateRecordRequest extends $dara.Model {
   recordId?: number;
   /**
    * @remarks
-   * The type of the origin for the CNAME record. This parameter is required when you add a CNAME record. Valid values:
+   * The origin type for the CNAME record. This parameter is required for CNAME records. Valid values:
+   * 
+   * - **OSS**: An OSS origin.
+   * 
+   * - **S3**: An S3 origin.
+   * 
+   * - **LB**: A load balancer origin.
+   * 
+   * - **OP**: An origin address pool origin.
    * 
-   * *   **OSS** : OSS origin.
-   * *   **S3** : S3 origin.
-   * *   **LB**: Load Balancer origin.
-   * *   **OP**: origin in an origin pool.
-   * *   **Domain**: common domain name.
+   * - **Domain**: A standard domain name origin.
    * 
-   * If you leave the parameter empty or set its value as null, the default is Domain, which is common domain name.
+   * If this parameter is omitted or left empty, the default value is `Domain`.
    * 
    * @example
    * OSS
@@ -338,7 +358,7 @@ export class UpdateRecordRequest extends $dara.Model {
   sourceType?: string;
   /**
    * @remarks
-   * The TTL of the record. Unit: seconds. The range is 30 to 86,400, or 1. If the value is 1, the TTL of the record is determined by the system.
+   * The record\\"s time to live (TTL) in seconds. The value must be an integer from **30 to 86400** or 1. A value of 1 sets the TTL to automatic.
    * 
    * @example
    * 30
@@ -352,6 +372,8 @@ export class UpdateRecordRequest extends $dara.Model {
       comment: 'Comment',
       data: 'Data',
       hostPolicy: 'HostPolicy',
+      httpPorts: 'HttpPorts',
+      httpsPorts: 'HttpsPorts',
       proxied: 'Proxied',
       recordId: 'RecordId',
       sourceType: 'SourceType',
@@ -367,6 +389,8 @@ export class UpdateRecordRequest extends $dara.Model {
       comment: 'string',
       data: UpdateRecordRequestData,
       hostPolicy: 'string',
+      httpPorts: 'string',
+      httpsPorts: 'string',
       proxied: 'boolean',
       recordId: 'number',
       sourceType: 'string',

package/src/models/UpdateRecordResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateRecordResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The unique request ID.
    * 
    * @example
    * 0AEDAF20-4DDF-4165-8750-47FF9C1929C9