区块链服务相关接口

1.查询实例列表

通过REST Api调用区块链服务。

描述

  • 查询实例列表

URI

GET /ibaas/instances

请求参数

名称 位置 类型 是否必须 描述
instanceName query String 否 实例名称
type query String 否 实例类型（服务、成员）
pageNo query Number 是 当前页码
pageSize query Number 是 每页显示的条目

返回参数

名称 位置 类型 是否必须 描述
code body Integer 是 响应码，200成功；400失败
msg body String 是 提示信息
data body List(Instance) 是 调用返回实例列表

示例

请求示例

http://localhost:8762/ibaas/instances?instanceName=&type=&pageNo=1&pageSize=10

响应示例

{
 "code": 100,
 "msg": "success",
 "data": {
  "pageNo": 1,
  "pageSize": 10,
  "totalCount": 1,
  "pages": 1,
  "list": [
   {
    "id": "40c65b9e-eb10-4443-8ab9-a8a9cf051e5c",
    "instanceId": "2de62eb6-c6ab-44a3-ba75-4d3eb022e86c",
    "serviceId": "e2767f22-5aa8-42a9-86d9-9a01b07dfb32",
    "instanceName": "ibaas-kmuk1vva9ot99q",
    "userId": "0034ec44-2a40-4957-b620-3dd60bcb63a3",
    "accountId": "acs-testuser01",
    "isOwner": "0",
    "userName": "acs-testuser01",
    "instanceStatus": "running",
    "secAlgorithm": "ECDSA",
    "billType": "monthly",
    "region": "cn-north-3",
    "duration": "1",
    "durationUnit": "M",
    "autoRenew": 0,
    "effectTime": "2021-10-20T11:24:33+08:00",
    "expiredTime": "2021-12-21T00:00:00+08:00",
    "createdTime": "2021-10-20T11:24:33+08:00",
    "updatedTime": "2021-10-20T16:45:27+08:00",
    "allianceType": "CHAIN",
    "databaseType": "LevelDB",
    "ordererType": "smartbft",
    "consoleOrderFlowId": "1307124e-fa90-4962-97fc-5f10a66fbf09"
   }
  ]
 }
}

2.检查实例名

描述

  • 检查实例名是否可用、重复

URI

GET /ibaas/instances/check

请求参数

名称 位置 类型 是否必须 描述
instanceName query String 是 实例名称

返回参数

名称 位置 类型 是否必须 描述
code body Integer 是 响应码，200成功；400失败
msg body String 是 提示信息
data body Object 是 调用返回信息

示例

请求示例

http://localhost:8762/ibaas/instances/check?instanceName=asklda

响应示例

{
    "code": 100,
    "msg": "实例名称符合要求"
}

3.查询实例下资源详情列表

描述

  • 查询实例下资源详情列表

URI

GET /ibaas/api/instances/detail

请求参数

名称 位置 类型 是否必须 描述
vmName query String 否 资源名称
pageNo query Number 是 当前页码
pageSize query Number 是 每页显示的条目

返回参数

名称 位置 类型 是否必须 描述
code body Integer 是 响应码，200成功；400失败
msg body String 是 提示信息
data body List(InstanceDetail) 是 调用返回信息

示例

请求示例

http://localhost:8762/ibaas/instances/detail?vmName=&pageNo=1&pageSize=10

响应示例

{
 "code": 100,
 "msg": "success",
 "data": {
  "pageNo": 1,
  "pageSize": 10,
  "totalCount": 5,
  "pages": 1,
  "list": [
   {
    "id": "0a463a15-ce0e-43c5-9b38-7d55c25c3d60",
    "userId": "0034ec44-2a40-4957-b620-3dd60bcb63a3",
    "instanceId": "2de62eb6-c6ab-44a3-ba75-4d3eb022e86c",
    "serverId": "7dba7ee6-5b55-4d90-a4f5-a48cc9eff5a8",
    "vmName": "ibaas_2de62eb6-c6ab-44a3-ba75-4d3eb022e86c_2",
    "mngtIp": "172.16.37.86",
    "mngtPortId": "eabe5eba-0168-4cba-8e3a-b67a90ce4d77",
    "vpcIp": "192.168.0.14",
    "vpcPortId": "98989337-2aae-47b6-b7fd-077dbe444633",
    "eipId": "40aa21b6-03ea-4d98-9c1a-1b89507e37f1",
    "eipAddress": "10.110.32.180",
    "createdTime": "2021-10-20T11:29:06+08:00",
    "updatedTime": "2021-10-20T11:29:06+08:00"
   }
  ]
 }
}

5.删除创建失败的实例信息

描述

  • 删除某个实例

URI

DELETE /ibaas/api/instances/{id}

请求参数

名称 位置 类型 是否必须 描述
id path String 是 实例ID

返回参数

名称 位置 类型 是否必须 描述
code body Integer 是 响应码，200成功；400失败
msg body String 是 提示信息
data body Object 是 调用返回信息

示例

请求示例

http://localhost:8762/ibaas/api/instances/480387391816794112

响应示例

{
    "code": 100,
    "msg": "操作成功！"
}