知识库

使用 Terraform 提供商 (zinn-digital/zinn)

从 Terraform Registry 添加 zinn-digital/zinn 提供程序，创建 API 密钥，并将 DNS 记录作为代码进行管理（创建、更新、导入），同时将您的站点、域名、套餐和托管区域作为数据源进行读取。

zinn-digital/zinn 是我们的官方 Terraform 提供商，附带签名版本发布在 Terraform Registry 上。它负责管理您组织中域名上的 DNS 记录，并将您的站点、域名、方案和托管区域作为数据源进行读取。目前站点、邮箱和方案本身不受 Terraform 管理 — 请使用控制面板、API、SDK 或 Zinnector® CLI 进行管理。

安装

terraform {
  required_providers {
    zinn = {
      source = "zinn-digital/zinn"
    }
  }
}

# api_key falls back to ZINN_API_KEY.
provider "zinn" {}

运行 terraform init。Terraform 会从注册表下载提供程序并验证其签名。

创建 API 密钥

打开控制面板的 API 密钥 页面 (app.zinndigital.com/api-keys) 并点击 创建密钥。如需管理 DNS，请在权限下勾选 sites.view 和 domains.dns.manage。在运行 Terraform 之前将其导出：

export ZINN_API_KEY=zdk_live_…

zinn_regions 和 zinn_plans 数据源不需要密钥。

管理 DNS 记录

data "zinn_regions" "all" {}
data "zinn_domains" "all" {}

resource "zinn_dns_record" "www" {
  domain_id = one([for d in data.zinn_domains.all.domains : d.id if d.fqdn == "example.com"])
  name      = "www"
  type      = "CNAME"
  value     = "example.com."
  ttl       = 3600
}

output "regions" { value = [for r in data.zinn_regions.all.regions : r.slug] }

terraform apply 会创建该记录；更改 value 或 ttl 会就地更新该记录；移除该块则会将其删除。name 接受用于顶点的 @、相对名称（例如 www）或完整名称。

将现有记录纳入 Terraform 管理

terraform import zinn_dns_record.www <domain_id>/<record_id>

域名 ID 来自 data.zinn_domains；记录 ID 由 API 的 DNS 记录列表显示。

读取您的资产清单

data "zinn_sites" "all" {}
data "zinn_plans" "agency" { product_line = "agency" }

output "site_count" { value = length(data.zinn_sites.all.sites) }
output "agency_plans" { value = [for p in data.zinn_plans.agency.plans : p.code] }