查询加速包直播质量报告¶

1. 接口描述¶

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

describeVQUserData 用于分页查询加速包直播质量报告，可通过 filters 按报告 ID（dataId）或抖音 uid（uid）筛选。

Token 获取方式见密钥鉴权。

2. 输入参数¶

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

参数名称	必选	类型	描述
pageNum	否	Integer	当前页。未传时默认 `1` 示例值：`1`
pageSize	否	Integer	每页显示条目个数。未传时默认 `10` 示例值：`10`
filters	否	[SearchFilterVo]	搜索条件，可传入一个或多个；支持按报告 ID / 抖音 uid 筛选
params	否	Object	预留扩展查询参数；无额外条件时可传 `{}`

3. 示例¶

示例1 按 dataId 与 uid 查询质量报告¶

输入示例¶

{
  "pageNum": 1,
  "pageSize": 10,
  "filters": [
    {
      "label": "dataId",
      "value": ["5"]
    },
    {
      "label": "uid",
      "value": ["7630145594"]
    }
  ],
  "searchHeader": {},
  "params": {}
}

代码调用¶

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

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

        String requestBody = "{"
                + "\"pageNum\":1,"
                + "\"pageSize\":10,"
                + "\"filters\":["
                + "{\"label\":\"dataId\",\"value\":[\"5\"]},"
                + "{\"label\":\"uid\",\"value\":[\"7630145594\"]}"
                + "],"
                + "\"searchHeader\":{},"
                + "\"params\":{}"
                + "}";

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

    requestBody := []byte(`{
  "pageNum": 1,
  "pageSize": 10,
  "filters": [
    {
      "label": "dataId",
      "value": ["5"]
    },
    {
      "label": "uid",
      "value": ["7630145594"]
    }
  ],
  "searchHeader": {},
  "params": {}
}`)

    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": [
    {
      "dataId": 5,
      "uid": "763044452594",
      "image": "http://livesaas.zbaidu.com/",
      "message": "no live data",
      "date": "2024-02-05",
      "createTime": "2024-02-05 13:57:23"
    }
  ],
  "code": 200,
  "msg": "查询成功"
}

4. 输出参数¶

参数名称	类型	描述
code	Integer	状态码。示例值：`200`
msg	String	提示信息。示例值：`查询成功`
total	Long	符合条件的总条数。示例值：`1`
rows	Array	报告列表
rows[].dataId	Long	报告 ID。示例值：`5`
rows[].uid	String	抖音 uid。示例值：`763044452594`
rows[].image	String	报告图地址。示例值：`http://livesaas.zbaidu.com/`
rows[].message	String	描述。示例值：`no live data`
rows[].date	String	报告日期，格式 `yyyy-MM-dd`。示例值：`2024-02-05`
rows[].createTime	String	创建时间，格式 `yyyy-MM-dd HH:mm:ss` 示例值：`2024-02-05 13:57:23`

5. 错误码¶

HTTP 状态码 / 业务提示	描述
200	成功
401	未鉴权或 Token 无效
403	无权限
参数异常	`filters` 中存在不支持的 `label`

6. 数据模型¶

SearchFilterVo¶

搜索条件项。

参数名称	必选	类型	描述
label	否	String	筛选字段，支持以下值： `dataId`：报告 ID `uid`：抖音 uid 示例值：`dataId`
value	否	Array of String	筛选值。传入单个值为模糊搜索，多个值为精确搜索示例值：`["5"]`