Event监听注销接口
更新时间:2019-09-19
Event监听注销接口
接口描述
本接口提供对已注册Event监听的注销。
权限说明
API权限认证采用Basic Auth方式,请求发起人需要具有合法的Username和Password才能发起请求,其中Username和Password详见所创建的以太坊网络。查看以太坊网络
注意事项
如果请求中没有用户认证信息(即匿名访问),返回401 Unauthorized
,错误信息:401 Authorization Required
。
服务域名
以太坊合约网关接口服务域名地址<ContractGateWayHost>
详见BBE中所创建的以太坊网络详情。查看以太坊网络
请求结构
DELETE /v2/ethereum/event/{subscribeId}?clientToken={clientToken} HTTP/1.1
Host: <ContractGateWayHost>
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
subscribeId | String | URL参数 | 事件监听ID | 必须 |
clientToken | String | Query参数 | 幂等性Token,是一个长度不超过64位的ASCII字符串 | 非必须 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
requestId | String | 用户请求携带的X-Request-Id |
data | JsonObject | 请求返回数据 |
result | String | 事件监听注销结果 |
请求示例
DELETE /v2/ethereum/event/6cb77e8d-b21b-4d5d-a446-b858af5b26af?clientToken=47026c75-008f-4fe5-be1f-807f8244df6f HTTP/1.1
Host: 106.12.189.XXX:8080
请求响应示例
HTTP/1.1 200 OK
Date: Thu, 19 Sep 2019 07:48:59 GMT
Content Type: application/json; charset=utf-8
Content-Length: 77
{
"requestId": "434e0977-7114-4a5b-be30-a3db80374e43",
"result": "Done"
}