查询终端设备模板列表 - ListDeviceTemplates

功能介绍

该API用于查询终端设备模板列表。

URI

GET /v2/{project_id}/edgemgr/device-templates?{name=xxx,limit=xxx,offset=xxx}

表1 Path参数
名称	是否必选	说明
project_id	是	项目ID，获取方法请参见获取项目ID。

表2 可选的查询检索参数
名称	是否必选	参数类型	说明
name	否	String	终端设备名称，模糊匹配
offset	否	String	查询的起始位置，取值范围为非负整数，默认为0
limit	否	String	每页显示的条目数量，取值范围1~1000，默认为1000

如果不携带任何检索参数，将返回该租户的所有设备模板信息。
可以同时携带多个检索参数，同时生效。

请求消息

表3 请求Header参数
参数	是否必选	类型	描述
Content-Type	是	String	消息体的类型（格式）推荐您使用默认值application/json。
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
ief-instance-id	否	String	铂金版实例ID，专业版实例为空值

响应消息

响应参数

表4 响应Body参数
名称	参数类型	说明
count	Integer	模板数量
device_templates	Array of 表7 objects	终端设备模板详情

响应示例

{
    "count": 1,
    "device_templates": [
        {
            "property_visitors": {},
            "description": "",
            "tags": {
                "key1": "value1"
            },
            "created_at": "2019-10-09T00:51:11.890571+08:00",
            "updated_at": null,
            "access_protocol": "userdefine",
            "twin": {},
            "attributes": {
                "ggg": {
                    "optional": true,
                    "value": "ggg",
                    "metadata": {
                        "type": "string"
                    }
                }
            },
            "project_id": "13b43583216e426b9dc9fad4000e9e1a",
            "id": "3950b024-7716-4580-8b85-4ab4bd3eeef0",
            "name": "mmmmmmm"
        }
    ]
}