批量设备移出流量池分组
接口描述
将一台或多台设备批量移出其所在的流量池分组。移出后,设备回到单设备流量套餐方案,不再消耗流量池共享额度。
- 支持一次请求处理多台设备,系统内部一次批量查询联通、统一重算;
- 若公司开启了「4G 智能补充默认配置」且某台设备未单独开启,该设备移出后会按公司默认配置自动开启(等价新设备入网);公司级配置在同一次批量请求内只读取一次;
- 接口立即同步返回逐条结果(成功计数 + 失败列表)。
请求说明
| 接口ID |
协议 |
方法 |
PATH |
| 84 |
HTTPS |
DELETE |
/openapi/v1/pbs/sim_data_pool/groups/:id/devices |
PATH参数
| 参数 |
类型 |
必填 |
说明 |
| id |
int |
是 |
设备当前所在的分组ID(移出该分组) |
URL参数
| 参数 |
类型 |
必填 |
说明 |
| accesskey_id |
string |
是 |
参见签名认证 |
| expires |
int |
是 |
参见签名认证 |
| signature |
string |
是 |
参见签名认证 |
HTTP请求头
| 字段 |
值 |
| Content-Type |
application/json |
请求参数
请求参数以 Json 格式放置于 Body 中,字段如下:
| 参数 |
类型 |
必填 |
说明 |
| sns |
array<string> |
是 |
设备SN数组,1~20 个(一次最多 20 台) |
请求示例
DELETE https://open.vzicloud.com/openapi/v1/pbs/sim_data_pool/groups/102/devices?accesskey_id=8d9EsDAD2115Q5PM8tuP6g1IdAglkayp&expires=1619022787&signature=G29eTBjMm0gZF7cpXNLX7Hrn0yM%3D HTTP/1.1
Host: open.vzicloud.com
Content-Type: application/json
Content-Length: 55
{"sns": ["12345678-87654321", "12345678-87654322"]}
返回说明
返回参数
| 参数 |
类型 |
说明 |
| successes |
array |
成功移出分组的设备列表(无成功时为空数组) |
| + sn |
string |
设备SN |
| failures |
array |
失败的设备列表(无失败时为空数组) |
| + sn |
string |
设备SN |
| + error |
object |
失败错误信息 |
| ++ code |
int |
错误码(1003=权限/越权,1005=业务/系统失败;移出场景均为 1005) |
| ++ message |
string |
失败原因 |
返回示例
{
"successes": [
{"sn": "12345678-87654321"},
{"sn": "12345678-87654322"}
],
"failures": []
}
设备原本就不在任何分组(或设备记录不存在),视为已移出,计入 successes(幂等)。智能补充回退失败不影响移出本身,设备仍计入 successes。