跳转至

获取套餐详情

1. 接口描述

接口请求路径：GET /prod-api/cdn/layer4/rules/getPackageDetails/{oid}

getPackageDetails 用于查询指定 TCP/UDP（四层）套餐的详情，包括套餐基本信息、实例节点、端口用量及可切换套餐列表等。

Token 获取方式见 密钥鉴权。

2. 输入参数

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

参数名称 必选 类型 描述
oid 是 String Path 参数。套餐号
示例值：123456789

3. 示例

示例1 获取套餐详情

输入示例

GET /prod-api/cdn/layer4/rules/getPackageDetails/123456789

代码调用

请将 {登录域名}、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 GetPackageDetailsTest {

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

        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() {
    url := "https://{登录域名}/prod-api/cdn/layer4/rules/getPackageDetails/123456789"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    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": {
    "oid": "123456789",
    "isTest": 0,
    "alias": "",
    "name": "测试TCP套餐",
    "cname": "",
    "fdesc": "",
    "nodes": [["123456789_0000-tcp.demo.om", "line_0"]],
    "ctime": 1682319372,
    "utime": 1682319372,
    "packages": [
      {
        "name": "四层DDos防御套餐",
        "alias": "123",
        "oid": "123456789"
      }
    ],
    "activate": 1,
    "mday": "2024-04-26",
    "consumptionPort": 2003,
    "totalPort": 65535,
    "isParsing": "off"
  }
}

4. 输出参数

参数名称 类型 描述
code Integer 状态码。示例值：200
msg String 提示信息。示例值：操作成功
data Object 套餐详情
data.oid String 当前套餐号。示例值：123456789
data.isTest Integer 套餐类型，支持以下值：
0：测试
1：正式
示例值：0
data.alias String 别名
data.name String 套餐名。示例值：测试TCP套餐
data.cname String CNAME
data.fdesc String 套餐描述
data.nodes Array 实例列表。每项为 [域名, 实例标识]，如 ["xxx.demo.om", "line_0"]
data.ctime Integer 开通时间（Unix 时间戳）。示例值：1682319372
data.utime Integer 更新时间（Unix 时间戳）。示例值：1682319372
data.packages Array 可切换的套餐列表
data.packages[].name String 套餐名称。示例值：四层DDos防御套餐
data.packages[].alias String 套餐别名。示例值：123
data.packages[].oid String 套餐号。示例值：123456789
data.activate Integer 套餐状态，支持以下值：
0：待支付
-1：已退订
1：使用中
3：关闭
4：配置中
示例值：1
data.mday String 到期日期。示例值：2024-04-26
data.consumptionPort Integer 已用端口数量。示例值：2003
data.totalPort Integer 端口总数。示例值：65535
data.isParsing String 是否开启解析，支持以下值：
off：否
on：是
示例值：off

5. 错误码

HTTP 状态码 / 业务提示 描述
200 成功
401 未鉴权或 Token 无效
403 无权限
请填写套餐 未传入套餐号 oid