实体卡限速 - SetSpeedValue
功能介绍
实体卡限速接口，接口仅支持中国电信和中国联通实体卡调用。中国联通卡需要个人实名认证后才能使用限速功能。注：由于运营商侧业务限制，建议您同一张SIM卡不要同时执行多种不同业务的操作。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
POST /v1/sim-cards/{sim_card_id}/speed-limit
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
sim_card_id | 是 | Long | SIM卡标识，如果SIM卡标识传0则表示需要根据iccid处理。可通过查询SIM卡列表接口获取 最小值：0 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
speed_value | 是 | Integer | 限制带宽速率，单位 Kbps，-1表示不限速,1Mbps=1024Kbps。正整数表示限制到当前速率，电信支持限制速率:1Kbps,64 Kbps,256 Kbps,512Kbps,1Mbs，3Mbs,5Mbs,7Mbs,10Mbs,20Mbs,30Mbs,40Mbs,50Mbs,60Mbs,70Mbs,80Mbs,90Mbs,100Mbs,110Mbs,120Mbs,130Mbs,140Mbs,150Mbs。联通支持限制速率:256Kbps,512Kbps,1Mbps,2Mbps,7.25Mbps。 最小值：-1 |
iccid | 否 | String | iccid，传入的sim_card_id为0,则根据iccid进行处理 最小长度：19 最大长度：20 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
work_order_id | Long | 业务受理单号 |
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
状态码：500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
请求示例
创建SIM卡限速的申请。限制指定sim_card_id卡片的带宽速率为1024Kbps。
POST https://{endpoint}/v1/sim-cards/{sim_card_id}/speed-limit { "speed_value" : 1024 }创建SIM卡限速的申请。当参数sim_card_id为最小值时，限制SIM卡标识iccid为“898600xxxxxxxxxx”的带宽速率为1024Kbps
POST https://{endpoint}/v1/sim-cards/{sim_card_id}/speed-limit { "iccid" : "898600xxxxxxxxxx", "speed_value" : 1024 }
响应示例
状态码：200
OK
{
"work_order_id" : 1000001
} 状态码：400
Parameter Invalid
{
"error_code" : "GSL.00010004",
"error_msg" : "参数异常"
} 状态码：500
Internal Server Error
{
"error_code" : "GSL.00010003",
"error_msg" : "系统繁忙，请稍后重试。"
} 状态码
状态码 | 描述 |
|---|---|
200 | OK |
400 | Parameter Invalid |
500 | Internal Server Error |
错误码
请参见错误码。
