@alicloud/waf-openapi20211001 6.5.2 → 6.6.1

package/src/models/DescribeHybridCloudResourcesResponseBody.ts

@@ -13,11 +13,13 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsListen extends $dara
   certId?: string;
   /**
    * @remarks
-   * The types of cipher suites that are added. Valid values:
+   * The type of the cipher suite. Valid values:
    * 
-   * *   **1:** all cipher suites.
-   * *   **2:** strong cipher suites.
-   * *   **99:** custom cipher suites.
+   * - **1**: all cipher suites.
+   * 
+   * - **2**: strong cipher suites.
+   * 
+   * - **99**: custom cipher suites.
    * 
    * @example
    * 1
@@ -25,17 +27,18 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsListen extends $dara
   cipherSuite?: number;
   /**
    * @remarks
-   * The custom cipher suites.
+   * The custom cipher suites to be added.
    * 
-   * >  This parameter is returned only if the value of **CipherSuite** is **99**.
+   * > This parameter is returned only when **CipherSuite** is set to **99**.
    */
   customCiphers?: string[];
   /**
    * @remarks
    * Indicates whether TLS 1.3 is supported. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **true**
+   * 
+   * - **false**
    * 
    * @example
    * true
@@ -43,10 +46,11 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsListen extends $dara
   enableTLSv3?: boolean;
   /**
    * @remarks
-   * Indicates whether exclusive IP addresses are supported. Valid values:
+   * Indicates whether an exclusive IP address is used. Valid values:
+   * 
+   * - **true**
    * 
-   * *   **true**
-   * *   **false**
+   * - **false**
    * 
    * @example
    * true
@@ -54,10 +58,11 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsListen extends $dara
   exclusiveIp?: boolean;
   /**
    * @remarks
-   * Indicates whether the HTTP to HTTPS redirection feature is enabled for the domain name. Valid values:
+   * Indicates whether HTTPS to HTTP redirection is enabled. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **true**
+   * 
+   * - **false**
    * 
    * @example
    * false
@@ -67,8 +72,9 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsListen extends $dara
    * @remarks
    * Indicates whether HTTP/2 is enabled. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **true**
+   * 
+   * - **false**
    * 
    * @example
    * false
@@ -76,20 +82,21 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsListen extends $dara
   http2Enabled?: boolean;
   /**
    * @remarks
-   * The HTTP listener ports.
+   * The list of HTTP listener ports.
    */
   httpPorts?: number[];
   /**
    * @remarks
-   * The HTTPS listener ports.
+   * The list of HTTPS ports.
    */
   httpsPorts?: number[];
   /**
    * @remarks
-   * Specifies whether to enable IPv6. Valid values:
+   * Indicates whether IPv6 is enabled. Valid values:
+   * 
+   * - **true**
    * 
-   * *   **true**
-   * *   **false**
+   * - **false**
    * 
    * @example
    * false
@@ -99,8 +106,9 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsListen extends $dara
    * @remarks
    * The type of the protection resource. Valid values:
    * 
-   * *   **share:** shared cluster.
-   * *   **gslb:** shared cluster-based intelligent load balancing.
+   * - **share**: shared cluster.
+   * 
+   * - **gslb**: intelligent load balancing for a shared cluster.
    * 
    * @example
    * share
@@ -108,11 +116,13 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsListen extends $dara
   protectionResource?: string;
   /**
    * @remarks
-   * The version of the Transport Layer Security (TLS) protocol. Valid values:
+   * The TLS version. Valid values:
+   * 
+   * - **tlsv1**
+   * 
+   * - **tlsv1.1**
    * 
-   * *   **tlsv1**
-   * *   **tlsv1.1**
-   * *   **tlsv1.2**
+   * - **tlsv1.2**
    * 
    * @example
    * tlsv1.2
@@ -120,11 +130,13 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsListen extends $dara
   TLSVersion?: string;
   /**
    * @remarks
-   * The method that is used to obtain the actual IP address of a client. Valid values:
+   * The method that WAF uses to obtain the client IP address. Valid values:
    * 
-   * *   **0**: No Layer 7 proxies are deployed in front of WAF.
-   * *   **1**: WAF reads the first value of the X-Forwarded-For (XFF) header field as the actual IP address of the client.
-   * *   **2**: WAF reads the value of a custom header field as the actual IP address of the client.
+   * - **0**: No Layer 7 proxies are deployed in front of WAF.
+   * 
+   * - **1**: WAF reads the first value of the X-Forwarded-For (XFF) header field as the client IP address.
+   * 
+   * - **2**: WAF reads the value of a custom header field as the client IP address.
    * 
    * @example
    * 0
@@ -132,9 +144,9 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsListen extends $dara
   xffHeaderMode?: number;
   /**
    * @remarks
-   * The custom header fields that are used to obtain the actual IP addresses of clients. The value is in the ["header1","header2",...] format.
+   * The list of custom header fields that are used to obtain the client IP address. The value is in the \\`["header1","header2",...]\\` format.
    * 
-   * >  This parameter is returned only if the value of **XffHeaderMode** is 2.
+   * > This parameter is returned only when XffHeaderMode is set to **2**.
    */
   xffHeaders?: string[];
   static names(): { [key: string]: string } {
@@ -199,7 +211,7 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsListen extends $dara
 export class DescribeHybridCloudResourcesResponseBodyDomainsRedirectRequestHeaders extends $dara.Model {
   /**
    * @remarks
-   * The key of the custom header field.
+   * The custom request header field.
    * 
    * @example
    * aaa
@@ -207,7 +219,7 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsRedirectRequestHeade
   key?: string;
   /**
    * @remarks
-   * The value of the custom header field.
+   * The value of the custom request header field.
    * 
    * @example
    * bbb
@@ -239,15 +251,16 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsRedirectRequestHeade
 export class DescribeHybridCloudResourcesResponseBodyDomainsRedirect extends $dara.Model {
   /**
    * @remarks
-   * The IP addresses or domain names of the origin server.
+   * The IP addresses or domain names of the origin servers for back-to-origin.
    */
   backends?: string[];
   /**
    * @remarks
-   * Indicates whether the public cloud disaster recovery feature is enabled. Valid values:
+   * Indicates whether public cloud disaster recovery is enabled. Valid values:
+   * 
+   * - **true**
    * 
-   * *   **true**
-   * *   **false**
+   * - **false**
    * 
    * @example
    * true
@@ -255,7 +268,7 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsRedirect extends $da
   cnameEnabled?: boolean;
   /**
    * @remarks
-   * The timeout period for connections. Unit: seconds. Valid values: 5 to 120.
+   * The connection timeout period. Unit: seconds. Valid values: 5 to 120.
    * 
    * @example
    * 120
@@ -263,10 +276,11 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsRedirect extends $da
   connectTimeout?: number;
   /**
    * @remarks
-   * Indicates whether the HTTPS to HTTP redirection feature is enabled for back-to-origin requests. Valid values:
+   * Indicates whether back-to-origin requests are forcefully sent over HTTP. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **true**
+   * 
+   * - **false**
    * 
    * @example
    * true
@@ -274,10 +288,11 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsRedirect extends $da
   focusHttpBackend?: boolean;
   /**
    * @remarks
-   * Indicates whether the persistent connection feature is enabled. Valid values:
+   * Indicates whether persistent connections are enabled. Valid values:
+   * 
+   * - **true**
    * 
-   * *   **true**
-   * *   **false**
+   * - **false**
    * 
    * @example
    * true
@@ -285,9 +300,9 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsRedirect extends $da
   keepalive?: boolean;
   /**
    * @remarks
-   * The number of reused persistent connections. Valid values: 60 to 1000.
+   * The maximum number of requests that can be sent over a persistent connection. Valid values: 60 to 1000.
    * 
-   * >  This parameter indicates the number of reused persistent connections after the persistent connection feature is enabled.
+   * > After the specified number of requests are sent, the persistent connection is closed and a new connection is established.
    * 
    * @example
    * 1000
@@ -295,9 +310,9 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsRedirect extends $da
   keepaliveRequests?: number;
   /**
    * @remarks
-   * The timeout period for persistent connections that are in the Idle state. Unit: seconds. Valid values: 1 to 60. Default value: 15.
+   * The timeout period for an idle persistent connection. Valid values: 1 to 60. Default value: 15. Unit: seconds.
    * 
-   * >  This parameter indicates the period of time during which a reused persistent connection can remain in the Idle state before the persistent connection is released.
+   * > An idle persistent connection is released after the timeout period expires.
    * 
    * @example
    * 15
@@ -305,11 +320,13 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsRedirect extends $da
   keepaliveTimeout?: number;
   /**
    * @remarks
-   * The load balancing algorithm that is used to forward requests to the origin server. Valid values:
+   * The load balancing algorithm for back-to-origin requests. Valid values:
+   * 
+   * - **iphash**: the IP hash algorithm.
+   * 
+   * - **roundRobin**: the round-robin algorithm.
    * 
-   * *   **iphash**
-   * *   **roundRobin**
-   * *   **leastTime**
+   * - **leastTime**: the least time algorithm.
    * 
    * @example
    * iphash
@@ -317,7 +334,7 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsRedirect extends $da
   loadbalance?: string;
   /**
    * @remarks
-   * The timeout period for read connections. Unit: seconds. Valid values: 5 to 1800.
+   * The read timeout period. Unit: seconds. Valid values: 5 to 1800.
    * 
    * @example
    * 200
@@ -325,15 +342,16 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsRedirect extends $da
   readTimeout?: number;
   /**
    * @remarks
-   * The key-value pair that is used to label requests that pass through WAF.
+   * The custom header field and value that are used to mark the traffic that is processed by WAF.
    */
   requestHeaders?: DescribeHybridCloudResourcesResponseBodyDomainsRedirectRequestHeaders[];
   /**
    * @remarks
-   * Indicates whether WAF retries forwarding requests if requests fail to be forwarded to the origin server. Valid values:
+   * Indicates whether WAF retries forwarding requests when a back-to-origin request fails. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **true**
+   * 
+   * - **false**
    * 
    * @example
    * true
@@ -341,11 +359,13 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsRedirect extends $da
   retry?: boolean;
   /**
    * @remarks
-   * The forwarding rules that are configured for the domain name. This parameter is a string that consists of JSON arrays. Each element in a JSON array is a JSON struct that contains the following fields:
+   * The forwarding rules for the hybrid cloud. The value is a string that consists of a JSON array. Each element in the array is a struct that contains the following fields:
+   * 
+   * - **rs**: The back-to-origin IP addresses or CNAMEs. This field is of the Array type.
+   * 
+   * - **location**: The name of the protection node. This field is of the String type.
    * 
-   * *   **rs**: the back-to-origin IP addresses or CNAMEs. The value is of the ARRAY type.
-   * *   **location**: the name of the protection node. The value is of the STRING type.
-   * *   **locationId**: the ID of the protection node. The value is of the LONG type.
+   * - **locationId**: The ID of the protection node. This field is of the Long type.
    * 
    * @example
    * [
@@ -361,10 +381,11 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsRedirect extends $da
   routingRules?: string;
   /**
    * @remarks
-   * Indicates whether the origin Server Name Indication (SNI) feature is enabled. Valid values:
+   * Indicates whether back-to-origin Server Name Indication (SNI) is enabled. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **true**
+   * 
+   * - **false**
    * 
    * @example
    * true
@@ -372,9 +393,9 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsRedirect extends $da
   sniEnabled?: boolean;
   /**
    * @remarks
-   * The value of the custom SNI field. If the parameter is left empty, the value of the **Host** field in the request header is automatically used as the value of the SNI field.
+   * The custom value of the SNI extension field. If this parameter is not specified, the value of the **Host** field in the request header is used as the value of the SNI extension field by default.
    * 
-   * >  This parameter is returned only if the value of **SniEnabled** is **true**.
+   * > This parameter is returned only when **SniEnabled** is set to **true**.
    * 
    * @example
    * www.aliyundoc.com
@@ -382,7 +403,7 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsRedirect extends $da
   sniHost?: string;
   /**
    * @remarks
-   * The timeout period for write connections. Unit: seconds. Valid values: 5 to 1800.
+   * The write timeout period. Unit: seconds. Valid values: 5 to 1800.
    * 
    * @example
    * 200
@@ -446,9 +467,9 @@ export class DescribeHybridCloudResourcesResponseBodyDomainsRedirect extends $da
 export class DescribeHybridCloudResourcesResponseBodyDomains extends $dara.Model {
   /**
    * @remarks
-   * The CNAME assigned by WAF.
+   * The CNAME that is assigned by WAF to the domain name.
    * 
-   * >  This parameter is returned only if the value of **CnameEnabled** is true.
+   * > This parameter is returned only when **CnameEnabled** is set to true.
    * 
    * @example
    * 50fqmu1ci7g0xtiyxnrhgx6qdhmn****.yundunwaf5.com
@@ -464,25 +485,25 @@ export class DescribeHybridCloudResourcesResponseBodyDomains extends $dara.Model
   domain?: string;
   /**
    * @remarks
-   * The access ID.
+   * The ID of the domain name configuration.
    * 
    * @example
-   * 1
+   * 12345
    */
   id?: number;
   /**
    * @remarks
-   * The listeners.
+   * The listener configuration.
    */
   listen?: DescribeHybridCloudResourcesResponseBodyDomainsListen;
   /**
    * @remarks
-   * The configurations of the forwarding rule.
+   * The forwarding configuration.
    */
   redirect?: DescribeHybridCloudResourcesResponseBodyDomainsRedirect;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud resource group.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfmvtc5z52****
@@ -492,11 +513,15 @@ export class DescribeHybridCloudResourcesResponseBodyDomains extends $dara.Model
    * @remarks
    * The status of the domain name. Valid values:
    * 
-   * *   **1:** The domain name is in a normal state.
-   * *   **2:** The domain name is being created.
-   * *   **3:** The domain name is being modified.
-   * *   **4:** The domain name is being released.
-   * *   **5:** WAF no longer forwards the traffic of the domain name.
+   * - **1**: The domain name is in a normal state.
+   * 
+   * - **2**: The domain name is being created.
+   * 
+   * - **3**: The domain name is being modified.
+   * 
+   * - **4**: The domain name is being released.
+   * 
+   * - **5**: Forwarding is disabled for the domain name.
    * 
    * @example
    * 1
@@ -504,7 +529,7 @@ export class DescribeHybridCloudResourcesResponseBodyDomains extends $dara.Model
   status?: number;
   /**
    * @remarks
-   * The user ID.
+   * The ID of the Alibaba Cloud account.
    * 
    * @example
    * 130715431409****
@@ -554,7 +579,7 @@ export class DescribeHybridCloudResourcesResponseBodyDomains extends $dara.Model
 export class DescribeHybridCloudResourcesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The domain names.
+   * The list of domain names.
    */
   domains?: DescribeHybridCloudResourcesResponseBodyDomains[];
   /**
@@ -567,7 +592,7 @@ export class DescribeHybridCloudResourcesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries that are returned.
+   * The total number of entries returned.
    * 
    * @example
    * 24

package/src/models/DescribeHybridCloudSdkServersRequest.ts

@@ -3,33 +3,74 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeHybridCloudSdkServersRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the hybrid cloud cluster that you want to query.
+   * 
+   * @example
+   * testcluster
+   */
   clusterName?: string;
+  /**
+   * @remarks
+   * The hostname of the hybrid cloud SDK server that you want to query.
+   * 
+   * @example
+   * online-***wwq
+   */
   hostName?: string;
   /**
    * @remarks
+   * The ID of the WAF instance.
+   * 
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
+   * 
    * This parameter is required.
    * 
    * @example
    * waf_v3prepaid_public_cn-i7m2***0b
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * The IP address of the hybrid cloud SDK server that you want to query.
+   * 
+   * @example
+   * 1.*.*1。
+   */
   ip?: string;
   /**
+   * @remarks
+   * The page number. Default value: 1.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page. Default value: 10.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The region where the WAF instance resides. Valid values:
+   * 
+   * - **cn-hangzhou**: the Chinese mainland.
+   * 
+   * - **ap-southeast-1**: outside the Chinese mainland.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud resource group.
+   * 
    * @example
    * rg-acfm***q
    */

package/src/models/DescribeHybridCloudSdkServersResponseBody.ts

@@ -3,39 +3,86 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeHybridCloudSdkServersResponseBodySdkServers extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the hybrid cloud cluster to which the SDK server belongs.
+   * 
+   * @example
+   * testcluster
+   */
   clusterName?: string;
   /**
+   * @remarks
+   * The time when the hybrid cloud SDK server was created. This value is a UNIX timestamp in milliseconds.
+   * 
    * @example
    * 1621428205000
    */
   createTime?: number;
   /**
+   * @remarks
+   * The hostname of the hybrid cloud SDK server.
+   * 
    * @example
    * qsh5-sec-8-fedd**005
    */
   hostName?: string;
   /**
+   * @remarks
+   * The IP address of the hybrid cloud SDK server.
+   * 
    * @example
    * 127.0.0.1
    */
   ip?: string;
   /**
    * @remarks
-   * SDKID。
+   * The ID of the SDK server.
    * 
    * @example
    * b11327c21790846374051d5d**83c
    */
   mid?: string;
+  /**
+   * @remarks
+   * The address of the protection group associated with the SDK server.
+   * 
+   * @example
+   * 1.1.1.1
+   */
   protectionGroupAddress?: string;
   /**
+   * @remarks
+   * Indicates whether traffic redirection is enabled. Valid values:
+   * 
+   * - **on**: Traffic redirection is enabled.
+   * 
+   * - **off**: Traffic redirection is disabled.
+   * 
    * @example
    * on
    */
   pullinStatus?: string;
+  /**
+   * @remarks
+   * The ID of the resource.
+   * 
+   * @example
+   * test-antifaud-2.jqt.wafqax.top-waf
+   */
   resourceId?: string;
+  /**
+   * @remarks
+   * The status of the hybrid cloud SDK server.
+   * 
+   * @example
+   * 1
+   */
   status?: string;
   /**
+   * @remarks
+   * The time when the hybrid cloud SDK server was last updated. This value is a UNIX timestamp in milliseconds.
+   * 
    * @example
    * 1719489906000
    */
@@ -81,12 +128,22 @@ export class DescribeHybridCloudSdkServersResponseBodySdkServers extends $dara.M
 
 export class DescribeHybridCloudSdkServersResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * 3600F008-2E76-5D0B-BC76-EFBD****6D
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The information about the hybrid cloud SDK servers.
+   */
   sdkServers?: DescribeHybridCloudSdkServersResponseBodySdkServers[];
   /**
+   * @remarks
+   * The total number of hybrid cloud SDK servers returned.
+   * 
    * @example
    * 5
    */