获取源列表¶
1. 接口描述¶
接口请求路径:GET /prod-api/acdn/originsRest/getOriginsList
getOriginsList 用于查询指定海外 ACDN 分发下的源(Origin)列表及其协议、超时、源护盾等配置。账号需具备 acdn:DescribeAllDistribution 权限。
Token 获取方式见 密钥鉴权。
2. 输入参数¶
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| distributionId | 是 | Long | Query 参数。分发主键 ID。示例值:34 |
| searchValue | 否 | String | Query 参数。搜索关键字(入参字段;当前服务端实现未用于过滤) |
3. 输出参数¶
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Integer | 状态码。示例值:200 |
| msg | String | 提示信息。示例值:操作成功 |
| data | Object | 源列表数据 |
| data.list | [Origin] | 源列表 |
4. 示例¶
示例1 查询源列表¶
输入示例¶
代码调用¶
请将 {登录域名}、token 替换为实际值。
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class GetOriginsListTest {
public static void main(String[] args) throws Exception {
String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";
URIBuilder uriBuilder = new URIBuilder("https://{登录域名}/prod-api/acdn/originsRest/getOriginsList");
uriBuilder.addParameter("distributionId", "34");
try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
HttpGet httpGet = new HttpGet(uriBuilder.build());
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"
"net/url"
)
func main() {
token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"
u, err := url.Parse("https://{登录域名}/prod-api/acdn/originsRest/getOriginsList")
if err != nil {
panic(err)
}
q := u.Query()
q.Set("distributionId", "34")
u.RawQuery = q.Encode()
req, err := http.NewRequest(http.MethodGet, u.String(), 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": {
"list": [
{
"id": "origin.example.com",
"domainName": "origin.example.com",
"originPath": "",
"customHeaders": {
"quantity": 0,
"items": []
},
"s3OriginConfig": null,
"customOriginConfig": {
"originProtocolPolicy": "http-only",
"originSslProtocols": {
"quantity": 1,
"items": ["TLSv1.2"]
},
"originReadTimeout": 30,
"originKeepaliveTimeout": 5,
"httpport": 80,
"httpsport": 443
},
"connectionAttempts": 3,
"connectionTimeout": 10,
"originShield": {
"enabled": false,
"originShieldRegion": null
}
}
]
}
}
5. 错误码¶
| HTTP 状态码 / 业务提示 | 描述 |
|---|---|
| 200 | 成功 |
| 401 | 未鉴权或 Token 无效 |
| 403 | 无权限 |
| id不能为空 | 未传入 distributionId |
6. 数据模型¶
Origin¶
单个源配置(CloudFront Origin 结构)。
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | 源名称。示例值:origin.example.com |
| domainName | String | 源域名。示例值:origin.example.com |
| originPath | String | 源路径 |
| customHeaders | Object | 自定义标头,含 quantity 与 items |
| s3OriginConfig | Object | S3 源配置;非 S3 源时为 null |
| customOriginConfig | CustomOriginConfig | 自定义源配置 |
| connectionAttempts | Integer | 连接尝试次数,范围 1–3。示例值:3 |
| connectionTimeout | Integer | 连接超时(秒),范围 1–10。示例值:10 |
| originShield | OriginShield | 源护盾配置 |
CustomOriginConfig¶
自定义源协议与超时。
| 参数名称 | 类型 | 描述 |
|---|---|---|
| originProtocolPolicy | String | 协议策略。取值:http-only(仅 HTTP)、https-only(仅 HTTPS)、match-viewer(匹配查看器)。示例值:http-only |
| originSslProtocols | Object | 源 SSL 协议,含 quantity 与 items |
| originReadTimeout | Integer | 响应超时(秒)。示例值:30 |
| originKeepaliveTimeout | Integer | 保持连接超时(秒)。示例值:5 |
| httpport | Integer | HTTP 端口。示例值:80 |
| httpsport | Integer | HTTPS 端口。示例值:443 |
OriginShield¶
源护盾。
| 参数名称 | 类型 | 描述 |
|---|---|---|
| enabled | Boolean | 是否启用。示例值:false |
| originShieldRegion | String | 源护盾区域;未启用时为 null |