查询DNS记录列表¶

1. 接口描述¶

接口请求路径：POST /prod-api/acdn/ccdn/dnsRecordsRest/describeDNSRecords

describeDNSRecords 用于分页查询指定主域名下的 DNS 记录。账号需具备 ccdn:domain:query 权限。

Token 获取方式见密钥鉴权。

注意：zoneId 必须为当前账号下的域名，取自查询域名列表返回的 rows[].zoneId。

2. 输入参数¶

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
zoneId	是	String	域名 Zone ID。示例值：`551290393816e70c5e9765ca020e30a4`
pageNum	是	Integer	当前页。示例值：`1`
pageSize	是	Integer	每页条数。示例值：`10`
searchValue	否	String	搜索关键字，按记录名、记录值等模糊匹配。示例值：`www`

3. 输出参数¶

data 为上游返回的分页结果，data.result 中每条记录由平台补充 cname 字段（记录名加解析后缀），用于配置 CNAME 接入；域名未生成解析后缀时 cname 为空字符串。

参数名称	类型	描述
code	Integer	状态码。示例值：`200`
msg	String	提示信息。示例值：`成功`
data	Object	上游分页结果
data.success	Boolean	上游调用是否成功。示例值：`true`
data.result	Array	当前页 DNS 记录列表
data.result[].id	String	DNS 记录 ID，更新、删除记录时使用。示例值：`023e105f4ecef8ad9ca31a8372d0c353`
data.result[].zone_id	String	域名 Zone ID
data.result[].zone_name	String	主域名。示例值：`example.com`
data.result[].name	String	主机名（完整记录名）。示例值：`www.example.com`
data.result[].type	String	记录类型。取值：`CNAME`、`A`。示例值：`CNAME`
data.result[].content	String	回源地址。示例值：`origin.example.com`
data.result[].proxied	Boolean	状态。是否启用 CDN 加速：`true` 启用、`false` 禁用。示例值：`true`
data.result[].ttl	Integer	TTL（秒），`1` 表示自动。示例值：`1`
data.result[].comment	String	注释
data.result[].created_on	String	创建时间（UTC）。示例值：`2025-09-03T14:34:46.000000Z`
data.result[].modified_on	String	更新时间（UTC）。示例值：`2025-09-03T14:34:46.000000Z`
data.result[].cname	String	CNAME 接入地址，记录名加解析后缀。示例值：`www.example.com.cdndns.com`
data.result_info	Object	分页信息
data.result_info.page	Integer	当前页。示例值：`1`
data.result_info.per_page	Integer	每页条数。示例值：`10`
data.result_info.count	Integer	当前页条数。示例值：`1`
data.result_info.total_count	Integer	记录总条数。示例值：`1`

4. 示例¶

示例1 分页查询 DNS 记录¶

输入示例¶

{
  "zoneId": "551290393816e70c5e9765ca020e30a4",
  "pageNum": 1,
  "pageSize": 10
}

代码调用¶

请将 {登录域名}、token 替换为实际值。

cURLJavaGo

curl -X POST 'https://{登录域名}/prod-api/acdn/ccdn/dnsRecordsRest/describeDNSRecords' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
  "zoneId": "551290393816e70c5e9765ca020e30a4",
  "pageNum": 1,
  "pageSize": 10
}'

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class DescribeDNSRecordsTest {

    public static void main(String[] args) throws Exception {
        String url = "https://{登录域名}/prod-api/acdn/ccdn/dnsRecordsRest/describeDNSRecords";
        String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";

        String requestBody = "{"
                + "\"zoneId\":\"551290393816e70c5e9765ca020e30a4\","
                + "\"pageNum\":1,"
                + "\"pageSize\":10"
                + "}";

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpPost httpPost = new HttpPost(url);
            httpPost.setHeader("Authorization", "Bearer " + token);
            httpPost.setEntity(new StringEntity(requestBody, ContentType.APPLICATION_JSON));

            try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
                int statusCode = response.getStatusLine().getStatusCode();
                String body = EntityUtils.toString(response.getEntity(), "UTF-8");
                System.out.println("Status Code: " + statusCode);
                System.out.println("Body: " + body);
            }
        }
    }
}

package main

import (
    "bytes"
    "fmt"
    "io"
    "net/http"
)

func main() {
    url := "https://{登录域名}/prod-api/acdn/ccdn/dnsRecordsRest/describeDNSRecords"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "zoneId": "551290393816e70c5e9765ca020e30a4",
  "pageNum": 1,
  "pageSize": 10
}`)

    req, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(requestBody))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer "+token)
    req.Header.Set("Content-Type", "application/json")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println("Status Code:", resp.StatusCode)
    fmt.Println("Body:", string(body))
}

输出示例¶

{
  "msg": "成功",
  "code": 200,
  "data": {
    "success": true,
    "errors": [],
    "messages": [],
    "result": [
      {
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "zone_id": "551290393816e70c5e9765ca020e30a4",
        "zone_name": "example.com",
        "name": "www.example.com",
        "type": "CNAME",
        "content": "origin.example.com",
        "proxied": true,
        "ttl": 1,
        "comment": "官网加速",
        "tags": [],
        "created_on": "2025-09-03T14:34:46.000000Z",
        "modified_on": "2025-09-03T14:34:46.000000Z",
        "cname": "www.example.com.cdndns.com"
      }
    ],
    "result_info": {
      "page": 1,
      "per_page": 10,
      "count": 1,
      "total_count": 1
    }
  }
}

5. 错误码¶

查询失败时，code 为 500，原因在 msg，没有 data。

HTTP 状态码 / 业务提示	描述
200	成功
401	未鉴权或 Token 无效
403	无权限，需具备 `ccdn:domain:query`
无效的zoneId	`zoneId` 不存在或不属于当前账号