查询 WAF 套餐列表¶

1. 接口描述¶

接口请求路径：POST /prod-api/waf/wafv3/dealOrder/describeDealOrder

describeDealOrder 用于分页查询当前账号下的 Web 应用防火墙（WAF 3.0）套餐列表，支持按套餐号、套餐名及套餐状态筛选。接口内部仅返回 WAF 相关订单类型。

Token 获取方式见密钥鉴权。

2. 输入参数¶

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

参数名称	必选	类型	描述
pageNum	是	Integer	当前页数示例值：`1`
pageSize	是	Integer	每页显示条目个数示例值：`10`
filters	否	Array	搜索条件列表
filters.label	否	String	搜索字段，支持以下值： `oid`：套餐号/别名 `packageName`：套餐名示例值：`packageName`
filters.value	否	Array of String	搜索值。传入单个值为模糊搜索，多个值为精确搜索示例值：`["textzt"]`
searchHeader	否	Object	筛选条件
searchHeader.activate	否	Array of String	套餐状态，支持以下值： `0`：待支付 `-1`：已退订 `1`：使用中 `3`：关闭 `4`：配置中示例值：`["1"]`

3. 示例¶

示例1 分页查询 WAF 套餐¶

输入示例¶

{
  "pageNum": 1,
  "pageSize": 10,
  "filters": [
    {
      "label": "packageName",
      "value": ["textzt"]
    }
  ],
  "searchHeader": {
    "activate": ["1"]
  }
}

代码调用¶

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

JavaGo

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

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

        String requestBody = "{"
                + "\"pageNum\":1,"
                + "\"pageSize\":10,"
                + "\"filters\":[{\"label\":\"packageName\",\"value\":[\"textzt\"]}],"
                + "\"searchHeader\":{\"activate\":[\"1\"]}"
                + "}";

        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/waf/wafv3/dealOrder/describeDealOrder"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "pageNum": 1,
  "pageSize": 10,
  "filters": [
    {
      "label": "packageName",
      "value": ["textzt"]
    }
  ],
  "searchHeader": {
    "activate": ["1"]
  }
}`)

    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))
}

输出示例¶

{
  "total": 1,
  "rows": [
    {
      "ctime": 1712884616,
      "isTest": 1,
      "domainCnt": 10,
      "topDomainCnt": 7,
      "maxDomainCou": 33,
      "maxTopDomainCou": 33,
      "distributionCnt": null,
      "ownerUid": 279,
      "projectName": "zr",
      "oid": "20240412279097884616",
      "packageName": "textzt",
      "price": 0,
      "remark": "",
      "activate": 1,
      "mday": "2026-12-31",
      "lastday": 227,
      "alias": "c8f24509cb564acfbad2fbfa2eac4d",
      "bandwidth": 0.0
    }
  ],
  "code": 200,
  "msg": "成功"
}

4. 输出参数¶

参数名称	类型	描述
code	Integer	状态码。示例值：`200`
msg	String	提示信息。示例值：`成功`
total	Integer	套餐总条数。示例值：`1`
rows	Array	当前页套餐列表
rows[].ctime	Integer	开通时间（Unix 时间戳）。示例值：`1712884616`
rows[].isTest	Integer	套餐类型，支持以下值： `0`：测试 `1`：正常示例值：`1`
rows[].domainCnt	Integer	已使用域名数。示例值：`10`
rows[].topDomainCnt	Integer	已使用顶级域名数。示例值：`7`
rows[].maxDomainCou	Integer	域名配额。示例值：`33`
rows[].maxTopDomainCou	Integer	顶级域名配额。示例值：`33`
rows[].distributionCnt	Integer	分发数量，可能为 `null`
rows[].ownerUid	Long	所属用户 ID。示例值：`279`
rows[].projectName	String	项目名称。示例值：`zr`
rows[].oid	String	套餐号。示例值：`20240412279097884616`
rows[].packageName	String	套餐名。示例值：`textzt`
rows[].price	Number	价格。示例值：`0`
rows[].remark	String	备注
rows[].activate	Integer	套餐状态，支持以下值： `0`：待支付 `-1`：已退订 `1`：使用中 `3`：关闭 `4`：配置中示例值：`1`
rows[].mday	String	到期日期。示例值：`2026-12-31`
rows[].lastday	Integer	距离到期天数。示例值：`227`
rows[].alias	String	别名。示例值：`c8f24509cb564acfbad2fbfa2eac4d`
rows[].bandwidth	Number	带宽。示例值：`0.0`

5. 错误码¶

HTTP 状态码 / 业务提示	描述
200	成功
401	未鉴权或 Token 无效
403	无权限