全部产品
云市场

加速状态查询

更新时间:2018-10-17 23:56:57

加速状态查询接口(BandStatusQuery)

查询当前宽带加速状态。返回值中分别展示了加速后,上行加速后的带宽,下行加速后的带宽。如果返回中上行/下行 返回值为空,则上行/下行 没有在加速状态或者加速失败。

参数列表

入参列表
参数名称 参数类型 是否必填 样例取值 参数说明
BandId Long 10001L 加速宽带ID
出参列表
参数名称 参数类型 样例取值 参数说明
RequestId String 89078768788ada 请求ID
Code String OK 状态码-返回OK代表请求成功,其他错误码详见错误码列表
Message String 请求成功 状态码的描述
ResultModle Object 查询结果,详见ResultModle 样例

ResultModle 格式

参数名称 参数类型 样例取值 参数说明
DownloadTarget Integer 200M 下行已经加速到的带宽,单位Mbps
UploadTarget Integer 10M 上行已经加速到的带宽,单位Mbps

技术对接步骤

1. 下载SDK开发工具

点击进入工具包下载

2. 编写样例程序
  1. /**
  2. * 加速状态查询
  3. *
  4. * 这是云通信智能网络加速服务API产品的DEMO程序,直接执行此文件即可体验云通信智能网络加速服务产品API功能
  5. * (只需要将AK替换成开通了云通信-云通信智能网络加速服务产品功能的AK即可)
  6. * 备注:Demo工程编码采用UTF-8
  7. */
  8. function bandStatusQuery() {
  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. /**
  27. * 组装请求对象-具体描述见控制台-文档部分内容
  28. */
  29. $request = new BandStatusQueryRequest();
  30. //可选-启用https协议
  31. //$request->setProtocol("https");
  32. $request->setBandId(10001);
  33. /**
  34. * 发起访问请求
  35. * 具体的错误码可以参考具体的文档
  36. * 禁止Client的自动重试,如果失败,最好选择手动重试
  37. */
  38. $acsResponse = $acsClient->getAcsResponse($request,false,0);
  39. /**
  40. * 调用加速接口是否成功
  41. */
  42. if ($acsResponse->ResultCode != null && $acsResponse->ResultCode == 'OK') {
  43. // todo 查询成功
  44. } else {
  45. // todo 查询失败
  46. }
  47. return $acsResponse;
  48. }
  49. // 调用示例:
  50. set_time_limit(0);
  51. header('Content-Type: text/plain; charset=utf-8');
  52. $response = bandStatusQuery();
  53. echo "加速状态查询(bandStatusQuery)接口返回的结果:\n";
  54. print_r($response);