设置播放域名限制规则

接口描述

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

接口URL

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

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看

请求参数描述

参数名必选类型说明

userid

true

String

保利威点播账户id,可以参考【获取密钥】获取,获取路径:官网->登录->点播(API接口)

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":""
}

Last updated