列取仪表盘订阅
更新时间 2025-11-27 17:14:26
最近更新时间: 2025-11-27 17:14:26
接口功能介绍
列取仪表盘订阅任务。
接口约束
无
URI
GET /v1/dashboard/subscribe/list
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| dashboardCodeList | 否 | String | 仪表盘编码列表，英文（半角）逗号分割。仪表盘编码列表和订阅编码列表至少其一不为空。 | 73a11952881f57 | |
| subscriptionCodeList | 否 | String | 订阅编码列表，英文（半角）逗号分割。仪表盘编码列表和订阅编码列表至少其一不为空。 | example1,example2 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池编码，可参考资源池列表 | 2000*****852 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应状态码。0：正常；-1：代表严重错误；-2：代表普通错误。 | 0 | |
| error | String | 业务错误码，仅错误时返回，例LTS_XXXX | LTS_0001 | |
| message | String | 消息内容。 | 成功 | |
| requestId | String | 请求ID。 | 3e31ebb2-572e5408e | |
| returnObj | Array of Objects | 订阅任务列表。 | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| code | String | 订阅编码。 | 72dc6c13898d4a | |
| name | String | 订阅名称。 | example-subscription-name | |
| dashboardCode | String | 仪表盘编码。 | 72dc6c13898d4a | |
| crontab | Object | 定时任务时间对象。 | crontab | |
| 表 crontab |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| type | String | 类型，week：按每周运行；month：按每月运行；day：按每天运行。 | week | |
| week | Integer | 按每周运行时，数值1，2，...7代表周一到周日。 | 5 | |
| day | Integer | 按每月运行时，对应的第N天。 | 10 | |
| time | String | 按每天运行时，对应的发送的时间。 | 01:00 |
枚举参数
无
请求示例
请求url
GET https://[endpoint]/v1/dashboard/subscribe/list?dashboardCodeList=73a11952881f57&subscriptionCodeList=73a11952881f57
请求头header
regionId:20000000***1852
请求体body
无
响应示例
{
"statusCode": 0,
"error": null,
"requestId": "fc534450-48684edcf",
"message": "成功",
"returnObj": [
{
"code": "dfjghdf",
"name": "周五的任务",
"dashboardCode": "dashboard123",
"crontab": {
"type": "week",
"week": 5,
"day": null,
"time": "09:00"
}
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
