修改地址簿。
接口說(shuō)明
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別：是指每個(gè)操作的訪問級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| yundun-cloudfirewall:ModifyAddressBook | update |
|
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
SourceIpdeprecated | string | 否 | 訪問者源 IP 地址。 | 192.0.XX.XX |
| Lang | string | 否 | 請(qǐng)求和接收消息的語(yǔ)言類型。取值：
| zh |
| AddressList | string | 否 | 地址簿中的地址列表，多個(gè)地址間用英文逗號(hào)分隔，一個(gè)地址元素用空格分隔地址和描述。當(dāng) GroupType 為 ip、port 或 domain 時(shí)，您必須配置此參數(shù)。
| 192.0.XX.XX/32 開發(fā)網(wǎng)段,192.0.XX.XX/24 測(cè)試網(wǎng)段 |
| Description | string | 是 | 地址簿的描述信息。 | bj-001 |
| GroupName | string | 是 | 地址簿的名稱。 | bj-001 |
| GroupUuid | string | 是 | 地址簿的唯一標(biāo)識(shí) ID。 說(shuō)明
修改訪問控制策略中設(shè)置的地址簿信息，需要提供該地址簿的唯一標(biāo)識(shí) ID，該 ID 可調(diào)用 DescribeAddressBook 接口查詢。
| 0657ab9d-fe8b-4174-b2a6-6baf358e**** |
| AutoAddTagEcs | string | 否 | 是否自動(dòng)添加新匹配標(biāo)簽的 ECS 公網(wǎng) IP 到地址簿。取值：
| 1 |
| TagRelation | string | 否 | 多個(gè) ECS 標(biāo)簽間的關(guān)系。取值：
| and |
| TagList | array<object> | 否 | 待匹配的標(biāo)簽列表。 | |
| object | 否 | 無(wú) | ||
| TagValue | string | 否 | 待匹配的 ECS 標(biāo)簽值。 | 1 |
| TagKey | string | 否 | 待匹配的 ECS 標(biāo)簽 Key。 | TXY |
| ModifyMode | string | 否 | 修改方式，取值說(shuō)明：
說(shuō)明
當(dāng) GroupType 為 ip、ipv6、port 或 domain 時(shí)，不配置該參數(shù)時(shí)，默認(rèn)采用 Cover 方式修改地址簿。
注意 當(dāng) GroupType 為 tag 時(shí)，該參數(shù)必須為空。 | Cover |
調(diào)用 API 時(shí)，除了本文中該 API 的請(qǐng)求參數(shù)，還需加入阿里云 API 公共請(qǐng)求參數(shù)。公共請(qǐng)求參數(shù)的詳細(xì)介紹，請(qǐng)參見公共參數(shù)。 調(diào)用 API 的請(qǐng)求格式，請(qǐng)參見本文示例中的請(qǐng)求示例。
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D"
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | ErrorParametersUid | The aliUid parameter is invalid. | aliUid 不合法 |
| 400 | ErrorDBSelect | An error occurred while querying database. | 內(nèi)部錯(cuò)誤：數(shù)據(jù)庫(kù)查詢錯(cuò)誤 |
| 400 | ErrorAddressCountExceed | The maximum number of addresses is exceeded. | 地址簿內(nèi)地址數(shù)量超出上限 |
| 400 | ErrorParametersGroupAddress | The IP address of the address group is invalid. | 地址簿IP地址錯(cuò)誤 |
| 400 | ErrorParamDomain | The parameter Domain is invalid. | 地址簿域名地址錯(cuò)誤 |
| 400 | ErrorAddressGroupNotExist | The address group does not exist. | 地址簿不存在 |
| 400 | ErrorDBInsert | An error occurred while performing an insert operation in the database. | 內(nèi)部錯(cuò)誤：數(shù)據(jù)庫(kù)插入錯(cuò)誤 |
| 400 | ErrorRecordLog | An error occurred while updating the operation log. | 寫日志失敗 |
| 400 | ErrorParametersGroupPort | The group port is invalid. | 地址簿端口錯(cuò)誤 |
| 400 | ErrorAclExtendedCountExceed | ACL or extended ACL rules are not matched. | ACL或擴(kuò)展ACL規(guī)格超出限制 |
| 400 | ErrorDBDelete | An error occurred while deleting the database. | 內(nèi)部錯(cuò)誤：數(shù)據(jù)庫(kù)刪除錯(cuò)誤 |
| 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. | 域名解析數(shù)量超過(guò)200，應(yīng)用http|https|smtp|smtps|ssl支持更多配置 |
| 401 | ErrorAuthentication | An authentication error occurred. | 認(rèn)證失敗 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-09-05 | OpenAPI 描述信息更新、OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-08-07 | OpenAPI 描述信息更新、OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |