文档首页/ 云防火墙 CFW/ API参考/ API/ 时间表管理/ 创建时间表 - CreateSchedule
更新时间：2025-10-20 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建时间表 - CreateSchedule

功能介绍

创建时间表

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v1/{project_id}/schedule

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以从调API处获取，也可以从控制台获取。项目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，周期计划为每天00:00:00到23:59:59，名称为test，描述为test

https://{Endpoint}/v1/a16df7cf1d094befa6bbc72cbf51e93a/schedule

{
  "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

错误码

请参见错误码。

父主题： 时间表管理

相关文档