跳转至

查询缓存策略

1. 接口描述

接口请求路径:POST /prod-api/acdn/distributions/listCachePolicies

listCachePolicies 用于查询 CloudFront 风格的缓存策略列表(托管与自定义),供创建/编辑分发时选择 cachePolicyId

Token 获取方式见 密钥鉴权

2. 输入参数

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

请求体对应 AWS SDK ListCachePoliciesRequest,可为空对象 {}

参数名称 必选 类型 描述
Marker String 分页标记,用于拉取下一页
MaxItems String 单次返回的最大条数
Type String 策略类型过滤。取值:
managed:托管策略
custom:自定义策略

3. 示例

示例1 查询缓存策略

输入示例

{}

代码调用

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

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

        String requestBody = "{}";

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

    requestBody := []byte(`{{}}`)

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

输出示例

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "nextMarker": null,
    "maxItems": 100,
    "quantity": 2,
    "items": [
      {
        "type": "managed",
        "cachePolicy": {
          "id": "658327ea-f89d-4fab-a63d-7e88639e58f6",
          "lastModifiedTime": "1970-01-01T08:00:00.000+08:00",
          "cachePolicyConfig": {
            "name": "Managed-CachingOptimized",
            "comment": "Policy with caching enabled. Supports Gzip and Brotli compression.",
            "defaultTTL": 86400,
            "maxTTL": 31536000,
            "minTTL": 1
          }
        }
      },
      {
        "type": "managed",
        "cachePolicy": {
          "id": "4135ea2d-6df8-44a3-9df3-4b5a84be39ad",
          "lastModifiedTime": "1970-01-01T08:00:00.000+08:00",
          "cachePolicyConfig": {
            "name": "Managed-CachingDisabled",
            "comment": "Policy with caching disabled",
            "defaultTTL": 0,
            "maxTTL": 0,
            "minTTL": 0
          }
        }
      }
    ]
  }
}

4. 输出参数

参数名称 类型 描述
code Integer 状态码。示例值:200
msg String 提示信息。示例值:操作成功
data Object CloudFront CachePolicyList
data.nextMarker String 下一页标记,无更多时为 null
data.maxItems Integer 单页最大条数。示例值:100
data.quantity Integer 当前返回条数。示例值:2
data.items Array 缓存策略列表
data.items[].type String 策略类型。取值:
managed:托管
custom:自定义
data.items[].cachePolicy Object 缓存策略对象
data.items[].cachePolicy.id String 策略 ID。示例值:658327ea-f89d-4fab-a63d-7e88639e58f6
data.items[].cachePolicy.lastModifiedTime String 最后修改时间
data.items[].cachePolicy.cachePolicyConfig Object 策略配置
data.items[].cachePolicy.cachePolicyConfig.name String 策略名称。示例值:Managed-CachingOptimized
data.items[].cachePolicy.cachePolicyConfig.comment String 策略说明
data.items[].cachePolicy.cachePolicyConfig.minTTL Integer 最小 TTL(秒)
data.items[].cachePolicy.cachePolicyConfig.defaultTTL Integer 默认 TTL(秒)
data.items[].cachePolicy.cachePolicyConfig.maxTTL Integer 最大 TTL(秒)

说明:data 为 CloudFront 原生列表。配置中还可能包含 parametersInCacheKeyAndForwardedToOrigin(Headers/Cookies/QueryStrings 等)。创建分发时通常只需读取 idnametype;完整嵌套 Schema 以 CloudFront API 为准,本文不展开。

6. 数据模型

CachePolicyListItem

参数名称 类型 描述
type String managed / custom
cachePolicy.id String 策略 ID
cachePolicy.cachePolicyConfig.name String 策略名称

5. 错误码

HTTP 状态码 / 业务提示 描述
200 成功
401 未鉴权或 Token 无效
403 无权限