新增存取控制策略。
介面說明
您可以使用本介面建立一條對經過雲端防火牆流量放行、拒絕或觀察的策略。
QPS 限制
本介面的單使用者 QPS 限制為 10 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理呼叫。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
yundun-cloudfirewall:AddControlPolicy |
create |
*ControlPolicy
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
SourceIp
deprecated
|
string |
否 |
存取者來源 IP 位址。 |
192.0.XX.XX |
| Lang |
string |
否 |
請求和接收訊息的語言類型。取值:
|
zh |
| AclAction |
string |
是 |
存取控制策略中設定的流量通過雲端防火牆的方式。取值:
|
accept |
ApplicationName
deprecated
|
string |
否 |
存取控制策略支援的應用類型。取值:
說明
支援的應用類型取值與協定類型(Proto)取值存在依賴關係。Proto 為 TCP 協定時,ApplicationName 支援選擇以上所有應用類型中的任意一種;Proto 為 UDP、ICMP 或 ANY 協定類型時,ApplicationName 僅支援選擇 ANY。ApplicationNameList 和 ApplicationName 二選一,必須傳其中一個,不能同時為空。 |
ANY |
| Description |
string |
是 |
存取控制策略的描述資訊。 |
Release flow |
| DestPort |
string |
否 |
存取控制策略中流量存取的目的連接埠。取值:
說明
協定類型為 ICMP 時,不支援對目的連接埠進行存取控制。
說明
存取控制策略目的連接埠類型選擇 group(目的連接埠位址簿)時,您無需設定具體的目的連接埠號。需要該存取控制策略管控的所有連接埠會包含在目的連接埠位址簿中。
|
80 |
| Destination |
string |
是 |
存取控制策略中的目的位址段。 取值:
說明
當 Destination 為目的區域時,更多資訊,請參見 地區編號。 |
192.0.XX.XX/24 |
| DestinationType |
string |
是 |
存取控制策略中的目的位址類型。取值:
|
net |
| Direction |
string |
是 |
存取控制策略的流量方向。取值:
|
in |
| Proto |
string |
是 |
存取控制策略中流量存取的協定類型。取值:
說明
流量方向為出向時,存取的目的位址為網域名稱類型的威脅情報位址簿或雲端服務位址簿時,只允許設定 TCP 協定,應用可選 HTTP/HTTPS/SMTP/SMTPS/SSL 五種。 |
ANY |
| Source |
string |
是 |
存取控制策略中的來源位址。取值:
說明
當 Source 為來源區域時,更多資訊,請參見 地區編號。 |
192.0.XX.XX/24 |
| SourceType |
string |
是 |
存取控制策略中的來源位址類型。取值:
|
net |
| NewOrder |
string |
是 |
存取控制策略生效的優先順序。優先順序數字從 1 開始順序遞增,優先順序數字越小,優先順序越高。 |
1 |
| DestPortType |
string |
否 |
存取控制策略中流量存取的目的連接埠類型。 取值:
|
port |
| DestPortGroup |
string |
否 |
存取控制策略中存取流量的目的連接埠位址簿名稱。 說明
DestPortType 設定為 group 時,您需要設定目的連接埠位址簿名稱。 |
my_port_group |
| Release |
string |
否 |
存取控制策略的啟用狀態。策略建立後預設啟用該策略。取值:
|
true |
| IpVersion |
string |
否 |
支援的 IP 位址版本。 取值:
|
6 |
| ApplicationNameList |
array |
否 |
存取控制策略支援的應用類型列表。 |
|
|
string |
否 |
存取控制策略支援的應用類型。取值:
說明
支援的應用類型取值與協定類型(Proto)取值存在依賴關係。Proto 為 TCP 協定時,ApplicationNameList 支援選擇以上所有應用類型,使用 |
["ANY"] |
|
| RepeatType |
string |
否 |
存取控制策略的策略有效期的重複類型。取值:
枚舉值:
|
Permanent |
| RepeatDays |
array |
否 |
存取控制策略的策略有效期的重複日期集合。
說明
RepeatType 設定為 Weekly 時,RepeatDays 不允許重複。
說明
RepeatType 設定為 Monthly 時,RepeatDays 不允許重複。 |
|
|
integer |
否 |
存取控制策略的策略有效期的重複日期。 說明
RepeatType 設定為 Weekly 時,取值範圍:0~6,每週開始於週日。 RepeatType 設定為 Monthly 時,取值範圍:1~31。 |
1 |
|
| RepeatStartTime |
string |
否 |
存取控制策略的策略有效期的重複開始時間。例如:08:00,必須為整點或半點時間,且小於重複結束時間至少半小時。 說明
當 RepeatType 為 Permanent、None 時,RepeatStartTime 為空。當 RepeatType 為 Daily、Weekly、Monthly 時,RepeatStartTime 必須有值,您需要設定重複開始時間。 時間格式為 HH:mm(24 小時制),例如 08:00、23:30。 |
08:00 |
| RepeatEndTime |
string |
否 |
存取控制策略的策略有效期的重複結束時間。例如:23:30,必須為整點或半點時間,且大於重複開始時間至少半小時。 說明
當 RepeatType 為 Permanent、None 時,RepeatEndTime 為空。當 RepeatType 為 Daily、Weekly、Monthly 時,RepeatEndTime 必須有值,您需要設定重複結束時間。 時間格式為 HH:mm(24 小時制),例如 08:00、23:30。 |
23:30 |
| StartTime |
integer |
否 |
存取控制策略的策略有效期的開始時間。使用秒級時間戳格式表示。必須為整點或半點時間,且小於結束時間至少半小時。 說明
當 RepeatType 為 Permanent 時,StartTime 為空。當 RepeatType 為 None、Daily、Weekly、Monthly 時,StartTime 必須有值,您需要設定開始時間。 |
1694761200 |
| EndTime |
integer |
否 |
存取控制策略的策略有效期的結束時間。使用秒級時間戳格式表示。必須為整點或半點時間,且大於開始時間至少半小時。 說明
當 RepeatType 為 Permanent 時,EndTime 為空。當 RepeatType 為 None、Daily、Weekly、Monthly 時,EndTime 必須有值,您需要設定結束時間。 |
1694764800 |
| DomainResolveType |
string |
否 |
存取控制策略的網域名稱解析方式。取值:
|
FQDN |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| AclUuid |
string |
網際網路邊界防火牆存取控制策略的唯一標識 ID。 |
00281255-d220-4db1-8f4f-c4df221ad84c |
| RequestId |
string |
回傳結果的請求 ID。 |
CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D |
樣本
正常返回樣本
JSON格式
{
"AclUuid": "00281255-d220-4db1-8f4f-c4df221ad84c",
"RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | ErrorAddressCountExceed | The maximum number of addresses is exceeded. | |
| 400 | ErrorParametersSource | The source is invalid. | |
| 400 | ErrorDomainResolve | An error occurred while resolving the domain. | |
| 400 | ErrorParametersDirection | The direction is invalid. | |
| 400 | ErrorDBSelect | An error occurred while querying database. | |
| 400 | ErrorParameterIpVersion | The IP version is invalid. | |
| 400 | ErrorParametersDestination | The Destination parameter is invalid. | |
| 400 | ErrorParametersProto | The protocol is invalid. | |
| 400 | ErrorParametersDestPort | The dst_port is invalid. | |
| 400 | ErrorParametersAction | The action is invalid. | |
| 400 | ErrorParametersUid | The aliUid parameter is invalid. | |
| 400 | ErrorAclDomainAnyCountExceed | The number of resolved domain names cannot exceed 200. ACL configuration can be continued for HTTP, HTTPS, SMTP, SMTPS, and SSL applications. | |
| 400 | ErrorParametersGroupPort | The group port is invalid. | |
| 400 | ErrorParametersFtpNotSupport | domain destination not support ftp. | |
| 400 | ErrorAclExtendedCountExceed | ACL or extended ACL rules are not matched. | |
| 400 | ErrorParametersDestinationCount | Exceeding the number of countries in a single ACL. | |
| 400 | ErrorSrcMand | Source is mandatory for this action. | |
| 400 | ErrorEmptyDomainResolveType | Empty DomainResolveType only support HTTP/HTTPS/SSL/SMTP/SMTPS apps. | |
| 400 | ErrorAddressGroupNotExist | The address group does not exist. | |
| 400 | ErrorParametersApplicationNameList | Specified parameter ApplicationNameList is not valid. | |
| 400 | ErrorParametersApplicationName | Specified parameter ApplicationName is not valid. | |
| 400 | ErrorApplicationTemplateNotFound | Application template not found. | |
| 400 | ErrorWebFilterTemplateNotFound | Web filter template not found. | |
| 400 | ErrorParameters | Parameters error. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。