添加訪問控制策略。
接口說明
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
yundun-cloudfirewall:AddControlPolicy | create | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SourceIpdeprecated | string | 否 | 訪問者源 IP 地址。 | 192.0.XX.XX |
Lang | string | 否 | 請求和接收消息的語言類型。取值:
| zh |
AclAction | string | 是 | 訪問控制策略中設置的流量通過云防火墻的方式。取值:
| accept |
ApplicationName | string | 否 | 訪問控制策略支持的應用類型。取值:
說明
支持的應用類型取值與協議類型(Proto)取值存在依賴關系。Proto 為 TCP 協議時,ApplicationName 支持選擇以上所有應用類型中的任意一種;Proto 為 UDP、ICMP 或 ANY 協議類型時,ApplicationName 僅支持選擇 ANY。ApplicationNameList 和 ApplicationName 二選一,必須傳其中一個,不能同時為空。
| ANY |
Description | string | 是 | 訪問控制策略的描述信息。 | 放行流量 |
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 支持選擇以上所有應用類型,使用 ["HTTP","HTTPS",……] 格式表示;Proto 為 UDP、ICMP 或 ANY 協議類型時,ApplicationNameList 僅支持選擇 ANY。ApplicationNameList 和 ApplicationName 二選一,必須傳其中一個,不能同時為空。當 ApplicationNameList 和 ApplicationName 同時傳值時,以 ApplicationNameList 為準。
| ["ANY"] | |
RepeatType | string | 否 | 訪問控制策略的策略有效期的重復類型。取值:
| Permanent |
RepeatDays | array | 否 | 訪問控制策略的策略有效期的重復日期集合。
說明
RepeatType 設置為 Weekly 時,RepeatDays 不允許重復。
說明
RepeatType 設置為 Monthly 時,RepeatDays 不允許重復。
| |
long | 否 | 訪問控制策略的策略有效期的重復日期。 說明
RepeatType 設置為 Weekly 時,取值范圍:0~6,每周開始于周日。
RepeatType 設置為 Monthly 時,取值范圍:1~31。
| 1 | |
RepeatStartTime | string | 否 | 訪問控制策略的策略有效期的重復開始時間。例如:08:00,必須為整點或半點時間,且小于重復結束時間至少半小時。 說明
當 RepeatType 為 Permanent、None 時,RepeatStartTime 為空。當 RepeatType 為 Daily、Weekly、Monthly 時,RepeatStartTime 必須有值,您需要設置重復開始時間。
| 08:00 |
RepeatEndTime | string | 否 | 訪問控制策略的策略有效期的重復結束時間。例如:23:30,必須為整點或半點時間,且大于重復開始時間至少半小時。 說明
當 RepeatType 為 Permanent、None 時,RepeatEndTime 為空。當 RepeatType 為 Daily、Weekly、Monthly 時,RepeatEndTime 必須有值,您需要設置重復結束時間。
| 23:30 |
StartTime | long | 否 | 訪問控制策略的策略有效期的開始時間。使用秒級時間戳格式表示。必須為整點或半點時間,且小于結束時間至少半小時。 說明
當 RepeatType 為 Permanent 時,StartTime 為空。當 RepeatType 為 None、Daily、Weekly、Monthly 時,StartTime 必須有值,您需要設置開始時間。
| 1694761200 |
EndTime | long | 否 | 訪問控制策略的策略有效期的結束時間。使用秒級時間戳格式表示。必須為整點或半點時間,且大于開始時間至少半小時。 說明
當 RepeatType 為 Permanent 時,EndTime 為空。當 RepeatType 為 None、Daily、Weekly、Monthly 時,EndTime 必須有值,您需要設置結束時間。
| 1694764800 |
DomainResolveType | string | 否 | 訪問控制策略的域名解析方式。取值:
| FQDN |
返回參數
示例
正常返回示例
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. | IP版本參數錯誤 |
400 | ErrorParametersDestination | The Destination parameter is invalid. | Destination參數非法 |
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. | aliUid 不合法 |
400 | ErrorParametersAppId | The AppId parameter is incorrect. | AppId不正確 |
400 | ErrorAclDomainAnyCountExceed | The number of resolved domain names cannot exceed 200. ACL configuration can be continued for HTTP, HTTPS, SMTP, SMTPS, and SSL applications. | 域名解析數量超過200,應用http|https|smtp|smtps|ssl支持更多配置 |
400 | ErrorParametersGroupPort | The group port is invalid. | 地址簿端口錯誤 |
400 | ErrorParametersFtpNotSupport | domain destination not support ftp. | 策略目的為域名時不支持FTP應用 |
400 | ErrorAclExtendedCountExceed | ACL or extended ACL rules are not matched. | ACL或擴展ACL規格超出限制 |
400 | ErrorParametersDestinationCount | Exceeding the number of countries in a single ACL. | 超出一條ACL選取區域個數, 建議拆分成多條ACL |
400 | ErrorSrcMand | Source is mandatory for this action. | 此操作需要提供指定的 source。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-08-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-07-30 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-07-25 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-10-12 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |