全部产品
云市场

物联卡管理停复机(DoIotUserStopResume)

更新时间:2019-07-23 09:11:42

物联卡管理停复机

步骤 1 创建阿里云账号

为了访问服务,您需要有一个阿里云账号。如果没有,可首先按照如下步骤创建阿里云账号:

  1. 访问阿里云 官方网站,单击页面上的 免费注册 按钮。
  2. 按照屏幕提示完成注册流程并进行实名认证,该服务只支持实名认证用户使用。为了更好地使用阿里云服务,建议尽快完成实名认证,否则部分阿里云服务将无法使用。具体实名认证流程,请参考 这里

步骤 2 获取阿里云访问密钥

为了使用物联卡 SDK,您必须申请阿里云的访问密钥

阿里云访问秘钥是阿里云为用户使用 API(非控制台)来访问其云资源设计的“安全口令”。您可以用它来签名 API 请求内容以通过服务端的安全验证。

该访问秘钥成对(AccessKeyId 与 AccessKeySecret)生成和使用。每个阿里云用户可以创建多对访问秘钥,且可随时启用(Active)、禁用(Inactive)或者删除已经生成的访问秘钥对。

您可以通过阿里云控制台的 秘钥管理页面 创建、管理所有的访问秘钥对,且保证它处于“启用”状态。由于访问秘钥是阿里云对 API 请求进行安全验证的关键因子,请妥善保管你的访问秘钥。如果某些秘钥对出现泄漏风险,建议及时删除该秘钥对并生成新的替代秘钥对。

步骤 3 在控制台完成购卡行为后,且卡被用户正常激活后,获得调用接口必备的参数

ICCID

请到阿里云控制台下的物联网无线服务下的卡管理页面,获取已经正常激活的卡对应的iccid值

OptionType

需要发起的操作类型 MANAGE_STOP:管理停,MANAGE_RESUME:管理复

参数
请求参数
名称 类型 是否必须 描述
Iccid String 必须 需要查询的物联卡对应的Iccid编码
OptionType String 必须 MANAGE_STOP:管理停,MANAGE_RESUME:管理复

其他请求参数请参见 公共请求参数

出参列表
出参名称 出参类型 样例取值 参数说明
RequestId String 8906582E-6722 请求ID
Code String OK 状态码-返回OK代表请求成功,其他错误码详见错误码列表
Message String 请求成功 状态码的描述
Result Object - 请参考下面的Result样例
Result样例
出参名称 出参类型 样例取值 参数说明
ControlResult Boolean true 停复操作结果

公共返回参数,详见 公共请求参数

技术对接步骤

1:下载SDK工具包

SDK&DEMO[下载地址]

2: 编写样例程序

注:有备注无需修改的位置请勿改动。

  1. // 代码节选,详见dyiot_php.zip\aliyun-dyiot-php-sdk\api_demo
  2. /**
  3. * 物联网卡管理停复机
  4. *
  5. * @return stdClass
  6. * @throws ClientException
  7. */
  8. public static function doIotUserStopResume() {
  9. $request = new DoIotUserStopResumeRequest();
  10. //必填: 填入你要查询的iccid值
  11. $request->setIccid('yourIccid');
  12. //必填: 操作类型 MANAGE_STOP(管理停), MANAGE_RESUME(管理复)
  13. $request->setOptionType('MANAGE_STOP');
  14. //hint 此处可能会抛出异常,注意catch
  15. $response = static::getAcsClient()->getAcsResponse($request);
  16. return $response;
  17. }

返回示例

JSON示例

  1. {
  2. /* 请求标签,用于追踪错误 */
  3. "RequestId": "475C4B95-FB6E-4B2A-B0C6-8AAA136B323A",
  4. /* 请求codeOK代表正常 */
  5. "Code": "OK",
  6. /* 异常描述 */
  7. "Message": "ServiceUnavailable",
  8. "Result": {
  9. "ControlResult": true
  10. }
  11. }

错误码

错误代码 描述 Http状态码 语义
isv.INVALID_PARAMETERS The parameters is invalid. 400 参数无效,具体看message表述
isv.PRODUCT_UN_SUBSCRIPT The Product need to order,before invoke the API. 400 未开通物联卡产品
isv.FORBIDDEN_ACTION Not support business action. 400 后台不支持业务配置发起此操作
isv.IOT_RES_NOT_EXIST Can’t found the card by the iccid number. 400 IccId对应的卡资源不存在
isv.QUERY_ASSETS_ERROR Query user infomation of the card response is error. 400 卡对应的用户资料异常
isv.RAM_PERMISSION_DENY The invoker is permission invoke the API for the card. 400 当前调用者无权对该卡发起请求
isv.SYSTEM_ERROR System error. 404 系统异常