2. 应用授权（实例）管理API

API列表

API调用

1.1: 新增授权

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/add

方法：POST

请求参数

请求Body描述(非Form表单)

{
    "msgId":"760eda98-a9f1-aba8-8c89-125ef0a7345d",
    "projectId":50450049,
    "projectName":"株洲美的城",
    "gatewayId":51,
    "gatewayName":"",
    "validPeriod":"-1",
    "gatewayVersionId": "101",
    "ymlInfo":"1",
    "dockerInfo": "1",
    "logInfo": "1",
    "agentList":[
       { 
         "agentName":"哈哈就是测试",
         "agentId":"2",
         "agentVersionId": "2",
         "productId": "90f7c8364eaa4aadae4c7f05ace3130c",
         "applicationName":"大华",
         "agentType":"门禁系统",
         "ymlInfo":"1",
         "dockerInfo":"1",
         "logInfo":"1"
       }
    ]
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "data": {
        "appKey": "sOjwjYFY",
        "appSecret": "gkGvHA1TWRWI8HaB"
    },
    "message": "success"
}

1.1.1: 更新授权

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/update

方法：POST

请求参数

请求Body描述(非Form表单)

{
    "msgId":"760eda98-a9f1-aba8-8c89-125ef0a7345d",
    "gatewayInstanceId": "74",
    "projectId":50450049,
    "projectName":"株洲美的城",
    "gatewayId":51,
    "gatewayName":"",
    "validPeriod":"-1",
    "gatewayVersionId": "101",
    "ymlInfo":"1",
    "dockerInfo": "1",
    "logInfo": "1",
    "agentList":[
       { 
         "agentName":"哈哈就是测试",
         "agentId":"2",
         "agentVersionId": "2",
         "productId": "90f7c8364eaa4aadae4c7f05ace3130c",
         "applicationName":"大华",
         "agentType":"门禁系统",
         "ymlInfo":"1",
         "dockerInfo":"1",
         "logInfo":"1"
       }
    ]
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "data": {
        "deleteFlag": 0,
        "dockerInfo": "1",
        "ymlInfo": "1",
        "versionId": 101,
        "instanceName": "株洲美的城-",
        "onlineStatus": 0,
        "certId": 148,
        "id": 74,
        "logInfo": "1",
        "projectName": "株洲美的城",
        "projectId": "50450049",
        "definitionId": 51
    },
    "message": "success"
}

1.2: 应用授权列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/list

方法：POST

请求参数

请求Body描述(非Form表单)

{
    "msgId":"123123123",
    "pageNo":1,
    "pageSize":10,
    "searchKey": "",
    "isActive": 0
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "data": {
        "paginator": {
            "pageNo": 1,
            "pageSize": 5,
            "totalCount": 20
        },
        "resultList": [
             {
                "instanceId": 38,
                "instance_name": "美的-测试项目-测试网关3",
                "gatewayName": "测试网关3",
                "firstOnlineTime": "2020-08-17 10:37:38",   //激活时间
                "packageVersion": "v11111111",
                "projectName": "美的-测试项目",
                "authType": 1,  //-1：永久， 1：有效期
                "isActive": 1,  //0：未激活，1：激活
                "projectId": 123456,
                "instanceStatus": 1,
                "expiredTime": "2021-01-17 10:37:38",   //到期时间
                "box_identifier": "999988887777"
            },
            {
                "instanceId": 39,
                "instance_name": "美的-测试项目-测试网关3",
                "gatewayName": "测试网关3",
                "firstOnlineTime": null,
                "packageVersion": null,
                "projectName": "美的-测试项目",
                "authType": 1,
                "isActive": 0,
                "projectId": 123456,
                "instanceStatus": 1,
                "expiredTime": null,
                "box_identifier": null
            }
        ]
    },
    "message": "success"
}

1.3: 授权启用/禁用

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/status/update

方法：POST

请求参数

请求Body描述(非Form表单)

{
    "msgId": "123123123",
    "instanceId": 18,
    "instanceStatus": 0
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.4: 授权延期

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/status/delay

方法：POST

请求参数

请求Body描述(非Form表单)

{
    "msgId": "123123123",
    "instanceId": "1",
    "delayMonth": 3
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.5: 授权升级

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/upgrade

方法：POST

请求参数

请求Body描述(非Form表单)

{
    "msgId": "123123123",
    "instanceId": 18,
    "latestPackageVersionId": 62,
    "latestPackageImageUrl": "www.baidu.com"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.6: 授权删除

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/delete

方法：POST

请求参数

请求Body描述(非Form表单)

{
    "msgId": "123123123",
    "instanceId": 3
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.7: 实例认证

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/auth

方法：POST

请求参数

请求Body描述(非Form表单)

{
    "msgId": "123123123",
    "mqttClientId": "999988887777",
    "mqttUserName":"a9f2LC7J",
    "mqttPassword":"IpOI+ukV3+YIg+LCCcVtgBy/UxU="
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

正确返回：
{
    "code": 200,
    "data": {},
    "message": "success"
}
错误返回：
{
    "msgId": null,
    "code": 30008,
    "message": "appSecret校验密码错误"
}

返回结果示例

// encryptText是待加密的clientId， encryptKey是分配给box的appSecret

1.8: 应用实例列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/active/list

方法：POST

请求参数

请求Body描述(非Form表单)

{
    "msgId":"123123123",
    "pageNo":1,
    "pageSize":5,
    "projectId": "",
    "projectName": ""
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "data": {
        "paginator": {
            "pageNo": 1,
            "pageSize": 5,
            "totalCount": 3
        },
        "resultList": [
            {
                "agentNum": 3,  
                "instanceId": 1,    //网关实例id
                "gatewayName": "测试网关",
                "firstOnlineTime": "2020-08-12 12:00:00",   //激活时间
                "boxIdentifier": "111111111",
                "packageVersion": "v1.0.0",
                "projectName": "测试项目"
            },
            {
                "agentNum": 0,
                "instanceId": 3,
                "gatewayName": "IOTBOX测试网关3",
                "firstOnlineTime": "2020-08-12 12:00:00",
                "boxIdentifier": "222222222",
                "packageVersion": "v1.0.0",
                "projectName": "123"
            },
            {
                "agentNum": 0,
                "instanceId": 4,
                "gatewayName": "IOTBOX测试网关3",
                "firstOnlineTime": "2020-08-12 12:00:00",
                "boxIdentifier": "333333333",
                "packageVersion": "v1.0.0",
                "projectName": "美的君兰江山（北滘）"
            }
        ]
    },
    "message": "success"
}

1.9: 实例详情

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/detail

方法：POST

请求参数

请求Body描述(非Form表单)

{
    "msgId": "123123123",
    "instanceId": 1
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "data": {
        "agentInstance": [
            {
                "islatestVersion": 0,   //0:不是最新版本，1:最新版本
                "deviceCategoryId": 1,  //设备分类
                "latestPackageVersionId": 14,   //最新版本id
                "agentPackageVersionId": 1,
                "firstOnlineTime": "2020-08-12 12:00:00",   //激活时间
                "latestPackageImageUrl": "www.google.com",
                "agentInstanceId": 1,
                "agentName": "agent捷顺门禁",
                "DeviceCategoryName": "门禁系统",
                "currentPackageVersion": "v1.0.0", 
                "latestPackageVerison": "v1.1.1"
            },
            {
                "islatestVersion": 0,
                "deviceCategoryId": 1,
                "latestPackageVersionId": 14,
                "agentPackageVersionId": 1,
                "firstOnlineTime": "2020-08-12 12:00:00",
                "latestPackageImageUrl": "www.google.com",
                "agentInstanceId": 2,
                "agentName": "agent捷顺门禁",
                "DeviceCategoryName": "门禁系统",
                "currentPackageVersion": "v1.0.0",
                "latestPackageVerison": "v1.1.1"
            },
            {   
                "islatestVersion": 1,   //
                "deviceCategoryId": 2,
                "agentPackageVersionId": 11,
                "firstOnlineTime": "2020-08-12 12:00:00",
                "agentInstanceId": 3,
                "agentName": "agent梯控",
                "DeviceCategoryName": "梯控系统",
                "currentPackageVersion": "v1.0.0"
            }
        ],
        "gatewayInstance": [{
            "islatestVersion": 0,
            "latestPackageVersionId": 26,
            "gatewayName": "测试网关",
            "firstOnlineTime": "2020-08-12 12:00:00",
            "latestPackageImageUrl": "www.google.com",
            "boxIdentifier": "111111111",
            "currentPackageVersion": "001",
            "gatewayInstanceId": 1,
            "projectName": "测试项目",
            "latestPackageVerison": "v1.02.1"
        }]
    },
    "message": "success"
}

2.0: 密钥校验

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/verify

方法：POST

请求参数

请求Body描述(非Form表单)

{
    "appKey": "123dsvdsfa",
    "appSecretkey": "xxx",
    "projectId": 610
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "msgId": "123123123",
    "code": 200
}

2.1: （边缘端）密钥校验

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/spatial/setup/verify

方法：POST

请求参数

请求Body描述(非Form表单)

{
    "appKey": "123dsvdsfa",
    "appSecretkey": "xxx",
    "projectId": 610
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": 200,
    "data": {},
    "message": "success"
}

2.2: 检测网关版本

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/checkGateway

方法：POST

请求参数

请求Body描述(非Form表单)

{ 
    "gatewayInstanceId":"12",
    "projectId":"21322153",
    "boxId":"AAAABBCC",
    "appKey":"AXnqME4h",
    "gatewayVersion":"1.0.5"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "200",
    "data": true,
    "requestId": "df38c73b94b44dd292306b32dfe19d83",
    "success": true
}

2.3: 更新网关版本

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/updateGateway

方法：POST

请求参数

请求Body描述(非Form表单)

{ 
    "gatewayInstanceId":"12",
    "projectId":"21322153",
    "boxId":"AAAABBCC",
    "appKey":"AXnqME4h",
    "gatewayVersion":"1.0.5"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "200",
    "data": true,
    "requestId": "df38c73b94b44dd292306b32dfe19d83",
    "success": true
}

2.4: 重启网关版本

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/startGateway

方法：POST

请求参数

请求Body描述(非Form表单)

{ 
    "gatewayInstanceId":"12",
    "projectId":"21322153",
    "boxId":"AAAABBCC",
    "appKey":"AXnqME4h",
    "gatewayVersion":"1.0.5"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "200",
    "data": true,
    "requestId": "df38c73b94b44dd292306b32dfe19d83",
    "success": true
}

2.5: 检测Agent版本

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/checkAgent

方法：POST

请求参数

请求Body描述(非Form表单)

{
    "agentInstanceId":8,
    "projectId": "21322153",
    "sn": "AAAABBCC",
    "appKey": "AXnqME4h",
    "agentVersion": "1.0.6",
    "agentType": "door",
    "applicationName": "edge-ajhua-door-agent",
    "productId": "160"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "200",
    "data": true,
    "requestId": "df38c73b94b44dd292306b32dfe19d83",
    "success": true
}

2.6: 更新Agent版本

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/updateAgent

方法：POST

请求参数

请求Body描述(非Form表单)

{
    "agentInstanceId":8,
    "projectId": "21322153",
    "sn": "AAAABBCC",
    "appKey": "AXnqME4h",
    "agentVersion": "1.0.6",
    "agentType": "door",
    "applicationName": "edge-ajhua-door-agent",
    "productId": "160",
    "agentExtParam":[
        {
            "ip":"192.168.10.1",
            "port": "8080",
            "username":"admin",
            "password":"admin"
        }
    ]
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "200",
    "data": true,
    "requestId": "df38c73b94b44dd292306b32dfe19d83",
    "success": true
}

2.7: 启动Agent版本

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/startAgent

方法：POST

请求参数

请求Body描述(非Form表单)

{
    "agentInstanceId":8,
    "projectId": "21322153",
    "sn": "AAAABBCC",
    "appKey": "AXnqME4h",
    "agentVersion": "1.0.6",
    "agentType": "door",
    "applicationName": "edge-ajhua-door-agent",
    "productId": "160"
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "200",
    "data": true,
    "requestId": "df38c73b94b44dd292306b32dfe19d83",
    "success": true
}

2.8: 更新网关配置信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/updateGatewayProfile

方法：POST

请求参数

请求Body描述(非Form表单)

{
    "gatewayInstanceId":8,
    "ymlInfo": "",
    "dockerInfo": "",
    "logInfo": ""
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "200",
    "data": true
}

2.9: 更新Agent配置信息

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/iot/gateway/instance/updateAgentProfile

方法：POST

请求参数

请求Body描述(非Form表单)

{
    "agentInstanceId":8,
    "ymlInfo": "",
    "dockerInfo": "",
    "logInfo": ""
}

返回信息

返回参数类型

JSON

返回参数

返回结果示例

{
    "code": "200",
    "data": true
}