修改地址簿。
介面說明
本介面一般用於修改地址簿。
QPS 限制
本介面的單使用者 QPS 限制為 10 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
SourceIp
deprecated
|
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 |
是 |
地址簿的描述資訊。 |
bj-001 |
| GroupName |
string |
是 |
地址簿的名稱。 |
bj-001 |
| GroupUuid |
string |
是 |
地址簿的唯一標識 ID。 說明
取值來源:批量查詢地址簿列表。 |
0657ab9d-fe8b-4174-b2a6-6baf358e**** |
| AutoAddTagEcs |
string |
否 |
是否自動添加新匹配標籤的 ECS 公網 IP 到地址簿。 枚舉值:
|
1 |
| TagRelation |
string |
否 |
多個 ECS 標籤間的關係。 枚舉值:
|
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 時,該參數必須為空白。 枚舉值:
|
Cover |
| AckNamespaces |
array |
否 |
ACK 叢集容器組命名空間列表。 說明
數量最多 10 個。 |
|
|
string |
否 |
ACK 叢集容器組命名空間。取值來源:
說明
當 GroupType 為 ackNamespace 時,必填。 |
default |
|
| AckLabels |
array<object> |
否 |
ACK 叢集容器組標籤列表。 說明
數量最多 10 個。 |
|
|
object |
否 |
ACK 叢集容器組標籤。取值來源:
說明
當 GroupType 為 ackLabel 時,必填。 |
||
| Key |
string |
否 |
ACK 叢集容器組標籤的鍵。 |
app |
| Value |
string |
否 |
ACK 叢集容器組標籤的值。 |
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. | aliUid 不合法 |
| 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. | 地址簿IP地址錯誤 |
| 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. | ACL或擴充ACL規格超出限制 |
| 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. | 網域名稱解析數量超過200,應用http|https|smtp|smtps|ssl支援更多配置 |
| 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. | 地址簿中的地址%s已存在。 |
| 400 | ErrorAckClusterConnectorBusy | The ACK cluster connector is operating. | 指定的ACK叢集連接器正在操作中。 |
| 401 | ErrorAuthentication | An authentication error occurred. | 認證失敗 |
| 404 | ErrorAckClusterConnectorNotFound | The specified resource ACK cluster connector is not found. | 指定資源的ACK叢集連接器不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。