1. Packages
  2. Volcengine
  3. API Docs
  4. waf
  5. getProhibitions
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine

volcengine.waf.getProhibitions

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine

    Use this data source to query detailed information of waf prohibitions

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@pulumi/volcengine";
    
    const foo = volcengine.waf.getProhibitions({
        endTime: 1749808824,
        host: "www.tf-test.com",
        startTime: 1749805224,
    });
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo = volcengine.waf.get_prohibitions(end_time=1749808824,
        host="www.tf-test.com",
        start_time=1749805224)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/waf"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := waf.GetProhibitions(ctx, &waf.GetProhibitionsArgs{
    			EndTime:   1749808824,
    			Host:      "www.tf-test.com",
    			StartTime: 1749805224,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = Volcengine.Waf.GetProhibitions.Invoke(new()
        {
            EndTime = 1749808824,
            Host = "www.tf-test.com",
            StartTime = 1749805224,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.waf.WafFunctions;
    import com.pulumi.volcengine.waf.inputs.GetProhibitionsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var foo = WafFunctions.getProhibitions(GetProhibitionsArgs.builder()
                .endTime(1749808824)
                .host("www.tf-test.com")
                .startTime(1749805224)
                .build());
    
        }
    }
    
    variables:
      foo:
        fn::invoke:
          Function: volcengine:waf:getProhibitions
          Arguments:
            endTime: 1.749808824e+09
            host: www.tf-test.com
            startTime: 1.749805224e+09
    

    Using getProhibitions

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getProhibitions(args: GetProhibitionsArgs, opts?: InvokeOptions): Promise<GetProhibitionsResult>
    function getProhibitionsOutput(args: GetProhibitionsOutputArgs, opts?: InvokeOptions): Output<GetProhibitionsResult>
    def get_prohibitions(end_time: Optional[int] = None,
                         host: Optional[str] = None,
                         letter_order_by: Optional[str] = None,
                         name_regex: Optional[str] = None,
                         output_file: Optional[str] = None,
                         reasons: Optional[Sequence[str]] = None,
                         start_time: Optional[int] = None,
                         opts: Optional[InvokeOptions] = None) -> GetProhibitionsResult
    def get_prohibitions_output(end_time: Optional[pulumi.Input[int]] = None,
                         host: Optional[pulumi.Input[str]] = None,
                         letter_order_by: Optional[pulumi.Input[str]] = None,
                         name_regex: Optional[pulumi.Input[str]] = None,
                         output_file: Optional[pulumi.Input[str]] = None,
                         reasons: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                         start_time: Optional[pulumi.Input[int]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetProhibitionsResult]
    func GetProhibitions(ctx *Context, args *GetProhibitionsArgs, opts ...InvokeOption) (*GetProhibitionsResult, error)
    func GetProhibitionsOutput(ctx *Context, args *GetProhibitionsOutputArgs, opts ...InvokeOption) GetProhibitionsResultOutput

    > Note: This function is named GetProhibitions in the Go SDK.

    public static class GetProhibitions 
    {
        public static Task<GetProhibitionsResult> InvokeAsync(GetProhibitionsArgs args, InvokeOptions? opts = null)
        public static Output<GetProhibitionsResult> Invoke(GetProhibitionsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetProhibitionsResult> getProhibitions(GetProhibitionsArgs args, InvokeOptions options)
    public static Output<GetProhibitionsResult> getProhibitions(GetProhibitionsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcengine:waf/getProhibitions:getProhibitions
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EndTime int
    end time.
    Host string
    The domain name of the website that needs to be queried.
    StartTime int
    starting time.
    LetterOrderBy string
    The list shows the order.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    Reasons List<string>
    Attack type filtering.
    EndTime int
    end time.
    Host string
    The domain name of the website that needs to be queried.
    StartTime int
    starting time.
    LetterOrderBy string
    The list shows the order.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    Reasons []string
    Attack type filtering.
    endTime Integer
    end time.
    host String
    The domain name of the website that needs to be queried.
    startTime Integer
    starting time.
    letterOrderBy String
    The list shows the order.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    reasons List<String>
    Attack type filtering.
    endTime number
    end time.
    host string
    The domain name of the website that needs to be queried.
    startTime number
    starting time.
    letterOrderBy string
    The list shows the order.
    nameRegex string
    A Name Regex of Resource.
    outputFile string
    File name where to save data source results.
    reasons string[]
    Attack type filtering.
    end_time int
    end time.
    host str
    The domain name of the website that needs to be queried.
    start_time int
    starting time.
    letter_order_by str
    The list shows the order.
    name_regex str
    A Name Regex of Resource.
    output_file str
    File name where to save data source results.
    reasons Sequence[str]
    Attack type filtering.
    endTime Number
    end time.
    host String
    The domain name of the website that needs to be queried.
    startTime Number
    starting time.
    letterOrderBy String
    The list shows the order.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    reasons List<String>
    Attack type filtering.

    getProhibitions Result

    The following output properties are available:

    EndTime int
    Host string
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAggGroups List<GetProhibitionsIpAggGroup>
    Details of the attack IP.
    StartTime int
    TotalCount int
    The total count of query.
    LetterOrderBy string
    NameRegex string
    OutputFile string
    Reasons List<string>
    Reason for the ban.
    EndTime int
    Host string
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAggGroups []GetProhibitionsIpAggGroup
    Details of the attack IP.
    StartTime int
    TotalCount int
    The total count of query.
    LetterOrderBy string
    NameRegex string
    OutputFile string
    Reasons []string
    Reason for the ban.
    endTime Integer
    host String
    id String
    The provider-assigned unique ID for this managed resource.
    ipAggGroups List<GetProhibitionsIpAggGroup>
    Details of the attack IP.
    startTime Integer
    totalCount Integer
    The total count of query.
    letterOrderBy String
    nameRegex String
    outputFile String
    reasons List<String>
    Reason for the ban.
    endTime number
    host string
    id string
    The provider-assigned unique ID for this managed resource.
    ipAggGroups GetProhibitionsIpAggGroup[]
    Details of the attack IP.
    startTime number
    totalCount number
    The total count of query.
    letterOrderBy string
    nameRegex string
    outputFile string
    reasons string[]
    Reason for the ban.
    end_time int
    host str
    id str
    The provider-assigned unique ID for this managed resource.
    ip_agg_groups Sequence[GetProhibitionsIpAggGroup]
    Details of the attack IP.
    start_time int
    total_count int
    The total count of query.
    letter_order_by str
    name_regex str
    output_file str
    reasons Sequence[str]
    Reason for the ban.
    endTime Number
    host String
    id String
    The provider-assigned unique ID for this managed resource.
    ipAggGroups List<Property Map>
    Details of the attack IP.
    startTime Number
    totalCount Number
    The total count of query.
    letterOrderBy String
    nameRegex String
    outputFile String
    reasons List<String>
    Reason for the ban.

    Supporting Types

    GetProhibitionsIpAggGroup

    DropCount int
    The number of attacks on the source IP of this attack.
    Ip string
    Attack source IP.
    Reason GetProhibitionsIpAggGroupReason
    Attack type filtering.
    RuleName string
    Name of the ban rule.
    RuleTag string
    Ban rule ID.
    Status int
    IP banned status.
    UpdateTime string
    Status update time.
    DropCount int
    The number of attacks on the source IP of this attack.
    Ip string
    Attack source IP.
    Reason GetProhibitionsIpAggGroupReason
    Attack type filtering.
    RuleName string
    Name of the ban rule.
    RuleTag string
    Ban rule ID.
    Status int
    IP banned status.
    UpdateTime string
    Status update time.
    dropCount Integer
    The number of attacks on the source IP of this attack.
    ip String
    Attack source IP.
    reason GetProhibitionsIpAggGroupReason
    Attack type filtering.
    ruleName String
    Name of the ban rule.
    ruleTag String
    Ban rule ID.
    status Integer
    IP banned status.
    updateTime String
    Status update time.
    dropCount number
    The number of attacks on the source IP of this attack.
    ip string
    Attack source IP.
    reason GetProhibitionsIpAggGroupReason
    Attack type filtering.
    ruleName string
    Name of the ban rule.
    ruleTag string
    Ban rule ID.
    status number
    IP banned status.
    updateTime string
    Status update time.
    drop_count int
    The number of attacks on the source IP of this attack.
    ip str
    Attack source IP.
    reason GetProhibitionsIpAggGroupReason
    Attack type filtering.
    rule_name str
    Name of the ban rule.
    rule_tag str
    Ban rule ID.
    status int
    IP banned status.
    update_time str
    Status update time.
    dropCount Number
    The number of attacks on the source IP of this attack.
    ip String
    Attack source IP.
    reason Property Map
    Attack type filtering.
    ruleName String
    Name of the ban rule.
    ruleTag String
    Ban rule ID.
    status Number
    IP banned status.
    updateTime String
    Status update time.

    GetProhibitionsIpAggGroupReason

    Black int
    The number of visits to the blacklist.
    Bot int
    The number of Bot attacks.
    GeoBlack int
    The number of geographical location access control.
    HttpFlood int
    The number of CC attacks.
    ParamAbnormal int
    The number of API parameter exceptions.
    RouteAbnormal int
    The number of API routing exceptions.
    SensitiveInfo int
    The number of times sensitive information is leaked.
    WebVulnerability int
    The number of Web vulnerability attacks.
    Black int
    The number of visits to the blacklist.
    Bot int
    The number of Bot attacks.
    GeoBlack int
    The number of geographical location access control.
    HttpFlood int
    The number of CC attacks.
    ParamAbnormal int
    The number of API parameter exceptions.
    RouteAbnormal int
    The number of API routing exceptions.
    SensitiveInfo int
    The number of times sensitive information is leaked.
    WebVulnerability int
    The number of Web vulnerability attacks.
    black Integer
    The number of visits to the blacklist.
    bot Integer
    The number of Bot attacks.
    geoBlack Integer
    The number of geographical location access control.
    httpFlood Integer
    The number of CC attacks.
    paramAbnormal Integer
    The number of API parameter exceptions.
    routeAbnormal Integer
    The number of API routing exceptions.
    sensitiveInfo Integer
    The number of times sensitive information is leaked.
    webVulnerability Integer
    The number of Web vulnerability attacks.
    black number
    The number of visits to the blacklist.
    bot number
    The number of Bot attacks.
    geoBlack number
    The number of geographical location access control.
    httpFlood number
    The number of CC attacks.
    paramAbnormal number
    The number of API parameter exceptions.
    routeAbnormal number
    The number of API routing exceptions.
    sensitiveInfo number
    The number of times sensitive information is leaked.
    webVulnerability number
    The number of Web vulnerability attacks.
    black int
    The number of visits to the blacklist.
    bot int
    The number of Bot attacks.
    geo_black int
    The number of geographical location access control.
    http_flood int
    The number of CC attacks.
    param_abnormal int
    The number of API parameter exceptions.
    route_abnormal int
    The number of API routing exceptions.
    sensitive_info int
    The number of times sensitive information is leaked.
    web_vulnerability int
    The number of Web vulnerability attacks.
    black Number
    The number of visits to the blacklist.
    bot Number
    The number of Bot attacks.
    geoBlack Number
    The number of geographical location access control.
    httpFlood Number
    The number of CC attacks.
    paramAbnormal Number
    The number of API parameter exceptions.
    routeAbnormal Number
    The number of API routing exceptions.
    sensitiveInfo Number
    The number of times sensitive information is leaked.
    webVulnerability Number
    The number of Web vulnerability attacks.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine