物联网用量预警阀值设置接口
步骤 1 创建阿里云账号
为了访问服务,您需要有一个阿里云账号。如果没有,可首先按照如下步骤创建阿里云账号:
访问阿里云 官方网站,单击页面上的 免费注册 按钮。
按照屏幕提示完成注册流程并进行实名认证,该服务只支持实名认证用户使用。为了更好地使用阿里云服务,建议尽快完成实名认证,否则部分阿里云服务将无法使用。具体实名认证流程,请参考 这里。
步骤 2 获取阿里云访问秘钥
为了使用物理卡 SDK,您必须申请阿里云的访问秘钥。
阿里云访问秘钥是阿里云为用户使用 API(非控制台)来访问其云资源设计的“安全口令”。您可以用它来签名 API 请求内容以通过服务端的安全验证。
该访问秘钥成对(AccessKeyId 与 AccessKeySecret)生成和使用。每个阿里云用户可以创建多对访问秘钥,且可随时启用(Active)、禁用(Inactive)或者删除已经生成的访问秘钥对。
您可以通过阿里云控制台的 秘钥管理页面 创建、管理所有的访问秘钥对,且保证它处于“启用”状态。由于访问秘钥是阿里云对 API 请求进行安全验证的关键因子,请妥善保管你的访问秘钥。如果某些秘钥对出现泄漏风险,建议及时删除该秘钥对并生成新的替代秘钥对。
步骤 3 在控制台完成购卡行为后,且卡被用户正常激活后,获得调用接口必备的参数
BizId
根据bizType不同,有不同含义的BizId,获取方式不同
bizType | BizId | 描述 | 获取方式 |
---|---|---|---|
Iccid | Iccid | biztype指单卡预警,bizid需要输入物联网卡号ICCID | 请到阿里云控制台下的物联网无线服务下的卡管理页面,获取已经正常激活的卡对应的ICCID |
GROUP | GROUP_ID | biztype指分组预警,bizid需要物联网卡分组编号GROUP_ID | 请联系您的业务对接人处理线下获取 |
POOL | POOLID | biztype指流量池预警,bizid需要输入流量池编号,一般为流量池对应的计费号,当前仅支持同档位池预警 | 请联系您的业务对接人处理线下获取 |
参数
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
BizType | String | 必须 | 业务类型:ICCID设置单卡预警,GROUP设置分组预警,POOL设置流量池预警 |
BizId | String | 必须 | 根据不同的biztype选择对应的bizId,ICCID指卡ICCID,GROUP指物联网卡分组编号GROUP_ID,POOL,流量池编号,一般为流量池对应的计费号 |
OperationType | String | 必须 | 操作类型:1-新增,2-更新,3-删除 |
ConfigInfo | String | 非必须 | 需要提醒的阈值,会有多个,如达到50%,70%,90%时提醒,则设置为50,70,90,当OperaterType为1、2时必填 |
其他请求参数请参见 公共请求参数
出参列表
出参名称 | 出参类型 | 样例取值 | 参数说明 |
---|---|---|---|
RequestId | String | 2430E47F-46A2-48C9-9587-E17C56FBCFE0 | 请求ID |
Code | String | 200 | 返回结果编码 |
Message | String | 是 | 返回消息 |
公共返回参数,详见 公共请求参数
技术对接步骤
1:下载SDK工具包
SDK工具包中一共包含了2个类库,一个aliyun-java-sdk-core包,另外一个是alicom-dyiotapi-api包,将这两个包执行mvn package命令或者mvn deploy命令打包出相应的jar包,添加到工程类库中依赖使用。
SDK&DEMO[下载地址]
2: 编写样例程序
注:有备注无需修改的位置请勿改动。
package com.alicom.dyiot.api;
import java.util.List;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.dyiotapi.model.v20171111.DoIotSetRemindConfigRequest;
import com.aliyuncs.dyiotapi.model.v20171111.DoIotSetRemindConfigResponse;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;
publicclassIotDemo{
staticfinalString PRODUCT="Dyiotapi";
staticfinalString DOMAIN="dyiotapi.aliyuncs.com";
// TODO 此处需要替换成开发者自己的AK(在阿里云访问控制台寻找)
staticfinalString accessKeyId ="yourAccessKeyId";
staticfinalString accessKeySecret ="yourAccessKeySecret";
publicstaticIAcsClient init()throwsClientException{
//可自助调整超时时间
System.setProperty("sun.net.client.defaultConnectTimeout","10000");
System.setProperty("sun.net.client.defaultReadTimeout","10000");
//初始化acsClient,暂不支持region化
IClientProfile profile =DefaultProfile.getProfile("cn-hangzhou", accessKeyId, accessKeySecret);
DefaultProfile.addEndpoint("cn-hangzhou","cn-hangzhou", PRODUCT, DOMAIN);
returnnewDefaultAcsClient(profile);
}
publicstaticDoIotSetRemindConfigResponse setRemindConfig(String bizType,String bizId,String operationType,String configInfo)throwsClientException{
IAcsClient client=init();
DoIotSetRemindConfigRequest request =newDoIotSetRemindConfigRequest();
/**
* 业务类型
*
* ICCID,设置单卡预警
*
* GROUP,设置分组预警
*
* POOL,设置流量池预警
*/
request.setBizType(bizType);
/**
* 根据bizType,有不同含义
*
* ICCID,卡号ICCID
*
* GROUP,物联网卡分组编号GROUP_ID
*
* POOL,流量池编号,一般为流量池对应的计费号
*/
request.setBizId(bizId);
/**
* 需要提醒的阈值,会有多个,如达到50%,70%,90%时提醒,则设置为
*
* List<50,70,90>
*
* 当OperaterType为1、2时必填
*/
request.setConfigInfo(configInfo);
/**
* 操作类型:1-新增,2-删除,3-更新
*/
request.setOperationType(operationType);
return client.getAcsResponse(request);
}
}
错误码
错误代码 | 描述 | Http状态码 | 语义 |
---|---|---|---|
IOT_OPERATION_NOT_SUPPORT | isv.OPERATION_NOT_SUPPORT. | 116 | 不支持该操作 |
IOT_PRODUCT_PAUSE_RESUME_ERROR | isv.PRODUCT_PAUSE_RESUME_ERROR. | 117 | 功能停开操作失败 |
在文档使用中是否遇到以下问题
更多建议
匿名提交