volcengine.waf.getCustomPages

Volcengine v0.0.38, Oct 31 25

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";

const foo = volcengine.waf.getCustomPages({
    host: "www.tf-test.com",
});

import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.waf.get_custom_pages(host="www.tf-test.com")

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.GetCustomPages(ctx, &waf.GetCustomPagesArgs{
			Host: "www.tf-test.com",
		}, 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.GetCustomPages.Invoke(new()
    {
        Host = "www.tf-test.com",
    });

});

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.GetCustomPagesArgs;
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.getCustomPages(GetCustomPagesArgs.builder()
            .host("www.tf-test.com")
            .build());

    }
}

variables:
  foo:
    fn::invoke:
      Function: volcengine:waf:getCustomPages
      Arguments:
        host: www.tf-test.com

Using getCustomPages

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 getCustomPages(args: GetCustomPagesArgs, opts?: InvokeOptions): Promise<GetCustomPagesResult>
function getCustomPagesOutput(args: GetCustomPagesOutputArgs, opts?: InvokeOptions): Output<GetCustomPagesResult>

def get_custom_pages(host: Optional[str] = None,
                     name_regex: Optional[str] = None,
                     output_file: Optional[str] = None,
                     project_name: Optional[str] = None,
                     rule_tag: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetCustomPagesResult
def get_custom_pages_output(host: Optional[pulumi.Input[str]] = None,
                     name_regex: Optional[pulumi.Input[str]] = None,
                     output_file: Optional[pulumi.Input[str]] = None,
                     project_name: Optional[pulumi.Input[str]] = None,
                     rule_tag: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetCustomPagesResult]

func GetCustomPages(ctx *Context, args *GetCustomPagesArgs, opts ...InvokeOption) (*GetCustomPagesResult, error)
func GetCustomPagesOutput(ctx *Context, args *GetCustomPagesOutputArgs, opts ...InvokeOption) GetCustomPagesResultOutput

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

public static class GetCustomPages 
{
    public static Task<GetCustomPagesResult> InvokeAsync(GetCustomPagesArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomPagesResult> Invoke(GetCustomPagesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCustomPagesResult> getCustomPages(GetCustomPagesArgs args, InvokeOptions options)
public static Output<GetCustomPagesResult> getCustomPages(GetCustomPagesArgs args, InvokeOptions options)

fn::invoke:
  function: volcengine:waf/getCustomPages:getCustomPages
  arguments:
    # arguments dictionary

The following arguments are supported:

Host string: The domain names that need to be viewed.
NameRegex string: A Name Regex of Resource.
OutputFile string: File name where to save data source results.
ProjectName string: The name of the project to which your domain names belong.
RuleTag string: Unique identification of the rules.

Host string: The domain names that need to be viewed.
NameRegex string: A Name Regex of Resource.
OutputFile string: File name where to save data source results.
ProjectName string: The name of the project to which your domain names belong.
RuleTag string: Unique identification of the rules.

host String: The domain names that need to be viewed.
nameRegex String: A Name Regex of Resource.
outputFile String: File name where to save data source results.
projectName String: The name of the project to which your domain names belong.
ruleTag String: Unique identification of the rules.

host string: The domain names that need to be viewed.
nameRegex string: A Name Regex of Resource.
outputFile string: File name where to save data source results.
projectName string: The name of the project to which your domain names belong.
ruleTag string: Unique identification of the rules.

host str: The domain names that need to be viewed.
name_regex str: A Name Regex of Resource.
output_file str: File name where to save data source results.
project_name str: The name of the project to which your domain names belong.
rule_tag str: Unique identification of the rules.

host String: The domain names that need to be viewed.
nameRegex String: A Name Regex of Resource.
outputFile String: File name where to save data source results.
projectName String: The name of the project to which your domain names belong.
ruleTag String: Unique identification of the rules.

getCustomPages Result

The following output properties are available:

Datas List<GetCustomPagesData>: Details of the rules.
Host string: Domain name to be protected.
Id string: The provider-assigned unique ID for this managed resource.
TotalCount int: The total count of query.
NameRegex string
OutputFile string
ProjectName string
RuleTag string: Unique identification of the rules.

Datas []GetCustomPagesData: Details of the rules.
Host string: Domain name to be protected.
Id string: The provider-assigned unique ID for this managed resource.
TotalCount int: The total count of query.
NameRegex string
OutputFile string
ProjectName string
RuleTag string: Unique identification of the rules.

datas List<GetCustomPagesData>: Details of the rules.
host String: Domain name to be protected.
id String: The provider-assigned unique ID for this managed resource.
totalCount Integer: The total count of query.
nameRegex String
outputFile String
projectName String
ruleTag String: Unique identification of the rules.

datas GetCustomPagesData[]: Details of the rules.
host string: Domain name to be protected.
id string: The provider-assigned unique ID for this managed resource.
totalCount number: The total count of query.
nameRegex string
outputFile string
projectName string
ruleTag string: Unique identification of the rules.

datas Sequence[GetCustomPagesData]: Details of the rules.
host str: Domain name to be protected.
id str: The provider-assigned unique ID for this managed resource.
total_count int: The total count of query.
name_regex str
output_file str
project_name str
rule_tag str: Unique identification of the rules.

datas List<Property Map>: Details of the rules.
host String: Domain name to be protected.
id String: The provider-assigned unique ID for this managed resource.
totalCount Number: The total count of query.
nameRegex String
outputFile String
projectName String
ruleTag String: Unique identification of the rules.

Supporting Types

GetCustomPagesData

Accurate GetCustomPagesDataAccurate: Advanced conditions.
Advanced int: Whether to configure advanced conditions.
Body string: The layout content of the response page.
ClientIp string: Fill in ALL, which means this rule will take effect on all IP addresses.
Code string: Custom HTTP code returned when the request is blocked. Required if PageMode=0 or 1.
ContentType string: The layout template of the response page. Required if PageMode=0 or 1.
Description string: Rule description.
Enable int: Whether to enable the rule.
GroupId int: The ID of the advanced conditional rule group.
Header string: Request header information.
Host string: The domain names that need to be viewed.
Id int: The ID of rule.
IsolationId string: The ID of Region.
Name string: Rule name.
PageMode int: The layout template of the response page.
Policy int: Action to be taken on requests that match the rule.
RedirectUrl string: The path where users should be redirected.
RuleTag string: Unique identification of the rules.
UpdateTime string: Rule update time.
Url string: Match the path.

Accurate GetCustomPagesDataAccurate: Advanced conditions.
Advanced int: Whether to configure advanced conditions.
Body string: The layout content of the response page.
ClientIp string: Fill in ALL, which means this rule will take effect on all IP addresses.
Code string: Custom HTTP code returned when the request is blocked. Required if PageMode=0 or 1.
ContentType string: The layout template of the response page. Required if PageMode=0 or 1.
Description string: Rule description.
Enable int: Whether to enable the rule.
GroupId int: The ID of the advanced conditional rule group.
Header string: Request header information.
Host string: The domain names that need to be viewed.
Id int: The ID of rule.
IsolationId string: The ID of Region.
Name string: Rule name.
PageMode int: The layout template of the response page.
Policy int: Action to be taken on requests that match the rule.
RedirectUrl string: The path where users should be redirected.
RuleTag string: Unique identification of the rules.
UpdateTime string: Rule update time.
Url string: Match the path.

accurate GetCustomPagesDataAccurate: Advanced conditions.
advanced Integer: Whether to configure advanced conditions.
body String: The layout content of the response page.
clientIp String: Fill in ALL, which means this rule will take effect on all IP addresses.
code String: Custom HTTP code returned when the request is blocked. Required if PageMode=0 or 1.
contentType String: The layout template of the response page. Required if PageMode=0 or 1.
description String: Rule description.
enable Integer: Whether to enable the rule.
groupId Integer: The ID of the advanced conditional rule group.
header String: Request header information.
host String: The domain names that need to be viewed.
id Integer: The ID of rule.
isolationId String: The ID of Region.
name String: Rule name.
pageMode Integer: The layout template of the response page.
policy Integer: Action to be taken on requests that match the rule.
redirectUrl String: The path where users should be redirected.
ruleTag String: Unique identification of the rules.
updateTime String: Rule update time.
url String: Match the path.

accurate GetCustomPagesDataAccurate: Advanced conditions.
advanced number: Whether to configure advanced conditions.
body string: The layout content of the response page.
clientIp string: Fill in ALL, which means this rule will take effect on all IP addresses.
code string: Custom HTTP code returned when the request is blocked. Required if PageMode=0 or 1.
contentType string: The layout template of the response page. Required if PageMode=0 or 1.
description string: Rule description.
enable number: Whether to enable the rule.
groupId number: The ID of the advanced conditional rule group.
header string: Request header information.
host string: The domain names that need to be viewed.
id number: The ID of rule.
isolationId string: The ID of Region.
name string: Rule name.
pageMode number: The layout template of the response page.
policy number: Action to be taken on requests that match the rule.
redirectUrl string: The path where users should be redirected.
ruleTag string: Unique identification of the rules.
updateTime string: Rule update time.
url string: Match the path.

accurate GetCustomPagesDataAccurate: Advanced conditions.
advanced int: Whether to configure advanced conditions.
body str: The layout content of the response page.
client_ip str: Fill in ALL, which means this rule will take effect on all IP addresses.
code str: Custom HTTP code returned when the request is blocked. Required if PageMode=0 or 1.
content_type str: The layout template of the response page. Required if PageMode=0 or 1.
description str: Rule description.
enable int: Whether to enable the rule.
group_id int: The ID of the advanced conditional rule group.
header str: Request header information.
host str: The domain names that need to be viewed.
id int: The ID of rule.
isolation_id str: The ID of Region.
name str: Rule name.
page_mode int: The layout template of the response page.
policy int: Action to be taken on requests that match the rule.
redirect_url str: The path where users should be redirected.
rule_tag str: Unique identification of the rules.
update_time str: Rule update time.
url str: Match the path.

accurate Property Map: Advanced conditions.
advanced Number: Whether to configure advanced conditions.
body String: The layout content of the response page.
clientIp String: Fill in ALL, which means this rule will take effect on all IP addresses.
code String: Custom HTTP code returned when the request is blocked. Required if PageMode=0 or 1.
contentType String: The layout template of the response page. Required if PageMode=0 or 1.
description String: Rule description.
enable Number: Whether to enable the rule.
groupId Number: The ID of the advanced conditional rule group.
header String: Request header information.
host String: The domain names that need to be viewed.
id Number: The ID of rule.
isolationId String: The ID of Region.
name String: Rule name.
pageMode Number: The layout template of the response page.
policy Number: Action to be taken on requests that match the rule.
redirectUrl String: The path where users should be redirected.
ruleTag String: Unique identification of the rules.
updateTime String: Rule update time.
url String: Match the path.

GetCustomPagesDataAccurate

AccurateRules List<GetCustomPagesDataAccurateAccurateRule>: Details of advanced conditions.
Logic int: The logical relationship of advanced conditions.

AccurateRules []GetCustomPagesDataAccurateAccurateRule: Details of advanced conditions.
Logic int: The logical relationship of advanced conditions.

accurateRules List<GetCustomPagesDataAccurateAccurateRule>: Details of advanced conditions.
logic Integer: The logical relationship of advanced conditions.

accurateRules GetCustomPagesDataAccurateAccurateRule[]: Details of advanced conditions.
logic number: The logical relationship of advanced conditions.

accurate_rules Sequence[GetCustomPagesDataAccurateAccurateRule]: Details of advanced conditions.
logic int: The logical relationship of advanced conditions.

accurateRules List<Property Map>: Details of advanced conditions.
logic Number: The logical relationship of advanced conditions.

GetCustomPagesDataAccurateAccurateRule

HttpObj string: The HTTP object to be added to the advanced conditions.
ObjType int: The matching field for HTTP objects.
Opretar int: The logical operator for the condition.
Property int: Operate the properties of the http object.
ValueString string: The value to be matched.

HttpObj string: The HTTP object to be added to the advanced conditions.
ObjType int: The matching field for HTTP objects.
Opretar int: The logical operator for the condition.
Property int: Operate the properties of the http object.
ValueString string: The value to be matched.

httpObj String: The HTTP object to be added to the advanced conditions.
objType Integer: The matching field for HTTP objects.
opretar Integer: The logical operator for the condition.
property Integer: Operate the properties of the http object.
valueString String: The value to be matched.

httpObj string: The HTTP object to be added to the advanced conditions.
objType number: The matching field for HTTP objects.
opretar number: The logical operator for the condition.
property number: Operate the properties of the http object.
valueString string: The value to be matched.

http_obj str: The HTTP object to be added to the advanced conditions.
obj_type int: The matching field for HTTP objects.
opretar int: The logical operator for the condition.
property int: Operate the properties of the http object.
value_string str: The value to be matched.

httpObj String: The HTTP object to be added to the advanced conditions.
objType Number: The matching field for HTTP objects.
opretar Number: The logical operator for the condition.
property Number: Operate the properties of the http object.
valueString String: The value to be matched.

Package Details

Repository: volcengine volcengine/pulumi-volcengine
License: Apache-2.0
Notes: This Pulumi package is based on the volcengine Terraform Provider.

Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

volcengine.waf.getCustomPages

On this page

On this page

Example Usage

Using getCustomPages

getCustomPages Result

Supporting Types

GetCustomPagesData

GetCustomPagesDataAccurate

GetCustomPagesDataAccurateAccurateRule

Package Details

On this page

On this page