添加安全訪問控制地址簿,包括IP地址簿、ECS標簽地址簿、端口地址簿和域名地址簿。
接口說明
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
yundun-cloudfirewall:AddAddressBook | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SourceIpdeprecated | string | 否 | 訪問者源 IP 地址。 | 192.0.XX.XX |
Lang | string | 否 | 接收消息的語言類型。
| zh |
AddressList | string | 是 | 地址簿的地址列表,多個地址間用英文逗號分隔,一個地址元素用空格分隔地址和描述。 說明
當 GroupType 為 ip 、port 或domain 時必須設置。
| 192.0.XX.XX/32 開發網段,192.0.XX.XX/24 測試網段 |
Description | string | 是 | 地址簿的描述信息。 | sz-001 |
GroupName | string | 是 | 地址簿的名稱。 | sz-001 |
GroupType | string | 是 | 地址簿的類型,可選值包括:
| ip |
AutoAddTagEcs | string | 否 | 是否自動添加新匹配標簽的 ECS 公網 IP 到地址簿。
| 1 |
TagRelation | string | 否 | 待匹配的多個 ECS 標簽間的關系。
| and |
TagList | array<object> | 否 | 待匹配的標簽列表信息。 | |
object | 否 | 無 | ||
TagValue | string | 否 | 待匹配的 ECS 標簽值。 | 1 |
TagKey | string | 否 | 待匹配的 ECS 標簽 Key。 | TXY |
調用 API 時,除了本文中該 API 的請求參數,還需加入阿里云 API 公共請求參數。公共請求參數的詳細介紹,請參見公共參數。 調用 API 的請求格式,請參見本文示例中的請求示例。
返回參數
示例
正常返回示例
JSON
格式
{
"GroupUuid": "f04ac7ce-628b-4cb7-be61-310222b7****",
"RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ErrorParametersGroupType | The group type is invalid. | 無效的group類型 |
400 | ErrorParametersUid | The aliUid parameter is invalid. | aliUid 不合法 |
400 | ErrorParametersGroupAddress | The IP address of the address group is invalid. | 地址簿IP地址錯誤 |
400 | ErrorDBSelect | An error occurred while querying database. | 內部錯誤:數據庫查詢錯誤 |
400 | ErrorAddressCountExceed | The maximum number of addresses is exceeded. | 地址簿內地址數量超出上限 |
400 | ErrorAddressGroupExist | The address group already exists. | 分組已存在 |
400 | ErrorParamDomain | The parameter Domain is invalid. | 地址簿域名地址錯誤 |
400 | ErrorUUIDNew | The UUID is invalid. | 內部錯誤:UUID錯誤 |
400 | ErrorAddressGroupCountExceed | The maximum number of address group is exceeded. | 地址簿數量超出上限 |
400 | ErrorDBInsert | An error occurred while performing an insert operation in the database. | 內部錯誤:數據庫插入錯誤 |
400 | ErrorRecordLog | An error occurred while updating the operation log. | 寫日志失敗 |
400 | ErrorDBUpdate | internal error: sql updat. | 請求錯誤,數據庫更新失敗。 |
400 | ErrorParametersTagKey | The tag key is invalid. | 無效的tag key |
400 | ErrorParametersTagList | The tag list is invalid. | 無效的tag list |
400 | ErrorTagCountExceed | The maximum number of tag is exceeded. | tag數量超出上限 |
400 | ErrorParametersTagRelation | The tag relation is invalid. | 無效的tag relation |
400 | ErrorParametersGroupPort | The group port is invalid. | 地址簿端口錯誤 |
400 | ErrorPortCountExceed | The maixmum number of port in the group is exceeded. | 地址簿內端口數量超出上限 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|