跳转至

查询源请求策略

1. 接口描述

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

listOriginRequestPolicies 用于查询 CloudFront 风格的源请求策略列表(托管与自定义),供创建/编辑分发时选择 originRequestPolicyId

Token 获取方式见 密钥鉴权

2. 输入参数

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

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

参数名称 必选 类型 描述
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 ListOriginRequestPoliciesTest {

    public static void main(String[] args) throws Exception {
        String url = "https://{登录域名}/prod-api/acdn/distributions/listOriginRequestPolicies";
        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/listOriginRequestPolicies"
    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",
        "originRequestPolicy": {
          "id": "216adef6-5c7f-47e4-b989-5492eafa07d3",
          "lastModifiedTime": "1970-01-01T08:00:00.000+08:00",
          "originRequestPolicyConfig": {
            "name": "Managed-AllViewer",
            "comment": "Policy to forward all parameters in viewer requests"
          }
        }
      },
      {
        "type": "managed",
        "originRequestPolicy": {
          "id": "acba4595-bd28-49b8-b9fe-13317c0390fa",
          "lastModifiedTime": "1970-01-01T08:00:00.000+08:00",
          "originRequestPolicyConfig": {
            "name": "Managed-UserAgentRefererHeaders",
            "comment": "Policy to forward user-agent and referer headers to origin"
          }
        }
      }
    ]
  }
}

4. 输出参数

参数名称 类型 描述
code Integer 状态码。示例值:200
msg String 提示信息。示例值:操作成功
data Object CloudFront OriginRequestPolicyList
data.nextMarker String 下一页标记,无更多时为 null
data.maxItems Integer 单页最大条数。示例值:100
data.quantity Integer 当前返回条数
data.items Array 源请求策略列表
data.items[].type String 策略类型。取值:
managed:托管
custom:自定义
data.items[].originRequestPolicy Object 源请求策略对象
data.items[].originRequestPolicy.id String 策略 ID。示例值:216adef6-5c7f-47e4-b989-5492eafa07d3
data.items[].originRequestPolicy.lastModifiedTime String 最后修改时间
data.items[].originRequestPolicy.originRequestPolicyConfig Object 策略配置
data.items[].originRequestPolicy.originRequestPolicyConfig.name String 策略名称。示例值:Managed-AllViewer
data.items[].originRequestPolicy.originRequestPolicyConfig.comment String 策略说明

说明:配置体内还可能包含 Headers/Cookies/QueryStrings 转发行为等嵌套字段。创建分发时通常只需 idnametype;完整 Schema 以 CloudFront API 为准。

6. 数据模型

OriginRequestPolicyListItem

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

5. 错误码

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