跳转至

创建资源包

1. 接口描述

接口请求路径:POST /prod-api/multiCdn/open/agent/resource/createResource

createResource 用于给当前代理商名下的指定客户创建一个 CDN 2.0 资源包。每次固定创建 1 个。客户在该区域尚无加速方案时,服务端会先初始化加速方案与地区权限,再写入资源包并触发一次用量抵扣结算。

本接口不使用 密钥鉴权 的 Bearer Token。请在请求头携带平台分配的 agent-codeagent-api-key。请用客户的 emailphone 定位账号。获取方式见 自有平台接入一键登录

查询、删除见 查询资源包列表删除资源包

注意emailphone 至少填写一项。两项都填时必须指向同一客户。offerCode 决定资源包所属区域。

2. 输入参数

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

参数名称 必选 类型 描述
agent-code String Header 参数。代理商唯一码。开通时由平台分配,总后台代理商列表 AgentCode 列可查看。示例值:{agent-code}
agent-api-key String Header 参数。代理商 API 密钥。在总后台该代理商的 代理商账号 页签单击 查看 获取。示例值:{agent-api-key}
email String 客户邮箱。与 phone 至少填一项。示例值:user@example.com
phone String 客户手机号。与 email 至少填一项。示例值:13800138000
trafficBytes Long 流量额度,单位字节。示例值:100000000000
totalRequests Long 请求数额度。示例值:500000
effectiveMonth Integer 生效月数,从创建时刻起按月累加到期时间。示例值:6
packageName String 资源包名称。示例值:100GB
offerCode String 报价码,须为产品枚举名。控制台常用:MULTI_CDN_TRAFFIC_D(中国大陆)、MULTI_CDN_TRAFFIC_O(中国大陆以外)。非法值返回「产品类型不存在」。示例值:MULTI_CDN_TRAFFIC_D

3. 输出参数

参数名称 类型 描述
code Integer 状态码。示例值:200
msg String 提示信息。示例值:成功
data Object 创建结果。
data.packageIds Array of Long 新创建的资源包 ID 列表,本接口固定 1 个元素。示例值:[1001]

4. 示例

示例1 为中国大陆客户创建资源包

输入示例

{
  "email": "user@example.com",
  "trafficBytes": 100000000000,
  "totalRequests": 500000,
  "effectiveMonth": 6,
  "packageName": "100GB",
  "offerCode": "MULTI_CDN_TRAFFIC_D"
}

代码调用

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

curl -X POST 'https://{登录域名}/prod-api/multiCdn/open/agent/resource/createResource' \
  -H 'agent-code: {agent-code}' \
  -H 'agent-api-key: {agent-api-key}' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "user@example.com",
  "trafficBytes": 100000000000,
  "totalRequests": 500000,
  "effectiveMonth": 6,
  "packageName": "100GB",
  "offerCode": "MULTI_CDN_TRAFFIC_D"
}'
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 CreateResourceTest {

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

        String requestBody = "{"
                + "\"email\":\"user@example.com\","
                + "\"trafficBytes\":100000000000,"
                + "\"totalRequests\":500000,"
                + "\"effectiveMonth\":6,"
                + "\"packageName\":\"100GB\","
                + "\"offerCode\":\"MULTI_CDN_TRAFFIC_D\""
                + "}";

        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/multiCdn/open/agent/resource/createResource"

    requestBody := []byte(`{
  "email": "user@example.com",
  "trafficBytes": 100000000000,
  "totalRequests": 500000,
  "effectiveMonth": 6,
  "packageName": "100GB",
  "offerCode": "MULTI_CDN_TRAFFIC_D"
}`)

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

输出示例

{
  "code": 200,
  "msg": "成功",
  "data": {
    "packageIds": [1001]
  }
}

5. 错误码

HTTP 状态码 / 业务提示 描述
200 成功
401 未鉴权或 Token 无效
403 无权限
agent-code不能为空 未传请求头 agent-code
agent-api-key不能为空 未传请求头 agent-api-key
鉴权失败:无效的agent-code或agent-api-key 请求头中的代理商编号或 API 密钥不正确
客户邮箱和手机号不能同时为空 emailphone 都未填写
无效的邮箱或手机号 客户不属于当前代理商,或邮箱与手机号不是同一账号
流量字节数不能为空 未传 trafficBytes
请求数不能为空 未传 totalRequests
生效月份不能为空 未传 effectiveMonth
套餐名称不能为空 未传 packageName
报价码不能为空 未传 offerCode
产品类型不存在 offerCode 不是合法产品枚举名