@alicloud/esa20240910 3.1.2 → 3.3.0

package/src/models/GetSiteOriginClientCertificateResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetSiteOriginClientCertificateResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The Common Name of the certificate.
+   * The common name of the certificate.
    * 
    * @example
    * www.example.com
@@ -13,7 +13,7 @@ export class GetSiteOriginClientCertificateResponseBodyResult extends $dara.Mode
   commonName?: string;
   /**
    * @remarks
-   * The time when the certificate was created.
+   * The time when the certificate record was created.
    * 
    * @example
    * 2024-06-24 07:48:51
@@ -37,7 +37,7 @@ export class GetSiteOriginClientCertificateResponseBodyResult extends $dara.Mode
   id?: string;
   /**
    * @remarks
-   * The certificate authority (CA) that issued the certificate.
+   * The issuer of the certificate.
    * 
    * @example
    * DigiCert
@@ -53,7 +53,7 @@ export class GetSiteOriginClientCertificateResponseBodyResult extends $dara.Mode
   name?: string;
   /**
    * @remarks
-   * The time when the certificate expires.
+   * The time after which the certificate is not valid.
    * 
    * @example
    * 2024-03-31 02:08:00
@@ -61,7 +61,7 @@ export class GetSiteOriginClientCertificateResponseBodyResult extends $dara.Mode
   notAfter?: string;
   /**
    * @remarks
-   * The time when the certificate takes effect.
+   * The time before which the certificate is not valid.
    * 
    * @example
    * 2023-03-31 02:08:00
@@ -69,7 +69,7 @@ export class GetSiteOriginClientCertificateResponseBodyResult extends $dara.Mode
   notBefore?: string;
   /**
    * @remarks
-   * The public-key algorithm of the certificate.
+   * The public key algorithm of the certificate.
    * 
    * @example
    * RSA
@@ -77,7 +77,7 @@ export class GetSiteOriginClientCertificateResponseBodyResult extends $dara.Mode
   pubkeyAlgorithm?: string;
   /**
    * @remarks
-   * The Subject Alternative Name (SAN) of the certificate.
+   * The subject alternative name (SAN) of the certificate.
    * 
    * @example
    * www.example.com,*.example.com
@@ -101,7 +101,7 @@ export class GetSiteOriginClientCertificateResponseBodyResult extends $dara.Mode
   signatureAlgorithm?: string;
   /**
    * @remarks
-   * The status of the certificate.
+   * The certificate status.
    * 
    * @example
    * OK
@@ -117,7 +117,7 @@ export class GetSiteOriginClientCertificateResponseBodyResult extends $dara.Mode
   type?: string;
   /**
    * @remarks
-   * The time when the certificate was updated.
+   * The time when the certificate record was last updated.
    * 
    * @example
    * 2024-07-20 06:18:42
@@ -183,7 +183,7 @@ export class GetSiteOriginClientCertificateResponseBody extends $dara.Model {
   certificate?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 34DCBC8A-****-****-****-6DAA11D7DDBD
@@ -191,12 +191,12 @@ export class GetSiteOriginClientCertificateResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The certificate information.
+   * The certificate details.
    */
   result?: GetSiteOriginClientCertificateResponseBodyResult;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID.
    * 
    * @example
    * 123456789****
@@ -204,7 +204,7 @@ export class GetSiteOriginClientCertificateResponseBody extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The website name.
+   * The site name.
    * 
    * @example
    * example.com
@@ -212,7 +212,7 @@ export class GetSiteOriginClientCertificateResponseBody extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * The status of the certificate.
+   * The certificate status.
    * 
    * @example
    * OK

package/src/models/GetSitePauseRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetSitePauseRequest extends $dara.Model {
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
+   * The site ID. Call the [ListSites](~~ListSites~~) operation to obtain this ID.
    * 
    * This parameter is required.
    * 

package/src/models/GetSitePauseResponseBody.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class GetSitePauseResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether ESA is paused on the website. Valid values:
+   * Indicates whether site acceleration is paused. Valid values:
    * 
-   * *   true
-   * *   false
+   * - true: The site\\"s acceleration is paused.
+   * 
+   * - false: The site is accelerating normally.
    * 
    * @example
    * true

package/src/models/GetSiteRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetSiteRequest extends $dara.Model {
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The ID of the site. Call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain this ID.
    * 
    * This parameter is required.
    * 

package/src/models/GetSiteResponseBody.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class GetSiteResponseBodySiteModel extends $dara.Model {
   /**
    * @remarks
-   * The DNS setup option for the website. Valid values:
+   * The access type of the site. Valid values:
    * 
-   * *   **NS**
-   * *   **CNAME**
+   * - **NS**: Access via NS.
+   * 
+   * - **CNAME**: Access via CNAME.
    * 
    * @example
    * NS
@@ -16,7 +17,7 @@ export class GetSiteResponseBodySiteModel extends $dara.Model {
   accessType?: string;
   /**
    * @remarks
-   * The CNAME of the website domain. If you use CNAME setup when you add your website to ESA, the value is the CNAME that you configured then.
+   * For sites onboarded via CNAME, use this suffix to configure the CNAME record.
    * 
    * @example
    * example.cname.com
@@ -24,11 +25,13 @@ export class GetSiteResponseBodySiteModel extends $dara.Model {
   cnameZone?: string;
   /**
    * @remarks
-   * The service location. Valid values:
+   * The acceleration region. Valid values:
+   * 
+   * - **domestic**: Chinese mainland only
    * 
-   * *   **domestic**: the Chinese mainland.
-   * *   **global**: global.
-   * *   **overseas**: outside the Chinese mainland.
+   * - **global**: Global
+   * 
+   * - **overseas**: Global (excluding the Chinese mainland)
    * 
    * @example
    * domestic
@@ -36,7 +39,7 @@ export class GetSiteResponseBodySiteModel extends $dara.Model {
   coverage?: string;
   /**
    * @remarks
-   * The time when the WEBsite was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.
+   * The time (in UTC) when the site was created, formatted in ISO 8601 (`yyyy-MM-ddTHH:mm:ssZ`).
    * 
    * @example
    * 2023-12-24T02:01:11Z
@@ -44,7 +47,7 @@ export class GetSiteResponseBodySiteModel extends $dara.Model {
   createTime?: string;
   /**
    * @remarks
-   * The plan ID.
+   * The ID of the plan instance.
    * 
    * @example
    * cas-merge-q6h0bv
@@ -52,16 +55,33 @@ export class GetSiteResponseBodySiteModel extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The nameservers assigned to the website domain. They are separated by commas (,).
+   * A comma-separated list of name servers assigned to the site.
    * 
    * @example
    * male1-1.ialicdn.com,female1-1.ialicdn.com
    */
   nameServerList?: string;
+  /**
+   * @remarks
+   * The reason the site is offline. This parameter appears only when `Status` is `offline`. Valid values:
+   * 
+   * - **expiration_arrears**: The subscription plan has expired or the account has overdue payments.
+   * 
+   * - **internally_disabled**: The site was disabled by the system.
+   * 
+   * - **missing_icp**: The domain is missing an ICP license.
+   * 
+   * - **content_violation**: The site violated content policies.
+   * 
+   * - **proactively_disabled**: The site was disabled either by you or by a usage limit that you configured.
+   * 
+   * @example
+   * expiration_ arrears
+   */
   offlineReason?: string;
   /**
    * @remarks
-   * The plan name.
+   * The name of the plan.
    * 
    * @example
    * plan-168777532****
@@ -69,7 +89,7 @@ export class GetSiteResponseBodySiteModel extends $dara.Model {
   planName?: string;
   /**
    * @remarks
-   * The specification of the plan associated with the website.
+   * The name of the plan specification.
    * 
    * @example
    * normal
@@ -77,7 +97,7 @@ export class GetSiteResponseBodySiteModel extends $dara.Model {
   planSpecName?: string;
   /**
    * @remarks
-   * The ID of your Alibaba Cloud resource group.
+   * The ID of the resource group.
    * 
    * @example
    * rg-aek26g6i6se****
@@ -85,7 +105,7 @@ export class GetSiteResponseBodySiteModel extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The website ID.
+   * The ID of the site.
    * 
    * @example
    * 1234567890123
@@ -93,7 +113,7 @@ export class GetSiteResponseBodySiteModel extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The website name.
+   * The name of the site.
    * 
    * @example
    * example.com
@@ -101,12 +121,15 @@ export class GetSiteResponseBodySiteModel extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * The website status. Valid values:
+   * The status of the site. Valid values:
+   * 
+   * - **pending**: The site is pending configuration.
+   * 
+   * - **active**: The site is active.
+   * 
+   * - **offline**: The site is offline.
    * 
-   * *   **pending**: The website is to be configured.
-   * *   **active**: The website is active.
-   * *   **offline**: The website is suspended.
-   * *   **moved**: The website has been added and verified by another Alibaba Cloud account.
+   * - **moved**: The site has been superseded.
    * 
    * @example
    * pending
@@ -114,7 +137,7 @@ export class GetSiteResponseBodySiteModel extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The tags of the website.
+   * The tags of the site.
    * 
    * @example
    * {"tag1":"value1"}
@@ -122,7 +145,7 @@ export class GetSiteResponseBodySiteModel extends $dara.Model {
   tags?: { [key: string]: any };
   /**
    * @remarks
-   * The time when the WEBsite was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.
+   * The time (in UTC) when the site was last updated, formatted in ISO 8601 (`yyyy-MM-ddTHH:mm:ssZ`).
    * 
    * @example
    * 2023-12-24T02:01:11Z
@@ -130,12 +153,12 @@ export class GetSiteResponseBodySiteModel extends $dara.Model {
   updateTime?: string;
   /**
    * @remarks
-   * The information about custom nameservers of the website domain. The key is a custom nameserver name, and the value is the IP address of the custom nameserver. Multiple IP addresses are separated by commas (,).
+   * Each key is a custom name server, and its value is a comma-separated list of the server\\"s IP addresses.
    */
   vanityNSList?: { [key: string]: string };
   /**
    * @remarks
-   * The code that is used to verify the website domain ownership. As part of the verification TXT record, this parameter is returned for websites that use CNAME setup.
+   * For sites onboarded via CNAME, you must configure this code as a TXT record.
    * 
    * @example
    * verify_d516cb3740f81f0cef77d162edd1****
@@ -143,7 +166,7 @@ export class GetSiteResponseBodySiteModel extends $dara.Model {
   verifyCode?: string;
   /**
    * @remarks
-   * The status of version management. If true is returned, version management is enabled for the website.
+   * If `true`, version management is enabled for the site.
    * 
    * @example
    * true
@@ -221,7 +244,7 @@ export class GetSiteResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The queried website information.
+   * The details of the site.
    */
   siteModel?: GetSiteResponseBodySiteModel;
   static names(): { [key: string]: string } {

package/src/models/GetTransportLayerApplicationRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetTransportLayerApplicationRequest extends $dara.Model {
   /**
    * @remarks
-   * Number of forwarding rules contained in the transport layer acceleration application.
+   * The application ID. Call the [ListTransportLayerApplications](~~ListTransportLayerApplications~~) API to obtain this ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class GetTransportLayerApplicationRequest extends $dara.Model {
   applicationId?: number;
   /**
    * @remarks
-   * Transport layer application ID.
+   * The site ID. Call the [ListSites](~~ListSites~~) API to obtain this ID.
    * 
    * This parameter is required.
    * 

package/src/models/GetTransportLayerApplicationResponseBody.ts

@@ -5,7 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class GetTransportLayerApplicationResponseBodyRules extends $dara.Model {
   /**
    * @remarks
-   * The domain name of the transport layer application.
+   * The client IP pass-through mode. Valid values:
+   * 
+   * - **off**: Client IP pass-through is disabled.
+   * 
+   * - **PPv1**: PROXY Protocol v1, which supports client IP pass-through for TCP.
+   * 
+   * - **PPv2**: PROXY Protocol v2, which supports client IP pass-through for both TCP and UDP.
+   * 
+   * - **SPP**: Simple Proxy Protocol, which supports client IP pass-through for UDP.
    * 
    * @example
    * off
@@ -13,18 +21,21 @@ export class GetTransportLayerApplicationResponseBodyRules extends $dara.Model {
   clientIPPassThroughMode?: string;
   /**
    * @remarks
-   * Switch for IP access rules. When turned on, the IP access rules in WAF take effect on the transport layer application.
-   * 
-   * - on: Turned on.
-   * - off: Turned off.
+   * A comment about the forwarding rule.
    * 
    * @example
-   * IPv6 switch.
+   * Test
    */
   comment?: string;
   /**
    * @remarks
-   * Comment information of the rule.
+   * The edge port. The following formats are supported:
+   * 
+   * - A single port, for example, `80`.
+   * 
+   * - A port range, such as `81-85` (ports 81 to 85).
+   * 
+   * - A comma-separated list of ports and port ranges, such as `80,81-85,90`.
    * 
    * @example
    * 80
@@ -32,11 +43,11 @@ export class GetTransportLayerApplicationResponseBodyRules extends $dara.Model {
   edgePort?: string;
   /**
    * @remarks
-   * Client IP pass-through protocol, supporting:
-   * - **off**: No pass-through.
-   * - **PPv1**: PROXY Protocol v1, supports client IP pass-through for TCP protocol.
-   * - **PPv2**: PROXY Protocol v2, supports client IP pass-through for TCP and UDP protocols.
-   * - **SPP**: Simple Proxy Protocol, supports client IP pass-through for UDP protocol.
+   * The protocol for the forwarding rule. Valid values:
+   * 
+   * - **TCP**: For TCP traffic.
+   * 
+   * - **UDP**: For UDP traffic.
    * 
    * @example
    * TCP
@@ -44,10 +55,7 @@ export class GetTransportLayerApplicationResponseBodyRules extends $dara.Model {
   protocol?: string;
   /**
    * @remarks
-   * Status of the transport layer application
-   * 
-   * - **deploying**: Deploying. In this state, modification and deletion are not allowed.
-   * - **active**: Active.
+   * The rule ID.
    * 
    * @example
    * 1234323***
@@ -55,10 +63,7 @@ export class GetTransportLayerApplicationResponseBodyRules extends $dara.Model {
   ruleId?: number;
   /**
    * @remarks
-   * Origin port. Supports:
-   * 
-   * - A single port, when the origin port is a single port, any valid edge port combination is supported.
-   * - Port range, only when the edge port is a port range, the origin port can be set as a port range and the size of the range must be consistent with the edge port. For example, if the edge port is 90-93, the origin port cannot be set to 81-85 because the origin port range is 5 and the edge port range is 3, which are inconsistent.
+   * The origin. This value must be consistent with the specified origin type.
    * 
    * @example
    * 1.1.1.1
@@ -66,7 +71,11 @@ export class GetTransportLayerApplicationResponseBodyRules extends $dara.Model {
   source?: string;
   /**
    * @remarks
-   * The CNAME domain corresponding to the transport layer acceleration application. This field is not empty only when the site is accessed via CNAME.
+   * The origin port. The following formats are supported:
+   * 
+   * - A single port. A single origin port can be mapped to one or more edge ports.
+   * 
+   * - A port range. When mapping a range of edge ports to a range of origin ports, both ranges must contain the same number of ports. For example, you cannot map edge ports `90-93` (4 ports) to origin ports `81-85` (5 ports).
    * 
    * @example
    * 80
@@ -74,7 +83,15 @@ export class GetTransportLayerApplicationResponseBodyRules extends $dara.Model {
   sourcePort?: string;
   /**
    * @remarks
-   * Rule ID.
+   * The origin type. Valid values:
+   * 
+   * - **ip**: An IP address.
+   * 
+   * - **domain**: A domain name.
+   * 
+   * - **OP**: An origin address pool.
+   * 
+   * - **LB**: A load balancer.
    * 
    * @example
    * domain
@@ -144,7 +161,7 @@ export class GetTransportLayerApplicationResponseBodyStaticIpV4List extends $dar
 export class GetTransportLayerApplicationResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Specific value of the origin, which needs to match the type of the origin.
+   * The ID of the Transport Layer Application.
    * 
    * @example
    * 17099311410****
@@ -152,22 +169,31 @@ export class GetTransportLayerApplicationResponseBody extends $dara.Model {
   applicationId?: number;
   /**
    * @remarks
-   * Whether to enable China mainland network access optimization, default is off. Value range:
-   * - on: Enabled.
-   * - off: Disabled.
+   * The CNAME domain name of the Transport Layer Application. This parameter is returned only if the Site was added using the CNAME method.
    * 
    * @example
    * example.com.ialicdn.com
    */
   cname?: string;
   /**
+   * @remarks
+   * Indicates whether network optimization for access from the Chinese mainland is enabled. This feature is disabled by default. Valid values:
+   * 
+   * - **on**: Enabled.
+   * 
+   * - **off**: Disabled.
+   * 
    * @example
    * on
    */
   crossBorderOptimization?: string;
   /**
    * @remarks
-   * #/components/schemas/WafRuleMatch2
+   * Indicates whether the IP Access Rule feature is enabled. If enabled, IP Access Rules in Web Application Firewall (WAF) take effect for the Transport Layer Application. Valid values:
+   * 
+   * - **on**: Enabled.
+   * 
+   * - **off**: Disabled.
    * 
    * @example
    * on
@@ -175,16 +201,20 @@ export class GetTransportLayerApplicationResponseBody extends $dara.Model {
   ipAccessRule?: string;
   /**
    * @remarks
-   * Ipv6 switch
+   * Indicates whether IPv6 is enabled.
    * 
    * @example
    * on
    */
   ipv6?: string;
+  /**
+   * @remarks
+   * Indicates whether keep-alive protection is enabled.
+   */
   keepAliveProtection?: string;
   /**
    * @remarks
-   * Query Transport Layer Acceleration Application
+   * The domain name of the Transport Layer Application.
    * 
    * @example
    * test.example.com
@@ -192,7 +222,7 @@ export class GetTransportLayerApplicationResponseBody extends $dara.Model {
   recordName?: string;
   /**
    * @remarks
-   * Id of the request
+   * The ID of the request.
    * 
    * @example
    * EB635996-1FD6-5DFD-BA57-27A849599940
@@ -200,19 +230,12 @@ export class GetTransportLayerApplicationResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Edge port. Supports:
-   * 
-   * - A single port, such as 80.
-   * - Port range, such as 81-85, representing ports 81, 82, 83, 84, 85.
-   * - Combination of ports and port ranges, separated by commas, for example 80,81-85,90, representing ports 80, 81, 82, 83, 84, 85, 90.
+   * A list of forwarding rules.
    */
   rules?: GetTransportLayerApplicationResponseBodyRules[];
   /**
    * @remarks
-   * Forwarding rule protocol, with values:
-   * 
-   * - TCP: TCP protocol.
-   * - UDP: UDP protocol.
+   * The number of forwarding rules in the Transport Layer Application.
    * 
    * @example
    * 1
@@ -220,7 +243,7 @@ export class GetTransportLayerApplicationResponseBody extends $dara.Model {
   rulesCount?: number;
   /**
    * @remarks
-   * Details of the forwarding rule.
+   * The ID of the Site.
    * 
    * @example
    * 123456****
@@ -229,6 +252,13 @@ export class GetTransportLayerApplicationResponseBody extends $dara.Model {
   staticIp?: string;
   staticIpV4List?: GetTransportLayerApplicationResponseBodyStaticIpV4List[];
   /**
+   * @remarks
+   * The status of the Transport Layer Application. Valid values:
+   * 
+   * - **deploying**: The application is deploying. You cannot modify or delete the application in this state.
+   * 
+   * - **active**: The application is active.
+   * 
    * @example
    * active
    */

package/src/models/GetUploadTaskRequest.ts

@@ -5,7 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GetUploadTaskRequest extends $dara.Model {
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * >Notice: This parameter is required when querying an upload task..
    * 
    * @example
    * 123456****
@@ -13,7 +14,8 @@ export class GetUploadTaskRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The ID of the file upload task. This field is assigned after you call the [UploadFile](https://help.aliyun.com/document_detail/2850466.html) operation.
+   * The file upload task ID, which is assigned when you call the [UploadFile](https://help.aliyun.com/document_detail/2850466.html) operation.
+   * >Notice: This parameter is required and must be a valid task ID returned by the UploadFile operation. If this parameter is not provided or the specified ID does not exist, an InvalidParameters (400) error is returned..
    * 
    * @example
    * 159253299357****

package/src/models/GetUploadTaskResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetUploadTaskResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The error message returned when the file upload task failed.
+   * The error message returned when the file upload task fails.
    * 
    * @example
    * invalid url
@@ -21,14 +21,14 @@ export class GetUploadTaskResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The task status.
+   * The task status. Valid values:
    * 
-   * *   **INIT**: The task is being initialized.
-   * *   **activacted**: The task is activated.
-   * *   **running**: The task is running.
-   * *   **success**: The task is successful.
-   * *   **partial**: The task is partially successful.
-   * *   **fail**: The task failed.
+   * - **init**: The task is being initialized.
+   * - **activacted**: The task is activated.
+   * - **running**: The task is running.
+   * - **success**: The task succeeded.
+   * - **partial**: The task partially succeeded.
+   * - **fail**: The task failed.
    * 
    * @example
    * running

package/src/models/GetUserDeliveryTaskRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetUserDeliveryTaskRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the delivery task.
+   * The task name.
    * 
    * This parameter is required.
    *