設定播放域名限制規則

更新時間：2025-01-14 16:10:55

介面說明

1、设置播放域名的限制规则
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

介面URL

http://api.polyv.net/v2/play/{userid}/domain

線上API呼叫

請求方式

POST

介面限制

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

請求參數說明

參數名	必填	類型	說明
ptime	true	Long	目前時間的毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為40位大寫的SHA1值，`產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
settingType	true	Integer	域名限制類型 0：無域名限制 1：黑名單 2：白名單 3：白名單和黑名單複合限制（先判斷白名單，再判斷黑名單）
host	false	String	域名配置，多個域名以英文逗號分隔，此參數僅在請求參數settingType值為1和2時且不為null時有效，最多設定5個

範例

http://api.polyv.net/v2/play/1b448be323/domain

表單參數：

host=www.baidu.com&sign=0DD842813DBE070805BFB6A806F3A813705DFB86&ptime=1620635007028&settingType=2

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	String	回應成功時返回修改成功，回應失敗時返回空

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(VodVideoDomainRestrictTest.class);
/**
 * 设置播放域名限制规则
 */
@Test
public void testSetDomainRestrictRule() throws Exception, NoSuchAlgorithmException {
        //业务参数
        String url = "http://v.polyv.net/uc/services/rest?method=saveHostSetting_type";
        String writeToken = super.writeToken;
        String settingType = "2";

        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("writetoken", writeToken);
        requestMap.put("settingType", settingType);
        String response = HttpUtil.postFormBody(url, requestMap);
        log.debug("测试设置播放域名限制规则,{}", response);
        //do somethings
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": "修改成功."
}

異常範例

簽名不正確

{
    "code":400,
    "status":"error",
    "message":"the sign is not right",
    "data":""
}

時間戳過期

{
    "code":400,
    "status":"error",
    "message":"ptime is too old.",
    "data":""
}