@alicloud/waf-openapi20211001 6.8.1 → 6.8.2

package/src/models/DescribeCloudResourceAccessPortDetailsResponseBody.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetailsCertificates extends $dara.Model {
   /**
    * @remarks
-   * The type of the HTTPS certificate. Valid values:
+   * The type of the certificate for the HTTPS protocol. Valid values:
    * 
-   * *   **default**: default certificate.
-   * *   **extension**: additional certificate.
+   * - **default**: the default certificate.
+   * 
+   * - **extension**: the additional certificate.
    * 
    * @example
    * default
@@ -16,7 +17,7 @@ export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails
   appliedType?: string;
   /**
    * @remarks
-   * The ID of the certificate.
+   * The ID of the added certificate.
    * 
    * @example
    * 123-cn-hangzhou
@@ -58,7 +59,7 @@ export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails
 export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetailsLogHeaders extends $dara.Model {
   /**
    * @remarks
-   * The key of the custom header field.
+   * The custom request header field.
    * 
    * @example
    * key1
@@ -66,7 +67,7 @@ export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails
   key?: string;
   /**
    * @remarks
-   * The value of the custom header field.
+   * The value of the custom request header field.
    * 
    * @example
    * value1
@@ -96,14 +97,89 @@ export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails
 }
 
 export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetailsSubStatusDetails extends $dara.Model {
+  /**
+   * @remarks
+   * The type of the certificate for the HTTPS protocol. Valid values:
+   * 
+   * - **default**: the default certificate.
+   * 
+   * - **extension**: the additional certificate.
+   * 
+   * @example
+   * default
+   */
   appliedType?: string;
+  /**
+   * @remarks
+   * The ID of the certificate in Certificates Management Service.
+   * 
+   * @example
+   * 123-cn-hangzhou
+   */
   certId?: string;
+  /**
+   * @remarks
+   * The name of the certificate in Certificates Management Service.
+   * 
+   * @example
+   * test-name
+   */
   certName?: string;
+  /**
+   * @remarks
+   * The common name (CN).
+   * 
+   * @example
+   * test.aliyun.com
+   */
   commonName?: string;
+  /**
+   * @remarks
+   * The domain name that is bound to the certificate.
+   * 
+   * @example
+   * test.aliyun.com
+   */
   domain?: string;
+  /**
+   * @remarks
+   * The expiration time of the certificate. The value is a UNIX timestamp. Unit: seconds.
+   * 
+   * @example
+   * 1746328456000
+   */
   expireTime?: number;
+  /**
+   * @remarks
+   * The ID of the certificate that is saved for the cloud service.
+   * 
+   * @example
+   * 123
+   */
   productCertId?: string;
+  /**
+   * @remarks
+   * The name of the certificate that is saved for the cloud service.
+   * 
+   * @example
+   * test-name
+   */
   productCertName?: string;
+  /**
+   * @remarks
+   * The reason for the abnormal protection status. Valid values:
+   * 
+   * - **UserUploadCert**: The certificate is manually uploaded.
+   * 
+   * - **CertNotExistInCertCenter**: The certificate does not exist in Certificates Management Service.
+   * 
+   * - **CertExpired**: The certificate has expired.
+   * 
+   * - **EmptyCertCN**: The CN of the certificate is empty.
+   * 
+   * @example
+   * CertNotExistInCertCenter
+   */
   reasonCode?: string;
   static names(): { [key: string]: string } {
     return {
@@ -145,33 +221,43 @@ export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails
 export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails extends $dara.Model {
   /**
    * @remarks
-   * The certificates that are associated with the ports of cloud services.
+   * The list of certificates for the port of the cloud service instance.
    */
   certificates?: DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetailsCertificates[];
   /**
    * @remarks
-   * The type of the cipher suites. 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
    */
   cipherSuite?: number;
+  /**
+   * @remarks
+   * The ID of the resource that is added to WAF. The ID is automatically generated by WAF.
+   * 
+   * @example
+   * i-bp1**************7ey-80-ecs
+   */
   cloudResourceId?: string;
   /**
    * @remarks
-   * The custom cipher suites that you want to add. This parameter is available only if you set **CipherSuite** to **99**.
+   * The custom cipher suites. This parameter is returned only when **CipherSuite** is set to **99**.
    */
   customCiphers?: string[];
   /**
    * @remarks
-   * Indicates whether to support TLS 1.3. Valid values:
+   * Indicates whether TLS 1.3 is supported. Valid values:
+   * 
+   * - **true**: TLS 1.3 is supported.
    * 
-   * *   **true**
-   * *   **false**
+   * - **false**: TLS 1.3 is not supported.
    * 
    * @example
    * true
@@ -179,10 +265,11 @@ export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails
   enableTLSv3?: boolean;
   /**
    * @remarks
-   * Indicates whether to enable HTTP/2. Valid values:
+   * Indicates whether HTTP/2 is enabled. Valid values:
+   * 
+   * - **true**: HTTP/2 is enabled.
    * 
-   * *   **true**
-   * *   **false**
+   * - **false**: HTTP/2 is not enabled.
    * 
    * @example
    * True
@@ -190,10 +277,11 @@ export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails
   http2Enabled?: boolean;
   /**
    * @remarks
-   * Indicates whether to enable the persistent connection feature. Valid values:
+   * Indicates whether to enable persistent connections. Valid values:
    * 
-   * *   **true** (default)
-   * *   **false:**
+   * - **true**: Enables persistent connections. This is the default value.
+   * 
+   * - **false**: Disables persistent connections.
    * 
    * @example
    * true
@@ -201,9 +289,9 @@ export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails
   keepalive?: boolean;
   /**
    * @remarks
-   * The number of reused persistent connections. Valid values: 60 to 1000.
+   * The number of requests that can be reused in a persistent connection. Valid values: 60 to 1000.
    * 
-   * >  This parameter specifies the number of requests that reuse persistent connections after you enable the persistent connection feature.
+   * > This parameter specifies the number of requests that can be reused after a persistent connection is established.
    * 
    * @example
    * 1000
@@ -211,9 +299,9 @@ export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails
   keepaliveRequests?: number;
   /**
    * @remarks
-   * The timeout period for idle persistent connections. Valid values: 10 to 3600. Default value: 15. Unit: seconds.
+   * The timeout period for an idle persistent connection. Valid values: 10 to 3600. Default value: 15. Unit: seconds.
    * 
-   * >  If no new requests are initiated over the idle persistent connection within the specified timeout period, the connection is closed.
+   * > This parameter specifies the period of time after which an idle persistent connection is released.
    * 
    * @example
    * 10
@@ -221,19 +309,22 @@ export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails
   keepaliveTimeout?: number;
   /**
    * @remarks
-   * The custom header field that you want to use to label requests that are processed by WAF.
+   * The key-value pair that is used to tag the traffic that is processed by WAF.
    * 
-   * >  This parameter is returned only when the traffic marking feature is enabled for the domain name.
+   * > This parameter is returned only when the traffic tagging feature is enabled for the domain name.
    */
   logHeaders?: DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetailsLogHeaders[];
   /**
+   * @remarks
+   * The maximum size of a request body. Valid values: 2 to 10. Default value: 2. Unit: GB.
+   * 
    * @example
    * 2
    */
   maxBodySize?: number;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account to which the resource belongs.
+   * The ID of the Alibaba Cloud account to which the cloud service belongs.
    * 
    * @example
    * 123
@@ -249,10 +340,11 @@ export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails
   port?: number;
   /**
    * @remarks
-   * The type of the protocol. Valid values:
+   * The protocol. Valid values:
+   * 
+   * - **http**: HTTP.
    * 
-   * *   **http**
-   * *   **https**
+   * - **https**: HTTPS.
    * 
    * @example
    * https
@@ -260,7 +352,7 @@ export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails
   protocol?: string;
   /**
    * @remarks
-   * The timeout period for read connections. Unit: seconds. Valid values: 1 to 3600.
+   * The read timeout period. Unit: seconds. Valid values: 1 to 3600.
    * 
    * @example
    * 5
@@ -270,24 +362,46 @@ export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails
    * @remarks
    * The status of the domain name. Valid values:
    * 
-   * *   **1**: indicates that the port is available.
-   * *   **2**: indicates that the port is being created.
-   * *   **3**: indicates that the port is being modified.
-   * *   **4**: indicates that the port is being released.
+   * - **1**: The port is in the Normal state.
+   * 
+   * - **2**: The port is being created.
+   * 
+   * - **3**: The port is being modified.
+   * 
+   * - **4**: The port is being released.
    * 
    * @example
    * 1
    */
   status?: number;
+  /**
+   * @remarks
+   * The abnormal protection status. Valid values:
+   * 
+   * - **InvalidCert**: The certificate is invalid.
+   * 
+   * - **ClientCertOpend**: Mutual authentication is enabled.
+   * 
+   * - **NetworkConfigLost**: The network configuration of the cloud service is abnormal.
+   * 
+   * @example
+   * InvalidCert
+   */
   subStatus?: string;
+  /**
+   * @remarks
+   * The details of the abnormal protection status. This parameter is returned only when **SubStatus** is set to InvalidCert.
+   */
   subStatusDetails?: DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetailsSubStatusDetails[];
   /**
    * @remarks
    * The version of the Transport Layer Security (TLS) protocol. Valid values:
    * 
-   * *   **tlsv1**
-   * *   **tlsv1.1**
-   * *   **tlsv1.2**
+   * - **tlsv1**
+   * 
+   * - **tlsv1.1**
+   * 
+   * - **tlsv1.2**
    * 
    * @example
    * tlsv1
@@ -295,7 +409,7 @@ export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails
   TLSVersion?: string;
   /**
    * @remarks
-   * The timeout period for write connections. Unit: seconds. Valid values: 1 to 3600.
+   * The write timeout period. Unit: seconds. Valid values: 1 to 3600.
    * 
    * @example
    * 1
@@ -303,11 +417,13 @@ export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails
   writeTimeout?: number;
   /**
    * @remarks
-   * The method that WAF uses to obtain the originating IP address of a client. Valid values:
+   * The mode that WAF uses to obtain the real IP address of a client. Valid values:
+   * 
+   * - **0**: WAF is the first Layer 7 proxy before client traffic is forwarded to the origin server.
    * 
-   * *   **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 originating IP address of the client.
-   * *   **2**: WAF reads the value of a custom header field as the originating IP address of the client.
+   * - **1**: WAF reads the first IP address from the X-Forwarded-For (XFF) header as the client IP address.
+   * 
+   * - **2**: WAF reads the value of a custom header as the client IP address.
    * 
    * @example
    * 0
@@ -315,17 +431,18 @@ export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails
   xffHeaderMode?: number;
   /**
    * @remarks
-   * The custom header field that is used to obtain the originating IP address of a client. Specify the value in the ["header1","header2",...] format.
+   * The custom header fields that are used to obtain the client IP address. The value is a string in the `["header1","header2",...]` format.
    * 
-   * >  This parameter is required only if you set **XffHeaderMode** to 2.
+   * > This parameter is returned only when **XffHeaderMode** is set to 2.
    */
   xffHeaders?: string[];
   /**
    * @remarks
-   * Indicates whether to use the X-Forward-For-Proto header to identify the protocol used by WAF to forward requests to the origin server. Valid values:
+   * Indicates whether to use the X-Forwarded-For-Proto header to identify the protocol used by WAF. Valid values:
+   * 
+   * - **true**: Identifies the protocol used by WAF. This is the default value.
    * 
-   * *   **true** (default)
-   * *   **false**
+   * - **false**: Does not identify the protocol used by WAF.
    * 
    * @example
    * true
@@ -414,7 +531,7 @@ export class DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails
 export class DescribeCloudResourceAccessPortDetailsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The details of the ports of cloud services that are added to WAF.
+   * The details of the ports for the cloud service instance that is added to WAF.
    */
   accessPortDetails?: DescribeCloudResourceAccessPortDetailsResponseBodyAccessPortDetails[];
   /**

package/src/models/DescribeCloudResourceAccessedPortsRequest.ts

@@ -7,7 +7,7 @@ export class DescribeCloudResourceAccessedPortsRequest extends $dara.Model {
    * @remarks
    * The ID of the WAF instance.
    * 
-   * >  You can call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
+   * > You can call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the current WAF instance.
    * 
    * This parameter is required.
    * 
@@ -17,10 +17,11 @@ export class DescribeCloudResourceAccessedPortsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The region in which the WAF instance is deployed. Valid values:
+   * The region ID of the WAF instance. Valid values:
    * 
-   * *   **cn-hangzhou**: the Chinese mainland.
-   * *   **ap-southeast-1**: outside the Chinese mainland.
+   * - **cn-hangzhou**: The Chinese mainland.
+   * 
+   * - **ap-southeast-1**: Outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou

package/src/models/DescribeCloudResourceAccessedPortsResponseBody.ts

@@ -5,17 +5,17 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCloudResourceAccessedPortsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The HTTP ports.
+   * The HTTP port.
    */
   http?: number[];
   /**
    * @remarks
-   * The HTTPS ports.
+   * The HTTPS port.
    */
   https?: number[];
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * C1823E96-EF4B-5BD2-9E02-1D18****3ED8

package/src/models/DescribeCloudResourceListRequest.ts

@@ -4,12 +4,21 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeCloudResourceListRequest extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the protected resource. WAF automatically generates this ID when you add the resource to WAF.
+   * 
+   * > Call [CreateCloudResource](https://help.aliyun.com/document_detail/2839876.html) to add a resource. Then, view the resource ID in the response.
+   * 
    * @example
    * i-8vbdlsd********81e22-80-ecs
    */
   cloudResourceId?: string;
   /**
    * @remarks
+   * The ID of the WAF instance.
+   * 
+   * > Call [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) to query the ID of the WAF instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -17,42 +26,92 @@ export class DescribeCloudResourceListRequest extends $dara.Model {
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The number of entries to return on each page. Valid values: 1 to 100. Default value: 10.
+   * 
    * @example
    * 10
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token that is used to retrieve the next page of results. You do not need to specify this parameter for the first request.
+   * 
+   * > If a value is returned for this parameter, it indicates that a next page is available. To retrieve the next page of data, include the returned **NextToken** in your next request. Repeat this process until no value is returned, which indicates that all data has been retrieved.
+   * 
    * @example
    * AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud account to which the resource belongs.
+   * 
    * @example
    * 1111111111
    */
   ownerUserId?: string;
   /**
+   * @remarks
+   * The port of the cloud service that is added to WAF.
+   * 
    * @example
    * 80
    */
   port?: string;
   /**
+   * @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;
   resourceDomain?: string;
   /**
+   * @remarks
+   * The ID of the resource instance.
+   * 
    * @example
    * i-8vbdlsd********81e22
    */
   resourceInstanceId?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud resource group.
+   * 
    * @example
    * rg-acfm***q
    */
   resourceManagerResourceGroupId?: string;
   /**
+   * @remarks
+   * The cloud service to which the resource belongs. Valid values:
+   * 
+   * - **alb**: Application Load Balancer (ALB).
+   * 
+   * - **mse**: Microservices Engine (MSE).
+   * 
+   * - **fc**: Function Compute (FC).
+   * 
+   * - **sae**: Serverless App Engine (SAE).
+   * 
+   * - **ecs**: Elastic Compute Service (ECS).
+   * 
+   * - **clb4**: Classic Load Balancer (CLB) that uses the TCP protocol.
+   * 
+   * - **clb7**: CLB that uses the HTTP or HTTPS protocol.
+   * 
+   * - **apig**: API Gateway (APIG).
+   * 
+   * - **nlb**: Network Load Balancer (NLB).
+   * 
+   * > Not all cloud services are available in all regions. If you specify this parameter, make sure that the specified cloud service is available in the selected region. Otherwise, the request may fail.
+   * 
    * @example
    * ecs
    */

package/src/models/DescribeCloudResourceListResponseBody.ts

@@ -4,37 +4,78 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeCloudResourceListResponseBodyCloudResourceList extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the protected resource. WAF automatically generates this ID when you add the resource to WAF.
+   * 
    * @example
    * i-8vbdlsd********81e22-80-ecs
    */
   cloudResourceId?: string;
   /**
+   * @remarks
+   * The port of the cloud service that is added to WAF.
+   * 
    * @example
    * 80
    */
   port?: number;
   /**
+   * @remarks
+   * The protocol type. Valid values:
+   * 
+   * - **http**: HTTP
+   * 
+   * - **https**: HTTPS
+   * 
    * @example
    * http
    */
   protocol?: string;
   resourceDomain?: string;
   /**
+   * @remarks
+   * The ID of the resource instance that is added to WAF.
+   * 
    * @example
    * i-8vbdlsd********81e22
    */
   resourceInstanceId?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud resource group.
+   * 
    * @example
    * rg-aek2uo2****lbka
    */
   resourceManagerResourceGroupId?: string;
   /**
+   * @remarks
+   * The cloud service to which the resource belongs. Valid values:
+   * 
+   * - **alb**: ALB.
+   * 
+   * - **mse**: MSE.
+   * 
+   * - **fc**: FC.
+   * 
+   * - **sae**: SAE.
+   * 
+   * - **ecs**: ECS.
+   * 
+   * - **clb4**: CLB that uses the TCP protocol.
+   * 
+   * - **clb7**: CLB that uses the HTTP or HTTPS protocol.
+   * 
+   * - **nlb**: NLB.
+   * 
    * @example
    * ecs
    */
   resourceProduct?: string;
   /**
+   * @remarks
+   * The ID of the region where the resource resides. For more information, see the "Regions and supported products" section in this topic.
+   * 
    * @example
    * cn-hangzhou
    */
@@ -75,23 +116,41 @@ export class DescribeCloudResourceListResponseBodyCloudResourceList extends $dar
 }
 
 export class DescribeCloudResourceListResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of resources that are added to WAF.
+   */
   cloudResourceList?: DescribeCloudResourceListResponseBodyCloudResourceList[];
   /**
+   * @remarks
+   * The number of entries returned on the current page.
+   * 
    * @example
    * 20
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token that is used to retrieve the next page of results.
+   * 
+   * > If a value is returned for this parameter, it indicates that a next page is available. To retrieve the next page of data, include the returned **NextToken** in your next request. Repeat this process until no value is returned, which indicates that all data has been retrieved.
+   * 
    * @example
    * AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * F35F45B0-5D6B-4238-BE02-A62D****E840
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries returned.
+   * 
    * @example
    * 118
    */