生成加速包直播质量报告¶

1. 接口描述¶

接口请求路径：POST /prod-api/acdn/volc/hostAcceleratePackRest/getVQUserDataAPI

getVQUserDataAPI 用于按指定日期范围与用户信息生成加速包直播质量报告。单次查询日期间隔最多 5 天（不含等于 5 天以上的跨度）。

注意事项：单用户请求频率限制为 120 次/分钟。

Token 获取方式见密钥鉴权。

2. 输入参数¶

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

参数名称	必选	类型	描述
beginTime	是	String	开始日期，格式 `yyyy-MM-dd` 示例值：`2024-01-14`
endTime	是	String	结束日期，格式 `yyyy-MM-dd` 示例值：`2024-01-16`
users	是	[QueryVQUser]	用户信息列表

3. 示例¶

示例1 生成直播质量报告¶

输入示例¶

{
  "beginTime": "2024-01-14",
  "endTime": "2024-01-16",
  "users": [
    {
      "nickname": "高磊",
      "source": "联通",
      "uid": "7511256778"
    }
  ]
}

代码调用¶

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

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

        String requestBody = "{"
                + "\"beginTime\":\"2024-01-14\","
                + "\"endTime\":\"2024-01-16\","
                + "\"users\":[{"
                + "\"nickname\":\"高磊\","
                + "\"source\":\"联通\","
                + "\"uid\":\"7511256778\""
                + "}]"
                + "}";

        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/acdn/volc/hostAcceleratePackRest/getVQUserDataAPI"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "beginTime": "2024-01-14",
  "endTime": "2024-01-16",
  "users": [
    {
      "nickname": "高磊",
      "source": "联通",
      "uid": "7511256778"
    }
  ]
}`)

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

输出示例¶

{
  "msg": "操作成功",
  "code": 200,
  "data": [
    {
      "2024-03-29": {
        "status": 1
      }
    }
  ]
}

4. 输出参数¶

参数名称	类型	描述
code	Integer	状态码。示例值：`200`
msg	String	提示信息。示例值：`操作成功`
data	Array	按日期汇总的生成结果列表
data[].{date}	Object	以日期（`yyyy-MM-dd`）为键的结果对象
data[].{date}.status	Integer	是否生成加速包直播质量报告。`1`：是；其他值：否。示例值：`1`

5. 错误码¶

HTTP 状态码 / 业务提示	描述
200	成功
401	未鉴权或 Token 无效
403	无权限
请输入参数	请求体为空
请输入需要生成的uid信息	`users` 为空
请输入需要生成的日期信息	未传入 `beginTime` 或 `endTime`
结束时间不能小于开始时间	`endTime` 早于 `beginTime`
一次性最多只能查询5天的数据	日期间隔大于等于 5 天
发起失败，存在无效的uid	存在不属于当前账号或无效的 uid

6. 数据模型¶

QueryVQUser¶

待生成报告的用户信息。

参数名称	必选	类型	描述
uid	是	String	抖音 uid 示例值：`7511256778`
source	是	String	运营商名称，支持以下值： `联通`：联通 `移动`：移动 `电信`：电信示例值：`联通`
nickname	否	String	昵称示例值：`高磊`