跳转至

获取安全加速套餐列表

1. 接口描述

接口请求路径：POST /prod-api/cdn/packageRest/list

list 用于分页查询当前账号下的安全加速套餐列表，支持按套餐号、套餐名及套餐状态筛选。

Token 获取方式见 密钥鉴权。

2. 输入参数

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

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

3. 示例

示例1 分页查询安全加速套餐

输入示例

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

代码调用

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

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

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

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

        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/cdn/packageRest/list"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

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

    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": 1661408922,
      "isTest": 1,
      "domainCnt": 30,
      "topDomainCnt": 23,
      "maxDomainCou": 105,
      "maxTopDomainCou": 101,
      "distributionCnt": null,
      "oid": "20220812345687",
      "packageName": "测试WAF",
      "price": 0,
      "remark": "",
      "activate": 1,
      "mday": "2024-06-27",
      "lastday": 156,
      "alias": "223.122.19.20",
      "bandwidth": 0
    }
  ],
  "code": 200,
  "msg": "查询成功"
}

4. 输出参数

参数名称 类型 描述
code Integer 状态码。示例值：200
msg String 提示信息。示例值：查询成功
total Integer 套餐总条数。示例值：1
rows Array 当前页套餐列表
rows[].ctime Integer 创建时间（Unix 时间戳）。示例值：1661408922
rows[].isTest Integer 套餐类型。取值：0（测试套餐）、1（正式套餐）。示例值：1
rows[].domainCnt Integer 已使用域名数。示例值：30
rows[].topDomainCnt Integer 已使用顶级域名数。示例值：23
rows[].maxDomainCou Integer 域名配额。示例值：105
rows[].maxTopDomainCou Integer 顶级域名配额。示例值：101
rows[].distributionCnt Integer 分发数量，可能为 null
rows[].oid String 套餐号。示例值：20220812345687
rows[].packageName String 套餐名。示例值：测试WAF
rows[].price Number 价格。示例值：0
rows[].remark String 备注
rows[].activate Integer 套餐状态。取值：0（待支付）、-1（已退订）、1（使用中）、3（关闭）、4（配置中）。示例值：1
rows[].mday String 到期日期。示例值：2024-06-27
rows[].lastday Integer 距离到期天数。示例值：156
rows[].alias String 别名。示例值：223.122.19.20
rows[].bandwidth Number 带宽。示例值：0

5. 错误码

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