Insights Hub "/api/agentmanagement/v3/agents" 接口如何使用？

2024-04-17T02:08:52Z

APIs & Services

摘要

详细信息

/api/agentmanagement/v3/agents 接口如何使用？

Solution

使用这个接口之前首先要创建一个基于 core.basicagent 类型的 assettype，并通过这个assettype创建一个asset 实体，通过 asset 实体的 asset id 创建代理，并将 asset 与 agent 进行绑定，这部分内容可以参考链接：https://documentation.mindsphere.io/MindSphere/howto/howto-agent-onboard.html

需要注意一点是在调用这个接口的时候如果变量信息较多的话，建议针对如创建 aspect， assettype，asset，agent 等操作都在 Insights Hub 的 Asset Manager 中进行，这样不容易出错。

Asset Manager 使用手册可参考链接：https://documentation.mindsphere.io/MindSphere/apps/asset-manager/introduction.html

以下操作步骤是 API https://{gateway_url_domain}/api/agentmanagement/v3/agents 的使用过程：

1. 创建 aspect type

使用 https://{gateway_url_domain}/api/assetmanagement/v3/aspecttypes/supplab.test_aspect_zjb1 创建 aspect "test_aspect_zjb1"

Body 信息：

{
  "name": "test_aspect_zjb1",
  "category": "static",
  "scope": "private",
  "description": "test api use--zjb",
  "variables": [
    {
      "name": "temperature",
      "dataType": "STRING",
      "unit": "C/F",
      "searchable": true,
      "length": 5,
      "defaultValue": "25/77",
      "qualityCode": true
    }
  ]
}

接口调用结果如图所示：

2. 创建 asset type

基于已创建的 aspect type 信息，通过 "core.basicagent" 类型的 Type 创建 agent 类型的 assettype，调用 https://{gateway_url_domain}/api/assetmanagement/v3/assettypes/supplab.test_assettype_zjb1 来创建代理类型的 asset type

Body 信息：

{
    "name": "test_assettype_zjb1",
    "description": "test assettype api apply zjb",
    "parentTypeId": "core.basicagent",
    "instantiable": true,
    "scope": "private",
    "aspects": [
        {
            "name": "test_aspect_zjb1",
            "aspectTypeId": "supplab.test_aspect_zjb1"
        }
    ],
    "variables": [
        {
            "name": "temperature",
            "dataType": "STRING",
            "unit": "C/F",
            "searchable": true,
            "length": 5,
            "defaultValue": "25/77"
        }
    ],
    "fileAssignments": []
}

调用结果如图所示：

3. 创建 agent asset

基于已创建的代理类型的 assettype，调用 https://{gateway_url_domain}/api/assetmanagement/v3/assets 来创建 agent asset。

Body 信息：

{
  "name": "testagentasset",
  "description": "zjb test",
  "variables": [],
  "typeId": "supplab.test_assettype_zjb1",
  "parentId": "24e558a453c743a985647c13d7a30f0c"
}

Parentid 的获取如图所示：

调用结果如图所示：

4. 创建 agent

使用已创建的 asset id，调用 https://{gateway_url_domain}/api/agentmanagement/v3/agents 来创建 agents

Body 信息：

{
  "name": "Nanobox Agent zjbtest1",
  "securityProfile": "SHARED_SECRET",
  "entityId": "5c0a34e77e8a45f89863f5cef1f103b0"
}

调用结果如图所示：

Notes

知识库文章 ID# PL8559640

内容

摘要详细信息

关联组件

Agent Management Service