更新时间表 - UpdateSchedule
功能介绍
更新时间表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
PUT /v1/{project_id}/schedule/{schedule_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以从调API处获取,也可以从控制台获取。项目ID获取方式 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
| schedule_id | 是 | String | 参数解释: 时间表ID,可以通过调用[查询时间表列表接口]获得,通过返回值中的data.records.schedule_id获得 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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 | 参数解释: 绝对时间计划 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| type | 是 | Integer | 参数解释: 周期计划类型 约束限制: 不涉及 取值范围: 0:每天 1:每周的某几天 2:每周的一段时间 默认取值: 不涉及 |
| start_time | 是 | String | 参数解释: 周期计划开始时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| end_time | 是 | String | 参数解释: 周期计划结束时间 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| week_mask | 否 | Array of integers | 参数解释: 每周的某几天 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| start_week | 否 | Integer | 参数解释: 每周周期计划开始日 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| end_week | 否 | Integer | 参数解释: 每周周期计划结束日 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | data object | 参数解释: 时间表返回体 取值范围: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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" : "参数错误"
} SDK代码示例
SDK代码示例如下。
更新时间表,项目ID为a16df7cf1d094befa6bbc72cbf51e93a,防护对象ID为24988c28-1357-4738-93aa-e6a120b1d0a0,时间表ID为3ed296c8-96f7-4a6d-a1f8-746d4a8f867a,周期计划为每天00:00:00到23:59:59,名称为test,描述为test
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cfw.v1.region.CfwRegion; import com.huaweicloud.sdk.cfw.v1.*; import com.huaweicloud.sdk.cfw.v1.model.*; import java.util.List; import java.util.ArrayList; public class UpdateScheduleSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CfwClient client = CfwClient.newBuilder() .withCredential(auth) .withRegion(CfwRegion.valueOf("<YOUR REGION>")) .build(); UpdateScheduleRequest request = new UpdateScheduleRequest(); request.withScheduleId("{schedule_id}"); ScheduleInfoDTO body = new ScheduleInfoDTO(); List<ScheduleInfoDTOPeriodic> listbodyPeriodic = new ArrayList<>(); listbodyPeriodic.add( new ScheduleInfoDTOPeriodic() .withType(0) .withStartTime("00:00:00") .withEndTime("23:59:59") ); body.withPeriodic(listbodyPeriodic); body.withDescription("test"); body.withName("test"); body.withObjectId("24988c28-1357-4738-93aa-e6a120b1d0a0"); request.withBody(body); try { UpdateScheduleResponse response = client.updateSchedule(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
更新时间表,项目ID为a16df7cf1d094befa6bbc72cbf51e93a,防护对象ID为24988c28-1357-4738-93aa-e6a120b1d0a0,时间表ID为3ed296c8-96f7-4a6d-a1f8-746d4a8f867a,周期计划为每天00:00:00到23:59:59,名称为test,描述为test
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcfw.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateScheduleRequest() request.schedule_id = "{schedule_id}" listPeriodicbody = [ ScheduleInfoDTOPeriodic( type=0, start_time="00:00:00", end_time="23:59:59" ) ] request.body = ScheduleInfoDTO( periodic=listPeriodicbody, description="test", name="test", object_id="24988c28-1357-4738-93aa-e6a120b1d0a0" ) response = client.update_schedule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
更新时间表,项目ID为a16df7cf1d094befa6bbc72cbf51e93a,防护对象ID为24988c28-1357-4738-93aa-e6a120b1d0a0,时间表ID为3ed296c8-96f7-4a6d-a1f8-746d4a8f867a,周期计划为每天00:00:00到23:59:59,名称为test,描述为test
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cfw.CfwClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cfw.NewCfwClient(hcClient) request := &model.UpdateScheduleRequest{} request.ScheduleId = "{schedule_id}" var listPeriodicbody = []model.ScheduleInfoDtoPeriodic{ { Type: int32(0), StartTime: "00:00:00", EndTime: "23:59:59", }, } descriptionScheduleInfoDto:= "test" request.Body = &model.ScheduleInfoDto{ Periodic: &listPeriodicbody, Description: &descriptionScheduleInfoDto, Name: "test", ObjectId: "24988c28-1357-4738-93aa-e6a120b1d0a0", } response, err := client.UpdateSchedule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
错误码
请参见错误码。