查询目录高级配置

1. 接口描述

接口请求路径：GET /prod-api/cdn/layer7/advance/describeAdvanceRules

describeAdvanceRules 用于查询指定域名下的目录高级配置规则列表。

Token 获取方式见 密钥鉴权。

2. 输入参数

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

参数名称	必选	类型	描述
domainId	是	Integer	Query 参数。域名 ID 示例值：215

3. 示例

示例1 查询目录高级配置

输入示例

GET /prod-api/cdn/layer7/advance/describeAdvanceRules?domainId=215

代码调用

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

JavaGo

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class DescribeAdvanceRulesTest {

    public static void main(String[] args) throws Exception {
        String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";

        URIBuilder uriBuilder = new URIBuilder("https://{登录域名}/prod-api/cdn/layer7/advance/describeAdvanceRules");
        uriBuilder.addParameter("domainId", "215");

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpGet httpGet = new HttpGet(uriBuilder.build());
            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"
    "net/url"
)

func main() {
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    u, err := url.Parse("https://{登录域名}/prod-api/cdn/layer7/advance/describeAdvanceRules")
    if err != nil {
        panic(err)
    }
    q := u.Query()
    q.Set("domainId", "215")
    u.RawQuery = q.Encode()

    req, err := http.NewRequest(http.MethodGet, u.String(), 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": {
    "total": 2,
    "row": [
      {
        "locationId": 2676,
        "name": "*",
        "type": "1",
        "json": "{\"listClass\":1,\"whiteBlacklist\":[\"1.1.1.1\"],\"detectionRobot\":\"off\"}",
        "sort": 1
      },
      {
        "locationId": 2678,
        "name": "/",
        "type": "5",
        "json": "{\"listClass\":1,\"whiteBlacklist\":[],\"detectionRobot\":\"off\"}",
        "sort": 1
      }
    ]
  }
}

4. 输出参数

参数名称	类型	描述
code	Integer	状态码。示例值：200
msg	String	提示信息。示例值：成功
data	Object	高级配置数据
data.total	Integer	规则总数。示例值：2
data.row	[AdvanceRuleRow]	规则列表

5. json 字段说明

data.row[].json 为 JSON 字符串，解析后常见字段如下：

字段	类型	描述
listClass	Integer	名单类型。1：白名单；2：黑名单
detectionRobot	String	人机识别。on：启用；off：未启用
whiteBlacklist	Array of String	IP 名单列表

6. type 取值说明

取值	描述
1	全部
3	文件夹
4	全路径
5	首页

7. 错误码

HTTP 状态码 / 业务提示	描述
200	成功
401	未鉴权或 Token 无效
403	无权限
CDN10014	域名不存在
CDN10015	域名不属于你

8. 数据模型

AdvanceRuleRow

目录高级配置规则项。

参数名称	类型	描述
locationId	Integer	规则 ID。该条高级配置的唯一 ID；更新高级配置 编辑时写入请求体，新增时不写。示例值：2676
name	String	规则内容。示例值：*
type	String	规则类型。取值：1（全部）、3（文件夹）、4（全路径）、5（首页）。示例值：1
json	String	规则详情 JSON 字符串，字段含义见上方说明
sort	Integer	排序。示例值：1