更新域名状态¶
1. 接口描述¶
接口请求路径:POST /prod-api/cdn/domain/updateDomainStatus
updateDomainStatus 用于更新指定域名的状态,支持停止、启动和删除。
Token 获取方式见 密钥鉴权。
2. 输入参数¶
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| domainId | 是 | Integer | 域名 ID 示例值: 123 |
| status | 是 | String | 目标状态。取值:stop(停止)、start(启动)、delete(删除)示例值: stop |
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 UpdateDomainStatusTest {
public static void main(String[] args) throws Exception {
String url = "https://{登录域名}/prod-api/cdn/domain/updateDomainStatus";
String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";
String requestBody = "{"
+ "\"domainId\":123,"
+ "\"status\":\"stop\""
+ "}";
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/updateDomainStatus"
token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"
requestBody := []byte(`{
"domainId": 123,
"status": "stop"
}`)
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))
}
输出示例¶
4. 输出参数¶
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Integer | 状态码。示例值:200 |
| msg | String | 提示信息。示例值:提交成功 |
5. 错误码¶
| HTTP 状态码 / 业务提示 | 描述 |
|---|---|
| 200 | 成功 |
| 401 | 未鉴权或 Token 无效 |
| 403 | 无权限 |
| 域名不存在,请刷新后重试 | 域名不存在或不属于当前账号 |
| 状态只能为 start/stop/delete | status 取值不合法 |
| 启用失败:该域名不为停止状态 | start 时域名当前不是停止状态 |
| 启用失败:您的域名已被管理员停止,如有问题请工单联系我们 | 域名被管理员停止,无法自行启用 |
| 启用失败:套餐已过期 | 所属套餐已过期,无法启用 |
| 删除失败:该域名不为停止状态 | delete 时域名不是配置中或停止状态 |
| 请于域名暂停1分钟后再删除 | 停止后需等待至少 1 分钟才能删除 |