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

更新时间表

功能介绍

更新时间表

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/schedule/{schedule_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

schedule_id

String

参数解释

时间表ID,可以通过调用[查询时间表列表接口]获得,通过返回值中的data.records.schedule_id获得

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

object_id

String

参数解释

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

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

name

String

参数解释

时间表名称

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

description

String

参数解释

时间表描述

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

periodic

Array of periodic objects

参数解释

周期计划

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

absolute

absolute object

参数解释

绝对时间计划

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表3 periodic

参数

是否必选

参数类型

描述

type

Integer

参数解释

周期计划类型

约束限制

不涉及

取值范围

0:每天

1:每周的某几天

2:每周的一段时间

默认取值

不涉及

start_time

String

参数解释

周期计划开始时间

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

end_time

String

参数解释

周期计划结束时间

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

week_mask

Array of integers

参数解释

每周的某几天

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

start_week

Integer

参数解释

每周周期计划开始日

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

end_week

Integer

参数解释

每周周期计划结束日

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表4 absolute

参数

是否必选

参数类型

描述

start_time

Long

参数解释

绝对计划开始时间

约束限制

不涉及

取值范围

时间戳(毫秒级)

默认取值

不涉及

end_time

Long

参数解释

绝对计划结束时间

约束限制

不涉及

取值范围

时间戳(毫秒级)

默认取值

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

data

data object

参数解释

时间表返回体

取值范围

不涉及

表6 data

参数

参数类型

描述

id

String

参数解释

时间表ID

取值范围

不涉及

name

String

参数解释

名称

取值范围

不涉及

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

不涉及

error_msg

String

参数解释

错误描述

取值范围

不涉及

请求示例

更新时间表,项目ID为a16df7cf1d094befa6bbc72cbf51e93a,防护对象ID为24988c28-1357-4738-93aa-e6a120b1d0a0,时间表ID为3ed296c8-96f7-4a6d-a1f8-746d4a8f867a,周期计划为每天00:00:00到23:59:59,名称为test,描述为test

https://{Endpoint}/v1/a16df7cf1d094befa6bbc72cbf51e93a/schedule/3ed296c8-96f7-4a6d-a1f8-746d4a8f867a

{
  "object_id" : "24988c28-1357-4738-93aa-e6a120b1d0a0",
  "periodic" : [ {
    "type" : 0,
    "start_time" : "00:00:00",
    "end_time" : "23:59:59"
  } ],
  "name" : "test",
  "description" : "test"
}

响应示例

状态码:200

OK

{
  "data" : {
    "id" : "3ed296c8-96f7-4a6d-a1f8-746d4a8f867a",
    "name" : "test"
  }
}

状态码:400

Bad Request

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

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码

相关文档