查询套餐列表

1. 接口描述

接口请求路径：POST /prod-api/cdn/open/agent/dealOrder/describeDealOrders

describeDealOrders 用于分页查询当前代理商名下客户的套餐。结果按套餐主键倒序，仅包含请求头 agent-code 对应代理商下的客户套餐。

本接口不使用 密钥鉴权 的 Bearer Token。请在请求头携带平台分配的 agent-code、agent-api-key。服务端以请求头中的 agent-code 作为查询条件。获取方式见 自有平台接入一键登录。

创建、变更套餐见 创建套餐、修改套餐。

注意：默认查询条件固定为 activate IN (0, -1, 1, 2, 4)，状态为 3（关闭）的套餐不会返回。pageNum、pageSize 默认值分别为 1、10。同一套餐若关联多个节点池，联表后可能出现多行。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。本接口请使用 agent-code、agent-api-key，不要携带 Bearer Token。

参数名称	必选	类型	描述
agent-code	是	String	Header 参数。代理商唯一码。开通时由平台分配，总后台代理商列表 AgentCode 列可查看。示例值：{agent-code}
agent-api-key	是	String	Header 参数。代理商 API 密钥。在总后台该代理商的 代理商账号 页签单击 查看 获取。示例值：{agent-api-key}
pageNum	否	Integer	当前页数。默认值：1。示例值：1
pageSize	否	Integer	每页条数。默认值：10。示例值：10
filters	否	[SearchFilter]	关键字筛选。label 须为下方允许的字段名，否则返回「复杂查询条件不存在」。
searchHeader.activate	否	String	套餐状态，单值精确匹配（不要传数组）。取值：0（待支付）、-1（已退订）、1（使用中）、2、4（配置中）。传入 3（关闭）时仍不会命中记录。示例值：1
searchHeader.orderType	否	Integer	套餐类型，单值精确匹配。取值见 rows[].orderType。示例值：2
params.beginTime	否	String	到期日期下限，须与 params.endTime 同时传入才生效。比较条件为 mday 大于该值（不含边界）。建议格式 yyyy-MM-dd。示例值：2025-01-01
params.endTime	否	String	到期日期上限，须与 params.beginTime 同时传入才生效。比较条件为 mday 小于该值（不含边界）。建议格式 yyyy-MM-dd。示例值：2025-12-31

3. 输出参数

参数名称	类型	描述
code	Integer	状态码。示例值：200
msg	String	提示信息。示例值：成功
total	Integer	符合条件的总条数。示例值：46
rows	Array of Object	当前页套餐列表。
rows[].oid	String	套餐号。示例值：204567993244
rows[].prefix	String	节点池标识（节点池 key_ui）。无关联节点池时可能为 null。示例值：fdbf8507561404fc9ac0
rows[].customerId	Long	所属客户用户 ID。示例值：279
rows[].packageName	String	套餐名称。示例值：demo-waf
rows[].activate	Integer	套餐状态。取值：0（待支付）、-1（已退订）、1（使用中）、2、4（配置中）。本接口不返回 3（关闭）。示例值：1
rows[].mday	String	到期日期，格式 yyyy-MM-dd。示例值：2025-12-02
rows[].alias	String	套餐别名。无别名时为空字符串。示例值：``
rows[].orderType	Integer	套餐类型。取值：1（高防）、2（云WAF）、3（DDOS防御）、4（TCP/UDP防御）、5（安全加速）、6（SSL证书）、1000（海外ACDN）、1110（国内DCDN）、1120（海外高防IP）、1130（海外CCDN v2.0）、1140（国内VCDN）、1150（TCDN）、1160（国内高防IP）、1170（融合CDN流量）、1171（融合CDN请求数）。示例值：2
rows[].orderTypeName	String	套餐类型名称，由 orderType 映射。无法识别时为 null。示例值：云WAF
rows[].customerName	String	所属客户名称。套餐 owner_uid 为 0 时固定为 系统后台添加。示例值：demoUser

4. 示例

示例1 分页查询套餐

输入示例

{
  "pageNum": 1,
  "pageSize": 10
}

代码调用

请将 {登录域名}、{agent-code}、{agent-api-key} 替换为实际值。

cURLJavaGo

curl -X POST 'https://{登录域名}/prod-api/cdn/open/agent/dealOrder/describeDealOrders' \
  -H 'agent-code: {agent-code}' \
  -H 'agent-api-key: {agent-api-key}' \
  -H 'Content-Type: application/json' \
  -d '{
  "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 DescribeDealOrdersTest {

    public static void main(String[] args) throws Exception {
        String url = "https://{登录域名}/prod-api/cdn/open/agent/dealOrder/describeDealOrders";

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

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpPost httpPost = new HttpPost(url);
            httpPost.setHeader("agent-code", "{agent-code}");
            httpPost.setHeader("agent-api-key", "{agent-api-key}");
            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/cdn/open/agent/dealOrder/describeDealOrders"

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

    req, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(requestBody))
    if err != nil {
        panic(err)
    }
    req.Header.Set("agent-code", "{agent-code}")
    req.Header.Set("agent-api-key", "{agent-api-key}")
    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))
}

输出示例

{
  "total": 46,
  "rows": [
    {
      "oid": "204567993244",
      "prefix": "fdbf8507561404fc9ac0",
      "customerId": 279,
      "packageName": "demo-waf",
      "activate": 1,
      "mday": "2025-12-02",
      "alias": "",
      "orderType": 2,
      "orderTypeName": "云WAF",
      "customerName": "demoUser"
    },
    {
      "oid": "202123959126",
      "prefix": null,
      "customerId": 279,
      "packageName": "demo-tcdn",
      "activate": 0,
      "mday": "2025-12-02",
      "alias": "",
      "orderType": 1150,
      "orderTypeName": "TCDN",
      "customerName": "demoUser"
    }
  ],
  "code": 200,
  "msg": "成功"
}

示例2 按套餐名、状态与到期日筛选

输入示例

{
  "pageNum": 1,
  "pageSize": 10,
  "filters": [
    {
      "label": "packageName",
      "value": ["demo"]
    }
  ],
  "searchHeader": {
    "activate": "1",
    "orderType": 2
  },
  "params": {
    "beginTime": "2025-01-01",
    "endTime": "2025-12-31"
  }
}

代码调用

请将 {登录域名}、{agent-code}、{agent-api-key} 替换为实际值。

cURLJavaGo

curl -X POST 'https://{登录域名}/prod-api/cdn/open/agent/dealOrder/describeDealOrders' \
  -H 'agent-code: {agent-code}' \
  -H 'agent-api-key: {agent-api-key}' \
  -H 'Content-Type: application/json' \
  -d '{
  "pageNum": 1,
  "pageSize": 10,
  "filters": [
    {
      "label": "packageName",
      "value": ["demo"]
    }
  ],
  "searchHeader": {
    "activate": "1",
    "orderType": 2
  },
  "params": {
    "beginTime": "2025-01-01",
    "endTime": "2025-12-31"
  }
}'

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 DescribeDealOrdersFilterTest {

    public static void main(String[] args) throws Exception {
        String url = "https://{登录域名}/prod-api/cdn/open/agent/dealOrder/describeDealOrders";

        String requestBody = "{"
                + "\"pageNum\":1,"
                + "\"pageSize\":10,"
                + "\"filters\":[{\"label\":\"packageName\",\"value\":[\"demo\"]}],"
                + "\"searchHeader\":{\"activate\":\"1\",\"orderType\":2},"
                + "\"params\":{\"beginTime\":\"2025-01-01\",\"endTime\":\"2025-12-31\"}"
                + "}";

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpPost httpPost = new HttpPost(url);
            httpPost.setHeader("agent-code", "{agent-code}");
            httpPost.setHeader("agent-api-key", "{agent-api-key}");
            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/cdn/open/agent/dealOrder/describeDealOrders"

    requestBody := []byte(`{
  "pageNum": 1,
  "pageSize": 10,
  "filters": [
    {
      "label": "packageName",
      "value": ["demo"]
    }
  ],
  "searchHeader": {
    "activate": "1",
    "orderType": 2
  },
  "params": {
    "beginTime": "2025-01-01",
    "endTime": "2025-12-31"
  }
}`)

    req, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(requestBody))
    if err != nil {
        panic(err)
    }
    req.Header.Set("agent-code", "{agent-code}")
    req.Header.Set("agent-api-key", "{agent-api-key}")
    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))
}

输出示例

{
  "total": 1,
  "rows": [
    {
      "oid": "204567993244",
      "prefix": "fdbf8507561404fc9ac0",
      "customerId": 279,
      "packageName": "demo-waf",
      "activate": 1,
      "mday": "2025-12-02",
      "alias": "",
      "orderType": 2,
      "orderTypeName": "云WAF",
      "customerName": "demoUser"
    }
  ],
  "code": 200,
  "msg": "成功"
}

5. 错误码

HTTP 状态码 / 业务提示	描述
200	成功
401	未鉴权或 Token 无效
403	无权限
agent-code不能为空	未传请求头 agent-code
agent-api-key不能为空	未传请求头 agent-api-key
鉴权失败：无效的agent-code或agent-api-key	请求头中的代理商编号或 API 密钥不正确
复杂查询条件不存在：[xxx]	filters.label 不在允许字段内，xxx 为传入的字段名

6. 数据模型

SearchFilter

关键字筛选条件。value 仅 1 个元素时按模糊匹配（LIKE），多个元素时按精确匹配（IN）。

参数名称	必选	类型	描述
label	是	String	筛选字段。取值：oid（套餐号）、packageName（套餐名）、customerName（客户名称）、projectName（节点池/区域名称）。示例值：packageName
value	是	Array of String	筛选值。单值模糊匹配，多值精确匹配。示例值：["demo"]