批量设备加入流量池分组
接口描述
将一台或多台 4G 流量设备批量加入指定的流量池分组。设备加入分组后,开始消耗流量池共享额度(而非单设备套餐额度)。
- 支持一次请求处理多台设备,系统内部一次批量查询联通、统一重算(而非逐台调用);
- 若某台设备已在其他分组,本次操作会将其移动到新分组(覆盖原归属);
- 接口立即同步返回逐条结果(成功计数 + 失败列表)。
请求说明
| 接口ID |
协议 |
方法 |
PATH |
| 83 |
HTTPS |
POST |
/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 台) |
请求示例
POST 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 |
错误码(见「错误码」段) |
| ++ message |
string |
失败原因 |
返回示例
{
"successes": [
{"sn": "12345678-87654321"},
{"sn": "12345678-87654322"}
],
"failures": [
{"sn": "12345678-87654323", "error": {"code": 1003, "message": "设备与分组不属于同一公司"}}
]
}
单台设备的失败不会导致整批失败,而是计入 failures 列表,其余设备正常处理。