1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. dns
  6. Zone
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.dns.Zone

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    The zone in the resource is the domain name, which can be a primary domain such as example.com or a subdomain such as abc.example.com

    Example Usage

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

const dnsZoneDemo = new volcenginecc.dns.Zone("DnsZoneDemo", {
    zoneName: "DnsZoneDemo",
    remark: "test",
    projectName: "default",
    tags: [{
        key: "env",
        value: "test",
    }],
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

dns_zone_demo = volcenginecc.dns.Zone("DnsZoneDemo",
    zone_name="DnsZoneDemo",
    remark="test",
    project_name="default",
    tags=[{
        "key": "env",
        "value": "test",
    }])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dns.NewZone(ctx, "DnsZoneDemo", &dns.ZoneArgs{
			ZoneName:    pulumi.String("DnsZoneDemo"),
			Remark:      pulumi.String("test"),
			ProjectName: pulumi.String("default"),
			Tags: dns.ZoneTagArray{
				&dns.ZoneTagArgs{
					Key:   pulumi.String("env"),
					Value: pulumi.String("test"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;

return await Deployment.RunAsync(() => 
{
    var dnsZoneDemo = new Volcenginecc.Dns.Zone("DnsZoneDemo", new()
    {
        ZoneName = "DnsZoneDemo",
        Remark = "test",
        ProjectName = "default",
        Tags = new[]
        {
            new Volcenginecc.Dns.Inputs.ZoneTagArgs
            {
                Key = "env",
                Value = "test",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.dns.Zone;
import com.volcengine.volcenginecc.dns.ZoneArgs;
import com.pulumi.volcenginecc.dns.inputs.ZoneTagArgs;
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) {
        var dnsZoneDemo = new Zone("dnsZoneDemo", ZoneArgs.builder()
            .zoneName("DnsZoneDemo")
            .remark("test")
            .projectName("default")
            .tags(ZoneTagArgs.builder()
                .key("env")
                .value("test")
                .build())
            .build());

    }
}

    resources:
  dnsZoneDemo:
    type: volcenginecc:dns:Zone
    name: DnsZoneDemo
    properties:
      zoneName: DnsZoneDemo
      remark: test
      projectName: default
      tags:
        - key: env
          value: test

    Create Zone Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Zone(name: string, args: ZoneArgs, opts?: CustomResourceOptions);
    @overload
def Zone(resource_name: str,
         args: ZoneArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Zone(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         zone_name: Optional[str] = None,
         project_name: Optional[str] = None,
         remark: Optional[str] = None,
         tags: Optional[Sequence[ZoneTagArgs]] = None)
    func NewZone(ctx *Context, name string, args ZoneArgs, opts ...ResourceOption) (*Zone, error)
    public Zone(string name, ZoneArgs args, CustomResourceOptions? opts = null)
    public Zone(String name, ZoneArgs args)
public Zone(String name, ZoneArgs args, CustomResourceOptions options)

    type: volcenginecc:dns:Zone
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ZoneArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var zoneResource = new Volcenginecc.Dns.Zone("zoneResource", new()
{
    ZoneName = "string",
    ProjectName = "string",
    Remark = "string",
    Tags = new[]
    {
        new Volcenginecc.Dns.Inputs.ZoneTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
});

    example, err := dns.NewZone(ctx, "zoneResource", &dns.ZoneArgs{
	ZoneName:    pulumi.String("string"),
	ProjectName: pulumi.String("string"),
	Remark:      pulumi.String("string"),
	Tags: dns.ZoneTagArray{
		&dns.ZoneTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
})

    var zoneResource = new Zone("zoneResource", ZoneArgs.builder()
    .zoneName("string")
    .projectName("string")
    .remark("string")
    .tags(ZoneTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .build());

    zone_resource = volcenginecc.dns.Zone("zoneResource",
    zone_name="string",
    project_name="string",
    remark="string",
    tags=[{
        "key": "string",
        "value": "string",
    }])

    const zoneResource = new volcenginecc.dns.Zone("zoneResource", {
    zoneName: "string",
    projectName: "string",
    remark: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
});

    type: volcenginecc:dns:Zone
properties:
    projectName: string
    remark: string
    tags:
        - key: string
          value: string
    zoneName: string

    Zone Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Zone resource accepts the following input properties:

    ZoneName string
    Domain name.
    ProjectName string
    Domain project.
    Remark string
    Domain notes
    Tags List<Volcengine.ZoneTag>
    ZoneName string
    Domain name.
    ProjectName string
    Domain project.
    Remark string
    Domain notes
    Tags []ZoneTagArgs
    zoneName String
    Domain name.
    projectName String
    Domain project.
    remark String
    Domain notes
    tags List<ZoneTag>
    zoneName string
    Domain name.
    projectName string
    Domain project.
    remark string
    Domain notes
    tags ZoneTag[]
    zone_name str
    Domain name.
    project_name str
    Domain project.
    remark str
    Domain notes
    tags Sequence[ZoneTagArgs]
    zoneName String
    Domain name.
    projectName String
    Domain project.
    remark String
    Domain notes
    tags List<Property Map>

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Zone resource produces the following output properties:

    AllocateDnsServerLists List<string>
    List of DNS servers assigned to the domain by Cloud DNS
    AutoRenew bool
    Whether domain auto-renewal is enabled. true: Auto-renewal enabled. false: Auto-renewal disabled.
    CacheStage int
    Domain ownership status. This parameter has the following values: 0: You are the domain owner. After adding this domain, you can manage its DNS resolution. 1: You are not the domain owner. After adding this domain, its status is 'domain reclaim pending.' To manage DNS resolution, you must verify domain ownership in the console as prompted.
    CreatedTime string
    Domain creation time.
    DnsSecurity string
    Version of DNS DDoS protection service. dnssecuritystandard_inner: Standard protection edition. "": No protection edition.
    ExpiredTime int
    Instance expiration time. Format is Unix timestamp. For Cloud DNS Free Edition, this field is null.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Instance ID. For Cloud DNS Free Edition, this field is null.
    InstanceNo string
    Instance ID. For Cloud DNS Free Edition, this field is null.
    IsNsCorrect bool
    Whether the DNS server configuration is correct. If configured correctly, the domain status in Cloud DNS is Normal. This parameter has the following values: true: The DNS server list in RealDNSServerList includes all DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is correct. false: The DNS server list in RealDNSServerList includes only some or none of the DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is incorrect.
    IsSubDomain bool
    Whether it is a subdomain. true: Subdomain. false: Primary domain.
    LastOperator string
    ID of the account that created the domain.
    RealDnsServerLists List<string>
    List of DNS servers actually used by the domain.
    RecordCount int
    Total number of DNS records contained in the domain.
    Stage int
    Domain status. This parameter has the following values: 0: Normal. In this state, the domain's DNS resolution records are active. 1: Domain reclaim pending. In this state, the domain's DNS resolution records are inactive. This status indicates you are not the owner of the domain. If you need to manage DNS resolution, you must verify domain ownership. 2: TrafficRoute not used for resolution. In this state, the domain's DNS resolution records are inactive. This status means the DNS server assigned to the domain is not a Cloud DNS server. 3: Abnormal. In this state, the domain's DNS resolution records are inactive. Common causes for this status include: the domain is disabled by the registry or registrar due to lack of real-name verification; DNS server not configured; domain not registered; API timeout when querying the domain, possibly due to network issues. 5: Please change DNS server. This status means you need to update the domain's DNS server to the newly assigned Cloud DNS server due to service upgrade or change.
    SubDomainHost string
    Prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
    TradeCode string
    Domain feature version. This parameter has the following values: freeinner: Free Edition; professionalinner: Professional Edition; enterpriseinner: Enterprise Edition; ultimateinner: Flagship Edition; ultimateexclusiveinner: Premium Edition.
    UpdatedTime string
    Last update time for the domain. Update operations include: updating domain remarks, creating DNS records under the domain.
    Zid string
    Domain ID.
    AllocateDnsServerLists []string
    List of DNS servers assigned to the domain by Cloud DNS
    AutoRenew bool
    Whether domain auto-renewal is enabled. true: Auto-renewal enabled. false: Auto-renewal disabled.
    CacheStage int
    Domain ownership status. This parameter has the following values: 0: You are the domain owner. After adding this domain, you can manage its DNS resolution. 1: You are not the domain owner. After adding this domain, its status is 'domain reclaim pending.' To manage DNS resolution, you must verify domain ownership in the console as prompted.
    CreatedTime string
    Domain creation time.
    DnsSecurity string
    Version of DNS DDoS protection service. dnssecuritystandard_inner: Standard protection edition. "": No protection edition.
    ExpiredTime int
    Instance expiration time. Format is Unix timestamp. For Cloud DNS Free Edition, this field is null.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Instance ID. For Cloud DNS Free Edition, this field is null.
    InstanceNo string
    Instance ID. For Cloud DNS Free Edition, this field is null.
    IsNsCorrect bool
    Whether the DNS server configuration is correct. If configured correctly, the domain status in Cloud DNS is Normal. This parameter has the following values: true: The DNS server list in RealDNSServerList includes all DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is correct. false: The DNS server list in RealDNSServerList includes only some or none of the DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is incorrect.
    IsSubDomain bool
    Whether it is a subdomain. true: Subdomain. false: Primary domain.
    LastOperator string
    ID of the account that created the domain.
    RealDnsServerLists []string
    List of DNS servers actually used by the domain.
    RecordCount int
    Total number of DNS records contained in the domain.
    Stage int
    Domain status. This parameter has the following values: 0: Normal. In this state, the domain's DNS resolution records are active. 1: Domain reclaim pending. In this state, the domain's DNS resolution records are inactive. This status indicates you are not the owner of the domain. If you need to manage DNS resolution, you must verify domain ownership. 2: TrafficRoute not used for resolution. In this state, the domain's DNS resolution records are inactive. This status means the DNS server assigned to the domain is not a Cloud DNS server. 3: Abnormal. In this state, the domain's DNS resolution records are inactive. Common causes for this status include: the domain is disabled by the registry or registrar due to lack of real-name verification; DNS server not configured; domain not registered; API timeout when querying the domain, possibly due to network issues. 5: Please change DNS server. This status means you need to update the domain's DNS server to the newly assigned Cloud DNS server due to service upgrade or change.
    SubDomainHost string
    Prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
    TradeCode string
    Domain feature version. This parameter has the following values: freeinner: Free Edition; professionalinner: Professional Edition; enterpriseinner: Enterprise Edition; ultimateinner: Flagship Edition; ultimateexclusiveinner: Premium Edition.
    UpdatedTime string
    Last update time for the domain. Update operations include: updating domain remarks, creating DNS records under the domain.
    Zid string
    Domain ID.
    allocateDnsServerLists List<String>
    List of DNS servers assigned to the domain by Cloud DNS
    autoRenew Boolean
    Whether domain auto-renewal is enabled. true: Auto-renewal enabled. false: Auto-renewal disabled.
    cacheStage Integer
    Domain ownership status. This parameter has the following values: 0: You are the domain owner. After adding this domain, you can manage its DNS resolution. 1: You are not the domain owner. After adding this domain, its status is 'domain reclaim pending.' To manage DNS resolution, you must verify domain ownership in the console as prompted.
    createdTime String
    Domain creation time.
    dnsSecurity String
    Version of DNS DDoS protection service. dnssecuritystandard_inner: Standard protection edition. "": No protection edition.
    expiredTime Integer
    Instance expiration time. Format is Unix timestamp. For Cloud DNS Free Edition, this field is null.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    Instance ID. For Cloud DNS Free Edition, this field is null.
    instanceNo String
    Instance ID. For Cloud DNS Free Edition, this field is null.
    isNsCorrect Boolean
    Whether the DNS server configuration is correct. If configured correctly, the domain status in Cloud DNS is Normal. This parameter has the following values: true: The DNS server list in RealDNSServerList includes all DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is correct. false: The DNS server list in RealDNSServerList includes only some or none of the DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is incorrect.
    isSubDomain Boolean
    Whether it is a subdomain. true: Subdomain. false: Primary domain.
    lastOperator String
    ID of the account that created the domain.
    realDnsServerLists List<String>
    List of DNS servers actually used by the domain.
    recordCount Integer
    Total number of DNS records contained in the domain.
    stage Integer
    Domain status. This parameter has the following values: 0: Normal. In this state, the domain's DNS resolution records are active. 1: Domain reclaim pending. In this state, the domain's DNS resolution records are inactive. This status indicates you are not the owner of the domain. If you need to manage DNS resolution, you must verify domain ownership. 2: TrafficRoute not used for resolution. In this state, the domain's DNS resolution records are inactive. This status means the DNS server assigned to the domain is not a Cloud DNS server. 3: Abnormal. In this state, the domain's DNS resolution records are inactive. Common causes for this status include: the domain is disabled by the registry or registrar due to lack of real-name verification; DNS server not configured; domain not registered; API timeout when querying the domain, possibly due to network issues. 5: Please change DNS server. This status means you need to update the domain's DNS server to the newly assigned Cloud DNS server due to service upgrade or change.
    subDomainHost String
    Prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
    tradeCode String
    Domain feature version. This parameter has the following values: freeinner: Free Edition; professionalinner: Professional Edition; enterpriseinner: Enterprise Edition; ultimateinner: Flagship Edition; ultimateexclusiveinner: Premium Edition.
    updatedTime String
    Last update time for the domain. Update operations include: updating domain remarks, creating DNS records under the domain.
    zid String
    Domain ID.
    allocateDnsServerLists string[]
    List of DNS servers assigned to the domain by Cloud DNS
    autoRenew boolean
    Whether domain auto-renewal is enabled. true: Auto-renewal enabled. false: Auto-renewal disabled.
    cacheStage number
    Domain ownership status. This parameter has the following values: 0: You are the domain owner. After adding this domain, you can manage its DNS resolution. 1: You are not the domain owner. After adding this domain, its status is 'domain reclaim pending.' To manage DNS resolution, you must verify domain ownership in the console as prompted.
    createdTime string
    Domain creation time.
    dnsSecurity string
    Version of DNS DDoS protection service. dnssecuritystandard_inner: Standard protection edition. "": No protection edition.
    expiredTime number
    Instance expiration time. Format is Unix timestamp. For Cloud DNS Free Edition, this field is null.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    Instance ID. For Cloud DNS Free Edition, this field is null.
    instanceNo string
    Instance ID. For Cloud DNS Free Edition, this field is null.
    isNsCorrect boolean
    Whether the DNS server configuration is correct. If configured correctly, the domain status in Cloud DNS is Normal. This parameter has the following values: true: The DNS server list in RealDNSServerList includes all DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is correct. false: The DNS server list in RealDNSServerList includes only some or none of the DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is incorrect.
    isSubDomain boolean
    Whether it is a subdomain. true: Subdomain. false: Primary domain.
    lastOperator string
    ID of the account that created the domain.
    realDnsServerLists string[]
    List of DNS servers actually used by the domain.
    recordCount number
    Total number of DNS records contained in the domain.
    stage number
    Domain status. This parameter has the following values: 0: Normal. In this state, the domain's DNS resolution records are active. 1: Domain reclaim pending. In this state, the domain's DNS resolution records are inactive. This status indicates you are not the owner of the domain. If you need to manage DNS resolution, you must verify domain ownership. 2: TrafficRoute not used for resolution. In this state, the domain's DNS resolution records are inactive. This status means the DNS server assigned to the domain is not a Cloud DNS server. 3: Abnormal. In this state, the domain's DNS resolution records are inactive. Common causes for this status include: the domain is disabled by the registry or registrar due to lack of real-name verification; DNS server not configured; domain not registered; API timeout when querying the domain, possibly due to network issues. 5: Please change DNS server. This status means you need to update the domain's DNS server to the newly assigned Cloud DNS server due to service upgrade or change.
    subDomainHost string
    Prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
    tradeCode string
    Domain feature version. This parameter has the following values: freeinner: Free Edition; professionalinner: Professional Edition; enterpriseinner: Enterprise Edition; ultimateinner: Flagship Edition; ultimateexclusiveinner: Premium Edition.
    updatedTime string
    Last update time for the domain. Update operations include: updating domain remarks, creating DNS records under the domain.
    zid string
    Domain ID.
    allocate_dns_server_lists Sequence[str]
    List of DNS servers assigned to the domain by Cloud DNS
    auto_renew bool
    Whether domain auto-renewal is enabled. true: Auto-renewal enabled. false: Auto-renewal disabled.
    cache_stage int
    Domain ownership status. This parameter has the following values: 0: You are the domain owner. After adding this domain, you can manage its DNS resolution. 1: You are not the domain owner. After adding this domain, its status is 'domain reclaim pending.' To manage DNS resolution, you must verify domain ownership in the console as prompted.
    created_time str
    Domain creation time.
    dns_security str
    Version of DNS DDoS protection service. dnssecuritystandard_inner: Standard protection edition. "": No protection edition.
    expired_time int
    Instance expiration time. Format is Unix timestamp. For Cloud DNS Free Edition, this field is null.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    Instance ID. For Cloud DNS Free Edition, this field is null.
    instance_no str
    Instance ID. For Cloud DNS Free Edition, this field is null.
    is_ns_correct bool
    Whether the DNS server configuration is correct. If configured correctly, the domain status in Cloud DNS is Normal. This parameter has the following values: true: The DNS server list in RealDNSServerList includes all DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is correct. false: The DNS server list in RealDNSServerList includes only some or none of the DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is incorrect.
    is_sub_domain bool
    Whether it is a subdomain. true: Subdomain. false: Primary domain.
    last_operator str
    ID of the account that created the domain.
    real_dns_server_lists Sequence[str]
    List of DNS servers actually used by the domain.
    record_count int
    Total number of DNS records contained in the domain.
    stage int
    Domain status. This parameter has the following values: 0: Normal. In this state, the domain's DNS resolution records are active. 1: Domain reclaim pending. In this state, the domain's DNS resolution records are inactive. This status indicates you are not the owner of the domain. If you need to manage DNS resolution, you must verify domain ownership. 2: TrafficRoute not used for resolution. In this state, the domain's DNS resolution records are inactive. This status means the DNS server assigned to the domain is not a Cloud DNS server. 3: Abnormal. In this state, the domain's DNS resolution records are inactive. Common causes for this status include: the domain is disabled by the registry or registrar due to lack of real-name verification; DNS server not configured; domain not registered; API timeout when querying the domain, possibly due to network issues. 5: Please change DNS server. This status means you need to update the domain's DNS server to the newly assigned Cloud DNS server due to service upgrade or change.
    sub_domain_host str
    Prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
    trade_code str
    Domain feature version. This parameter has the following values: freeinner: Free Edition; professionalinner: Professional Edition; enterpriseinner: Enterprise Edition; ultimateinner: Flagship Edition; ultimateexclusiveinner: Premium Edition.
    updated_time str
    Last update time for the domain. Update operations include: updating domain remarks, creating DNS records under the domain.
    zid str
    Domain ID.
    allocateDnsServerLists List<String>
    List of DNS servers assigned to the domain by Cloud DNS
    autoRenew Boolean
    Whether domain auto-renewal is enabled. true: Auto-renewal enabled. false: Auto-renewal disabled.
    cacheStage Number
    Domain ownership status. This parameter has the following values: 0: You are the domain owner. After adding this domain, you can manage its DNS resolution. 1: You are not the domain owner. After adding this domain, its status is 'domain reclaim pending.' To manage DNS resolution, you must verify domain ownership in the console as prompted.
    createdTime String
    Domain creation time.
    dnsSecurity String
    Version of DNS DDoS protection service. dnssecuritystandard_inner: Standard protection edition. "": No protection edition.
    expiredTime Number
    Instance expiration time. Format is Unix timestamp. For Cloud DNS Free Edition, this field is null.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    Instance ID. For Cloud DNS Free Edition, this field is null.
    instanceNo String
    Instance ID. For Cloud DNS Free Edition, this field is null.
    isNsCorrect Boolean
    Whether the DNS server configuration is correct. If configured correctly, the domain status in Cloud DNS is Normal. This parameter has the following values: true: The DNS server list in RealDNSServerList includes all DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is correct. false: The DNS server list in RealDNSServerList includes only some or none of the DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is incorrect.
    isSubDomain Boolean
    Whether it is a subdomain. true: Subdomain. false: Primary domain.
    lastOperator String
    ID of the account that created the domain.
    realDnsServerLists List<String>
    List of DNS servers actually used by the domain.
    recordCount Number
    Total number of DNS records contained in the domain.
    stage Number
    Domain status. This parameter has the following values: 0: Normal. In this state, the domain's DNS resolution records are active. 1: Domain reclaim pending. In this state, the domain's DNS resolution records are inactive. This status indicates you are not the owner of the domain. If you need to manage DNS resolution, you must verify domain ownership. 2: TrafficRoute not used for resolution. In this state, the domain's DNS resolution records are inactive. This status means the DNS server assigned to the domain is not a Cloud DNS server. 3: Abnormal. In this state, the domain's DNS resolution records are inactive. Common causes for this status include: the domain is disabled by the registry or registrar due to lack of real-name verification; DNS server not configured; domain not registered; API timeout when querying the domain, possibly due to network issues. 5: Please change DNS server. This status means you need to update the domain's DNS server to the newly assigned Cloud DNS server due to service upgrade or change.
    subDomainHost String
    Prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
    tradeCode String
    Domain feature version. This parameter has the following values: freeinner: Free Edition; professionalinner: Professional Edition; enterpriseinner: Enterprise Edition; ultimateinner: Flagship Edition; ultimateexclusiveinner: Premium Edition.
    updatedTime String
    Last update time for the domain. Update operations include: updating domain remarks, creating DNS records under the domain.
    zid String
    Domain ID.

    Look up Existing Zone Resource

    Get an existing Zone resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ZoneState, opts?: CustomResourceOptions): Zone
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocate_dns_server_lists: Optional[Sequence[str]] = None,
        auto_renew: Optional[bool] = None,
        cache_stage: Optional[int] = None,
        created_time: Optional[str] = None,
        dns_security: Optional[str] = None,
        expired_time: Optional[int] = None,
        instance_id: Optional[str] = None,
        instance_no: Optional[str] = None,
        is_ns_correct: Optional[bool] = None,
        is_sub_domain: Optional[bool] = None,
        last_operator: Optional[str] = None,
        project_name: Optional[str] = None,
        real_dns_server_lists: Optional[Sequence[str]] = None,
        record_count: Optional[int] = None,
        remark: Optional[str] = None,
        stage: Optional[int] = None,
        sub_domain_host: Optional[str] = None,
        tags: Optional[Sequence[ZoneTagArgs]] = None,
        trade_code: Optional[str] = None,
        updated_time: Optional[str] = None,
        zid: Optional[str] = None,
        zone_name: Optional[str] = None) -> Zone
    func GetZone(ctx *Context, name string, id IDInput, state *ZoneState, opts ...ResourceOption) (*Zone, error)
    public static Zone Get(string name, Input<string> id, ZoneState? state, CustomResourceOptions? opts = null)
    public static Zone get(String name, Output<String> id, ZoneState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:dns:Zone    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllocateDnsServerLists List<string>
    List of DNS servers assigned to the domain by Cloud DNS
    AutoRenew bool
    Whether domain auto-renewal is enabled. true: Auto-renewal enabled. false: Auto-renewal disabled.
    CacheStage int
    Domain ownership status. This parameter has the following values: 0: You are the domain owner. After adding this domain, you can manage its DNS resolution. 1: You are not the domain owner. After adding this domain, its status is 'domain reclaim pending.' To manage DNS resolution, you must verify domain ownership in the console as prompted.
    CreatedTime string
    Domain creation time.
    DnsSecurity string
    Version of DNS DDoS protection service. dnssecuritystandard_inner: Standard protection edition. "": No protection edition.
    ExpiredTime int
    Instance expiration time. Format is Unix timestamp. For Cloud DNS Free Edition, this field is null.
    InstanceId string
    Instance ID. For Cloud DNS Free Edition, this field is null.
    InstanceNo string
    Instance ID. For Cloud DNS Free Edition, this field is null.
    IsNsCorrect bool
    Whether the DNS server configuration is correct. If configured correctly, the domain status in Cloud DNS is Normal. This parameter has the following values: true: The DNS server list in RealDNSServerList includes all DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is correct. false: The DNS server list in RealDNSServerList includes only some or none of the DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is incorrect.
    IsSubDomain bool
    Whether it is a subdomain. true: Subdomain. false: Primary domain.
    LastOperator string
    ID of the account that created the domain.
    ProjectName string
    Domain project.
    RealDnsServerLists List<string>
    List of DNS servers actually used by the domain.
    RecordCount int
    Total number of DNS records contained in the domain.
    Remark string
    Domain notes
    Stage int
    Domain status. This parameter has the following values: 0: Normal. In this state, the domain's DNS resolution records are active. 1: Domain reclaim pending. In this state, the domain's DNS resolution records are inactive. This status indicates you are not the owner of the domain. If you need to manage DNS resolution, you must verify domain ownership. 2: TrafficRoute not used for resolution. In this state, the domain's DNS resolution records are inactive. This status means the DNS server assigned to the domain is not a Cloud DNS server. 3: Abnormal. In this state, the domain's DNS resolution records are inactive. Common causes for this status include: the domain is disabled by the registry or registrar due to lack of real-name verification; DNS server not configured; domain not registered; API timeout when querying the domain, possibly due to network issues. 5: Please change DNS server. This status means you need to update the domain's DNS server to the newly assigned Cloud DNS server due to service upgrade or change.
    SubDomainHost string
    Prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
    Tags List<Volcengine.ZoneTag>
    TradeCode string
    Domain feature version. This parameter has the following values: freeinner: Free Edition; professionalinner: Professional Edition; enterpriseinner: Enterprise Edition; ultimateinner: Flagship Edition; ultimateexclusiveinner: Premium Edition.
    UpdatedTime string
    Last update time for the domain. Update operations include: updating domain remarks, creating DNS records under the domain.
    Zid string
    Domain ID.
    ZoneName string
    Domain name.
    AllocateDnsServerLists []string
    List of DNS servers assigned to the domain by Cloud DNS
    AutoRenew bool
    Whether domain auto-renewal is enabled. true: Auto-renewal enabled. false: Auto-renewal disabled.
    CacheStage int
    Domain ownership status. This parameter has the following values: 0: You are the domain owner. After adding this domain, you can manage its DNS resolution. 1: You are not the domain owner. After adding this domain, its status is 'domain reclaim pending.' To manage DNS resolution, you must verify domain ownership in the console as prompted.
    CreatedTime string
    Domain creation time.
    DnsSecurity string
    Version of DNS DDoS protection service. dnssecuritystandard_inner: Standard protection edition. "": No protection edition.
    ExpiredTime int
    Instance expiration time. Format is Unix timestamp. For Cloud DNS Free Edition, this field is null.
    InstanceId string
    Instance ID. For Cloud DNS Free Edition, this field is null.
    InstanceNo string
    Instance ID. For Cloud DNS Free Edition, this field is null.
    IsNsCorrect bool
    Whether the DNS server configuration is correct. If configured correctly, the domain status in Cloud DNS is Normal. This parameter has the following values: true: The DNS server list in RealDNSServerList includes all DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is correct. false: The DNS server list in RealDNSServerList includes only some or none of the DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is incorrect.
    IsSubDomain bool
    Whether it is a subdomain. true: Subdomain. false: Primary domain.
    LastOperator string
    ID of the account that created the domain.
    ProjectName string
    Domain project.
    RealDnsServerLists []string
    List of DNS servers actually used by the domain.
    RecordCount int
    Total number of DNS records contained in the domain.
    Remark string
    Domain notes
    Stage int
    Domain status. This parameter has the following values: 0: Normal. In this state, the domain's DNS resolution records are active. 1: Domain reclaim pending. In this state, the domain's DNS resolution records are inactive. This status indicates you are not the owner of the domain. If you need to manage DNS resolution, you must verify domain ownership. 2: TrafficRoute not used for resolution. In this state, the domain's DNS resolution records are inactive. This status means the DNS server assigned to the domain is not a Cloud DNS server. 3: Abnormal. In this state, the domain's DNS resolution records are inactive. Common causes for this status include: the domain is disabled by the registry or registrar due to lack of real-name verification; DNS server not configured; domain not registered; API timeout when querying the domain, possibly due to network issues. 5: Please change DNS server. This status means you need to update the domain's DNS server to the newly assigned Cloud DNS server due to service upgrade or change.
    SubDomainHost string
    Prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
    Tags []ZoneTagArgs
    TradeCode string
    Domain feature version. This parameter has the following values: freeinner: Free Edition; professionalinner: Professional Edition; enterpriseinner: Enterprise Edition; ultimateinner: Flagship Edition; ultimateexclusiveinner: Premium Edition.
    UpdatedTime string
    Last update time for the domain. Update operations include: updating domain remarks, creating DNS records under the domain.
    Zid string
    Domain ID.
    ZoneName string
    Domain name.
    allocateDnsServerLists List<String>
    List of DNS servers assigned to the domain by Cloud DNS
    autoRenew Boolean
    Whether domain auto-renewal is enabled. true: Auto-renewal enabled. false: Auto-renewal disabled.
    cacheStage Integer
    Domain ownership status. This parameter has the following values: 0: You are the domain owner. After adding this domain, you can manage its DNS resolution. 1: You are not the domain owner. After adding this domain, its status is 'domain reclaim pending.' To manage DNS resolution, you must verify domain ownership in the console as prompted.
    createdTime String
    Domain creation time.
    dnsSecurity String
    Version of DNS DDoS protection service. dnssecuritystandard_inner: Standard protection edition. "": No protection edition.
    expiredTime Integer
    Instance expiration time. Format is Unix timestamp. For Cloud DNS Free Edition, this field is null.
    instanceId String
    Instance ID. For Cloud DNS Free Edition, this field is null.
    instanceNo String
    Instance ID. For Cloud DNS Free Edition, this field is null.
    isNsCorrect Boolean
    Whether the DNS server configuration is correct. If configured correctly, the domain status in Cloud DNS is Normal. This parameter has the following values: true: The DNS server list in RealDNSServerList includes all DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is correct. false: The DNS server list in RealDNSServerList includes only some or none of the DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is incorrect.
    isSubDomain Boolean
    Whether it is a subdomain. true: Subdomain. false: Primary domain.
    lastOperator String
    ID of the account that created the domain.
    projectName String
    Domain project.
    realDnsServerLists List<String>
    List of DNS servers actually used by the domain.
    recordCount Integer
    Total number of DNS records contained in the domain.
    remark String
    Domain notes
    stage Integer
    Domain status. This parameter has the following values: 0: Normal. In this state, the domain's DNS resolution records are active. 1: Domain reclaim pending. In this state, the domain's DNS resolution records are inactive. This status indicates you are not the owner of the domain. If you need to manage DNS resolution, you must verify domain ownership. 2: TrafficRoute not used for resolution. In this state, the domain's DNS resolution records are inactive. This status means the DNS server assigned to the domain is not a Cloud DNS server. 3: Abnormal. In this state, the domain's DNS resolution records are inactive. Common causes for this status include: the domain is disabled by the registry or registrar due to lack of real-name verification; DNS server not configured; domain not registered; API timeout when querying the domain, possibly due to network issues. 5: Please change DNS server. This status means you need to update the domain's DNS server to the newly assigned Cloud DNS server due to service upgrade or change.
    subDomainHost String
    Prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
    tags List<ZoneTag>
    tradeCode String
    Domain feature version. This parameter has the following values: freeinner: Free Edition; professionalinner: Professional Edition; enterpriseinner: Enterprise Edition; ultimateinner: Flagship Edition; ultimateexclusiveinner: Premium Edition.
    updatedTime String
    Last update time for the domain. Update operations include: updating domain remarks, creating DNS records under the domain.
    zid String
    Domain ID.
    zoneName String
    Domain name.
    allocateDnsServerLists string[]
    List of DNS servers assigned to the domain by Cloud DNS
    autoRenew boolean
    Whether domain auto-renewal is enabled. true: Auto-renewal enabled. false: Auto-renewal disabled.
    cacheStage number
    Domain ownership status. This parameter has the following values: 0: You are the domain owner. After adding this domain, you can manage its DNS resolution. 1: You are not the domain owner. After adding this domain, its status is 'domain reclaim pending.' To manage DNS resolution, you must verify domain ownership in the console as prompted.
    createdTime string
    Domain creation time.
    dnsSecurity string
    Version of DNS DDoS protection service. dnssecuritystandard_inner: Standard protection edition. "": No protection edition.
    expiredTime number
    Instance expiration time. Format is Unix timestamp. For Cloud DNS Free Edition, this field is null.
    instanceId string
    Instance ID. For Cloud DNS Free Edition, this field is null.
    instanceNo string
    Instance ID. For Cloud DNS Free Edition, this field is null.
    isNsCorrect boolean
    Whether the DNS server configuration is correct. If configured correctly, the domain status in Cloud DNS is Normal. This parameter has the following values: true: The DNS server list in RealDNSServerList includes all DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is correct. false: The DNS server list in RealDNSServerList includes only some or none of the DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is incorrect.
    isSubDomain boolean
    Whether it is a subdomain. true: Subdomain. false: Primary domain.
    lastOperator string
    ID of the account that created the domain.
    projectName string
    Domain project.
    realDnsServerLists string[]
    List of DNS servers actually used by the domain.
    recordCount number
    Total number of DNS records contained in the domain.
    remark string
    Domain notes
    stage number
    Domain status. This parameter has the following values: 0: Normal. In this state, the domain's DNS resolution records are active. 1: Domain reclaim pending. In this state, the domain's DNS resolution records are inactive. This status indicates you are not the owner of the domain. If you need to manage DNS resolution, you must verify domain ownership. 2: TrafficRoute not used for resolution. In this state, the domain's DNS resolution records are inactive. This status means the DNS server assigned to the domain is not a Cloud DNS server. 3: Abnormal. In this state, the domain's DNS resolution records are inactive. Common causes for this status include: the domain is disabled by the registry or registrar due to lack of real-name verification; DNS server not configured; domain not registered; API timeout when querying the domain, possibly due to network issues. 5: Please change DNS server. This status means you need to update the domain's DNS server to the newly assigned Cloud DNS server due to service upgrade or change.
    subDomainHost string
    Prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
    tags ZoneTag[]
    tradeCode string
    Domain feature version. This parameter has the following values: freeinner: Free Edition; professionalinner: Professional Edition; enterpriseinner: Enterprise Edition; ultimateinner: Flagship Edition; ultimateexclusiveinner: Premium Edition.
    updatedTime string
    Last update time for the domain. Update operations include: updating domain remarks, creating DNS records under the domain.
    zid string
    Domain ID.
    zoneName string
    Domain name.
    allocate_dns_server_lists Sequence[str]
    List of DNS servers assigned to the domain by Cloud DNS
    auto_renew bool
    Whether domain auto-renewal is enabled. true: Auto-renewal enabled. false: Auto-renewal disabled.
    cache_stage int
    Domain ownership status. This parameter has the following values: 0: You are the domain owner. After adding this domain, you can manage its DNS resolution. 1: You are not the domain owner. After adding this domain, its status is 'domain reclaim pending.' To manage DNS resolution, you must verify domain ownership in the console as prompted.
    created_time str
    Domain creation time.
    dns_security str
    Version of DNS DDoS protection service. dnssecuritystandard_inner: Standard protection edition. "": No protection edition.
    expired_time int
    Instance expiration time. Format is Unix timestamp. For Cloud DNS Free Edition, this field is null.
    instance_id str
    Instance ID. For Cloud DNS Free Edition, this field is null.
    instance_no str
    Instance ID. For Cloud DNS Free Edition, this field is null.
    is_ns_correct bool
    Whether the DNS server configuration is correct. If configured correctly, the domain status in Cloud DNS is Normal. This parameter has the following values: true: The DNS server list in RealDNSServerList includes all DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is correct. false: The DNS server list in RealDNSServerList includes only some or none of the DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is incorrect.
    is_sub_domain bool
    Whether it is a subdomain. true: Subdomain. false: Primary domain.
    last_operator str
    ID of the account that created the domain.
    project_name str
    Domain project.
    real_dns_server_lists Sequence[str]
    List of DNS servers actually used by the domain.
    record_count int
    Total number of DNS records contained in the domain.
    remark str
    Domain notes
    stage int
    Domain status. This parameter has the following values: 0: Normal. In this state, the domain's DNS resolution records are active. 1: Domain reclaim pending. In this state, the domain's DNS resolution records are inactive. This status indicates you are not the owner of the domain. If you need to manage DNS resolution, you must verify domain ownership. 2: TrafficRoute not used for resolution. In this state, the domain's DNS resolution records are inactive. This status means the DNS server assigned to the domain is not a Cloud DNS server. 3: Abnormal. In this state, the domain's DNS resolution records are inactive. Common causes for this status include: the domain is disabled by the registry or registrar due to lack of real-name verification; DNS server not configured; domain not registered; API timeout when querying the domain, possibly due to network issues. 5: Please change DNS server. This status means you need to update the domain's DNS server to the newly assigned Cloud DNS server due to service upgrade or change.
    sub_domain_host str
    Prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
    tags Sequence[ZoneTagArgs]
    trade_code str
    Domain feature version. This parameter has the following values: freeinner: Free Edition; professionalinner: Professional Edition; enterpriseinner: Enterprise Edition; ultimateinner: Flagship Edition; ultimateexclusiveinner: Premium Edition.
    updated_time str
    Last update time for the domain. Update operations include: updating domain remarks, creating DNS records under the domain.
    zid str
    Domain ID.
    zone_name str
    Domain name.
    allocateDnsServerLists List<String>
    List of DNS servers assigned to the domain by Cloud DNS
    autoRenew Boolean
    Whether domain auto-renewal is enabled. true: Auto-renewal enabled. false: Auto-renewal disabled.
    cacheStage Number
    Domain ownership status. This parameter has the following values: 0: You are the domain owner. After adding this domain, you can manage its DNS resolution. 1: You are not the domain owner. After adding this domain, its status is 'domain reclaim pending.' To manage DNS resolution, you must verify domain ownership in the console as prompted.
    createdTime String
    Domain creation time.
    dnsSecurity String
    Version of DNS DDoS protection service. dnssecuritystandard_inner: Standard protection edition. "": No protection edition.
    expiredTime Number
    Instance expiration time. Format is Unix timestamp. For Cloud DNS Free Edition, this field is null.
    instanceId String
    Instance ID. For Cloud DNS Free Edition, this field is null.
    instanceNo String
    Instance ID. For Cloud DNS Free Edition, this field is null.
    isNsCorrect Boolean
    Whether the DNS server configuration is correct. If configured correctly, the domain status in Cloud DNS is Normal. This parameter has the following values: true: The DNS server list in RealDNSServerList includes all DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is correct. false: The DNS server list in RealDNSServerList includes only some or none of the DNS servers in AllocateDNSServerList. In this case, the DNS server configuration is incorrect.
    isSubDomain Boolean
    Whether it is a subdomain. true: Subdomain. false: Primary domain.
    lastOperator String
    ID of the account that created the domain.
    projectName String
    Domain project.
    realDnsServerLists List<String>
    List of DNS servers actually used by the domain.
    recordCount Number
    Total number of DNS records contained in the domain.
    remark String
    Domain notes
    stage Number
    Domain status. This parameter has the following values: 0: Normal. In this state, the domain's DNS resolution records are active. 1: Domain reclaim pending. In this state, the domain's DNS resolution records are inactive. This status indicates you are not the owner of the domain. If you need to manage DNS resolution, you must verify domain ownership. 2: TrafficRoute not used for resolution. In this state, the domain's DNS resolution records are inactive. This status means the DNS server assigned to the domain is not a Cloud DNS server. 3: Abnormal. In this state, the domain's DNS resolution records are inactive. Common causes for this status include: the domain is disabled by the registry or registrar due to lack of real-name verification; DNS server not configured; domain not registered; API timeout when querying the domain, possibly due to network issues. 5: Please change DNS server. This status means you need to update the domain's DNS server to the newly assigned Cloud DNS server due to service upgrade or change.
    subDomainHost String
    Prefix of the subdomain. If the domain is not a subdomain, this parameter is null.
    tags List<Property Map>
    tradeCode String
    Domain feature version. This parameter has the following values: freeinner: Free Edition; professionalinner: Professional Edition; enterpriseinner: Enterprise Edition; ultimateinner: Flagship Edition; ultimateexclusiveinner: Premium Edition.
    updatedTime String
    Last update time for the domain. Update operations include: updating domain remarks, creating DNS records under the domain.
    zid String
    Domain ID.
    zoneName String
    Domain name.

    Supporting Types

    ZoneTag, ZoneTagArgs

    Key string
    Tag key
    Value string
    Tag value.
    Key string
    Tag key
    Value string
    Tag value.
    key String
    Tag key
    value String
    Tag value.
    key string
    Tag key
    value string
    Tag value.
    key str
    Tag key
    value str
    Tag value.
    key String
    Tag key
    value String
    Tag value.

    Import

    $ pulumi import volcenginecc:dns/zone:Zone example "zid"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.