创建隔离区
更新时间:2022-09-02 18:08:07
接口描述
1、创建隔离区
2、接口支持https协议
接口URL
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
2、集团账号接口计算签名请使用集团主账号的appId、appSecret
3、同一userId创建隔离区会抛出异常
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 集团主账号appId |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| userId | true | String | 用户全局ID,即userId |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
示例
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 状态码,与 http 状态码相同,用于确定基本的响应状态 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 是否成功响应 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
| error | Object | 状态码非200时的错误信息【详见Error字段描述】 |
| data | Object | 【详见data字段说明】 |
Error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码,用于确定具体的错误原因 |
| desc | String | 错误描述,与 error.code 对应 |
Data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| isolationId | String | 隔离区ID |
Java请求示例
响应示例
系统全局错误说明详见全局错误说明
成功示例
异常示例
{
"code": 400,
"status": "error",
"error": {
"code": 10003,
"desc": "时间戳过期"
},
"success": false
}
