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

volcenginecc.dns.getZone

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

    Data Source schema for Volcengine::DNS::Zone

    Using getZone

    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 getZone(args: GetZoneArgs, opts?: InvokeOptions): Promise<GetZoneResult>
function getZoneOutput(args: GetZoneOutputArgs, opts?: InvokeOptions): Output<GetZoneResult>
    def get_zone(id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetZoneResult
def get_zone_output(id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetZoneResult]
    func LookupZone(ctx *Context, args *LookupZoneArgs, opts ...InvokeOption) (*LookupZoneResult, error)
func LookupZoneOutput(ctx *Context, args *LookupZoneOutputArgs, opts ...InvokeOption) LookupZoneResultOutput

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

    public static class GetZone 
{
    public static Task<GetZoneResult> InvokeAsync(GetZoneArgs args, InvokeOptions? opts = null)
    public static Output<GetZoneResult> Invoke(GetZoneInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetZoneResult> getZone(GetZoneArgs args, InvokeOptions options)
public static Output<GetZoneResult> getZone(GetZoneArgs args, InvokeOptions options)

    fn::invoke:
  function: volcenginecc:dns/getZone:getZone
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getZone Result

    The following output properties are available:

    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
    Uniquely identifies the 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.
    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.GetZoneTag>
    Tags for the domain. Default is empty.
    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.
    Id string
    Uniquely identifies the 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.
    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 []GetZoneTag
    Tags for the domain. Default is empty.
    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.
    id String
    Uniquely identifies the 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.
    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<GetZoneTag>
    Tags for the domain. Default is empty.
    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.
    id string
    Uniquely identifies the 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.
    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 GetZoneTag[]
    Tags for the domain. Default is empty.
    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.
    id str
    Uniquely identifies the 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.
    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[GetZoneTag]
    Tags for the domain. Default is empty.
    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.
    id String
    Uniquely identifies the 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.
    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>
    Tags for the domain. Default is empty.
    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

    GetZoneTag

    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.

    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.