查询域名信息¶
1. 接口描述¶
接口请求路径:GET /prod-api/acdn/ccdn/domainRest/describeZone/{zoneId}
describeZone 用于查询当前账号下指定主域名的信息,包含域名归属验证所需的 TXT 记录和 CNAME 解析后缀。账号需具备 ccdn:domain:query 权限。
Token 获取方式见 密钥鉴权。
注意:
zoneId必须为当前账号下的域名,取自 查询域名列表 返回的rows[].zoneId。
2. 输入参数¶
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| zoneId | 是 | String | 路径参数。域名 Zone ID。示例值:551290393816e70c5e9765ca020e30a4 |
3. 输出参数¶
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Integer | 状态码。示例值:200 |
| msg | String | 提示信息。示例值:成功 |
| data | CCDNDescribeZone | 域名信息 |
4. 示例¶
示例1 查询域名信息¶
输入示例¶
代码调用¶
请将 {登录域名}、token 替换为实际值。
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class DescribeZoneTest {
public static void main(String[] args) throws Exception {
String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";
String zoneId = "551290393816e70c5e9765ca020e30a4";
String url = "https://{登录域名}/prod-api/acdn/ccdn/domainRest/describeZone/" + zoneId;
try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
HttpGet httpGet = new HttpGet(url);
httpGet.setHeader("Authorization", "Bearer " + token);
try (CloseableHttpResponse response = httpClient.execute(httpGet)) {
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 (
"fmt"
"io"
"net/http"
)
func main() {
token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"
url := "https://{登录域名}/prod-api/acdn/ccdn/domainRest/describeZone/551290393816e70c5e9765ca020e30a4"
req, err := http.NewRequest(http.MethodGet, url, nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+token)
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": {
"zoneId": "551290393816e70c5e9765ca020e30a4",
"oid": "202505271234561329409",
"status": "process",
"txtName": "_cdn-verify.example.com",
"txtValue": "9f8b7a6c5d4e3f2a1b0c",
"dnsSuffix": "example.com.cdndns.com"
}
}
5. 错误码¶
查询失败时,code 为 500,原因在 msg,没有 data。
| HTTP 状态码 / 业务提示 | 描述 |
|---|---|
| 200 | 成功 |
| 401 | 未鉴权或 Token 无效 |
| 403 | 无权限,需具备 ccdn:domain:query |
| 无效的zoneId | zoneId 不存在或不属于当前账号 |
| 域名信息不存在 | 本地域名记录不存在 |
6. 数据模型¶
CCDNDescribeZone¶
域名信息。
| 参数名称 | 类型 | 描述 |
|---|---|---|
| zoneId | String | 域名 Zone ID。示例值:551290393816e70c5e9765ca020e30a4 |
| oid | String | 所属套餐号。示例值:202505271234561329409 |
| status | String | 域名状态。取值:process(审核中)、active(活跃)。示例值:process |
| txtName | String | 域名归属验证 TXT 记录名,由平台在审核时写入,未完成审核时可能为空 |
| txtValue | String | 域名归属验证 TXT 记录值,由平台在审核时写入,未完成审核时可能为空 |
| dnsSuffix | String | CNAME 解析后缀,添加域名配置后将域名 CNAME 至 二级域名.dnsSuffix 完成接入 |