预热 URL¶
1. 接口描述¶
接口请求路径:POST /prod-api/acdn/tcdn/content/pushUrlsCache
pushUrlsCache 用于对国内 TCDN 加速域名发起 URL 预热任务,将源站内容提前拉取至 CDN 节点。提交的 URL 须包含 http:// 或 https://,且 URL 中的域名须为本账号下已接入的 TCDN 域名。
Token 获取方式见 密钥鉴权。
2. 输入参数¶
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| urls | 是 | Array of String | 待预热的 URL 列表。须包含协议头 http:// 或 https://示例值: ["http://www.test.com/test.html"] |
| urlEncode | 是 | Boolean | 是否对 URL 做 URL Encode 示例值: false |
| parseM3U8 | 是 | Boolean | 是否递归解析 m3u8 文件中的 ts 分片并预热 示例值: false |
| area | 是 | String | 预热地域,支持以下值:mainland:中国境内overseas:中国境外global:全球示例值: overseas |
3. 示例¶
示例1 预热 URL¶
输入示例¶
{
"area": "overseas",
"parseM3U8": false,
"urlEncode": false,
"urls": ["http://www.test.com/test.html"]
}
代码调用¶
请将 {登录域名}、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 PushUrlsCacheTest {
public static void main(String[] args) throws Exception {
String url = "https://{登录域名}/prod-api/acdn/tcdn/content/pushUrlsCache";
String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";
String requestBody = "{"
+ "\"area\":\"overseas\","
+ "\"parseM3U8\":false,"
+ "\"urlEncode\":false,"
+ "\"urls\":[\"http://www.test.com/test.html\"]"
+ "}";
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/tcdn/content/pushUrlsCache"
token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"
requestBody := []byte(`{
"area": "overseas",
"parseM3U8": false,
"urlEncode": false,
"urls": ["http://www.test.com/test.html"]
}`)
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))
}
输出示例¶
4. 输出参数¶
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Integer | 状态码。示例值:200 |
| msg | String | 提示信息。示例值:成功 |
5. 错误码¶
| HTTP 状态码 / 业务提示 | 描述 |
|---|---|
| 200 | 成功 |
| 401 | 未鉴权或 Token 无效 |
| 403 | 无权限 |
| 域名不属于你 | URL 中的域名未接入或不属于当前账号 |