Event监听查询接口
更新时间:2019-09-19
Event监听查询接口
接口描述
本接口提供对已注册Event监听的查询。
权限说明
API权限认证采用Basic Auth方式,请求发起人需要具有合法的Username和Password才能发起请求,其中Username和Password详见所创建的以太坊网络。查看以太坊网络
注意事项
如果请求中没有用户认证信息(即匿名访问),返回401 Unauthorized
,错误信息:401 Authorization Required
。
服务域名
以太坊合约网关接口服务域名地址<ContractGateWayHost>
详见BBE中所创建的以太坊网络详情。查看以太坊网络
请求结构
GET /v2/ethereum/event?contract={contract}&subscribeId={subscribeId} HTTP/1.1
Host: <ContractGateWayHost>
请求头域
除公共头域外,无其它特殊头域。
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
subscribeId | String | Query参数 | 事件监听ID | 选填 |
contract | String | Query参数 | 事件所在合约地址 | 选填 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
requestId | String | 用户请求Id |
result | JsonObject | 事件监听注册查询结果 |
count | Integer | 事件监听注册个数 |
subscribeList | Array | 事件监听注册列表 |
subscribeId | String | 事件监听注册ID |
contract | String | 事件所在合约地址 |
subscribeUrl | String | 用户接收事件数据URL |
invokeDescription | InvokeDescription | 事件订阅描述 |
name | String | 事件名称 |
params | Array | 事件监听过滤条件 |
subscribeTime | String | 事件监听注册时间 |
请求示例
说明:可根据事件订阅ID和事件所在合约地址进行检索过滤,如下方请求示例中,使用合约地址所以查询条件。
GET /v2/ethereum/event?contract=0x134BFd7a3D43ca3b4599718045156ADa22EC8591 HTTP/1.1
Host: 106.12.189.XXX:8080
请求响应示例
HTTP/1.1 200 OK
Date: Thu, 19 Sep 2019 07:38:37 GMT
Content Type: application/json; charset=utf-8
Content-Length: 1029
{
"requestId": "a34272bb-652c-4d29-97e6-1a412fc12493",
"result": {
"count": 2,
"subscribeList": [
{
"subscribeId": "fbd08f7f-2ee7-46d1-b210-cb2ede56030e",
"contract": "0x134BFd7a3D43ca3b4599718045156ADa22EC8591",
"subscribeUrl": "http://XXX",
"invokeDescription": {
"name": "ChangeEvent",
"params": {
"i": [
111,
222
]
}
},
"subscribeTime": "2019-09-19T07:23:55.435083031Z"
},
{
"subscribeId": "6cb77e8d-b21b-4d5d-a446-b858af5b26af",
"contract": "0x134BFd7a3D43ca3b4599718045156ADa22EC8591",
"subscribeUrl": "http://XXX",
"invokeDescription": {
"name": "ChangeEvent",
"params": {
"from": [
"0x7244ea287849942baac280b1912a575aeeccc792"
]
}
},
"subscribeTime": "2019-09-19T07:38:34.777865918Z"
}
]
}
}