编辑: AA003 | 2019-08-11 |
【商标声明】 及其它腾讯云服务相关的商标均为腾讯云计算(北京)有限责任公司及其关联公司所有.本文档涉及的第三方主体的商标,依法由权利人 所有. 【服务声明】 本文档意在向客户介绍腾讯云全部或部分产品、服务的当时的整体概况,部分产品、服务的内容可能有所调整.您所购买的腾讯云产品、 服务的种类、服务标准等应由您与腾讯云之间的商业合同约定,除非双方另有约定,否则,腾讯云对本文档内容不做任何明示或模式的承 诺或保证. TBaaS 版权所有:腾讯云计算(北京)有限责任公司 第3 共43页 文档目录 API 文档 更新历史 简介 API 概览 调用方式 请求结构 公共参数 接口鉴权 v3 接口鉴权 返回结果 Fabric交易相关接口 Invoke异步调用结果查询 新增交易 查询交易 数据结构 错误码 TBaaS 版权所有:腾讯云计算(北京)有限责任公司 第4 共43页第3次发布 发布时间:2019-05-30 19:29:39 本次发布包含了以下内容: 改善已有的文档. 新增接口: GetBlockList GetClusterSummary GetLatesdTransactionList 修改接口: GetInvokeTx 新增出参:BlockId 新增数据结构: Block TransactionItem 第2次发布 发布时间:2019-04-25 20:19:09 本次发布包含了以下内容: 改善已有的文档. 修改接口: GetInvokeTx 新增入参:GroupName Invoke 新增入参:GroupName Query 新增入参:GroupName 第1次发布 API 文档 更新历史 最近更新时间:2019-05-30 19:32:20 TBaaS 版权所有:腾讯云计算(北京)有限责任公司 第5 共43页 发布时间:2018-08-30 15:59:14 本次发布包含了以下内容: 改善已有的文档. 新增接口: GetInvokeTx Invoke Query 新增数据结构: PeerSet TBaaS 版权所有:腾讯云计算(北京)有限责任公司 第6 共43页TBaaS API 升级到 3.0 版本,全新的 API 接口文档更加规范和全面,统一的参数风格和公共错误码,统一的 SDK/CLI 版本与 API 文档 严格一致,给您带来简单快捷的使用体验;
支持全地域就近接入让您更快连接腾讯云产品. 欢迎使用腾讯云区块链(TBaaS)! 腾讯云区块链致力于为企业提供金融级别区块链基础设施服务,通过区块链云上的服务,为行业提供安全、可靠、灵活的解决方案.打造 一个开放分享、能力全面,标准统一的区块链生态圈,为众多行业客户提供完备的区块链服务. 1. 术语表 术语 中文 说明 channel 通道 通道是构建在 Fabric 网络上的私有区块链,实现了数据的隔离和保密. ledger 账本 一个channel的chain和由channel中每个peer维护的world state. chaincode 合约 一个运行在账本上的软件,它可以对资产进行编码,其中的交易指令(或者叫业务逻辑)也可以用来修改资 产. block 区块 在一个通道上,(区块是)一组有序交易的集合. peer 节点 一个网络实体,维护Ledger并运行Chaincode容器来对账本执行read-write操作. 2. API快速入门 通过 交易发起 (Invoke)接口新增、修改对象的属性值,支持同步模式和异步模式. 通过 交易查询 (Query)接口查询对象的属性值. 通过 交易异步查询 (GetInvokeTx)接口查询异步模式的交易发起接口的执行结果. 简介 最近更新时间:2019-04-25 20:26:00 TBaaS 版权所有:腾讯云计算(北京)有限责任公司 第7 共43页Fabric 区块链浏览器相关接口 接口名称 接口功能 GetBlockList 查询区块列表 GetClusterSummary 获取区块链网络概要 GetLatesdTransactionList 获取最新交易列表 Fabric交易相关接口 接口名称 接口功能 GetInvokeTx Invoke异步调用结果查询 Invoke 新增交易 Query 查询交易 API 概览 最近更新时间:2019-05-30 19:32:20 TBaaS 版权所有:腾讯云计算(北京)有限责任公司 第8 共43页1. 服务地址 API 支持就近地域接入,本产品就近地域接入域名为 tbaas.tencentcloudapi.com ,也支持指定地域域名访问,例如广州地域的域名为 tbaas.ap-guangzhou.tencentcloudapi.com . 推荐使用就近地域接入域名.根据调用接口时客户端所在位置,会自动解析到最近的某个具体地域的服务器.例如在广州发起请求,会自 动解析到广州的服务器,效果和指定 tbaas.ap-guangzhou.tencentcloudapi.com 是一致的. 注意:对时延敏感的业务,建议指定带地域的域名. 目前支持的域名列表为: 接入地域 域名 就近地域接入(推荐,只支持非金融区) tbaas.tencentcloudapi.com 华南地区(广州) tbaas.ap-guangzhou.tencentcloudapi.com 华东地区(上海) tbaas.ap-shanghai.tencentcloudapi.com 华北地区(北京) tbaas.ap-beijing.tencentcloudapi.com 西南地区(成都) tbaas.ap-chengdu.tencentcloudapi.com 西南地区(重庆) tbaas.ap-chongqing.tencentcloudapi.com 东南亚地区(中国香港) tbaas.ap-hongkong.tencentcloudapi.com 东南亚地区(新加坡) tbaas.ap-singapore.tencentcloudapi.com 亚太地区(曼谷) tbaas.ap-bangkok.tencentcloudapi.com 亚太地区(孟买) tbaas.ap-mumbai.tencentcloudapi.com 亚太地区(首尔) tbaas.ap-seoul.tencentcloudapi.com 亚太地区(东京) tbaas.ap-tokyo.tencentcloudapi.com 美国东部(弗吉尼亚) tbaas.na-ashburn.tencentcloudapi.com 美国西部(硅谷) tbaas.na-siliconvalley.tencentcloudapi.com 北美地区(多伦多) tbaas.na-toronto.tencentcloudapi.com 欧洲地区(法兰克福) tbaas.eu-frankfurt.tencentcloudapi.com 欧洲地区(莫斯科) tbaas.eu-moscow.tencentcloudapi.com 调用方式 请求结构 最近更新时间:2019-04-25 20:26:01 TBaaS 版权所有:腾讯云计算(北京)有限责任公司 第9 共43页 注意:由于金融区和非金融区是隔离不互通的,因此当访问金融区服务时(公共参数 Region 为金融区地域),需要同时指定带金融区地 域的域名,最好和 Region 的地域保持一致. 金融区接入地域 金融区域名 华东地区(上海金融) tbaas.ap-shanghai-fsi.tencentcloudapi.com 华南地区(深圳金融) tbaas.ap-shenzhen-fsi.tencentcloudapi.com 2. 通信协议 腾讯云 API 的所有接口均通过 HTTPS 进行通信,提供高安全性的通信通道. 3. 请求方法 支持的 HTTP 请求方法: POST(推荐) GET POST 请求支持的 Content-Type 类型: application/json(推荐),必须使用 TC3-HMAC-SHA256 签名方法. application/x-www-form-urlencoded,必须使用 HmacSHA1 或HmacSHA256 签名方法. multipart/form-data(仅部分接口支持),必须使用 TC3-HMAC-SHA256 签名方法. GET 请求的请求包大小不得超过
32 KB.POST 请求使用签名方法为 HmacSHA
1、HmacSHA256 时不得超过
1 MB.POST 请求使用签 名方法为 TC3-HMAC-SHA256 时支持
10 MB. 4. 字符编码 均使用UTF-8编码. TBaaS 版权所有:腾讯云计算(北京)有限责任公司 第10 共43页 公共参数是用于标识用户和接口鉴权目的的参数,如非必要,在每个接口单独的接口文档中不再对这些参数进行说明,但每次请求均需要 携带这些参数,才能正常发起请求. 签名方法 v3 使用 TC3-HMAC-SHA256 签名方法时,公共参数需要统一放到 HTTP Header 请求头部中,如下: 参数名称 类型 必选 描述 X-TC-Action String 是 操作的接口名称.取值参考接口文档中输入参数公共参数 Action 的说明.例如云服务器的 查询实例列表接口,取值为 DescribeInstances. X-TC-Region String 是 地域参数,用来标识希望操作哪个地域的数据.接口接受的地域取值参考接口文档中输入参 数公共参数 Region 的说明.注意:某些接口不需要传递该参数,接口文档中会对此特别说 明,此时即使传递该参数也不会生效. X-TC- Timestamp Integer 是 当前 UNIX 时间戳,可记录发起 API 请求的时间.例如 1529223702.注意:如果与服务器 时间相差超过5分钟,会引起签名过期错误. X-TC-Version String 是 操作的 API 的版本.取值参考接口文档中入参公共参数 Version 的说明.例如云服务器的版 本2017-03-12. Authorization String 是HTTP 标准身份认证头部字段,例如: TC3-HMAC-SHA256 Credential=AKIDEXAMPLE/Date/service/tc3_request, SignedHeaders=content-type;
host, Signature=fe5f80f77d5fa3beca038a248ff027d0445342fe2855ddc963176630326f1024 其中, - TC3-HMAC-SHA256:签名方法,目前固定取该值;
- Credential:签名凭证,AKIDEXAMPLE 是SecretId;
Date 是UTC 标准时间的日期,取 值需要和公共参数 X-TC-Timestamp 换算的 UTC 标准时间日期一致;
service为产品名,必 须与调用的产品域名一致,例如cvm;
- SignedHeaders:参与签名计算的头部信息,content-type 和host 为必选头部;
- Signature:签名摘要. X-TC-Token String 否 临时证书所用的 Token ,需要结合临时密钥一起使用.临时密钥和 Token 需要到访问管理 服务调用接口获取.长期密钥不需要 Token. 假设用户想要查询广州地域的云服务器实例列表,则其请求结构按照请求 URL、请求头部、请求体示例如下: HTTP GET 请求结构示例: http........