更新时间:2025-08-28 GMT+08:00
分享

查询时间表列表

功能介绍

查询时间表列表

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/schedules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以从调API处获取,也可以从控制台获取。项目ID获取方式

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

object_id

String

参数解释

防护对象ID,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志ID,可通过调用查询防火墙实例接口获得,通过返回值中的data.records.protect_objects.object_id(.表示各对象之间层级的区分)获得,注意type为0的为互联网边界防护对象ID,type为1的为VPC边界防护对象ID。

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

name

String

参数解释

时间表名称

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

desc

String

参数解释

时间表描述

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

limit

Integer

参数解释

查询返回记录的数量限制

约束限制

不涉及

取值范围

1-1024

默认取值

不涉及

offset

Integer

参数解释

偏移量,表示查询该偏移量后面的记录

约束限制

不涉及

取值范围

0 - 1024

默认取值

不涉及

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data

PageDataScheduleVO object

参数解释

时间表响应信息

取值范围

不涉及

表4 PageDataScheduleVO

参数

参数类型

描述

limit

Integer

参数解释

数量限制

取值范围

不涉及

offset

Integer

参数解释

偏移量

取值范围

不涉及

records

Array of ScheduleVO objects

参数解释

时间表列表

取值范围

不涉及

total

Long

参数解释

总数

取值范围

不涉及

表5 ScheduleVO

参数

参数类型

描述

schedule_id

String

参数解释

时间表ID

取值范围

不涉及

name

String

参数解释

时间表名称

取值范围

不涉及

description

String

参数解释

时间表描述

取值范围

不涉及

ref_count

Integer

参数解释

引用次数

取值范围

不涉及

periodic

Array of periodic objects

参数解释

周期计划

取值范围

不涉及

absolute

absolute object

参数解释

绝对时间计划

取值范围

不涉及

表6 periodic

参数

参数类型

描述

type

Integer

参数解释

周期计划类型

取值范围

0:每天

1:每周的某几天

2:每周的一段时间

start_time

String

参数解释

周期计划开始时间

取值范围

不涉及

end_time

String

参数解释

周期计划结束时间

取值范围

不涉及

week_mask

Array of integers

参数解释

每周的某几天

取值范围

不涉及

start_week

Integer

参数解释

每周周期计划开始日

取值范围

不涉及

end_week

Integer

参数解释

每周周期计划结束日

取值范围

不涉及

表7 absolute

参数

参数类型

描述

start_time

String

参数解释

绝对计划开始时间

取值范围

不涉及

end_time

String

参数解释

绝对计划结束时间

取值范围

不涉及

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

不涉及

error_msg

String

参数解释

错误描述

取值范围

不涉及

请求示例

查询项目id为2349ba469daf4b7daf268bb0261d18b0的项目的防护对象id为a37bb4eb-c49e-4e88-bf77-944a75b0ce8a的第一页时间表列表

https://{Endpoint}/v1/2349ba469daf4b7daf268bb0261d18b0/schedules?object_id=a37bb4eb-c49e-4e88-bf77-944a75b0ce8a&limit=10&offset=0

响应示例

状态码:200

OK

{
  "data" : {
    "limit" : 2,
    "offset" : 0,
    "records" : [ {
      "schedule_id" : "4cf990c4-e71c-4540-8852-06693b76f15b",
      "name" : "dfsaasf",
      "description" : "",
      "ref_count" : 0,
      "periodic" : [ ],
      "absolute" : {
        "start_time" : 1752909841782,
        "end_time" : 1756365845000
      }
    }, {
      "schedule_id" : "8e8bb0b6-bd4b-4970-affe-1fd277d7520f",
      "name" : "fdsf",
      "description" : "",
      "ref_count" : 0,
      "periodic" : [ {
        "type" : 0,
        "start_time" : "00:00:00",
        "end_time" : "23:59:59"
      } ],
      "absolute" : { }
    } ],
    "total" : 2
  }
}

状态码:400

Bad Request

{
  "error_code" : "CFW.00200003",
  "error_msg" : "参数错误"
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码

相关文档