@alicloud/waf-openapi20211001 6.6.0 → 6.6.1

package/src/models/DescribeApisecAbnormalsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecAbnormalsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The number of risk-related security events.
+   * The number of risk events that are associated with the security risk.
    * 
    * @example
    * 2
@@ -13,7 +13,7 @@ export class DescribeApisecAbnormalsResponseBodyData extends $dara.Model {
   abnormalEventNumber?: number;
   /**
    * @remarks
-   * The ID of the risk.
+   * The ID of the security risk.
    * 
    * @example
    * 7c1431f27ae7e9c8cc64095***68e
@@ -21,24 +21,38 @@ export class DescribeApisecAbnormalsResponseBodyData extends $dara.Model {
   abnormalId?: string;
   /**
    * @remarks
-   * The details of the risk. The value is a string that consists of multiple parameters in the JSON format. Valid values:
+   * The details of the security risk in JSON format. The JSON object contains the following fields:
    * 
-   * * **rule**: risk-related rule
-   * * **data_type**: sensitive data type
-   * * **custom_rule_name**: custom rule name
-   * * **rule_name**: built-in rule name
+   * - **rule**: The detection rule that triggered the security risk.
+   * 
+   * - **data_type**: The type of sensitive data.
+   * 
+   * - **custom_rule_name**: The name of the custom rule.
+   * 
+   * - **rule_name**: The name of the built-in rule.
    * 
    * @example
-   * { "data_type": ["1005","1004"], "rule": { "parent": "RiskType_Permission", "code": "Risk_UnauthSensitive", "level": "high", "origin": "default", "name": "Risk_UnauthSensitive" } }
+   * {
+   *     "data_type": ["1005","1004"],
+   *     "rule": {
+   *         "parent": "RiskType_Permission",
+   *         "code": "Risk_UnauthSensitive",
+   *         "level": "high",
+   *         "origin": "default",
+   *         "name": "Risk_UnauthSensitive"
+   *     }
+   * }
    */
   abnormalInfo?: string;
   /**
    * @remarks
-   * The level of the risk. Valid values:
+   * The severity level of the security risk. Valid values:
+   * 
+   * - **high**: High.
    * 
-   * * **high**
-   * * **medium**
-   * * **low**
+   * - **medium**: Medium.
+   * 
+   * - **low**: Low.
    * 
    * @example
    * high
@@ -46,9 +60,9 @@ export class DescribeApisecAbnormalsResponseBodyData extends $dara.Model {
   abnormalLevel?: string;
   /**
    * @remarks
-   * The type of the risk.
+   * The type of the security risk.
    * 
-   * >  You can call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the supported types of risks.
+   * > Call [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) to query the supported risk types.
    * 
    * @example
    * LackOfSpeedLimit
@@ -56,7 +70,7 @@ export class DescribeApisecAbnormalsResponseBodyData extends $dara.Model {
   abnormalTag?: string;
   /**
    * @remarks
-   * The status of the risk.
+   * The processing status of the security risk.
    * 
    * @example
    * unresolved
@@ -64,7 +78,7 @@ export class DescribeApisecAbnormalsResponseBodyData extends $dara.Model {
   abnromalStatus?: string;
   /**
    * @remarks
-   * The risk-related API.
+   * The path of the API that is associated with the security risk.
    * 
    * @example
    * /api/login
@@ -72,7 +86,7 @@ export class DescribeApisecAbnormalsResponseBodyData extends $dara.Model {
   apiFormat?: string;
   /**
    * @remarks
-   * The ID of the risk-related API.
+   * The ID of the API that is associated with the security risk.
    * 
    * @example
    * 09559c0d71ca2ffc996b81***836d8
@@ -82,7 +96,7 @@ export class DescribeApisecAbnormalsResponseBodyData extends $dara.Model {
    * @remarks
    * The business purpose of the API.
    * 
-   * >  You can call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the business purposes of APIs.
+   * > Call [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) to query the supported business purposes.
    * 
    * @example
    * SendMail
@@ -90,7 +104,7 @@ export class DescribeApisecAbnormalsResponseBodyData extends $dara.Model {
   apiTag?: string;
   /**
    * @remarks
-   * The time at which the risk was first detected. The value is a UNIX timestamp displayed in UTC. Unit: seconds.
+   * The time when the security risk was first detected. The value is a UNIX timestamp. Unit: seconds.
    * 
    * @example
    * 1684252800
@@ -98,14 +112,14 @@ export class DescribeApisecAbnormalsResponseBodyData extends $dara.Model {
   discoverTime?: number;
   /**
    * @remarks
-   * The risk-related samples.
+   * The list of security risk samples.
    * 
    * @deprecated
    */
   examples?: string[];
   /**
    * @remarks
-   * The time at which the API was first detected. The value is a UNIX timestamp displayed in UTC. Unit: seconds.
+   * The time when the API was first discovered. The value is a UNIX timestamp. Unit: seconds.
    * 
    * @example
    * 1701138088
@@ -113,10 +127,11 @@ export class DescribeApisecAbnormalsResponseBodyData extends $dara.Model {
   firstTime?: number;
   /**
    * @remarks
-   * Indicates whether the API is followed. Valid values:
+   * Indicates whether the security risk is being followed. Valid values:
+   * 
+   * - **1**: The security risk is being followed.
    * 
-   * *   **1**: yes
-   * *   **0**(default): no
+   * - **0** (default): The security risk is not being followed.
    * 
    * @example
    * 0
@@ -124,7 +139,7 @@ export class DescribeApisecAbnormalsResponseBodyData extends $dara.Model {
   follow?: number;
   /**
    * @remarks
-   * The time at which the risk was marked as ignored. The value is a UNIX timestamp displayed in UTC. Unit: seconds.
+   * The time when the security risk was marked as ignored. The value is a UNIX timestamp. Unit: seconds.
    * 
    * @example
    * 1684252800
@@ -132,7 +147,7 @@ export class DescribeApisecAbnormalsResponseBodyData extends $dara.Model {
   ignoreTime?: number;
   /**
    * @remarks
-   * The time at which the API was last accessed. The value is a UNIX timestamp displayed in UTC. Unit: seconds.
+   * The most recent time when the API was accessed. The value is a UNIX timestamp. Unit: seconds.
    * 
    * @example
    * 1684252800
@@ -140,7 +155,7 @@ export class DescribeApisecAbnormalsResponseBodyData extends $dara.Model {
   lastestTime?: number;
   /**
    * @remarks
-   * The time at which the risk was last detected. The value is a UNIX timestamp displayed in UTC. Unit: seconds.
+   * The most recent time when the security risk was detected. The value is a UNIX timestamp. Unit: seconds.
    * 
    * @example
    * 1684252800
@@ -148,7 +163,7 @@ export class DescribeApisecAbnormalsResponseBodyData extends $dara.Model {
   latestDiscoverTime?: number;
   /**
    * @remarks
-   * The domain name or IP address of the API.
+   * The domain name or IP address that the API resides on.
    * 
    * @example
    * a.aliyun.com
@@ -156,18 +171,19 @@ export class DescribeApisecAbnormalsResponseBodyData extends $dara.Model {
   matchedHost?: string;
   /**
    * @remarks
-   * The remarks.
+   * The remarks for the security risk.
    * 
    * @example
-   * Business side notified
+   * Strict
    */
   note?: string;
   /**
    * @remarks
-   * The source of the risk type. Valid values:
+   * The source of the risk detection rule. Valid values:
+   * 
+   * - **custom**: Custom rule.
    * 
-   * *   **custom**
-   * *   **default**
+   * - **default**: Built-in rule.
    * 
    * @example
    * custom
@@ -175,13 +191,23 @@ export class DescribeApisecAbnormalsResponseBodyData extends $dara.Model {
   origin?: string;
   /**
    * @remarks
-   * The status of the risk. Valid values:
+   * The handling status of the security risk. Valid values:
+   * 
+   * - **toBeConfirmed**: To be confirmed.
+   * 
+   * - **confirmed**: Confirmed.
+   * 
+   * - **toBeFixed**: To be fixed.
+   * 
+   * - **fixed**: Fixed (manually verified).
+   * 
+   * - **ignored**: Ignored.
+   * 
+   * - **toBeVerified**: To be verified by the system.
+   * 
+   * - **notFixed**: Verification failed.
    * 
-   * * **toBeConfirmed**
-   * * **confirmed**
-   * * **toBeFixed**
-   * * **fixed**
-   * * **ignored**
+   * - **systemFixed**: Fixed (verified by the system).
    * 
    * @example
    * Confirmed
@@ -252,7 +278,7 @@ export class DescribeApisecAbnormalsResponseBodyData extends $dara.Model {
 export class DescribeApisecAbnormalsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The risks.
+   * The list of security risks.
    */
   data?: DescribeApisecAbnormalsResponseBodyData[];
   /**
@@ -265,10 +291,10 @@ export class DescribeApisecAbnormalsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of security risks returned.
    * 
    * @example
-   * 35
+   * 5
    */
   totalCount?: number;
   static names(): { [key: string]: string } {

package/src/models/DescribeApisecApiResourcesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApisecApiResourcesRequest extends $dara.Model {
   /**
    * @remarks
-   * The API.
+   * The API endpoint path used to filter the query results.
    * 
    * @example
    * /auth/login
@@ -21,16 +21,7 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   apiId?: string;
   /**
    * @remarks
-   * The request method of the API. Valid values:
-   * 
-   * * **GET**
-   * * **POST**
-   * * **HEAD**
-   * * **PUT**
-   * * **DELETE**
-   * * **CONNECT**
-   * * **PATCH**
-   * * **OPTIONS**
+   * The HTTP request method of the API. Valid values: **GET**, **POST**, **HEAD**, **PUT**, **DELETE**, **CONNECT**, **PATCH**, and **OPTIONS**.
    * 
    * @example
    * POST
@@ -38,11 +29,13 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   apiMethod?: string;
   /**
    * @remarks
-   * The API status. Valid values:
+   * The lifecycle status of the API. Valid values:
+   * 
+   * - **NewbornInterface**: newly discovered.
+   * 
+   * - **OfflineInterface**: inactive.
    * 
-   * * **NewbornInterface**: The API is newly added.
-   * * **OfflineInterface**: The API is inactive.
-   * * **normal**: The API is normal.
+   * - **normal**: active.
    * 
    * @example
    * OfflineInterface
@@ -52,7 +45,7 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
    * @remarks
    * The business purpose of the API.
    * 
-   * >  You can call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the business purposes of APIs.
+   * > Call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to obtain the supported business purposes.
    * 
    * @example
    * SendMail
@@ -60,11 +53,13 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   apiTag?: string;
   /**
    * @remarks
-   * The service object. Valid values:
+   * The type of service that the API serves. Valid values:
+   * 
+   * - **PublicAPI**: public-facing service.
+   * 
+   * - **ThirdpartAPI**: third-party service.
    * 
-   * * **PublicAPI**: public services
-   * * **ThirdpartAPI**: cooperation with third-party partners
-   * * **InternalAPI**: internal office
+   * - **InternalAPI**: internal service.
    * 
    * @example
    * innerAPI
@@ -72,10 +67,11 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   apiType?: string;
   /**
    * @remarks
-   * Specifies whether authentication is required. Valid values:
+   * Indicates whether the API requires authentication. Valid values:
    * 
-   * * **0**: Authentication is required.
-   * * **1**: Authentication is not required.
+   * - **0**: The API requires authentication.
+   * 
+   * - **1**: The API does not require authentication.
    * 
    * @example
    * 0
@@ -83,9 +79,9 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   authFlag?: string;
   /**
    * @remarks
-   * The ID of the hybrid cloud cluster.
+   * The ID of the Hybrid Cloud WAF cluster.
    * 
-   * >  This parameter is available only in hybrid cloud scenarios. You can call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to query hybrid cloud clusters.
+   * > This parameter is available only for hybrid cloud scenarios. Call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to obtain information about Hybrid Cloud WAF clusters.
    * 
    * @example
    * 740
@@ -93,7 +89,7 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   clusterId?: string;
   /**
    * @remarks
-   * The end of the time range to query. This value is a UNIX timestamp in UTC. Unit: seconds.
+   * The end of the time range to query. Specify a UNIX timestamp in seconds.
    * 
    * @example
    * 1683388800
@@ -101,10 +97,11 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   endTime?: string;
   /**
    * @remarks
-   * Specifies whether to follow the API. Valid values:
+   * Indicates whether the API is followed. Valid values:
+   * 
+   * - **1**: The API is followed.
    * 
-   * * **1**: follows the API.
-   * * **0**: does not follow the API.
+   * - **0**: The API is not followed.
    * 
    * @example
    * 0
@@ -112,9 +109,9 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   follow?: number;
   /**
    * @remarks
-   * The ID of the Web Application Firewall (WAF) instance.
+   * 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.
+   * > Call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to obtain the ID of the WAF instance.
    * 
    * This parameter is required.
    * 
@@ -124,7 +121,7 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The domain name or IP address of the API.
+   * The domain name or IP address of the API used to filter the query results.
    * 
    * @example
    * a.aliyun.com
@@ -132,23 +129,29 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   matchedHost?: string;
   /**
    * @remarks
-   * The remarks.
+   * The remarks of the API asset used to filter the query results.
    * 
    * @example
-   * API for logon
+   * loginApi
    */
   note?: string;
   /**
    * @remarks
-   * The name of the sorting field. Valid values:
+   * The field by which to sort the results. Valid values:
+   * 
+   * - **allCnt**: sorts by the total number of requests in the last 30 days.
+   * 
+   * - **botCnt**: sorts by the number of bot requests in the last 30 days.
    * 
-   * * **allCnt**: the total number of calls to the API in the previous 30 days
-   * * **botCnt**: the number of bot-initiated requests in the previous 30 days
-   * * **crossBorderCnt**: the number of cross-border requests in the previous 30 days
-   * * **abnormalNum**: the number of API-related risks
-   * * **eventNum**: the number of API-related security events
-   * * **farthestTs**: the time when the API was first detected
-   * * **lastestTs**: the time of the most recent access to the API
+   * - **crossBorderCnt**: sorts by the number of cross-border requests in the last 30 days.
+   * 
+   * - **abnormalNum**: sorts by the number of threats associated with the API.
+   * 
+   * - **eventNum**: sorts by the number of security events associated with the API.
+   * 
+   * - **farthestTs**: sorts by the time when the API was first discovered.
+   * 
+   * - **lastestTs**: sorts by the time of the most recent access.
    * 
    * @example
    * allCnt
@@ -156,10 +159,11 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   orderKey?: string;
   /**
    * @remarks
-   * The sorting method. Valid values:
+   * The sort order. Valid values:
+   * 
+   * - **desc**: descending order (default).
    * 
-   * * **desc** (default): descending order
-   * * **asc**: ascending order
+   * - **asc**: ascending order.
    * 
    * @example
    * desc
@@ -183,10 +187,11 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region ID of the WAF instance. Value:
+   * The region ID of the WAF instance. Valid values:
    * 
-   * *   **cn-hangzhou**: Chinese mainland.
-   * *   **ap-southeast-1**: outside the Chinese mainland.
+   * - **cn-hangzhou**: the Chinese mainland.
+   * 
+   * - **ap-southeast-1**: outside the Chinese mainland.
    * 
    * @example
    * cn-hangzhou
@@ -194,9 +199,9 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The sensitive data type in the request.
+   * The type of sensitive data in the request.
    * 
-   * >  You can call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the supported sensitive data types.
+   * > Call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to obtain the supported sensitive data types.
    * 
    * @example
    * 1004,1005
@@ -214,10 +219,13 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
    * @remarks
    * The sensitivity level of the API. Valid values:
    * 
-   * * **L1**: high sensitivity
-   * * **L2**: moderate sensitivity
-   * * **L3**: low sensitivity
-   * * **N**: non-sensitivity
+   * - **L1**: High.
+   * 
+   * - **L2**: Medium.
+   * 
+   * - **L3**: Low.
+   * 
+   * - **N**: Non-sensitive.
    * 
    * @example
    * L3
@@ -225,9 +233,9 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   sensitiveLevel?: string;
   /**
    * @remarks
-   * The sensitive data type in the response.
+   * The type of sensitive data in the response.
    * 
-   * >  You can call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to query the supported sensitive data types.
+   * > Call the [DescribeApisecRules](https://help.aliyun.com/document_detail/2859155.html) operation to obtain the supported sensitive data types.
    * 
    * @example
    * 1004
@@ -235,7 +243,7 @@ export class DescribeApisecApiResourcesRequest extends $dara.Model {
   sensitiveType?: string;
   /**
    * @remarks
-   * The beginning of the time range to query. This value is a UNIX timestamp in UTC. Unit: seconds.
+   * The beginning of the time range to query. Specify a UNIX timestamp in seconds.
    * 
    * @example
    * 1681833600