文档首页/ IoT边缘 IoTEdge/ API参考/ API列表/ 推送通道管理/ 查询推送通道列表
更新时间：2026-08-13 GMT+08:00
查看PDF
分享

查询推送通道列表

功能介绍

查询推送通道列表

调试

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

URI

GET /v2/{project_id}/push-channels

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见 获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

查询的起始位置，取值范围为非负整数，默认为0

limit

否

Integer

每页记录数，取值范围为非负整数，默认值为10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

count

Long

总记录数

page_info

PageInfoDTO object

分页信息

channels

Array of ChannelDTO objects

通道信息
表5 PageInfoDTO

参数

参数类型

描述

offset

Integer

页码

limit

Integer

每页记录数
表6 ChannelDTO

参数

参数类型

描述

channel_id

String

规则ID

name

String

规则名称

channel

String

通道

endpoint

String

推送地址信息

description

String

规则描述

create_time

String

创建时间

update_time

String

更新时间

请求示例

GET https://{endpoint}/v2/{project_id}/push-channels

响应示例

状态码：200

OK

{
  "count" : 15,
  "page_info" : {
    "offset" : 0,
    "limit" : 10
  },
  "channels" : [ {
    "channel_id" : "123456",
    "name" : "注塑机",
    "channel" : "MQTT",
    "endpoint" : "ssl://192.168.1.1:8883",
    "description" : "将注塑机数据推送至broker",
    "create_time" : "2020-05-28T11:31:29.740Z",
    "update_time" : "2020-05-28T11:31:29.740Z"
  } ]
}

状态码

状态码

描述

200

OK

400

BAD REQUEST

401

Unauthorized

500

Internal Server Error

错误码

请参见错误码。

父主题： 推送通道管理

相关文档