Event日志检索接口
更新时间:2019-09-19
Event日志检索接口
接口描述
Event(事件)触发后形成日志记录在区块里,本接口提供根据区块范围和Event主题对日志进行检索功能。
权限说明
API权限认证采用Basic Auth方式,请求发起人需要具有合法的Username和Password才能发起请求,其中Username和Password详见所创建的以太坊网络。查看以太坊网络
注意事项
如果请求中没有用户认证信息(即匿名访问),返回401 Unauthorized
,错误信息:401 Authorization Required
。
服务域名
以太坊合约网关接口服务域名地址<ContractGateWayHost>
详见BBE中所创建的以太坊网络详情。查看以太坊网络
请求结构
POST /v2/ethereum/log/{contract}/{eventName} HTTP/1.1
Host: <ContractGateWayHost>
Content-Type: application/json
请求头域
头域 | 说明 | 是否必须 |
---|---|---|
Content-Type | 值为application/json | 必须 |
请求参数
名称 | 类型 | 位置 | 描述 | 是否必须 |
---|---|---|---|---|
contract | String | URL参数 | 合约地址 | 必须 |
eventName | String | URL参数 | 所请求的事件名称 | 必须 |
fromBlock | Integer | RequestBody参数 | 起始区块高度,默认为0 | 非必须 |
toBlock | Integer | RequestBody参数 | 结束区块高度,默认为最新区块高度 | 非必须 |
invokeParameters | JsonObject | RequestBody参数 | 根据指定合约事件topic过滤,如未指定,则默认返回全部 | 选填 |
使用限制
- 事件检索支持主题参数类型: intX/uintX, string, address, bytes, bytes32
- 使用indexed修饰的事件主题输出不支持string和动态类型数组
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
requestId | String | 用户请求携带的X-Request-Id |
result | JsonObject | 日志检索返回结果 |
contract | String | 日志所在的合约地址 |
data | JsonObject | 检索的日志信息,包括indexed修饰的topics数据和未修饰的data数据 |
blockNumber | Integer | 发生本事件的区块高度 |
blockHash | String | 发生本事件的区块哈希 |
txHash | String | 发生本事件的交易哈希 |
txIndex | Integer | 发生本事件的交易所在区块交易的位置 |
index | Integer | 本日志在收据中的位置 |
removed | Bool | 日志是否被回退 |
请求示例
说明:以太坊支持对indexed修饰的topic进行多条件过滤,即指定多个topic关键字则会按照多个关键字进行过滤。如本请求示例中使用address类型的from和int64类型的i进行日志检索。
POST /v2/ethereum/log/0x134bfd7a3d43ca3b4599718045156ada22ec8591/ChangeEvent HTTP/1.1
Host: 106.12.189.XXX:8080
Content-Type: application/json
{
"fromBlock":0,
"toBlock":123439,
"invokeParameters":{
"from":["0x7244ea287849942baac280b1912a575aeeccc792"],
"i":[111,222]
}
}
请求响应示例
HTTP/1.1 200 OK
Date: Thu, 19 Sep 2019 07:08:06 GMT
Content Type: application/json; charset=utf-8
Content-Length: 1007
{
"requestId": "5d7b994a-9485-4d01-a2e1-3bc8f141db28",
"result": [
{
"contract": "0x134bfd7a3d43ca3b4599718045156ada22ec8591",
"data": {
"from": "0x7244ea287849942baac280b1912a575aeeccc792",
"i": 222,
"s": "baidu"
},
"blockNumber": 101467,
"txHash": "0xa6791480e9546170965860c90e27ed6f17c19227734c58708956b34a8a6d5c8b",
"txIndex": 0,
"blockHash": "0xcaf81f10e0874a8490b85df95b223b04dd83f3054dd96989149df3e95fc03ee1",
"index": 0,
"removed": false
},
{
"contract": "0x134bfd7a3d43ca3b4599718045156ada22ec8591",
"data": {
"from": "0x7244ea287849942baac280b1912a575aeeccc792",
"i": 111,
"s": "bbe"
},
"blockNumber": 101467,
"txHash": "0x208140b148622f260f354c38d9424722949cb1b31f542cd33125630dfa6c9809",
"txIndex": 1,
"blockHash": "0xcaf81f10e0874a8490b85df95b223b04dd83f3054dd96989149df3e95fc03ee1",
"index": 1,
"removed": false
}
]
}