文档

ModifyControlPolicy - 修改安全访问控制策略的配置信息

更新时间:

修改安全访问控制策略的配置信息。

接口说明

本接口一般用于修改流量通过云防火墙方式为放行、拒绝或观察的访问控制策略的配置信息。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-cloudfirewall:ModifyControlPolicyWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Langstring

请求和接收消息的语言类型。取值:

  • zh(默认):中文
  • en:英文
zh
AclActionstring

安全访问控制策略中流量通过云防火墙的方式。取值:

  • accept:放行
  • drop:拒绝
  • log:观察
accept
ApplicationNamestring

安全访问控制策略支持的应用类型。支持的应用类型有以下几种:

  • ANY
  • HTTP
  • HTTPS
  • MySQL
  • SMTP
  • SMTPS
  • RDP
  • VNC
  • SSH
  • Redis
  • MQTT
  • MongoDB
  • Memcache
  • SSL
说明 ANY 表示策略应用在所有类型的应用中。
说明 ApplicationNameList 和 ApplicationName 二选一,必须传其中一个,不能同时为空。当 ApplicationNameList 和 ApplicationName 同时传值时,以 ApplicationNameList 为准。
HTTP
Descriptionstring

安全访问控制策略的描述信息。

test
DestPortstring

安全访问控制策略中流量访问的目的端口。

80
Destinationstring

安全访问控制策略中的目的地址。

  • DestinationType 为 net 时,Destination 为目的 CIDR。例如:1.2.XX.XX/24
  • DestinationType 为 group 时,Destination 为目的地址簿名称。例如:db_group
  • DestinationType 为 domain 时,Destination 为目的域名。例如:*.aliyuncs.com
  • DestinationType 为 location 时,Destination 为目的区域(具体区域位置编码见后文)。例如: ["BJ11", "ZB"]
192.0.XX.XX/24
DestinationTypestring

安全访问控制策略中的目的地址类型。取值:

  • net:目的网段(CIDR)
  • group:目的地址簿
  • domain:目的域名
  • location:目的区域
net
Directionstring

安全访问控制策略的流量方向。取值:

  • in:外对内流量访问控制
  • out:内对外流量访问控制
in
Protostring

安全访问控制策略中流量访问的安全协议类型。支持的应用类型有以下几种:

  • ANY
  • TCP
  • UDP
  • ICMP
说明 ANY 表示策略应用在所有类型的应用中。
说明 流量方向为出向时,访问的目的地址为域名类型的威胁情报地址簿或云服务地址簿时,可选配置 TCP/ANY 协议。选择 TCP 时,应用可选 HTTP/HTTPS/SMTP/SMTPS/SSL 五种,选择 ANY 时,应用可选 ANY。
TCP
Sourcestring

安全访问控制策略中的源地址。

  • SourceType 为 net 时,Source 为源 CIDR。例如:1.2.XX.XX/24
  • SourceType 为 group 时,Source 为源地址簿名称。例如:db_group
  • SourceType 为 location 时,Source 为源区域(具体区域位置编码见后文)。例如["BJ11", "ZB"]
192.0.XX.XX/24
AclUuidstring

安全访问控制策略的唯一标识 ID。

说明 修改安全访问控制策略,需要提供该策略的唯一标识 ID,该 ID 可调用 DescribeControlPolicy 接口获取。
00281255-d220-4db1-8f4f-c4df221ad84c
SourceTypestring

安全访问控制策略中的源地址类型。取值:

  • net:源网段(CIDR)

  • group:源地址簿

  • location:源区域

net
DestPortTypestring

安全访问控制策略中流量访问的目的端口类型。取值:

  • port:端口
  • group:端口地址簿
port
DestPortGroupstring

安全访问控制策略中流量访问的目的端口地址簿名称。

my_port_group
Releasestring

安全访问控制策略的状态。取值:

  • true:策略开启状态
  • false:策略关闭状态
true
ApplicationNameListarray

应用名称列表。

说明 ApplicationNameList 和 ApplicationName 二选一,必须传其中一个,不能同时为空。当 ApplicationNameList 和 ApplicationName 同时传值时,以 ApplicationNameList 为准。
string

应用名称。

HTTP
RepeatTypestring

访问控制策略的策略有效期的重复类型。取值:

  • Permanent(默认):总是
  • None:指定单次时间
  • Daily:每天
  • Weekly:每周
  • Monthly:每月
Permanent
RepeatDaysarray

访问控制策略的策略有效期的重复日期集合。

  • 当 RepeatType 为PermanentNoneDaily时,RepeatDays 为空集合。 例如:[]
  • 当 RepeatType 为 Weekly 时,RepeatDays 不能为空。 例如:[0, 6]
说明 RepeatType 设置为 Weekly 时,RepeatDays 不允许重复。
  • 当 RepeatType 为Monthly时,RepeatDays 不能为空。 例如:[1, 31]
说明 RepeatType 设置为 Monthly 时,RepeatDays 不允许重复。
long

访问控制策略的策略有效期的重复日期。

说明 RepeatType 设置为 Weekly 时,取值范围:0~6,每周开始于周日。 RepeatType 设置为 Monthly 时,取值范围:1~31。
1
RepeatStartTimestring

访问控制策略的策略有效期的重复开始时间。例如:08:00,必须为整点或半点时间,且小于重复结束时间至少半小时。

说明 当 RepeatType 为 Permanent、None 时,RepeatStartTime 为空。当 RepeatType 为 Daily、Weekly、Monthly 时,RepeatStartTime 必须有值,您需要设置重复开始时间。
08:00
RepeatEndTimestring

访问控制策略的策略有效期的重复结束时间。例如:23:30,必须为整点或半点时间,且大于重复开始时间至少半小时。

说明 当 RepeatType 为 Permanent、None 时,RepeatEndTime 为空。当 RepeatType 为 Daily、Weekly、Monthly 时,RepeatEndTime 必须有值,您需要设置重复结束时间。
23:30
StartTimelong

访问控制策略的策略有效期的开始时间。使用秒级时间戳格式表示。必须为整点或半点时间,且小于结束时间至少半小时。

说明 当 RepeatType 为 Permanent 时,StartTime 为空。当 RepeatType 为 None、Daily、Weekly、Monthly 时,StartTime 必须有值,您需要设置开始时间。
1694761200
EndTimelong

访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间,且大于开始时间至少半小时。

说明 当 RepeatType 为 Permanent 时,EndTime 为空。当 RepeatType 为 None、Daily、Weekly、Monthly 时,EndTime 必须有值,您需要设置结束时间。
1694764800

返回参数

名称类型描述示例值
object
RequestIdstring

结果的请求 ID。

CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D

示例

正常返回示例

JSON格式

{
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D"
}

错误码

HTTP status code错误码错误信息描述
400ErrorParametersUidThe aliUid parameter is invalid.aliUid 不合法
400ErrorParametersDirectionThe direction is invalid.无效的方向
400ErrorDBSelectAn error occurred while querying database.内部错误:数据库查询错误
400ErrorRecordLogAn error occurred while updating the operation log.写日志失败
400ErrorParametersError Parameters参数错误
400ErrorParametersSourceThe source is invalid.无效的来源

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-10-12OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:RepeatType
    新增入参:RepeatDays
    新增入参:RepeatStartTime
    新增入参:RepeatEndTime
    新增入参:StartTime
    新增入参:EndTime
  • 本页导读 (1)
文档反馈