新建
最大可创建256个通行策略。
需要注意，如果所有的时刻表都为空，则表示任何时间段都不可通行。
周一到周日时间段每天最多12条；特殊日计划按天设置，最多可以添加31天，每天最多也是12个时间段。
请求路径
/v1/rule
请求方式
POST
请求体:
application/json
rule_id
String
Y
由提交端设置的唯一标识,不可重复,长度上限128字节
name
String
Y
策略名称，内容长度1~128字节，不可重
schedule
Object
Y
通行策略的具体内容
其中schedule字段值的具体内容字段如下:
onset_point
Long
Y
起效时间点,毫秒级Unix时间戳,范围: 大于 0 小于 4102415999000 (2099-12-31 23:59:59)
expire_point
Long
Y
失效时间点,毫秒级Unix时间戳,范围: 大于 0 小于 4102415999000 (2099-12-31 23:59:59)
mon_period
Object array
N
周一时刻表,上限12条;默认空
the_period
Object array
N
周二时刻表,上限12条;默认空
wed_period
Object array
N
周三时刻表,上限12条;默认空
thur_period
Object array
N
周四时刻表,上限12条;默认空
fri_period
Object array
N
周五时刻表,上限12条;默认空
sat_period
Object array
N
周六时刻表,上限12条;默认空
sun_period
Object array
N
周日时刻表,上限12条;默认空
special_days
Object array
N
特殊日期时刻表,上限31条;默认空
各period字段值的具体内容字段如下:
start_time
Object
N
当日起效时间;默认空
end_time
Object
N
当日失效时间;默认空
special_days字段值的具体内容字段如下：
year
Int
N
起效时间点的年,有效值0~2099，若为0则表示每年都生效;默认0
month
Int
N
起效时间点的月,有效值0~12，若为0则表示每月都生效;默认0
day
Int
N
起效时间点的日,有效值0~31，若为0则表示每日都生效;默认0
today_period
Object array
N
当日时刻表,上限12条;默认空
start_time与end_time字段值的具体内容如下：
hour
Int
N
起效时间点中的小时，有效值0~23;默认0
min
Int
N
起效时间点中的分钟，有效值0~59;默认0
sec
Int
N
起效时间点中的秒数，有效值0~59;默认0
请求示例:
新建一条策略，策略起效时间为2022-1-1 0:0:0，失效时间为2022-12-31 23:59:59,可通行的时间段为每周一的6:30:0到12:30:0与14:0:0到18:30:30,以及每月的6:30:0到12:30:0与14:0:0到18:30:30。
/v1/rule
{
"rule_id": "1",
"name": "1",
"schedule": {
"onset_point": 1640966400000,
"expire_point": 1672502399000,
"mon_period": [
{
"start_time": {
"hour": 6,
"min": 30,
"sec": 0
},
"end_time": {
"hour": 12,
"min": 30,
"sec": 0
}
},
{
"start_time": {
"hour": 14,
"min": 0,
"sec": 0
},
"end_time": {
"hour": 18,
"min": 30,
"sec": 30
}
}
],
"special_days": [
{
"year": 0,
"month": 0,
"day": 1,
"today_period": [
{
"start_time": {
"hour": 6,
"min": 30,
"sec": 0
},
"end_time": {
"hour": 12,
"min": 30,
"sec": 0
}
},
{
"start_time": {
"hour": 14,
"min": 0,
"sec": 0
},
"end_time": {
"hour": 18,
"min": 30,
"sec": 30
}
}
]
}
]
}
}返回示例
{
"data": {
"rule_id": 1,
"name": "1",
"schedule": {
"onset_point": 1640966400000,
"expire_point": 1672502399000,
"mon_period": [
{
"start_time": {
"hour": 6,
"min": 30,
"sec": 0
},
"end_time": {
"hour": 12,
"min": 30,
"sec": 0
}
},
{
"start_time": {
"hour": 14,
"min": 0,
"sec": 0
},
"end_time": {
"hour": 18,
"min": 30,
"sec": 30
}
}
],
"the_period": [],
"wed_period": [],
"thur_period": [],
"fri_period": [],
"sat_period": [],
"sun_period": [],
"special_days": [
{
"year": 0,
"month": 0,
"day": 1,
"today_period": [
{
"start_time": {
"hour": 6,
"min": 30,
"sec": 0
},
"end_time": {
"hour": 12,
"min": 30,
"sec": 0
}
},
{
"start_time": {
"hour": 14,
"min": 0,
"sec": 0
},
"end_time": {
"hour": 18,
"min": 30,
"sec": 30
}
}
]
}
]
},
"create_at": 1660297993368,
"update_at": 1660297993368
},
"code": 200,
"msg": "OK"
}Last updated