修改域名基本信息¶
1. 接口描述¶
接口请求路径:POST /prod-api/cdn/domain/updateDomainBasic
updateDomainBasic 用于修改指定域名的基本信息,包括套餐、回源地址、负载均衡及源站配置等。
Token 获取方式见 密钥鉴权。
2. 输入参数¶
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| domainId | 是 | Integer | 域名 ID。示例值:657 |
| doid | 是 | String | 所属套餐号。示例值:202123542279097884616 |
| ip | 是 | String | 回源地址。示例值:1.1.1.1 |
| upstream | 是 | Integer | 负载均衡。取值:0(轮询)、2(会话保持)。示例值:2 |
| resouceHost | 是 | String | 回源 Host,使用默认 HOST 时传空字符串 |
| customerRemark | 否 | String | 备注 |
| origin | 是 | DomainOrigin | 源站配置 |
| backUpSource | 否 | Array of String | 备用源列表 |
3. 输出参数¶
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Integer | 状态码。示例值:200 |
| msg | String | 提示信息。示例值:更新成功 |
4. 示例¶
示例1 修改域名基本信息(源站组)¶
输入示例¶
{
"domainId": 657,
"doid": "202123542279097884616",
"ip": "1.1.1.1",
"upstream": 2,
"resouceHost": "",
"customerRemark": "",
"origin": {
"httpOriginPort": 80,
"httpsOriginPort": 443,
"originGroupId": 1338,
"originRecord": "",
"originType": "originGroup",
"originProtocol": 0
},
"backUpSource": []
}
代码调用¶
请将 {登录域名}、token 替换为实际值。
curl -X POST 'https://{登录域名}/prod-api/cdn/domain/updateDomainBasic' \
-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx' \
-H 'Content-Type: application/json' \
-d '{
"domainId": 657,
"doid": "202123542279097884616",
"ip": "1.1.1.1",
"upstream": 2,
"resouceHost": "",
"customerRemark": "",
"origin": {
"httpOriginPort": 80,
"httpsOriginPort": 443,
"originGroupId": 1338,
"originRecord": "",
"originType": "originGroup",
"originProtocol": 0
},
"backUpSource": []
}'
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 UpdateDomainBasicTest {
public static void main(String[] args) throws Exception {
String url = "https://{登录域名}/prod-api/cdn/domain/updateDomainBasic";
String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";
String requestBody = "{"
+ "\"domainId\":657,"
+ "\"doid\":\"202123542279097884616\","
+ "\"ip\":\"1.1.1.1\","
+ "\"upstream\":2,"
+ "\"resouceHost\":\"\","
+ "\"customerRemark\":\"\","
+ "\"origin\":{"
+ "\"httpOriginPort\":80,"
+ "\"httpsOriginPort\":443,"
+ "\"originGroupId\":1338,"
+ "\"originRecord\":\"\","
+ "\"originType\":\"originGroup\","
+ "\"originProtocol\":0"
+ "},"
+ "\"backUpSource\":[]"
+ "}";
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/cdn/domain/updateDomainBasic"
token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"
requestBody := []byte(`{
"domainId": 657,
"doid": "202123542279097884616",
"ip": "1.1.1.1",
"upstream": 2,
"resouceHost": "",
"customerRemark": "",
"origin": {
"httpOriginPort": 80,
"httpsOriginPort": 443,
"originGroupId": 1338,
"originRecord": "",
"originType": "originGroup",
"originProtocol": 0
},
"backUpSource": []
}`)
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 | 套餐不存在或不属于当前账号 |
| 该套餐可使用域名已达上限({0}/{1}) | 更换套餐时目标套餐域名配额已满 |
| 缺少必填来源:请填写必填来源。 | 未传 origin |
| 回源端口无效:特殊域名端口情况下,回源端口需一致。 | 回源端口越界或 HTTP/HTTPS 回源端口不一致 |
| 回源类型只能为ipDomain或originGroup | originType 不合法 |
| 域名与回源地址不能相同 | 域名与 ip 或源站地址相同 |
| 回源协议originProtocol取值无效:取值:0(HTTP)、1(协议跟随)、2(HTTPS)。 | originProtocol 取值不合法 |
| 使用中间源的域名,无法修改回源地址,如需修改请提交工单 | 已开启中间源的域名不允许修改回源地址 |
6. 数据模型¶
DomainOrigin¶
源站配置。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| originType | 是 | String | 源站类型。取值:ipDomain(IP)、originGroup(源站组)。示例值:originGroup |
| originRecord | 否 | String | 源站 IP。originType 为 ipDomain 时必填 |
| originGroupId | 否 | Integer | 源站组 ID。originType 为 originGroup 时必填。示例值:1338 |
| originProtocol | 是 | Integer | 回源协议。取值:0(HTTP)、1(协议跟随)、2(HTTPS)。示例值:0 |
| httpOriginPort | 是 | Integer | HTTP 回源端口,范围 1–65535。示例值:80 |
| httpsOriginPort | 是 | Integer | HTTPS 回源端口,范围 1–65535;特殊端口场景下需与 HTTP 回源端口一致。示例值:443 |