全部产品

物联网卡状态信息(QueryCardStatus)---JAVA

更新时间:2020-10-26 17:50:16

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

物联网卡状态信息接口

步骤 1 创建阿里云账号

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

  1. 访问阿里云

    官方网站

    ,单击页面上的 免费注册 按钮。

  2. 按照屏幕提示完成注册流程并进行实名认证,

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

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

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

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

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

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

ICCID

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

参数
请求参数

名称

类型

是否必须

描述

Iccid

String

必须

需要查询的物联卡对应的Iccid编码

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

出参列表

出参名称

出参类型

样例取值

参数说明

RequestId

String

8906582E-6722

请求ID

Code

String

OK

状态码-返回OK代表请求成功,其他错误码详见错误码列表

Message

String

请求成功

状态码的描述

CardStatus

Object

-

请参考下面的CardStatus样例

CardStatus样例

出参名称

出参类型

样例取值

参数说明

Iccid

String

89860617030017300390

ICCID编号

Msisdn

String

1064633113571

MSISDN编码

UserStatus

String

正常

用户状态(运营商侧的卡状态),包括正常、营业预销、未激活状态

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

技术对接步骤

1:下载SDK工具包

SDK工具包中一共包含了2个类库,一个aliyun-java-sdk-core包,另外一个是alicom-dyiotapi-api包,将这两个包执行mvn package命令或者mvn deploy命令打包出相应的jar包,添加到工程类库中依赖使用。

SDK&DEMO[下载地址]

2: 编写样例程序

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

//设置超时时间-可自行调整
System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
System.setProperty("sun.net.client.defaultReadTimeout", "10000");
//初始化ascClient需要的几个参数
final String product = "Dyiotapi";//物联卡API产品名称(短信产品名固定,无需修改)
final String domain = "dyiotapi.aliyuncs.com";//物联卡API产品域名(接口地址固定,无需修改)
//替换成你的AK
final String accessKeyId = "yourAccessKeyId";//你的accessKeyId,参考本文档步骤2
final String accessKeySecret = "yourAccessKeySecret";//你的accessKeySecret,参考本文档步骤2
//初始化ascClient,暂时不支持多region(请勿修改)
IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId,
accessKeySecret);
DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
IAcsClient acsClient = new DefaultAcsClient(profile);

//构建该API特定的请求参数
QueryCardInfoRequest request = new QueryCardInfoRequest();  
//填入你要查询的iccid值
request.setIccid("yourIccid");

//请求失败这里会抛ClientException异常
QueryCardInfoResponse acsResponse = acsClient.getAcsResponse(request);
if(acsResponse.getCode() != null && acsResponse.getCode().equals("OK")) {
//请求成功
}

返回示例

JSON示例

{
    /* 请求标签,用于追踪错误 */
    "RequestId": "475C4B95-FB6E-4B2A-B0C6-8AAA136B323A",
    /* 请求code,OK代表正常 */
    "Code": "OK",
    /* 异常描述 */
    "Message": "ServiceUnavailable",
    "CardStatus": {
        <!--iccid编号-->
        "Iccid": "89860617030017300390",
        <!--Msisdn 编号-->
        "Msisdn": "1064633113571",
        <!--用户状态 (运营商侧的卡状态)-->
        "UserStatus": "正常"
    }
}

错误码

错误代码

描述

Http状态码

语义

isv.RES_OWNER_ID_UNKNOWN

Can’t found of the card owner.

400

卡资源归属无效

isv.PRODUCT_UN_SUBSCRIPT

The Product need to order,before invoke the API.

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.INVALID_PARAMETERS

The parameters is invalid.

400

请求参数无效,q请核查对应的入参信息

isv.SYSTEM_ERROR

System error.

404

系统异常