修改分发配置信息¶
1. 接口描述¶
接口请求路径:POST /prod-api/acdn/cloudfrontRest/updateDistributionSetting
updateDistributionSetting 用于修改海外 ACDN 分发的常规配置,包括价格级别、CNAME、证书、安全策略、HTTP 版本、IPv6、标准日志等。账号需具备 acdn:EditDistribution 权限。开启标准日志还需具备角色 acdn_logging。
Token 获取方式见 密钥鉴权。
2. 输入参数¶
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| distributionId | 是 | Long | 分发主键 ID。示例值:38 |
| aliases | 否 | [Value] | 备用域名(CNAME)列表;不传或空列表表示清空 CNAME |
| comment | 否 | String | 说明,最长 128 字符 |
| defaultRootObject | 否 | String | 默认根对象。示例值:index.html |
| isHttpVersion | 否 | String | HTTP 版本。示例值:http2 |
| isIpv6Enabled | 否 | Boolean | 是否启用 IPv6。示例值:true |
| isLogging | 否 | Boolean | 是否开启标准日志。开启时必须提供可用的 loggingBucket |
| loggingBucket | 否 | String | 标准日志存储桶,域名形式如 xxx.s3.amazonaws.com;未带 .s3. 时服务端会自动拼接 |
| isCookie | 否 | Boolean | 是否将 Cookie 写入标准日志 |
| priceClass | 否 | String | 价格级别。取值:PriceClass_All(使用所有边缘站点)、PriceClass_100(仅北美洲和欧洲)、PriceClass_200(北美洲、欧洲、亚洲、中东和非洲)。示例值:PriceClass_All |
| protocolVersionType | 否 | String | 安全策略。取值:TLSv1.2_2021、TLSv1.2_2019、TLSv1.2_2018、TLSv1.1_2016、TLSv1_2016、TLSv1。示例值:TLSv1.2_2021 |
| sslCertificateId | 否 | String | SSL 证书 ARN;非空时会同步写入查看器证书与最低协议版本 |
| webACLId | 否 | String | WAF Web ACL ID |
3. 输出参数¶
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Integer | 状态码。示例值:200 |
| msg | String | 提示信息。示例值:修改成功 |
4. 示例¶
示例1 修改分发配置¶
输入示例¶
{
"sslCertificateId": "",
"comment": "demo",
"webACLId": "",
"aliases": [
{"value": "cdn.example.com"}
],
"distributionId": 38,
"isIpv6Enabled": true,
"priceClass": "PriceClass_All",
"defaultRootObject": "index.html",
"isHttpVersion": "http2",
"protocolVersionType": "TLSv1.2_2021",
"isLogging": false,
"isCookie": false
}
代码调用¶
请将 {登录域名}、token 替换为实际值。
curl -X POST 'https://{登录域名}/prod-api/acdn/cloudfrontRest/updateDistributionSetting' \
-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx' \
-H 'Content-Type: application/json' \
-d '{
"sslCertificateId": "",
"comment": "demo",
"webACLId": "",
"aliases": [
{"value": "cdn.example.com"}
],
"distributionId": 38,
"isIpv6Enabled": true,
"priceClass": "PriceClass_All",
"defaultRootObject": "index.html",
"isHttpVersion": "http2",
"protocolVersionType": "TLSv1.2_2021",
"isLogging": false,
"isCookie": false
}'
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 UpdateDistributionSettingTest {
public static void main(String[] args) throws Exception {
String url = "https://{登录域名}/prod-api/acdn/cloudfrontRest/updateDistributionSetting";
String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";
String requestBody = "{"
+ "\"sslCertificateId\":\"\","
+ "\"comment\":\"demo\","
+ "\"webACLId\":\"\","
+ "\"aliases\":[{\"value\":\"cdn.example.com\"}],"
+ "\"distributionId\":38,"
+ "\"isIpv6Enabled\":true,"
+ "\"priceClass\":\"PriceClass_All\","
+ "\"defaultRootObject\":\"index.html\","
+ "\"isHttpVersion\":\"http2\","
+ "\"protocolVersionType\":\"TLSv1.2_2021\","
+ "\"isLogging\":false,"
+ "\"isCookie\":false"
+ "}";
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/cloudfrontRest/updateDistributionSetting"
token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"
requestBody := []byte(`{
"sslCertificateId": "",
"comment": "demo",
"webACLId": "",
"aliases": [
{"value": "cdn.example.com"}
],
"distributionId": 38,
"isIpv6Enabled": true,
"priceClass": "PriceClass_All",
"defaultRootObject": "index.html",
"isHttpVersion": "http2",
"protocolVersionType": "TLSv1.2_2021",
"isLogging": false,
"isCookie": false
}`)
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))
}
输出示例¶
5. 错误码¶
| HTTP 状态码 / 业务提示 | 描述 |
|---|---|
| 200 | 成功 |
| 401 | 未鉴权或 Token 无效 |
| 403 | 无权限 |
| id不能为空! | 未传入 distributionId |
| 无有效id | 分发不存在或不属于当前账号 |
| 开启标准日志必须选择日志存储桶 | isLogging 为 true 但未提供可用存储桶 |
| 操作失败:您没有开启日志存储的权限。请确认账号权限或联系管理员。 | 缺少角色 acdn_logging |
| 修改失败 | 更新未成功 |
6. 数据模型¶
Value¶
CNAME 项。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| value | 是 | String | CNAME 值。示例值:cdn.example.com |