获取失效列表¶
1. 接口描述¶
接口请求路径:GET /prod-api/acdn/cloudfrontRest/getInvalidationList/{distributionId}
getInvalidationList 用于查询指定海外 ACDN 分发下的缓存失效任务列表。
Token 获取方式见 密钥鉴权。
2. 输入参数¶
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| distributionId | 是 | Long | 分发主键 ID(路径参数) 示例值: 1001 |
3. 示例¶
示例1 查询失效列表¶
输入示例¶
代码调用¶
请将 {登录域名}、token、distributionId 替换为实际值。
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 GetInvalidationListTest {
public static void main(String[] args) throws Exception {
String distributionId = "1001";
String url = "https://{登录域名}/prod-api/acdn/cloudfrontRest/getInvalidationList/" + distributionId;
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() {
distributionId := "1001"
url := "https://{登录域名}/prod-api/acdn/cloudfrontRest/getInvalidationList/" + distributionId
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": {
"marker": "",
"nextMarker": "I9U3P14589VE4UH1L",
"maxItems": 100,
"isTruncated": true,
"quantity": 100,
"items": [
{
"id": "IYP12546HW0D",
"createTime": "2024-01-19T14:11:15.210+08:00",
"status": "Completed"
}
],
"truncated": true
}
}
4. 输出参数¶
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Integer | 状态码。示例值:200 |
| msg | String | 提示信息。示例值:操作成功 |
| data | Object | 失效列表数据 |
| data.marker | String | 当前分页标记 |
| data.nextMarker | String | 下一页标记,null 表示无更多数据 |
| data.maxItems | Integer | 单页最大条数。示例值:100 |
| data.isTruncated | Boolean | 是否截断。示例值:true |
| data.quantity | Integer | 当前返回条数。示例值:100 |
| data.items | Array | 失效任务列表 |
| data.items[].id | String | 失效任务 ID。示例值:IYP12546HW0D |
| data.items[].createTime | String | 创建时间(ISO 8601)。示例值:2024-01-19T14:11:15.210+08:00 |
| data.items[].status | String | 任务状态,支持以下值:Completed:已完成InProgress:进行中示例值: Completed |
| data.truncated | Boolean | 是否还有更多数据。示例值:true |
5. 错误码¶
| HTTP 状态码 / 业务提示 | 描述 |
|---|---|
| 200 | 成功 |
| 401 | 未鉴权或 Token 无效 |
| 403 | 无权限 |
| id不能为空! | 未传入 distributionId |