---
title: "获取自定义协议信息列表"
method: POST
path: "/api/v1/things/protocol/info/index"
tags: ["things/protocol/info", "thingsProtocolInfo"]
---

# 获取自定义协议信息列表

`POST /api/v1/things/protocol/info/index`

## Request body

- ProtocolInfoIndexReq
  - `code` string
  - `codes` string[]
  - `name` string
  - `page` PageInfo
    - `orders` OrderBy[] — 排序
      - `field` string — 排序的字段名
      - `sort` integer — 排序方式：1 从小到大, 2 从大到小
    - `page` integer — 页码
    - `size` integer — 每页大小
  - `transProtocol` string — 传输协议: mqtt,tcp,udp
  - `type` string — 协议类型: 普通设备(默认):normal 音视频:media

## Response `200`

A successful response.

- object
  - `code` integer
  - `data` ProtocolInfoIndexResp
    - `list` ProtocolInfo[], required — 自定义协议信息
      - `code` string — iThings,iThings-thingsboard,wumei,aliyun,huaweiyun,tuya
      - `configFields` ProtocolConfigField[] — 配置字段列表,没有可以不传
        - `group` string, required
        - `id` integer, required
        - `isRequired` boolean, required
        - `key` string, required
        - `label` string, required
        - `sort` integer, required
      - `configInfos` ProtocolConfigInfo[] — 配置列表
        - `config` object, required
        - `desc` string, required
        - `id` integer, required
      - `desc` string
      - `deviceFields` ProtocolConfigField[] — 设备级的配置字段列表,没有可以不传
        - `group` string, required
        - `id` integer, required
        - `isRequired` boolean, required
        - `key` string, required
        - `label` string, required
        - `sort` integer, required
      - `endpoints` string[]
      - `etcdKey` string
      - `id` integer
      - `isEnableSyncDevice` integer, required — 是否支持主动同步设备信息
      - `isEnableSyncProduct` integer, required — 是否支持主动同步产品信息
      - `name` string
      - `productFields` ProtocolConfigField[] — 产品级的配置字段列表,没有可以不传
        - `group` string, required
        - `id` integer, required
        - `isRequired` boolean, required
        - `key` string, required
        - `label` string, required
        - `sort` integer, required
      - `transProtocol` string — 传输协议: mqtt,tcp,udp
      - `type` string — 协议类型: 普通设备(默认):normal 音视频:media
    - `total` integer — 拥有的总数
  - `msg` string

---

[API](https://skmtc.net/unitedrhino/apis/things-api.md) · [All operations](https://skmtc.net/unitedrhino/apis/things-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unitedrhino/things-api/revisions/f3bdeb916389/schema)