Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. dns
  5. getZones
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.dns.getZones

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
volcengine/pulumi-volcengine

    Use this data source to query detailed information of dns zones

    Example Usage

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

const foo = volcengine.dns.getZones({
    tags: [{
        key: "xx",
        values: ["xx"],
    }],
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.dns.get_zones(tags=[volcengine.dns.GetZonesTagArgs(
    key="xx",
    values=["xx"],
)])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/dns"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dns.GetZones(ctx, &dns.GetZonesArgs{
			Tags: []dns.GetZonesTag{
				{
					Key: "xx",
					Values: []string{
						"xx",
					},
				},
			},
		}, 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.Dns.GetZones.Invoke(new()
    {
        Tags = new[]
        {
            new Volcengine.Dns.Inputs.GetZonesTagInputArgs
            {
                Key = "xx",
                Values = new[]
                {
                    "xx",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.dns.DnsFunctions;
import com.pulumi.volcengine.dns.inputs.GetZonesArgs;
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 = DnsFunctions.getZones(GetZonesArgs.builder()
            .tags(GetZonesTagArgs.builder()
                .key("xx")
                .values("xx")
                .build())
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:dns:getZones
      Arguments:
        tags:
          - key: xx
            values:
              - xx

    Using getZones

    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 getZones(args: GetZonesArgs, opts?: InvokeOptions): Promise<GetZonesResult>
function getZonesOutput(args: GetZonesOutputArgs, opts?: InvokeOptions): Output<GetZonesResult>
    def get_zones(key: Optional[str] = None,
              name_regex: Optional[str] = None,
              order_key: Optional[str] = None,
              output_file: Optional[str] = None,
              project_name: Optional[str] = None,
              search_mode: Optional[str] = None,
              search_order: Optional[str] = None,
              stage: Optional[str] = None,
              tags: Optional[Sequence[GetZonesTag]] = None,
              trade_code: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetZonesResult
def get_zones_output(key: Optional[pulumi.Input[str]] = None,
              name_regex: Optional[pulumi.Input[str]] = None,
              order_key: Optional[pulumi.Input[str]] = None,
              output_file: Optional[pulumi.Input[str]] = None,
              project_name: Optional[pulumi.Input[str]] = None,
              search_mode: Optional[pulumi.Input[str]] = None,
              search_order: Optional[pulumi.Input[str]] = None,
              stage: Optional[pulumi.Input[str]] = None,
              tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetZonesTagArgs]]]] = None,
              trade_code: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetZonesResult]
    func GetZones(ctx *Context, args *GetZonesArgs, opts ...InvokeOption) (*GetZonesResult, error)
func GetZonesOutput(ctx *Context, args *GetZonesOutputArgs, opts ...InvokeOption) GetZonesResultOutput

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

    public static class GetZones 
{
    public static Task<GetZonesResult> InvokeAsync(GetZonesArgs args, InvokeOptions? opts = null)
    public static Output<GetZonesResult> Invoke(GetZonesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetZonesResult> getZones(GetZonesArgs args, InvokeOptions options)
public static Output<GetZonesResult> getZones(GetZonesArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:dns/getZones:getZones
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Key string
    The keyword included in domains.
    NameRegex string
    A Name Regex of Resource.
    OrderKey string
    The key for sorting the results.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The ProjectName of the domain.
    SearchMode string
    The matching mode for the Key parameter.
    SearchOrder string
    The sorting order of the results.
    Stage string
    The status of the domain.
    Tags List<GetZonesTag>
    Tags.
    TradeCode string
    The edition of the domain.
    Key string
    The keyword included in domains.
    NameRegex string
    A Name Regex of Resource.
    OrderKey string
    The key for sorting the results.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The ProjectName of the domain.
    SearchMode string
    The matching mode for the Key parameter.
    SearchOrder string
    The sorting order of the results.
    Stage string
    The status of the domain.
    Tags []GetZonesTag
    Tags.
    TradeCode string
    The edition of the domain.
    key String
    The keyword included in domains.
    nameRegex String
    A Name Regex of Resource.
    orderKey String
    The key for sorting the results.
    outputFile String
    File name where to save data source results.
    projectName String
    The ProjectName of the domain.
    searchMode String
    The matching mode for the Key parameter.
    searchOrder String
    The sorting order of the results.
    stage String
    The status of the domain.
    tags List<GetZonesTag>
    Tags.
    tradeCode String
    The edition of the domain.
    key string
    The keyword included in domains.
    nameRegex string
    A Name Regex of Resource.
    orderKey string
    The key for sorting the results.
    outputFile string
    File name where to save data source results.
    projectName string
    The ProjectName of the domain.
    searchMode string
    The matching mode for the Key parameter.
    searchOrder string
    The sorting order of the results.
    stage string
    The status of the domain.
    tags GetZonesTag[]
    Tags.
    tradeCode string
    The edition of the domain.
    key str
    The keyword included in domains.
    name_regex str
    A Name Regex of Resource.
    order_key str
    The key for sorting the results.
    output_file str
    File name where to save data source results.
    project_name str
    The ProjectName of the domain.
    search_mode str
    The matching mode for the Key parameter.
    search_order str
    The sorting order of the results.
    stage str
    The status of the domain.
    tags Sequence[GetZonesTag]
    Tags.
    trade_code str
    The edition of the domain.
    key String
    The keyword included in domains.
    nameRegex String
    A Name Regex of Resource.
    orderKey String
    The key for sorting the results.
    outputFile String
    File name where to save data source results.
    projectName String
    The ProjectName of the domain.
    searchMode String
    The matching mode for the Key parameter.
    searchOrder String
    The sorting order of the results.
    stage String
    The status of the domain.
    tags List<Property Map>
    Tags.
    tradeCode String
    The edition of the domain.

    getZones Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    Zones List<GetZonesZone>
    The collection of query.
    Key string
    The Key of Tags.
    NameRegex string
    OrderKey string
    OutputFile string
    ProjectName string
    The ProjectName of the domain.
    SearchMode string
    SearchOrder string
    Stage string
    The status of the domain.
    Tags List<GetZonesTag>
    Tags.
    TradeCode string
    The edition of the domain.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    Zones []GetZonesZone
    The collection of query.
    Key string
    The Key of Tags.
    NameRegex string
    OrderKey string
    OutputFile string
    ProjectName string
    The ProjectName of the domain.
    SearchMode string
    SearchOrder string
    Stage string
    The status of the domain.
    Tags []GetZonesTag
    Tags.
    TradeCode string
    The edition of the domain.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of query.
    zones List<GetZonesZone>
    The collection of query.
    key String
    The Key of Tags.
    nameRegex String
    orderKey String
    outputFile String
    projectName String
    The ProjectName of the domain.
    searchMode String
    searchOrder String
    stage String
    The status of the domain.
    tags List<GetZonesTag>
    Tags.
    tradeCode String
    The edition of the domain.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of query.
    zones GetZonesZone[]
    The collection of query.
    key string
    The Key of Tags.
    nameRegex string
    orderKey string
    outputFile string
    projectName string
    The ProjectName of the domain.
    searchMode string
    searchOrder string
    stage string
    The status of the domain.
    tags GetZonesTag[]
    Tags.
    tradeCode string
    The edition of the domain.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of query.
    zones Sequence[GetZonesZone]
    The collection of query.
    key str
    The Key of Tags.
    name_regex str
    order_key str
    output_file str
    project_name str
    The ProjectName of the domain.
    search_mode str
    search_order str
    stage str
    The status of the domain.
    tags Sequence[GetZonesTag]
    Tags.
    trade_code str
    The edition of the domain.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of query.
    zones List<Property Map>
    The collection of query.
    key String
    The Key of Tags.
    nameRegex String
    orderKey String
    outputFile String
    projectName String
    The ProjectName of the domain.
    searchMode String
    searchOrder String
    stage String
    The status of the domain.
    tags List<Property Map>
    Tags.
    tradeCode String
    The edition of the domain.

    Supporting Types

    GetZonesTag

    Key string
    The Key of Tags.
    Values List<string>
    The Value of Tags.
    Key string
    The Key of Tags.
    Values []string
    The Value of Tags.
    key String
    The Key of Tags.
    values List<String>
    The Value of Tags.
    key string
    The Key of Tags.
    values string[]
    The Value of Tags.
    key str
    The Key of Tags.
    values Sequence[str]
    The Value of Tags.
    key String
    The Key of Tags.
    values List<String>
    The Value of Tags.

    GetZonesZone

    AllocateDnsServerLists List<string>
    The list of DNS servers allocated to the domain by BytePlus DNS.
    AutoRenew bool
    Whether automatic domain renewal is enabled.
    CacheStage int
    The most recent update time of the domain.
    CreatedAt string
    The creation time of the domain.
    DnsSecurity string
    The version of DNS DDoS protection service.
    ExpiredTime int
    The expiration time of the domain.
    Id string
    The id of the zone.
    InstanceId string
    The ID of the instance.
    InstanceNo string
    The ID of the instance. For free edition, the value of this field is null.
    IsNsCorrect bool
    Indicates whether the configuration of NS servers is correct. If the configuration is correct, the status of the domain in BytePlus DNS is Active.
    IsSubDomain bool
    Whether the domain is a subdomain.
    LastOperator string
    The ID of the account that last updated this domain.
    ProjectName string
    The ProjectName of the domain.
    RealDnsServerLists List<string>
    The list of DNS servers actually used by the domain.
    RecordCount int
    The total number of DNS records contained in the domain.
    Remark string
    The remarks for the domain.
    Stage int
    The status of the domain.
    SubDomainHost string
    The domain prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
    Tags List<GetZonesZoneTag>
    Tags.
    TradeCode string
    The edition of the domain.
    UpdatedAt string
    The most recent update time of the domain.
    Zid int
    The ID of the domain.
    ZoneName string
    The domain name.
    AllocateDnsServerLists []string
    The list of DNS servers allocated to the domain by BytePlus DNS.
    AutoRenew bool
    Whether automatic domain renewal is enabled.
    CacheStage int
    The most recent update time of the domain.
    CreatedAt string
    The creation time of the domain.
    DnsSecurity string
    The version of DNS DDoS protection service.
    ExpiredTime int
    The expiration time of the domain.
    Id string
    The id of the zone.
    InstanceId string
    The ID of the instance.
    InstanceNo string
    The ID of the instance. For free edition, the value of this field is null.
    IsNsCorrect bool
    Indicates whether the configuration of NS servers is correct. If the configuration is correct, the status of the domain in BytePlus DNS is Active.
    IsSubDomain bool
    Whether the domain is a subdomain.
    LastOperator string
    The ID of the account that last updated this domain.
    ProjectName string
    The ProjectName of the domain.
    RealDnsServerLists []string
    The list of DNS servers actually used by the domain.
    RecordCount int
    The total number of DNS records contained in the domain.
    Remark string
    The remarks for the domain.
    Stage int
    The status of the domain.
    SubDomainHost string
    The domain prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
    Tags []GetZonesZoneTag
    Tags.
    TradeCode string
    The edition of the domain.
    UpdatedAt string
    The most recent update time of the domain.
    Zid int
    The ID of the domain.
    ZoneName string
    The domain name.
    allocateDnsServerLists List<String>
    The list of DNS servers allocated to the domain by BytePlus DNS.
    autoRenew Boolean
    Whether automatic domain renewal is enabled.
    cacheStage Integer
    The most recent update time of the domain.
    createdAt String
    The creation time of the domain.
    dnsSecurity String
    The version of DNS DDoS protection service.
    expiredTime Integer
    The expiration time of the domain.
    id String
    The id of the zone.
    instanceId String
    The ID of the instance.
    instanceNo String
    The ID of the instance. For free edition, the value of this field is null.
    isNsCorrect Boolean
    Indicates whether the configuration of NS servers is correct. If the configuration is correct, the status of the domain in BytePlus DNS is Active.
    isSubDomain Boolean
    Whether the domain is a subdomain.
    lastOperator String
    The ID of the account that last updated this domain.
    projectName String
    The ProjectName of the domain.
    realDnsServerLists List<String>
    The list of DNS servers actually used by the domain.
    recordCount Integer
    The total number of DNS records contained in the domain.
    remark String
    The remarks for the domain.
    stage Integer
    The status of the domain.
    subDomainHost String
    The domain prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
    tags List<GetZonesZoneTag>
    Tags.
    tradeCode String
    The edition of the domain.
    updatedAt String
    The most recent update time of the domain.
    zid Integer
    The ID of the domain.
    zoneName String
    The domain name.
    allocateDnsServerLists string[]
    The list of DNS servers allocated to the domain by BytePlus DNS.
    autoRenew boolean
    Whether automatic domain renewal is enabled.
    cacheStage number
    The most recent update time of the domain.
    createdAt string
    The creation time of the domain.
    dnsSecurity string
    The version of DNS DDoS protection service.
    expiredTime number
    The expiration time of the domain.
    id string
    The id of the zone.
    instanceId string
    The ID of the instance.
    instanceNo string
    The ID of the instance. For free edition, the value of this field is null.
    isNsCorrect boolean
    Indicates whether the configuration of NS servers is correct. If the configuration is correct, the status of the domain in BytePlus DNS is Active.
    isSubDomain boolean
    Whether the domain is a subdomain.
    lastOperator string
    The ID of the account that last updated this domain.
    projectName string
    The ProjectName of the domain.
    realDnsServerLists string[]
    The list of DNS servers actually used by the domain.
    recordCount number
    The total number of DNS records contained in the domain.
    remark string
    The remarks for the domain.
    stage number
    The status of the domain.
    subDomainHost string
    The domain prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
    tags GetZonesZoneTag[]
    Tags.
    tradeCode string
    The edition of the domain.
    updatedAt string
    The most recent update time of the domain.
    zid number
    The ID of the domain.
    zoneName string
    The domain name.
    allocate_dns_server_lists Sequence[str]
    The list of DNS servers allocated to the domain by BytePlus DNS.
    auto_renew bool
    Whether automatic domain renewal is enabled.
    cache_stage int
    The most recent update time of the domain.
    created_at str
    The creation time of the domain.
    dns_security str
    The version of DNS DDoS protection service.
    expired_time int
    The expiration time of the domain.
    id str
    The id of the zone.
    instance_id str
    The ID of the instance.
    instance_no str
    The ID of the instance. For free edition, the value of this field is null.
    is_ns_correct bool
    Indicates whether the configuration of NS servers is correct. If the configuration is correct, the status of the domain in BytePlus DNS is Active.
    is_sub_domain bool
    Whether the domain is a subdomain.
    last_operator str
    The ID of the account that last updated this domain.
    project_name str
    The ProjectName of the domain.
    real_dns_server_lists Sequence[str]
    The list of DNS servers actually used by the domain.
    record_count int
    The total number of DNS records contained in the domain.
    remark str
    The remarks for the domain.
    stage int
    The status of the domain.
    sub_domain_host str
    The domain prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
    tags Sequence[GetZonesZoneTag]
    Tags.
    trade_code str
    The edition of the domain.
    updated_at str
    The most recent update time of the domain.
    zid int
    The ID of the domain.
    zone_name str
    The domain name.
    allocateDnsServerLists List<String>
    The list of DNS servers allocated to the domain by BytePlus DNS.
    autoRenew Boolean
    Whether automatic domain renewal is enabled.
    cacheStage Number
    The most recent update time of the domain.
    createdAt String
    The creation time of the domain.
    dnsSecurity String
    The version of DNS DDoS protection service.
    expiredTime Number
    The expiration time of the domain.
    id String
    The id of the zone.
    instanceId String
    The ID of the instance.
    instanceNo String
    The ID of the instance. For free edition, the value of this field is null.
    isNsCorrect Boolean
    Indicates whether the configuration of NS servers is correct. If the configuration is correct, the status of the domain in BytePlus DNS is Active.
    isSubDomain Boolean
    Whether the domain is a subdomain.
    lastOperator String
    The ID of the account that last updated this domain.
    projectName String
    The ProjectName of the domain.
    realDnsServerLists List<String>
    The list of DNS servers actually used by the domain.
    recordCount Number
    The total number of DNS records contained in the domain.
    remark String
    The remarks for the domain.
    stage Number
    The status of the domain.
    subDomainHost String
    The domain prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
    tags List<Property Map>
    Tags.
    tradeCode String
    The edition of the domain.
    updatedAt String
    The most recent update time of the domain.
    zid Number
    The ID of the domain.
    zoneName String
    The domain name.

    GetZonesZoneTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    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.31 published on Monday, May 12, 2025 by Volcengine
    volcengine/pulumi-volcengine