1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. dns
  5. getZone
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.dns.getZone

bytepluscc logo
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::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: bytepluscc: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>
    云解析 DNS 分配给域名的 DNS 服务器列表。
    AutoRenew bool
    是否开启域名自动续费。true：开启域名自动续费。false：关闭域名自动续费。
    CacheStage int
    域名所有权的状态。该参数有以下取值：0：表示您是域名的所有者。您添加此域名后，就可以管理该域名的 DNS 解析。1：表示您不是域名的所有者。您添加此域名后，该域名的状态是 域名待找回。如果您要管理该域名的 DNS 解析，您需要在控制台根据提示验证您的域名所有权。
    CreatedTime string
    域名的创建时间。
    DnsSecurity string
    DNS DDoS 防护服务的版本。dnssecuritystandard_inner：安全防护标准版。""：无安全防护版。
    ExpiredTime int
    实例的过期时间。格式是 Unix 时间戳。对于云解析 DNS 免费版，该字段的值为 null。
    Id string
    Uniquely identifies the resource.
    InstanceId string
    实例的 ID。对于云解析 DNS 免费版，该字段的值为 null。
    InstanceNo string
    实例的 ID。对于云解析 DNS 免费版，该字段的值为 null。
    IsNsCorrect bool
    DNS 服务器的配置是否正确。如果配置正确，该域名在云解析 DNS 中的状态是 正常。该参数有以下取值：true： RealDNSServerList的 DNS 服务器列表包含所有 AllocateDNSServerList中的 DNS 服务器。此时，DNS 服务器的配置是正确的。false： RealDNSServerList的 DNS 服务器列表包含部分或者未包含 AllocateDNSServerList中的 DNS 服务器。此时，DNS 服务器的配置是不正确的。
    IsSubDomain bool
    是否是子域名。true：子域名。false：主域名。
    LastOperator string
    创建该域名的用户的账号的 ID。
    ProjectName string
    域名的项目。
    RealDnsServerLists List<string>
    域名实际使用的 DNS 服务器列表。
    RecordCount int
    域名所包含的解析记录的总数。
    Remark string
    域名的备注。
    Stage int
    域名的状态。该参数有以下取值：0：正常。在该状态下，该域名的解析记录处于生效状态。1：域名待找回。在该状态下，该域名的解析记录不生效。该状态表示您不是该域名的所有者。如果您需要管理域名解析，您需要验证您的域名所有权。2：未使用TrafficRoute解析。在该状态下，该域名的解析记录不生效。该状态表示分配给该域名的 DNS 服务器不是云解析 DNS 的 DNS 服务器。3：异常。在该状态下，该域名的解析记录不生效。引起该状态的常见原因如下：域名未实名认证导致域名被注册局或注册商停用。域名未配置 DNS 服务器。域名未注册。API 在查询域名时超时。超时原因可能是网络问题。5：请变更DNS服务器。该状态表示由于云解析 DNS 的服务升级或变更，您需要把域名的 DNS 服务器更新为云解析 DNS 新分配的 DNS 服务器。
    SubDomainHost string
    子域名的域名前缀。如果该域名不是子域名，那么该参数为 null。
    Tags List<Byteplus.GetZoneTag>
    该域名的标签。默认为空。
    TradeCode string
    域名的功能版本。该参数有以下取值：freeinner：免费版。professionalinner：专业版。enterpriseinner：企业版。ultimateinner：旗舰版。ultimateexclusiveinner：尊享版。
    UpdatedTime string
    域名最近一次的更新时间。更新操作包括：更新域名备注在域名下创建解析记录。
    Zid string
    域名的 ID。
    ZoneName string
    域名。
    AllocateDnsServerLists []string
    云解析 DNS 分配给域名的 DNS 服务器列表。
    AutoRenew bool
    是否开启域名自动续费。true：开启域名自动续费。false：关闭域名自动续费。
    CacheStage int
    域名所有权的状态。该参数有以下取值：0：表示您是域名的所有者。您添加此域名后，就可以管理该域名的 DNS 解析。1：表示您不是域名的所有者。您添加此域名后，该域名的状态是 域名待找回。如果您要管理该域名的 DNS 解析，您需要在控制台根据提示验证您的域名所有权。
    CreatedTime string
    域名的创建时间。
    DnsSecurity string
    DNS DDoS 防护服务的版本。dnssecuritystandard_inner：安全防护标准版。""：无安全防护版。
    ExpiredTime int
    实例的过期时间。格式是 Unix 时间戳。对于云解析 DNS 免费版，该字段的值为 null。
    Id string
    Uniquely identifies the resource.
    InstanceId string
    实例的 ID。对于云解析 DNS 免费版，该字段的值为 null。
    InstanceNo string
    实例的 ID。对于云解析 DNS 免费版，该字段的值为 null。
    IsNsCorrect bool
    DNS 服务器的配置是否正确。如果配置正确，该域名在云解析 DNS 中的状态是 正常。该参数有以下取值：true： RealDNSServerList的 DNS 服务器列表包含所有 AllocateDNSServerList中的 DNS 服务器。此时，DNS 服务器的配置是正确的。false： RealDNSServerList的 DNS 服务器列表包含部分或者未包含 AllocateDNSServerList中的 DNS 服务器。此时，DNS 服务器的配置是不正确的。
    IsSubDomain bool
    是否是子域名。true：子域名。false：主域名。
    LastOperator string
    创建该域名的用户的账号的 ID。
    ProjectName string
    域名的项目。
    RealDnsServerLists []string
    域名实际使用的 DNS 服务器列表。
    RecordCount int
    域名所包含的解析记录的总数。
    Remark string
    域名的备注。
    Stage int
    域名的状态。该参数有以下取值：0：正常。在该状态下，该域名的解析记录处于生效状态。1：域名待找回。在该状态下，该域名的解析记录不生效。该状态表示您不是该域名的所有者。如果您需要管理域名解析，您需要验证您的域名所有权。2：未使用TrafficRoute解析。在该状态下，该域名的解析记录不生效。该状态表示分配给该域名的 DNS 服务器不是云解析 DNS 的 DNS 服务器。3：异常。在该状态下，该域名的解析记录不生效。引起该状态的常见原因如下：域名未实名认证导致域名被注册局或注册商停用。域名未配置 DNS 服务器。域名未注册。API 在查询域名时超时。超时原因可能是网络问题。5：请变更DNS服务器。该状态表示由于云解析 DNS 的服务升级或变更，您需要把域名的 DNS 服务器更新为云解析 DNS 新分配的 DNS 服务器。
    SubDomainHost string
    子域名的域名前缀。如果该域名不是子域名，那么该参数为 null。
    Tags []GetZoneTag
    该域名的标签。默认为空。
    TradeCode string
    域名的功能版本。该参数有以下取值：freeinner：免费版。professionalinner：专业版。enterpriseinner：企业版。ultimateinner：旗舰版。ultimateexclusiveinner：尊享版。
    UpdatedTime string
    域名最近一次的更新时间。更新操作包括：更新域名备注在域名下创建解析记录。
    Zid string
    域名的 ID。
    ZoneName string
    域名。
    allocateDnsServerLists List<String>
    云解析 DNS 分配给域名的 DNS 服务器列表。
    autoRenew Boolean
    是否开启域名自动续费。true：开启域名自动续费。false：关闭域名自动续费。
    cacheStage Integer
    域名所有权的状态。该参数有以下取值：0：表示您是域名的所有者。您添加此域名后，就可以管理该域名的 DNS 解析。1：表示您不是域名的所有者。您添加此域名后，该域名的状态是 域名待找回。如果您要管理该域名的 DNS 解析，您需要在控制台根据提示验证您的域名所有权。
    createdTime String
    域名的创建时间。
    dnsSecurity String
    DNS DDoS 防护服务的版本。dnssecuritystandard_inner：安全防护标准版。""：无安全防护版。
    expiredTime Integer
    实例的过期时间。格式是 Unix 时间戳。对于云解析 DNS 免费版，该字段的值为 null。
    id String
    Uniquely identifies the resource.
    instanceId String
    实例的 ID。对于云解析 DNS 免费版，该字段的值为 null。
    instanceNo String
    实例的 ID。对于云解析 DNS 免费版，该字段的值为 null。
    isNsCorrect Boolean
    DNS 服务器的配置是否正确。如果配置正确，该域名在云解析 DNS 中的状态是 正常。该参数有以下取值：true： RealDNSServerList的 DNS 服务器列表包含所有 AllocateDNSServerList中的 DNS 服务器。此时，DNS 服务器的配置是正确的。false： RealDNSServerList的 DNS 服务器列表包含部分或者未包含 AllocateDNSServerList中的 DNS 服务器。此时，DNS 服务器的配置是不正确的。
    isSubDomain Boolean
    是否是子域名。true：子域名。false：主域名。
    lastOperator String
    创建该域名的用户的账号的 ID。
    projectName String
    域名的项目。
    realDnsServerLists List<String>
    域名实际使用的 DNS 服务器列表。
    recordCount Integer
    域名所包含的解析记录的总数。
    remark String
    域名的备注。
    stage Integer
    域名的状态。该参数有以下取值：0：正常。在该状态下，该域名的解析记录处于生效状态。1：域名待找回。在该状态下，该域名的解析记录不生效。该状态表示您不是该域名的所有者。如果您需要管理域名解析，您需要验证您的域名所有权。2：未使用TrafficRoute解析。在该状态下，该域名的解析记录不生效。该状态表示分配给该域名的 DNS 服务器不是云解析 DNS 的 DNS 服务器。3：异常。在该状态下，该域名的解析记录不生效。引起该状态的常见原因如下：域名未实名认证导致域名被注册局或注册商停用。域名未配置 DNS 服务器。域名未注册。API 在查询域名时超时。超时原因可能是网络问题。5：请变更DNS服务器。该状态表示由于云解析 DNS 的服务升级或变更，您需要把域名的 DNS 服务器更新为云解析 DNS 新分配的 DNS 服务器。
    subDomainHost String
    子域名的域名前缀。如果该域名不是子域名，那么该参数为 null。
    tags List<GetZoneTag>
    该域名的标签。默认为空。
    tradeCode String
    域名的功能版本。该参数有以下取值：freeinner：免费版。professionalinner：专业版。enterpriseinner：企业版。ultimateinner：旗舰版。ultimateexclusiveinner：尊享版。
    updatedTime String
    域名最近一次的更新时间。更新操作包括：更新域名备注在域名下创建解析记录。
    zid String
    域名的 ID。
    zoneName String
    域名。
    allocateDnsServerLists string[]
    云解析 DNS 分配给域名的 DNS 服务器列表。
    autoRenew boolean
    是否开启域名自动续费。true：开启域名自动续费。false：关闭域名自动续费。
    cacheStage number
    域名所有权的状态。该参数有以下取值：0：表示您是域名的所有者。您添加此域名后，就可以管理该域名的 DNS 解析。1：表示您不是域名的所有者。您添加此域名后，该域名的状态是 域名待找回。如果您要管理该域名的 DNS 解析，您需要在控制台根据提示验证您的域名所有权。
    createdTime string
    域名的创建时间。
    dnsSecurity string
    DNS DDoS 防护服务的版本。dnssecuritystandard_inner：安全防护标准版。""：无安全防护版。
    expiredTime number
    实例的过期时间。格式是 Unix 时间戳。对于云解析 DNS 免费版，该字段的值为 null。
    id string
    Uniquely identifies the resource.
    instanceId string
    实例的 ID。对于云解析 DNS 免费版，该字段的值为 null。
    instanceNo string
    实例的 ID。对于云解析 DNS 免费版，该字段的值为 null。
    isNsCorrect boolean
    DNS 服务器的配置是否正确。如果配置正确，该域名在云解析 DNS 中的状态是 正常。该参数有以下取值：true： RealDNSServerList的 DNS 服务器列表包含所有 AllocateDNSServerList中的 DNS 服务器。此时，DNS 服务器的配置是正确的。false： RealDNSServerList的 DNS 服务器列表包含部分或者未包含 AllocateDNSServerList中的 DNS 服务器。此时，DNS 服务器的配置是不正确的。
    isSubDomain boolean
    是否是子域名。true：子域名。false：主域名。
    lastOperator string
    创建该域名的用户的账号的 ID。
    projectName string
    域名的项目。
    realDnsServerLists string[]
    域名实际使用的 DNS 服务器列表。
    recordCount number
    域名所包含的解析记录的总数。
    remark string
    域名的备注。
    stage number
    域名的状态。该参数有以下取值：0：正常。在该状态下，该域名的解析记录处于生效状态。1：域名待找回。在该状态下，该域名的解析记录不生效。该状态表示您不是该域名的所有者。如果您需要管理域名解析，您需要验证您的域名所有权。2：未使用TrafficRoute解析。在该状态下，该域名的解析记录不生效。该状态表示分配给该域名的 DNS 服务器不是云解析 DNS 的 DNS 服务器。3：异常。在该状态下，该域名的解析记录不生效。引起该状态的常见原因如下：域名未实名认证导致域名被注册局或注册商停用。域名未配置 DNS 服务器。域名未注册。API 在查询域名时超时。超时原因可能是网络问题。5：请变更DNS服务器。该状态表示由于云解析 DNS 的服务升级或变更，您需要把域名的 DNS 服务器更新为云解析 DNS 新分配的 DNS 服务器。
    subDomainHost string
    子域名的域名前缀。如果该域名不是子域名，那么该参数为 null。
    tags GetZoneTag[]
    该域名的标签。默认为空。
    tradeCode string
    域名的功能版本。该参数有以下取值：freeinner：免费版。professionalinner：专业版。enterpriseinner：企业版。ultimateinner：旗舰版。ultimateexclusiveinner：尊享版。
    updatedTime string
    域名最近一次的更新时间。更新操作包括：更新域名备注在域名下创建解析记录。
    zid string
    域名的 ID。
    zoneName string
    域名。
    allocate_dns_server_lists Sequence[str]
    云解析 DNS 分配给域名的 DNS 服务器列表。
    auto_renew bool
    是否开启域名自动续费。true：开启域名自动续费。false：关闭域名自动续费。
    cache_stage int
    域名所有权的状态。该参数有以下取值：0：表示您是域名的所有者。您添加此域名后，就可以管理该域名的 DNS 解析。1：表示您不是域名的所有者。您添加此域名后，该域名的状态是 域名待找回。如果您要管理该域名的 DNS 解析，您需要在控制台根据提示验证您的域名所有权。
    created_time str
    域名的创建时间。
    dns_security str
    DNS DDoS 防护服务的版本。dnssecuritystandard_inner：安全防护标准版。""：无安全防护版。
    expired_time int
    实例的过期时间。格式是 Unix 时间戳。对于云解析 DNS 免费版，该字段的值为 null。
    id str
    Uniquely identifies the resource.
    instance_id str
    实例的 ID。对于云解析 DNS 免费版，该字段的值为 null。
    instance_no str
    实例的 ID。对于云解析 DNS 免费版，该字段的值为 null。
    is_ns_correct bool
    DNS 服务器的配置是否正确。如果配置正确，该域名在云解析 DNS 中的状态是 正常。该参数有以下取值：true： RealDNSServerList的 DNS 服务器列表包含所有 AllocateDNSServerList中的 DNS 服务器。此时，DNS 服务器的配置是正确的。false： RealDNSServerList的 DNS 服务器列表包含部分或者未包含 AllocateDNSServerList中的 DNS 服务器。此时，DNS 服务器的配置是不正确的。
    is_sub_domain bool
    是否是子域名。true：子域名。false：主域名。
    last_operator str
    创建该域名的用户的账号的 ID。
    project_name str
    域名的项目。
    real_dns_server_lists Sequence[str]
    域名实际使用的 DNS 服务器列表。
    record_count int
    域名所包含的解析记录的总数。
    remark str
    域名的备注。
    stage int
    域名的状态。该参数有以下取值：0：正常。在该状态下，该域名的解析记录处于生效状态。1：域名待找回。在该状态下，该域名的解析记录不生效。该状态表示您不是该域名的所有者。如果您需要管理域名解析，您需要验证您的域名所有权。2：未使用TrafficRoute解析。在该状态下，该域名的解析记录不生效。该状态表示分配给该域名的 DNS 服务器不是云解析 DNS 的 DNS 服务器。3：异常。在该状态下，该域名的解析记录不生效。引起该状态的常见原因如下：域名未实名认证导致域名被注册局或注册商停用。域名未配置 DNS 服务器。域名未注册。API 在查询域名时超时。超时原因可能是网络问题。5：请变更DNS服务器。该状态表示由于云解析 DNS 的服务升级或变更，您需要把域名的 DNS 服务器更新为云解析 DNS 新分配的 DNS 服务器。
    sub_domain_host str
    子域名的域名前缀。如果该域名不是子域名，那么该参数为 null。
    tags Sequence[GetZoneTag]
    该域名的标签。默认为空。
    trade_code str
    域名的功能版本。该参数有以下取值：freeinner：免费版。professionalinner：专业版。enterpriseinner：企业版。ultimateinner：旗舰版。ultimateexclusiveinner：尊享版。
    updated_time str
    域名最近一次的更新时间。更新操作包括：更新域名备注在域名下创建解析记录。
    zid str
    域名的 ID。
    zone_name str
    域名。
    allocateDnsServerLists List<String>
    云解析 DNS 分配给域名的 DNS 服务器列表。
    autoRenew Boolean
    是否开启域名自动续费。true：开启域名自动续费。false：关闭域名自动续费。
    cacheStage Number
    域名所有权的状态。该参数有以下取值：0：表示您是域名的所有者。您添加此域名后，就可以管理该域名的 DNS 解析。1：表示您不是域名的所有者。您添加此域名后，该域名的状态是 域名待找回。如果您要管理该域名的 DNS 解析，您需要在控制台根据提示验证您的域名所有权。
    createdTime String
    域名的创建时间。
    dnsSecurity String
    DNS DDoS 防护服务的版本。dnssecuritystandard_inner：安全防护标准版。""：无安全防护版。
    expiredTime Number
    实例的过期时间。格式是 Unix 时间戳。对于云解析 DNS 免费版，该字段的值为 null。
    id String
    Uniquely identifies the resource.
    instanceId String
    实例的 ID。对于云解析 DNS 免费版，该字段的值为 null。
    instanceNo String
    实例的 ID。对于云解析 DNS 免费版，该字段的值为 null。
    isNsCorrect Boolean
    DNS 服务器的配置是否正确。如果配置正确，该域名在云解析 DNS 中的状态是 正常。该参数有以下取值：true： RealDNSServerList的 DNS 服务器列表包含所有 AllocateDNSServerList中的 DNS 服务器。此时，DNS 服务器的配置是正确的。false： RealDNSServerList的 DNS 服务器列表包含部分或者未包含 AllocateDNSServerList中的 DNS 服务器。此时，DNS 服务器的配置是不正确的。
    isSubDomain Boolean
    是否是子域名。true：子域名。false：主域名。
    lastOperator String
    创建该域名的用户的账号的 ID。
    projectName String
    域名的项目。
    realDnsServerLists List<String>
    域名实际使用的 DNS 服务器列表。
    recordCount Number
    域名所包含的解析记录的总数。
    remark String
    域名的备注。
    stage Number
    域名的状态。该参数有以下取值：0：正常。在该状态下，该域名的解析记录处于生效状态。1：域名待找回。在该状态下，该域名的解析记录不生效。该状态表示您不是该域名的所有者。如果您需要管理域名解析，您需要验证您的域名所有权。2：未使用TrafficRoute解析。在该状态下，该域名的解析记录不生效。该状态表示分配给该域名的 DNS 服务器不是云解析 DNS 的 DNS 服务器。3：异常。在该状态下，该域名的解析记录不生效。引起该状态的常见原因如下：域名未实名认证导致域名被注册局或注册商停用。域名未配置 DNS 服务器。域名未注册。API 在查询域名时超时。超时原因可能是网络问题。5：请变更DNS服务器。该状态表示由于云解析 DNS 的服务升级或变更，您需要把域名的 DNS 服务器更新为云解析 DNS 新分配的 DNS 服务器。
    subDomainHost String
    子域名的域名前缀。如果该域名不是子域名，那么该参数为 null。
    tags List<Property Map>
    该域名的标签。默认为空。
    tradeCode String
    域名的功能版本。该参数有以下取值：freeinner：免费版。professionalinner：专业版。enterpriseinner：企业版。ultimateinner：旗舰版。ultimateexclusiveinner：尊享版。
    updatedTime String
    域名最近一次的更新时间。更新操作包括：更新域名备注在域名下创建解析记录。
    zid String
    域名的 ID。
    zoneName String
    域名。

    Supporting Types

    GetZoneTag

    Key string
    标签的键。
    Value string
    标签的值。
    Key string
    标签的键。
    Value string
    标签的值。
    key String
    标签的键。
    value String
    标签的值。
    key string
    标签的键。
    value string
    标签的值。
    key str
    标签的键。
    value str
    标签的值。
    key String
    标签的键。
    value String
    标签的值。

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.16
    published on Monday, Mar 9, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.