@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/ListClientCertificatesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListClientCertificatesResponseBodyResult extends $dara.Model {
   /**
    * @remarks
-   * The ID of the CA certificate.
+   * The CA certificate ID.
    * 
    * @example
    * baba39055622c008b90285a8838ed09a
@@ -13,7 +13,7 @@ export class ListClientCertificatesResponseBodyResult extends $dara.Model {
   CACertificateId?: string;
   /**
    * @remarks
-   * The Common Name of the certificate.
+   * The common name of the certificate.
    * 
    * @example
    * www.example.com
@@ -21,12 +21,16 @@ export class ListClientCertificatesResponseBodyResult extends $dara.Model {
   commonName?: string;
   /**
    * @remarks
-   * The time when the certificate was created.
+   * The creation time of the certificate.
    * 
    * @example
    * 2024-06-24 07:48:51
    */
   createTime?: string;
+  /**
+   * @remarks
+   * The SHA-256 fingerprint of the certificate.
+   */
   fingerprintSha256?: string;
   /**
    * @remarks
@@ -38,7 +42,7 @@ export class ListClientCertificatesResponseBodyResult extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The certificate authority (CA) that issued the certificate.
+   * The certificate issuer.
    * 
    * @example
    * GlobalSign nv-sa
@@ -62,7 +66,7 @@ export class ListClientCertificatesResponseBodyResult extends $dara.Model {
   notAfter?: string;
   /**
    * @remarks
-   * The time when the certificate takes effect.
+   * The time when the certificate becomes valid.
    * 
    * @example
    * 2023-03-31 02:08:00
@@ -78,12 +82,16 @@ export class ListClientCertificatesResponseBodyResult extends $dara.Model {
   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
    */
   SAN?: string;
+  /**
+   * @remarks
+   * The serial number of the certificate.
+   */
   serialNumber?: string;
   /**
    * @remarks
@@ -111,7 +119,7 @@ export class ListClientCertificatesResponseBodyResult extends $dara.Model {
   type?: string;
   /**
    * @remarks
-   * The time when the certificate was updated.
+   * The last update time of the certificate.
    * 
    * @example
    * 2024-07-20 06:18:42
@@ -171,7 +179,7 @@ export class ListClientCertificatesResponseBodyResult extends $dara.Model {
 export class ListClientCertificatesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The page number returned.
+   * The page number of the returned entries.
    * 
    * @example
    * 1
@@ -195,12 +203,12 @@ export class ListClientCertificatesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The client certificates.
+   * The list of client certificates.
    */
   result?: ListClientCertificatesResponseBodyResult[];
   /**
    * @remarks
-   * The website ID.
+   * The site ID.
    * 
    * @example
    * 1234567890123
@@ -208,7 +216,7 @@ export class ListClientCertificatesResponseBody extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The website name.
+   * The site name.
    * 
    * @example
    * example.com

package/src/models/ListCustomHostnamesRequest.ts

@@ -4,32 +4,53 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListCustomHostnamesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The SaaS domain name.
+   * 
    * @example
    * custom.site.com
    */
   hostname?: string;
   /**
+   * @remarks
+   * The search match mode for the SaaS domain name. Default value: exact. Valid values:
+   * - **prefix**: prefix match.
+   * - **suffix**: suffix match.
+   * - **exact**: exact match.
+   * - **fuzzy**: fuzzy match.
+   * 
    * @example
    * exact
    */
   nameMatchType?: string;
   /**
+   * @remarks
+   * The page number, starting from 1. Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page. Default value: 100. Maximum value: 500.
+   * 
    * @example
    * 100
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The associated record ID. You can call the [ListRecords](https://help.aliyun.com/document_detail/2850265.html) operation to obtain the record ID.
+   * 
    * @example
    * 1234567890123
    */
   recordId?: number;
   /**
    * @remarks
+   * The site ID. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain the site ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -37,6 +58,13 @@ export class ListCustomHostnamesRequest extends $dara.Model {
    */
   siteId?: number;
   /**
+   * @remarks
+   * The SaaS domain name status. Valid values:
+   * - **pending**: pending verification.
+   * - **active**: activated.
+   * - **conflicted**: occupied.
+   * - **offline**: offline.
+   * 
    * @example
    * active
    */

package/src/models/ListCustomHostnamesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   /**
    * @remarks
-   * 免费证书申请错误码
+   * The error code for the free certificate application.
    * 
    * @example
    * 2
@@ -13,7 +13,7 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   certApplyCode?: number;
   /**
    * @remarks
-   * 免费证书申请错误说明
+   * The error description for the free certificate application.
    * 
    * @example
    * canceled
@@ -21,7 +21,7 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   certApplyMessage?: string;
   /**
    * @remarks
-   * 证书校验HTTP名称
+   * The HTTP address for certificate verification.
    * 
    * @example
    * http://custom.site.com/.well-known/acme-challenge/jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc
@@ -29,7 +29,7 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   certHttpKey?: string;
   /**
    * @remarks
-   * 证书校验HTTP内容
+   * The HTTP content for certificate verification.
    * 
    * @example
    * jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc.GridYdfJJB5PgFEL-t89XfaFvMPB4f2-I9fwLpKl6e0
@@ -37,20 +37,28 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   certHttpValue?: string;
   /**
    * @remarks
-   * 证书过期时间
+   * The certificate expiration time, in the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
    * 
    * @example
    * 2026-04-19T11:15:20Z
    */
   certNotAfter?: string;
   /**
+   * @remarks
+   * The certificate status. Valid values:
+   * - **OK**: Normal.
+   * - **Applying**: Being applied.
+   * - **ApplyFailed**: Application failed.
+   * - **Expiring**: About to expire.
+   * - **Expired**: Expired.
+   * 
    * @example
    * OK
    */
   certStatus?: string;
   /**
    * @remarks
-   * 证书校验TXT名称
+   * The TXT name for certificate verification.
    * 
    * @example
    * _acme-challenge.custom.site.com
@@ -58,7 +66,7 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   certTxtKey?: string;
   /**
    * @remarks
-   * 证书校验TXT内容
+   * The TXT content for certificate verification.
    * 
    * @example
    * lcKYad3UQXgrZLvMm_6TBUYKK4xTkGmninV0Mzx4gjM
@@ -66,20 +74,30 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   certTxtValue?: string;
   /**
    * @remarks
-   * 证书类型
+   * The certificate type. Valid values:
+   * - **free**: free certificate.
+   * - **upload**: uploaded certificate.
+   * - **cas**: SSL Certificates Service certificate.
    * 
    * @example
    * free
    */
   certType?: string;
   /**
+   * @remarks
+   * The reason why the SaaS domain name is occupied. Valid values:
+   * - **existing_custom_hostname**: Conflicts with an existing SaaS domain name.
+   * - **existing_record**: Conflicts with an existing site record.
+   * - **existing_load_balancer**: Conflicts with an existing load balancing instance.
+   * - **existing_origin_pool**: Conflicts with an existing origin IPAM pool.
+   * 
    * @example
    * existing_custom_hostname
    */
   conflictWith?: string;
   /**
    * @remarks
-   * 创建时间
+   * The time when the SaaS domain name was created, in the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
    * 
    * @example
    * 2026-04-19T11:15:20Z
@@ -87,25 +105,36 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   createTime?: string;
   /**
    * @remarks
-   * 用户自定义的主机名
+   * The SaaS domain name.
    * 
    * @example
    * custom.site.com
    */
   hostname?: string;
   /**
+   * @remarks
+   * The ID of the SaaS domain name.
+   * 
    * @example
    * 1234567890123
    */
   hostnameId?: number;
   /**
+   * @remarks
+   * The reason why the SaaS domain name was taken offline. Valid values:
+   * - **expiration_ arrears**: The subscription plan has expired or the account has an overdue payment.
+   * - **internally_disabled**: Disabled by the system.
+   * - **missing_icp**: The domain name does not have an ICP filing.
+   * - **content_violation**: Content violation.
+   * - **proactively_disabled**: You proactively disabled the domain name or the usage cap you configured was reached.
+   * 
    * @example
    * missing_icp
    */
   offlineReason?: string;
   /**
    * @remarks
-   * 绑定的源站记录ID
+   * The record ID.
    * 
    * @example
    * 3386032455886912
@@ -113,7 +142,7 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   recordId?: number;
   /**
    * @remarks
-   * 绑定的源站记录名
+   * The record name.
    * 
    * @example
    * origin.example.com
@@ -121,7 +150,7 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   recordName?: string;
   /**
    * @remarks
-   * 与主机名关联的站点ID
+   * The site ID.
    * 
    * @example
    * 890601022130656
@@ -129,7 +158,7 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * 关联站点名称
+   * The site name.
    * 
    * @example
    * example.com
@@ -137,7 +166,9 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * SSL开关的状态
+   * The SSL switch. Valid values:
+   * - **on**: SSL is enabled.
+   * - **off**: SSL is disabled.
    * 
    * @example
    * on
@@ -145,7 +176,12 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   sslFlag?: string;
   /**
    * @remarks
-   * 自定义主机名状态
+   * The SaaS domain name status. Valid values:
+   * - **pending**: pending verification.
+   * - **active**: activated.
+   * - **conflicted**: occupied.
+   * - **offline**: offline.
+   * - **configuring**: being configured.
    * 
    * @example
    * active
@@ -153,7 +189,7 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * 更新时间
+   * The time when the SaaS domain name was last updated, in the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
    * 
    * @example
    * 2026-04-19T11:15:20Z
@@ -161,7 +197,7 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   updateTime?: string;
   /**
    * @remarks
-   * 归属校验TXT内容
+   * The TXT content for domain name verification.
    * 
    * @example
    * verify_16ab7f4d389d4dff6655f995c6a997bd
@@ -169,7 +205,7 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
   verifyCode?: string;
   /**
    * @remarks
-   * 归属校验TXT名称
+   * The TXT name for domain name verification.
    * 
    * @example
    * _esa_custom_hostname.custom.site.com
@@ -241,23 +277,39 @@ export class ListCustomHostnamesResponseBodyHostnames extends $dara.Model {
 }
 
 export class ListCustomHostnamesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of SaaS domain names.
+   */
   hostnames?: ListCustomHostnamesResponseBodyHostnames[];
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 100
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID, which is a unique identifier generated by Alibaba Cloud for this request.
+   * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of SaaS domain names.
+   * 
    * @example
    * 10
    */

package/src/models/ListCustomResponseCodeRulesRequest.ts

@@ -13,10 +13,11 @@ export class ListCustomResponseCodeRulesRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The configuration type to query. Valid values:
+   * The configuration type. Use this parameter to query global or rule configurations. Valid values:
    * 
-   * *   global: global configurations.
-   * *   rule: rule configurations.
+   * - global: Queries global configurations.
+   * 
+   * - rule: Queries rule configurations.
    * 
    * @example
    * global
@@ -24,7 +25,7 @@ export class ListCustomResponseCodeRulesRequest extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * The page number. Default value: 1.
+   * The page number. The default value is 1 if you do not specify this parameter.
    * 
    * @example
    * 1
@@ -32,7 +33,7 @@ export class ListCustomResponseCodeRulesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Maximum value: 500. Default value: 500.
+   * The number of entries per page. The maximum value is 500. The default value is 500 if you do not specify this parameter.
    * 
    * @example
    * 20
@@ -48,7 +49,7 @@ export class ListCustomResponseCodeRulesRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID. For more information, see [ListSites](https://help.aliyun.com/document_detail/2850189.html).
    * 
    * This parameter is required.
    * 
@@ -58,7 +59,7 @@ export class ListCustomResponseCodeRulesRequest 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.
+   * The version number of the site configuration. For sites with configuration version control enabled, specify the site version for which the configuration takes effect using this parameter. The default value is version 0.
    * 
    * @example
    * 0

package/src/models/ListCustomResponseCodeRulesResponseBody.ts

@@ -15,8 +15,9 @@ export class ListCustomResponseCodeRulesResponseBodyConfigs extends $dara.Model
    * @remarks
    * The configuration type. Valid values:
    * 
-   * *   global: global configuration.
-   * *   rule: rule configuration.
+   * - global: Global configuration.
+   * 
+   * - rule: Rule configuration.
    * 
    * @example
    * global
@@ -24,7 +25,7 @@ export class ListCustomResponseCodeRulesResponseBodyConfigs extends $dara.Model
   configType?: string;
   /**
    * @remarks
-   * Response page.
+   * The response page.
    * 
    * @example
    * 0
@@ -32,7 +33,7 @@ export class ListCustomResponseCodeRulesResponseBodyConfigs extends $dara.Model
   pageId?: string;
   /**
    * @remarks
-   * Response code
+   * The response code.
    * 
    * @example
    * 200
@@ -40,10 +41,11 @@ export class ListCustomResponseCodeRulesResponseBodyConfigs extends $dara.Model
   returnCode?: 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:
+   * The rule content. Use a conditional expression to match user requests. Do not set this parameter when adding a global configuration. There are two scenarios:
+   * 
+   * - Match all incoming requests: Set the value to true.
    * 
-   * *   true: Match all incoming requests.
-   * *   Set the value to a custom expression, for example, (http.host eq "video.example.com"): Match the specified request.
+   * - Match specific requests: Set the value to a custom expression, such as (http.host eq "video.example.com").
    * 
    * @example
    * (http.host eq "video.example.com")
@@ -51,10 +53,11 @@ export class ListCustomResponseCodeRulesResponseBodyConfigs extends $dara.Model
   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:
+   * The rule switch. Do not set this parameter when adding a global configuration. Valid values:
+   * 
+   * - on: Enabled.
    * 
-   * *   on
-   * *   off
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -62,7 +65,7 @@ export class ListCustomResponseCodeRulesResponseBodyConfigs extends $dara.Model
   ruleEnable?: string;
   /**
    * @remarks
-   * The rule name. You do not need to set this parameter when you add global configuration.
+   * The rule name. Do not set this parameter when adding a global configuration.
    * 
    * @example
    * rule_example
@@ -70,7 +73,7 @@ export class ListCustomResponseCodeRulesResponseBodyConfigs extends $dara.Model
   ruleName?: string;
   /**
    * @remarks
-   * The order in which the rule is executed. A smaller value gives priority to the rule.
+   * The rule execution order. A smaller value indicates higher priority.
    * 
    * @example
    * 1
@@ -78,7 +81,7 @@ export class ListCustomResponseCodeRulesResponseBodyConfigs extends $dara.Model
   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.
+   * The version number of the site configuration. For sites with configuration version control enabled, this parameter specifies the site version for which the configuration takes effect. The default value is version 0.
    * 
    * @example
    * 0
@@ -124,12 +127,12 @@ export class ListCustomResponseCodeRulesResponseBodyConfigs extends $dara.Model
 export class ListCustomResponseCodeRulesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Modifies the list of response code configurations.
+   * You can modify the response code configuration list.
    */
   configs?: ListCustomResponseCodeRulesResponseBodyConfigs[];
   /**
    * @remarks
-   * The number of the returned page. Default value: **1**.
+   * The page number. Default value: **1**.
    * 
    * @example
    * 1
@@ -137,7 +140,7 @@ export class ListCustomResponseCodeRulesResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Default value: 500. Valid values: 1 to 500.
+   * The page size. Default value: 500. Valid values: 1 to 500.
    * 
    * @example
    * 20
@@ -145,7 +148,7 @@ export class ListCustomResponseCodeRulesResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 36af3fcc-43d0-441c-86b1-428951dc8225
@@ -153,7 +156,7 @@ export class ListCustomResponseCodeRulesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 10
@@ -161,7 +164,7 @@ export class ListCustomResponseCodeRulesResponseBody extends $dara.Model {
   totalCount?: number;
   /**
    * @remarks
-   * The total number of pages returned.
+   * The total number of pages.
    * 
    * @example
    * 1

package/src/models/ListDdoSinstancesRequest.ts

@@ -4,36 +4,63 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListDDoSInstancesRequest extends $dara.Model {
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * esa-ddos-b1e0l80ugfeo
    */
   instanceId?: string;
   /**
+   * @remarks
+   * Page number. Default: **1**.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * Number of entries per page. Default: 20. Maximum: 500. Valid values: integers from 1 to 500.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
+   * @remarks
+   * Associated site package instance ID.
+   * 
    * @example
    * esa-site-a71k7bw1adf
    */
   siteInstanceId?: string;
   /**
+   * @remarks
+   * Sort field. Default: CreateTime.
+   * 
+   * - **CreateTime**: Time when the instance was purchased.
+   * 
    * @example
    * CreateTime
    */
   sortBy?: string;
   /**
+   * @remarks
+   * Sort order:
+   * 
+   * - asc: ascending.
+   * 
+   * - desc: descending.
+   * 
    * @example
    * asc
    */
   sortOrder?: string;
   /**
+   * @remarks
+   * Instance status.
+   * 
    * @example
    * online
    */