全部产品
云市场

宽带加速预校验

更新时间:2018-10-19 10:10:58

宽带加速预校验接口(BandPreCheck)

用于判断当前宽带线路是否可以被提速及可以被提速到的目标带宽。

参数列表

入参列表
参数名称 参数类型 是否必填 样例取值 参数说明
IpAddress String 192.168.1.2 加速IP地址
Port Integer 80 加速端口
出参列表
参数名称 参数类型 样例取值 参数说明
RequestId String 89078768788ada 请求ID
Code String OK 状态码-返回OK代表请求成功,其他错误码详见错误码列表
Message String 请求成功 状态码的描述
ResultModule Object 返回结果 具体校验结果,详见ResultModule样例

ResultModule 格式

参数名称 参数类型 样例取值 参数说明
BandId Long 1000001L 当前宽带Id
UploadBandwidth Integer 10M 当前上行带宽,单位Mbps
DownloadBandwidth Integer 10M 当前下行带宽,单位Mbps
BandOfferList List 可订购的加速产品列表,详见BandOffer样例

BandOffer 格式

参数名称 参数类型 样例取值 参数说明
OfferId Long 220980804008L 加速产品ID
Bandwidth Integer 100M 目标加速带宽,单位Mbps
Duration Long 10 加速时长,单位分钟,包月返回99999
Direction String UP/DOWN 加速方向,UP上行加速,DOWN 下行加速

技术对接步骤

1. 下载SDK工具包

点击进入工具包下载

2. 编写样例程序
  1. /**
  2. * 宽带加速预校验
  3. *
  4. * 这是云通信智能网络加速服务API产品的DEMO程序,直接执行此文件即可体验云通信智能网络加速服务产品API功能
  5. * (只需要将AK替换成开通了云通信-云通信智能网络加速服务产品功能的AK即可)
  6. * 备注:Demo工程编码采用UTF-8
  7. */
  8. function bandPrecheck() {
  9. // 产品名称,开发者无需替换
  10. $product = "Snsuapi";
  11. // 产品域名,开发者无需替换
  12. $domain = "snsuapi.aliyuncs.com";
  13. // TODO 此处需要替换成开发者自己的AK (https://ak-console.aliyun.com/)
  14. $accessKeyId = "yourAccessKeyId"; // AccessKeyId
  15. $accessKeySecret = "yourAccessKeySecret"; // AccessKeySecret
  16. // 暂时不支持多Region
  17. $region = "cn-hangzhou";
  18. // 服务结点
  19. $endPointName = "cn-hangzhou";
  20. //初始化acsClient,暂不支持region化
  21. $profile = DefaultProfile::getProfile($region, $accessKeyId, $accessKeySecret);
  22. // 增加服务结点
  23. DefaultProfile::addEndpoint($endPointName, $region, $product, $domain);
  24. // 初始化AcsClient用于发起请求
  25. $acsClient = new DefaultAcsClient($profile);
  26. // 初始化SendSmsRequest实例用于设置发送短信的参数
  27. $request = new BandPrecheckRequest();
  28. //可选-启用https协议
  29. //$request->setProtocol("https");
  30. $request->setIpAddress("127.0.0.1");
  31. $request->setPort(80);
  32. /**
  33. * 禁止Client的自动重试,如果失败,最好选择手动重试
  34. */
  35. $response = $acsClient->getAcsResponse($request,false,0);
  36. /**
  37. * 具体的错误码可以参考具体的文档
  38. */
  39. $resultModule = $response->ResultModule;
  40. /**
  41. * 入参的BandId
  42. */
  43. $bandId = $resultModule->BandId;
  44. /**
  45. * 当前宽带的下行速率,单位是 Mbps
  46. */
  47. $downLoadBandWidth = $resultModule->DownloadBandwidth;
  48. /**
  49. * 当前宽带的上行速率,单位是 Mbps
  50. */
  51. $uploadBandWidth = $resultModule->UploadBandwidth;
  52. /**
  53. * 当前带宽可购买的加速产品Offer
  54. * 如果当前返回值为null 或者 空列表,表示当前没有合适的加速服务
  55. */
  56. $bandOfferListItemList = $resultModule->BandOfferList->BandOfferList;
  57. foreach ($bandOfferListItemList as $item) {
  58. $item->OfferId; // Long 类型
  59. $item->Bandwidth; // 单位 Mbps
  60. $item->Direction; // up, down 两个值,UP:上行; DOWN:下行
  61. $item->Duration; // 可用时长 BandOfferListItem.Duration >= 9999 表示包月
  62. }
  63. return $response;
  64. }
  65. // 调用示例:
  66. set_time_limit(0);
  67. header('Content-Type: text/plain; charset=utf-8');
  68. $response = bandPrecheck();
  69. echo "宽带加速预校验(bandPrecheck)接口返回的结果:\n";
  70. print_r($response);