alipay.commerce.iot.deviceservice.cancel(撤销指定的设备服务) 在线调试(沙箱环境)

当用户的某一设备服务失效时,可调用该接口对服务进行撤销

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.commerce.iot.deviceservice.cancel
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
user_id String 必选 16 蚂蚁统一会员ID 2088202950901042
service_id String 可选 64 协议服务商定义的设备服务id+不唯一+用于指定要撤销的服务+协议服务商在创建该服务时指定的该服务的id+该字段不是必填字段,如果不指定,则会撤销该协议服务商的默认设备服务实例 93882774

响应参数

参数 类型 是否必填 最大长度 描述 示例值

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayCommerceIotDeviceserviceCancelRequest request = new AlipayCommerceIotDeviceserviceCancelRequest();
request.setBizContent("{" +
"\"user_id\":\"2088202950901042\"," +
"\"service_id\":\"93882774\"" +
"}");
AlipayCommerceIotDeviceserviceCancelResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_commerce_iot_deviceservice_cancel_response": {
        "code": "10000",
        "msg": "Success"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "alipay_commerce_iot_deviceservice_cancel_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
INVALID_PARAMETER 参数有误业务参数无效 请检查业务参数是否齐全,格式是否正确
INVALID_USER_ID 用户id无效 请确认用户id是否正确
SYSTEM_ERROR 系统繁忙 请稍后再试
INVALID_PARAMETER 参数有误 请检查业务参数是否齐全,格式是否正确
NO_SERVICE_MATCHED 业务异常,更新时没有查到相关服务 该用户名下未查询到指定的设备服务,请确认提供的userId、serviceId是否正确
onlineServer