全部產品
Search

搜尋本產品

    Cloud Firewall：ModifyAddressBook

    文件中心

    Cloud Firewall：ModifyAddressBook

    更新時間：Jul 07, 2026

    修改通訊錄。

    介面說明

    此介面通常用於修改通訊錄。

    QPS 限制

    此介面的單一使用者 QPS 限制為每秒 10 次。超過限制時，API 呼叫將會被限流，這可能會影響您的業務，請合理呼叫。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    yundun-cloudfirewall:ModifyAddressBook

    update

    *AddressBook

    acs:yundun-cloudfirewall::{#accountId}:addressbook/{#GroupUuid}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    SourceIp deprecated

    string

    否

    存取者來源 IP 位址。

    192.0.XX.XX
    Lang

    string

    否

    語言類型。

    枚舉值：

    • en :

      英文。

    • zh :

      中文（預設）

    zh
    AddressList

    string

    否

    通訊錄中的位址清單，多個位址之間以英文逗號分隔，單一位址元素以空格分隔位址與描述。當 GroupType 為 ip、port 或 domain 時，您必須設定此參數。

    • 當 GroupType 為 ip 時，位址清單中填寫 IP 位址，例如：1.2.XX.XX/32 開發網段，10.0.0.X/24,1.2.XX.XX/24 測試網段。

    • 當 GroupType 為 port 時，位址清單中填寫連接埠或連接埠範圍，例如：80/80 HTTP 連接埠，100/200,3306 資料庫連接埠。

    • 當 GroupType 為 domain 時，位址清單中填寫網域名稱，例如：demo1.aliyun.com 測試網域，demo2.aliyun.com,www.aliyun.com 阿里雲官網。

    192.0.XX.XX/32 ,192.0.XX.XX/24
    Description

    string

    是

    通訊錄的描述資訊。

    bj-001
    GroupName

    string

    是

    通訊錄的名稱。

    bj-001
    GroupUuid

    string

    是

    通訊錄的唯一識別碼 ID。

    說明

    取值來源：批次查詢通訊錄清單。

    0657ab9d-fe8b-4174-b2a6-6baf358e****
    AutoAddTagEcs

    string

    否

    是否自動將新匹配標籤的 ECS 公網 IP 新增至通訊錄。

    枚舉值：

    • 0 :

      不自動新增。

    • 1 :

      自動新增。

    1
    TagRelation

    string

    否

    多個 ECS 標籤之間的關係。

    枚舉值：

    • or :

      多個標籤之間為「或」關係，即只要匹配一個標籤的 ECS 公網 IP 就會被加入通訊錄。

    • and :

      多個標籤之間為「且」關係，即同時匹配多個標籤的 ECS 公網 IP 才會被加入通訊錄。

    and
    TagList

    array<object>

    否

    ECS 標籤清單。

    object

    否

    ECS 標籤。

    TagValue

    string

    否

    ECS 標籤值。

    1
    TagKey

    string

    否

    ECS 標籤鍵。

    TXY
    ModifyMode

    string

    否

    修改方式。

    說明

    當 GroupType 為 ip、ipv6、port 或 domain 時，若未設定此參數，預設採用 Cover 方式修改通訊錄。

    重要 當 GroupType 為 tag 時，此參數必須為空。

    枚舉值：

    • Delete :

      從通訊錄中刪除使用 AddressList 參數的值。

    • Cover :

      使用 AddressList 參數的值覆蓋原通訊錄。

    • Append :

      在原通訊錄後，使用 AddressList 參數的值追加修改的位址。

    Cover
    AckNamespaces

    array

    否

    ACK 叢集容器 Pod 命名空間清單。

    說明

    數量最多 10 個。

    string

    否

    ACK 叢集容器 Pod 命名空間。取值來源：

    說明

    當 GroupType 為 ackNamespace 時，必填。

    default
    AckLabels

    array<object>

    否

    ACK 叢集容器 Pod 標籤清單。

    說明

    數量最多 10 個。

    object

    否

    ACK 叢集容器 Pod 標籤。取值來源：

    說明

    當 GroupType 為 ackLabel 時，必填。

    Key

    string

    否

    ACK 叢集容器 Pod 標籤的鍵。

    app
    Value

    string

    否

    ACK 叢集容器 Pod 標籤的值。

    storage-operator

    否

    資產通訊錄，成員帳號清單。

    否

    資產通訊錄，地域與資源類型清單。

    呼叫 API 時，除了本文中該 API 的請求參數，還需加入阿里雲 API 公用請求參數。公用請求參數的詳細介紹，請參閱公用參數。 呼叫 API 的請求格式，請參閱本文範例中的請求範例。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    本次請求的 ID。

    CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 ErrorParametersUid The aliUid parameter is invalid.
    400 ErrorDBSelect An error occurred while querying database.
    400 ErrorAddressCountExceed The maximum number of addresses is exceeded.
    400 ErrorParametersGroupAddress The IP address of the address group is invalid.
    400 ErrorParamDomain The parameter Domain is invalid.
    400 ErrorAddressGroupNotExist The address group does not exist.
    400 ErrorDBInsert An error occurred while performing an insert operation in the database.
    400 ErrorRecordLog An error occurred while updating the operation log.
    400 ErrorParametersGroupPort The group port is invalid.
    400 ErrorAclExtendedCountExceed ACL or extended ACL rules are not matched.
    400 ErrorDBDelete An error occurred while deleting the database.
    400 ErrorAddressGroupExist The address group already exists.
    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 ErrorParametersAddressGroupAddressNotFound The address to be deleted does not exist in the address book.
    400 InvalidParameter.AddressBook.AddressDuplicate The address book address %s is already exist.
    400 ErrorAckClusterConnectorBusy The ACK cluster connector is operating.
    400 ErrorParameters Parameters error.
    400 ErrorParametersMemberUidMismatch The memberUid mismatch the aliUid.
    401 ErrorAuthentication An authentication error occurred.
    404 ErrorAckClusterConnectorNotFound The specified resource ACK cluster connector is not found.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。