删除资源包¶
1. 接口描述¶
接口请求路径:POST /prod-api/multiCdn/open/agent/resource/deleteResource
deleteResource 用于按资源包 ID 批量删除当前代理商名下客户的 CDN 2.0 资源包。已产生流量或请求数用量的资源包不能删除。不属于当前代理商的 ID 按不存在处理,不区分他户数据。
本接口不使用 密钥鉴权 的 Bearer Token。请在请求头携带平台分配的 agent-code、agent-api-key。获取方式见 自有平台接入一键登录。
注意:删除为软删除。接口按 ID 逐条返回结果,部分失败不影响其余 ID。
2. 输入参数¶
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。本接口请使用 agent-code、agent-api-key,不要携带 Bearer Token。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| agent-code | 是 | String | Header 参数。代理商唯一码。开通时由平台分配,总后台代理商列表 AgentCode 列可查看。示例值:{agent-code} |
| agent-api-key | 是 | String | Header 参数。代理商 API 密钥。在总后台该代理商的 代理商账号 页签单击 查看 获取。示例值:{agent-api-key} |
| ids | 是 | Array of String | 资源包 ID 列表,不能为空。示例值:["1001","1002"] |
3. 输出参数¶
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Integer | 状态码。示例值:200 |
| msg | String | 提示信息。示例值:成功 |
| data | Array of Object | 逐条删除结果,顺序与请求 ids 一致。 |
| data[].id | String | 资源包 ID。示例值:1001 |
| data[].message | String | 该条结果。成功为 success;失败为业务文案,例如 资源包[1002]不存在、资源包[1002]已被使用,不能删除、删除失败。示例值:success |
4. 示例¶
示例1 批量删除资源包¶
输入示例¶
代码调用¶
请将 {登录域名}、{agent-code}、{agent-api-key} 替换为实际值。
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 DeleteResourceTest {
public static void main(String[] args) throws Exception {
String url = "https://{登录域名}/prod-api/multiCdn/open/agent/resource/deleteResource";
String requestBody = "{"
+ "\"ids\":[\"1001\",\"1002\"]"
+ "}";
try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
HttpPost httpPost = new HttpPost(url);
httpPost.setHeader("agent-code", "{agent-code}");
httpPost.setHeader("agent-api-key", "{agent-api-key}");
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/multiCdn/open/agent/resource/deleteResource"
requestBody := []byte(`{
"ids": ["1001", "1002"]
}`)
req, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(requestBody))
if err != nil {
panic(err)
}
req.Header.Set("agent-code", "{agent-code}")
req.Header.Set("agent-api-key", "{agent-api-key}")
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": [
{
"id": "1001",
"message": "success"
},
{
"id": "1002",
"message": "资源包[1002]不存在"
}
]
}
5. 错误码¶
| HTTP 状态码 / 业务提示 | 描述 |
|---|---|
| 200 | 成功 |
| 401 | 未鉴权或 Token 无效 |
| 403 | 无权限 |
| agent-code不能为空 | 未传请求头 agent-code |
| agent-api-key不能为空 | 未传请求头 agent-api-key |
| 鉴权失败:无效的agent-code或agent-api-key | 请求头中的代理商编号或 API 密钥不正确 |
| 必填项ids不能为空 | 未传 ids 或列表为空 |
| 资源包[id]不存在 | 资源包不存在,或不属于当前代理商 |
| 资源包[id]已被使用,不能删除 | 该资源包已产生流量或请求数用量 |
| 删除失败 | 标记删除时更新行数为 0 |