---
name: "getAstronomicalList"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.5.2" }
title: "getAstronomicalList - 获取天文定时列表"
---

## getAstronomicalList

> [VERSION] @ray-js/ray >= 1.5.2

### 描述

获取天文定时列表

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `params` | `IGetAstronomicalList` | 是 | 请求参数 |

### 返回值

类型: `Promise<IGetAstronomicalListResponse>`

天文定时列表数组

##### IGetAstronomicalListResponse

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `astronomicalType` | `number` | 日出日落类型 |
| `bizId` | `string` | 设备或群组 ID |
| `bizType` | `number` | 资源类型。0：单设备。1：群组设备。 |
| `dps` | `string` | DP 值 |
| `id` | `number` | 定时任务 ID |
| `lat` | `number` | 经度 |
| `lon` | `number` | 纬度 |
| `loops` | `string` | 周循环 |
| `nextSunSet` | `string` | 下一个日出时间 |
| `offsetType` | `number` | 定时偏移执行类型 |
| `status` | `number` | 定时任务状态，0 关闭，1 开启，2 无效/已删除 |
| `time` | `string` | 定时时间 |
| `timezone` | `string` | 时区 |

### 引用对象

##### `interface` IGetAstronomicalList

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `bizId` | `string` | 设备 ID 或群组 ID |


### 示例代码

#### 基础用法

```ts
import { getAstronomicalList } from '@ray-js/ray';

getAstronomicalList({
  bizId: 'vdevo160456552237748',
}).then((response) => {
  console.log('天文定时列表:', response);
}).catch((err) => {
  console.error(err);
});
```