@alicloud/ddosbgp20180720 3.0.0 → 3.1.0

package/dist/client.js

@@ -70,6 +70,10 @@ class Client extends openapi_core_1.default {
             'cn-shenzhen-finance-1': "ddosbgp.aliyuncs.com",
             'cn-shanghai-finance-1': "ddosbgp.aliyuncs.com",
             'cn-north-2-gov-1': "ddosbgp.aliyuncs.com",
+            'us-west-1': "ddosbgp.us-west-1.aliyuncs.com",
+            'us-east-1': "ddosbgp.us-east-1.aliyuncs.com",
+            'cn-hongkong': "ddosbgp.cn-hongkong.aliyuncs.com",
+            'ap-southeast-1': "ddosbgp.ap-southeast-1.aliyuncs.com",
         };
         this.checkConfig(config);
         this._endpoint = this.getEndpoint("ddosbgp", this._regionId, this._endpointRule, this._network, this._suffix, this._endpointMap, this._endpoint);
@@ -232,7 +236,10 @@ class Client extends openapi_core_1.default {
         return await this.attachAssetGroupToInstanceWithOptions(request, runtime);
     }
     /**
-     * Associates a mitigation policy to a protected object.
+     * Associates protection objects with a mitigation policy.
+     *
+     * @remarks
+     * A mitigation policy that is associated with protection objects cannot be deleted.
      *
      * @param tmpReq - AttachToPolicyRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -272,7 +279,10 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.AttachToPolicyResponse({}));
     }
     /**
-     * Associates a mitigation policy to a protected object.
+     * Associates protection objects with a mitigation policy.
+     *
+     * @remarks
+     * A mitigation policy that is associated with protection objects cannot be deleted.
      *
      * @param request - AttachToPolicyRequest
      * @returns AttachToPolicyResponse
@@ -372,6 +382,9 @@ class Client extends openapi_core_1.default {
     /**
      * Creates a mitigation policy.
      *
+     * @remarks
+     * A mitigation policy that is associated with protected objects cannot be deleted.
+     *
      * @param request - CreatePolicyRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns CreatePolicyResponse
@@ -407,6 +420,9 @@ class Client extends openapi_core_1.default {
     /**
      * Creates a mitigation policy.
      *
+     * @remarks
+     * A mitigation policy that is associated with protected objects cannot be deleted.
+     *
      * @param request - CreatePolicyRequest
      * @returns CreatePolicyResponse
      */
@@ -475,10 +491,7 @@ class Client extends openapi_core_1.default {
         return await this.deleteBlackholeWithOptions(request, runtime);
     }
     /**
-     * Removes specific IP addresses from an Anti-DDoS Origin instance.
-     *
-     * @remarks
-     * The Anti-DDoS Origin Enterprise instance no longer protects the IP addresses that are removed.
+     * Deletes an IP address from Anti-DDoS Origin and disables protection for that IP address.
      *
      * @param request - DeleteIpRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -516,10 +529,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteIpResponse({}));
     }
     /**
-     * Removes specific IP addresses from an Anti-DDoS Origin instance.
-     *
-     * @remarks
-     * The Anti-DDoS Origin Enterprise instance no longer protects the IP addresses that are removed.
+     * Deletes an IP address from Anti-DDoS Origin and disables protection for that IP address.
      *
      * @param request - DeleteIpRequest
      * @returns DeleteIpResponse
@@ -796,7 +806,10 @@ class Client extends openapi_core_1.default {
         return await this.describeDdosEventWithOptions(request, runtime);
     }
     /**
-     * Queries the bill of an Anti-DDoS Origin (Pay-as-you-go) instance.
+     * Queries the pay-as-you-go billing information of an Anti-DDoS Origin instance.
+     *
+     * @remarks
+     * This operation is used to perform a paged query of the billing details of all Anti-DDoS Origin instances owned by the current Alibaba Cloud account. The billing details include instance IDs, validity periods, and statuses. Paging is supported for this query.
      *
      * @param request - DescribeDdosOriginInstanceBillRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -834,7 +847,10 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeDdosOriginInstanceBillResponse({}));
     }
     /**
-     * Queries the bill of an Anti-DDoS Origin (Pay-as-you-go) instance.
+     * Queries the pay-as-you-go billing information of an Anti-DDoS Origin instance.
+     *
+     * @remarks
+     * This operation is used to perform a paged query of the billing details of all Anti-DDoS Origin instances owned by the current Alibaba Cloud account. The billing details include instance IDs, validity periods, and statuses. Paging is supported for this query.
      *
      * @param request - DescribeDdosOriginInstanceBillRequest
      * @returns DescribeDdosOriginInstanceBillResponse
@@ -894,10 +910,10 @@ class Client extends openapi_core_1.default {
         return await this.describeExcpetionCountWithOptions(request, runtime);
     }
     /**
-     * Queries the details of all Anti-DDoS Origin instances.
+     * Retrieves the details of all Anti-DDoS Origin instances.
      *
      * @remarks
-     * Queries the details of all Anti-DDoS Origin instances.
+     * Retrieves the details of all Anti-DDoS Origin instances.
      *
      * @param request - DescribeInstanceListRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -962,10 +978,10 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeInstanceListResponse({}));
     }
     /**
-     * Queries the details of all Anti-DDoS Origin instances.
+     * Retrieves the details of all Anti-DDoS Origin instances.
      *
      * @remarks
-     * Queries the details of all Anti-DDoS Origin instances.
+     * Retrieves the details of all Anti-DDoS Origin instances.
      *
      * @param request - DescribeInstanceListRequest
      * @returns DescribeInstanceListResponse
@@ -1019,6 +1035,85 @@ class Client extends openapi_core_1.default {
         let runtime = new $dara.RuntimeOptions({});
         return await this.describeInstanceSpecsWithOptions(request, runtime);
     }
+    /**
+     * Queries the network-layer interception records of Anti-DDoS Origin instances.
+     *
+     * @remarks
+     * This operation is used to perform a paged query of the details of Layer 3 and Layer 4 packet interception records for all Anti-DDoS Origin instances owned by the current Alibaba Cloud account. Paging is supported.
+     * ### QPS limit
+     * The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, API invokes are throttled, which may affect your business. Invoke this operation at an appropriate frequency.
+     *
+     * @param request - DescribeNetworkLayerInterceptsRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DescribeNetworkLayerInterceptsResponse
+     */
+    async describeNetworkLayerInterceptsWithOptions(request, runtime) {
+        request.validate();
+        let query = {};
+        if (!$dara.isNull(request.destinationIp)) {
+            query["DestinationIp"] = request.destinationIp;
+        }
+        if (!$dara.isNull(request.destinationPort)) {
+            query["DestinationPort"] = request.destinationPort;
+        }
+        if (!$dara.isNull(request.endTime)) {
+            query["EndTime"] = request.endTime;
+        }
+        if (!$dara.isNull(request.instanceId)) {
+            query["InstanceId"] = request.instanceId;
+        }
+        if (!$dara.isNull(request.networkProtocol)) {
+            query["NetworkProtocol"] = request.networkProtocol;
+        }
+        if (!$dara.isNull(request.page)) {
+            query["Page"] = request.page;
+        }
+        if (!$dara.isNull(request.pageSize)) {
+            query["PageSize"] = request.pageSize;
+        }
+        if (!$dara.isNull(request.protocolNumber)) {
+            query["ProtocolNumber"] = request.protocolNumber;
+        }
+        if (!$dara.isNull(request.sourcePort)) {
+            query["SourcePort"] = request.sourcePort;
+        }
+        if (!$dara.isNull(request.srcIp)) {
+            query["SrcIp"] = request.srcIp;
+        }
+        if (!$dara.isNull(request.startTime)) {
+            query["StartTime"] = request.startTime;
+        }
+        let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
+            query: openapi_core_2.OpenApiUtil.query(query),
+        });
+        let params = new openapi_core_2.$OpenApiUtil.Params({
+            action: "DescribeNetworkLayerIntercepts",
+            version: "2018-07-20",
+            protocol: "HTTPS",
+            pathname: "/",
+            method: "POST",
+            authType: "AK",
+            style: "RPC",
+            reqBodyType: "formData",
+            bodyType: "json",
+        });
+        return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeNetworkLayerInterceptsResponse({}));
+    }
+    /**
+     * Queries the network-layer interception records of Anti-DDoS Origin instances.
+     *
+     * @remarks
+     * This operation is used to perform a paged query of the details of Layer 3 and Layer 4 packet interception records for all Anti-DDoS Origin instances owned by the current Alibaba Cloud account. Paging is supported.
+     * ### QPS limit
+     * The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, API invokes are throttled, which may affect your business. Invoke this operation at an appropriate frequency.
+     *
+     * @param request - DescribeNetworkLayerInterceptsRequest
+     * @returns DescribeNetworkLayerInterceptsResponse
+     */
+    async describeNetworkLayerIntercepts(request) {
+        let runtime = new $dara.RuntimeOptions({});
+        return await this.describeNetworkLayerInterceptsWithOptions(request, runtime);
+    }
     /**
      * Queries the operation logs of an Anti-DDoS Origin instance.
      *
@@ -1096,12 +1191,12 @@ class Client extends openapi_core_1.default {
         return await this.describeOpEntitiesWithOptions(request, runtime);
     }
     /**
-     * Queries the IP addresses that are protected by a specific Anti-DDoS Origin instance.
+     * Queries the list of protected IP addresses for a single Anti-DDoS Origin instance.
      *
      * @remarks
-     * You can call the DescribePackIpList operation to query the details about each IP address that is protected by a specific Anti-DDoS Origin instance by page. The details include the IP address and the type of the cloud asset to which the IP address belongs. The details also include the status of the IP address, such as whether blackhole filtering is triggered for the IP address.
-     * ## Limits
-     * You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
+     * You can call this operation to query a paginated list of protected IP addresses for an Anti-DDoS Origin instance. The query returns details such as the IP addresses, the types of cloud assets to which the IP addresses belong, and their current status, such as whether they are under blackhole filtering.
+     * ### QPS limit
+     * This operation has a queries per second (QPS) limit of 10 for each user. Calls that exceed this limit are throttled, which may affect your business. We recommend that you call this operation within this limit.
      *
      * @param request - DescribePackIpListRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1151,12 +1246,12 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribePackIpListResponse({}));
     }
     /**
-     * Queries the IP addresses that are protected by a specific Anti-DDoS Origin instance.
+     * Queries the list of protected IP addresses for a single Anti-DDoS Origin instance.
      *
      * @remarks
-     * You can call the DescribePackIpList operation to query the details about each IP address that is protected by a specific Anti-DDoS Origin instance by page. The details include the IP address and the type of the cloud asset to which the IP address belongs. The details also include the status of the IP address, such as whether blackhole filtering is triggered for the IP address.
-     * ## Limits
-     * You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
+     * You can call this operation to query a paginated list of protected IP addresses for an Anti-DDoS Origin instance. The query returns details such as the IP addresses, the types of cloud assets to which the IP addresses belong, and their current status, such as whether they are under blackhole filtering.
+     * ### QPS limit
+     * This operation has a queries per second (QPS) limit of 10 for each user. Calls that exceed this limit are throttled, which may affect your business. We recommend that you call this operation within this limit.
      *
      * @param request - DescribePackIpListRequest
      * @returns DescribePackIpListResponse
@@ -1213,7 +1308,6 @@ class Client extends openapi_core_1.default {
     /**
      * Queries the status of the multi-account management feature.
      *
-     * @param request - DescribeRdStatusRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DescribeRdStatusResponse
      */
@@ -1241,7 +1335,7 @@ class Client extends openapi_core_1.default {
         return await this.describeRdStatusWithOptions(runtime);
     }
     /**
-     * Queries the regions of assets that can be protected by Anti-DDoS Origin Enterprise in a specific region.
+     * Queries all regions supported by Anti-DDoS Origin Enterprise.
      *
      * @param request - DescribeRegionsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1273,7 +1367,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeRegionsResponse({}));
     }
     /**
-     * Queries the regions of assets that can be protected by Anti-DDoS Origin Enterprise in a specific region.
+     * Queries all regions supported by Anti-DDoS Origin Enterprise.
      *
      * @param request - DescribeRegionsRequest
      * @returns DescribeRegionsResponse
@@ -1283,13 +1377,13 @@ class Client extends openapi_core_1.default {
         return await this.describeRegionsWithOptions(request, runtime);
     }
     /**
-     * Queries traffic statistics of an Anti-DDoS Origin instance within a specific time period.
+     * Queries the traffic statistics of a specified Anti-DDoS Origin instance within a specified time period.
      *
      * @remarks
-     * You can call the DescribeTraffic operation to query traffic statistics of an Anti-DDoS Origin instance within a specific time period.
-     * >  When you call this operation, you must configure the **InstanceId** parameter to specify the Anti-DDoS Origin instance whose traffic statistics you want to query.
-     * ## Limits
-     * You can call this operation once per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
+     * Queries the traffic statistics of a specified Anti-DDoS Origin instance within a specified time range.
+     * > When calling this operation, you must set the **InstanceId** parameter to specify the Anti-DDoS Origin instance to query.
+     * ### QPS limit
+     * The single-user QPS limit for this operation is 1 call per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation as appropriate.
      *
      * @param request - DescribeTrafficRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1342,13 +1436,13 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeTrafficResponse({}));
     }
     /**
-     * Queries traffic statistics of an Anti-DDoS Origin instance within a specific time period.
+     * Queries the traffic statistics of a specified Anti-DDoS Origin instance within a specified time period.
      *
      * @remarks
-     * You can call the DescribeTraffic operation to query traffic statistics of an Anti-DDoS Origin instance within a specific time period.
-     * >  When you call this operation, you must configure the **InstanceId** parameter to specify the Anti-DDoS Origin instance whose traffic statistics you want to query.
-     * ## Limits
-     * You can call this operation once per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
+     * Queries the traffic statistics of a specified Anti-DDoS Origin instance within a specified time range.
+     * > When calling this operation, you must set the **InstanceId** parameter to specify the Anti-DDoS Origin instance to query.
+     * ### QPS limit
+     * The single-user QPS limit for this operation is 1 call per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation as appropriate.
      *
      * @param request - DescribeTrafficRequest
      * @returns DescribeTrafficResponse
@@ -1358,7 +1452,7 @@ class Client extends openapi_core_1.default {
         return await this.describeTrafficWithOptions(request, runtime);
     }
     /**
-     * Removes protected objects from a mitigation policy.
+     * Dissociates a mitigation policy from a protected object.
      *
      * @param tmpReq - DetachFromPolicyRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1398,7 +1492,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.DetachFromPolicyResponse({}));
     }
     /**
-     * Removes protected objects from a mitigation policy.
+     * Dissociates a mitigation policy from a protected object.
      *
      * @param request - DetachFromPolicyRequest
      * @returns DetachFromPolicyResponse
@@ -1596,7 +1690,7 @@ class Client extends openapi_core_1.default {
         return await this.listPolicyWithOptions(request, runtime);
     }
     /**
-     * Queries attachments to mitigation policies.
+     * Queries the associations of mitigation policies.
      *
      * @param tmpReq - ListPolicyAttachmentRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1645,7 +1739,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListPolicyAttachmentResponse({}));
     }
     /**
-     * Queries attachments to mitigation policies.
+     * Queries the associations of mitigation policies.
      *
      * @param request - ListPolicyAttachmentRequest
      * @returns ListPolicyAttachmentResponse
@@ -1832,10 +1926,10 @@ class Client extends openapi_core_1.default {
         return await this.modifyPolicyWithOptions(request, runtime);
     }
     /**
-     * Modifies the content of the mitigation policy.
+     * Modifies the content of a mitigation policy.
      *
      * @remarks
-     * Make sure that all request parameters are configured when you call this operation. If any parameter is left empty, the configuration is deleted.
+     * Make sure that you pass all parameters when you call this operation. If a parameter is left empty, the corresponding configuration is deleted.
      *
      * @param tmpReq - ModifyPolicyContentRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1878,10 +1972,10 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyPolicyContentResponse({}));
     }
     /**
-     * Modifies the content of the mitigation policy.
+     * Modifies the content of a mitigation policy.
      *
      * @remarks
-     * Make sure that all request parameters are configured when you call this operation. If any parameter is left empty, the configuration is deleted.
+     * Make sure that you pass all parameters when you call this operation. If a parameter is left empty, the corresponding configuration is deleted.
      *
      * @param request - ModifyPolicyContentRequest
      * @returns ModifyPolicyContentResponse
@@ -1891,12 +1985,12 @@ class Client extends openapi_core_1.default {
         return await this.modifyPolicyContentWithOptions(request, runtime);
     }
     /**
-     * Adds remarks for a single Anti-DDoS Origin instance.
+     * Sets a remark for a single Anti-DDoS Origin instance.
      *
      * @remarks
-     * You can call the ModifyRemark operation to add remarks for a single Anti-DDoS Origin instance.
-     * ### [](#qps-)Limits
-     * You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
+     * Sets a remark for a single Anti-DDoS Origin instance.
+     * ### QPS limit
+     * The single-user QPS limit for this API is 10 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this API appropriately.
      *
      * @param request - ModifyRemarkRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1934,12 +2028,12 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyRemarkResponse({}));
     }
     /**
-     * Adds remarks for a single Anti-DDoS Origin instance.
+     * Sets a remark for a single Anti-DDoS Origin instance.
      *
      * @remarks
-     * You can call the ModifyRemark operation to add remarks for a single Anti-DDoS Origin instance.
-     * ### [](#qps-)Limits
-     * You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
+     * Sets a remark for a single Anti-DDoS Origin instance.
+     * ### QPS limit
+     * The single-user QPS limit for this API is 10 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this API appropriately.
      *
      * @param request - ModifyRemarkRequest
      * @returns ModifyRemarkResponse