1. 创建物流节点

1.1. 接口定义

POST /group/{groupId}/node

参数 是否必填 说明
groupId 是 资源组ID

请求体(JSON)

字段 是否必填 说明
nodeName 是 物流节点名称
nodeCode 是 物流节点编码（资源组下唯一）

1.2. 请求示例

  1. POST '/group/INNTER_TEST_PRE/node' --data '{"nodeName":"1230测试节点","nodeCode":"1230TESTCODE"}'

1.3. 返回值

1.3.1. 成功 (Status 200)，返回body为空

1.3.2. 失败-资源组不存在（Status 404）

Group not exists: {groupId}

1.3.2. 失败-节点已存在（Status 400）

Node already exists: {nodeCode}

2. 根据资源组查询物流节点列表

2.1. 接口定义

GET /group/{groupId}/nodes

参数 是否必填 说明
groupId 是 资源组ID
pageNo 是 指定从返回结果中的第几页开始显示
pageSize 是 每页记录数

2.2. 请求示例

GET '/group/INNTER_TEST_PRE/nodes?pageNo=1&pageSize=100'

2.3. 返回值

2.3.1. 成功 (Status 200)，按创建时间倒排序

{
    "data": [{
        "nodeId": "f0b4846ddbca49dfb0ea087ccc407c03",
        "nodeName": "1230测试节点",
        "businessId": "INNTER_TEST",
        "groupId": "INNTER_TEST_PRE",
        "clusterId": null,
        "nodeCode": "1230TESTCODE",
        "priority": null,
        "createTime": 1640863920000,
        "updateTime": 1640863920000
    }, {
        "nodeId": "d2283693f61a42668910d1154942fadd",
        "nodeName": "测试节点211206",
        "businessId": "INNTER_TEST",
        "groupId": "INNTER_TEST_PRE",
        "clusterId": null,
        "nodeCode": "csjd_211206",
        "priority": null,
        "createTime": 1638782865000,
        "updateTime": 1638782865000
    }],
    "total": 31,
    "totalPages": 1
}

3. 查询节点信息

3.1. 接口定义

GET /node/{nodeId}

参数 是否必填 说明
nodeId 是 节点ID

3.2. 请求示例

GET '/node/118d5961484f8fd533c417a27e6c53fe'

3.3. 返回值

3.3.1. 成功 (Status 200)

{
  "nodeId": "118d5961484f8fd533c417a27e6c53fe",
  "nodeName": "测试节点",
  "businessId": "INNTER_TEST",
  "groupId": "INNTER_TEST_PRE",
  "clusterId": null,
  "nodeCode": "1230TESTCODE", //仓code
  "priority": 0,
  "createTime": 168912312313,
  "updateTime": 168912312313
}

3.3.2. 失败-节点不存在(Status 404)

Node not exists: 118d5961484f8fd533c417a27e6c53fe

4. 根据资源组和节点编码查询节点信息

4.1. 接口定义

GET /group/{groupId}/node/{nodeCode}

参数 是否必填 说明
groupId 是 资源组ID
nodeCode 是 物流节点编码（资源组下唯一）

4.2. 请求示例

GET '/group/INNTER_TEST_PRE/node/1230TESTCODE'

4.3. 返回值

4.3.1. 成功 (Status 200)

{
  "nodeId": "118d5961484f8fd533c417a27e6c53fe",
  "nodeName": "测试节点",
  "businessId": "INNTER_TEST",
  "groupId": "INNTER_TEST_PRE",
  "clusterId": null,
  "nodeCode": "1230TESTCODE", //仓code
  "priority": 0,
  "createTime": 168912312313,
  "updateTime": 168912312313
}

4.3.2. 失败-节点不存在(Status 404)

Node not exists. groupId:  INNTER_TEST_PRE, nodeCode: 1231TESTCODE

5. 删除节点

只允许删除没有绑定任何设备的节点

4.1. 接口定义

POST /node/{nodeId}/delete

参数 是否必填 说明
nodeId 是 节点id

4.2. 请求示例

POST '/node/063cff08cf214caab7f3de41ac2cc530/delete'

4.3. 返回值

4.3.1. 成功 (Status 200)，无返回体

4.3.2. 失败-节点下存在设备(Status 400)

There are devices under the node, try again after deleting them.