文档首页/ IoT边缘 IoTEdge/ API参考/ API列表/ 设备管理/ 获取协议配置
更新时间：2024-06-20 GMT+08:00
查看PDF
分享

获取协议配置

功能介绍

获取协议配置

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/protocol-configs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见 获取项目ID。

最小长度：1

最大长度：64
表2 Query参数

参数

是否必选

参数类型

描述

protocol_type

是

String

协议类型

最小长度：1

最大长度：32

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。

最小长度：0

最大长度：20000

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

service_id

String

服务id

最小长度：1

最大长度：256

service_type

String

服务类型

最小长度：1

最大长度：256

description

String

描述

最小长度：0

最大长度：1024

properties

Array of objects

属性

数组长度：0 - 1000

请求示例

GET https://{endpoint}/v2/{project_id}/protocol-configs

{
  "protocol_type" : "MQTT"
}

响应示例

状态码： 200

OK

{
  "service_id" : "string",
  "service_type" : "string",
  "description" : "string",
  "properties" : [ { } ]
}

状态码

状态码

描述

200

OK

401

Bad Request

500

Internal Server Error

错误码

请参见错误码。

父主题： 设备管理

相关文档