保利威文档中心

幫助中心

刪除分類

更新時間:2023-02-24 10:40:46

介面描述

1、通过分类id删除视频信息
2、接口支持https协议

介面URL

http://api.polyv.net/v3/category/delete

線上API呼叫

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看

請求參數說明

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true Long 目前時間的毫秒級時間戳,3分鐘內有效
sign true String 簽名,32位元大寫MD5值【詳見MD5簽名產生規則
cateId true String 分類id【可透過查詢分類列表取得】

範例

http://api.polyv.net/v3/category/delete

表單參數:

cateId=1618197697939&appId=a0Wmol5EwX&sign=93D4B0AE342CE8B52E9DF058D12F05F9&timestamp=1618197726044

回應參數說明

參數名 類型 說明
requestId String 每次請求的業務流水號,必須唯一,便於用戶端/伺服器端排查問題
code Integer 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
error Object 回應失敗的錯誤資訊,回應成功時返回null【詳見error欄位說明
data Object 回應成功和回應失敗都返回null

error欄位說明

參數名 類型 說明
code Integer 錯誤碼
desc String 錯誤描述

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 VodSignUtil.java 都包含在下載檔案中。

強烈建議您使用點播Java SDK完成API的功能對接,點播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(VodSubAccountTest.class);

/**
 * 删除分类
 */
@Test
public void testSubDeleteCategory() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.appSecret;//使用子账号的secretKey
    String appId = super.appId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/v3/category/delete";
    String cateId = "1618197697939";
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("cateId", cateId);

    //用md5进行签名
    requestMap.put("sign", VodSignUtil.getSignMd5(requestMap, secretKey));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.debug("测试删除分类,{}", response);
    //do somethings
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "requestId": "930bffa2-2731-4cf9-9e9f-323036019cd0",
    "code": 200,
    "status": "success",
    "error": null,
    "data": null
}

異常範例

時間戳錯誤

{
    "requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
    "code": 400,
    "status": "error",
    "error": {
        "code": 100,
        "desc": "invalid timestamp"
    },
    "data": null
}

appId不正確

{
    "requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
    "code": 400,
    "status": "error",
    "error": {
        "code": 101,
        "desc": "application not exist"
    },
    "data": null
}

子帳號不存在

{
    "requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
    "code": 400,
    "status": "error",
    "error": {
        "code": 102,
        "desc": "user children not exist"
    },
    "data": null
}

子帳號過期

{
    "requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
    "code": 403,
    "status": "error",
    "error": {
        "code": 103,
        "desc": "user children expired"
    },
    "data": null
}

簽名錯誤

{
    "requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
    "code": 403,
    "status": "error",
    "error": {
        "code": 104,
        "desc": "invalid signature"
    },
    "data": null
}

帳號權限不足

{
    "requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
    "code": 403,
    "status": "error",
    "error": {
        "code": 105,
        "desc": "permission limited"
    },
    "data": null
}

無法操作此分類,權限不足

{
    "requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
    "code": 400,
    "status": "error",
    "error": {
        "code": 106,
        "desc": "category limited"
    },
    "data": null
}

刪除分類失敗,原因有:cataid不合法、頂層分類不允許刪除

{
    "requestId": "5ede3d23-45f0-4661-99be-e95d07daf049",
    "code": 400,
    "status": "error",
    "error": {
        "code": 3004,
        "desc": "delete category failed"
    },
    "data": null
}
联系客服,在线咨询