Appearance
更新 EAB IP 白名单
PUT
/openapi/v3/acme/eabs/:kid/white-ips
全量替换指定 ACME EAB 的 IP 白名单。配置后,只有来自白名单来源 IP 的 ACME 请求才能使用该 EAB 注册账户。
Path 参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| kid | string | 是 | 当前有效 EAB 的 Key ID |
Body 参数 application/json
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| white_ips | array[string] | 是 | IP 白名单,全量替换语义。数组项支持单个 IP(IPv4/IPv6)或 CIDR 网段,单项内也支持逗号或换行分隔多个条目;最多 50 条。传显式空数组 [] 表示清空白名单;缺失或 null 返回 invalid_parameters |
返回数据
| 参数名称 | 类型 | 描述 |
|---|---|---|
| order_id | string | EAB 绑定的订单 ID |
| eab_kid | string | 当前有效 EAB 的 Key ID |
| white_ips | array[string] | 更新后生效的白名单(已规范化:CIDR 统一为掩码后的网段地址,IPv6 统一为小写形式) |
清空白名单的风险
空白名单表示不限制来源 IP。white_ips 传 [] 会放开全部来源,请确认这是预期行为;字段缺失或传 null 会被拒绝,不会误判为清空。
TIP
kid 必须是当前有效的 EAB:已轮换作废的 kid 会被拒绝(order_acme_eab_not_found_for_rotate),避免把白名单静默写到新凭证上。轮换 EAB 后请使用新的 eab_kid 调用本接口。
bash
curl -X PUT 'https://api.certcloud.cn/openapi/v3/acme/eabs/eab-9f3k2d/white-ips' \
-H 'Content-Type: application/json' \
-H 'X-CC-Auth-Key: your-auth-key' \
-H 'X-CC-Key-ID: your-key-id' \
-d '{
"white_ips": ["203.0.113.10", "2001:db8::/32"]
}'错误说明
| 编号 | code | HTTP | 说明 |
|---|---|---|---|
| 101 | invalid_parameters | 400 | white_ips 缺失、为 null、存在非法 IP/CIDR 条目或超过 50 条上限 |
| 19505 | order_not_found | 400 | EAB 所属订单不存在,或当前账户无权访问 |
| 33020 | 33020 | 400 | 当前订单状态不允许维护 EAB(如订单已取消、过期) |
| 33074 | 33074 | 400 | 该产品目前不支持 ACME |
| 33181 | order_org_validation_not_passed_for_acme_eab | 400 | 订单组织验证未通过 |
| 33182 | order_acme_eab_not_found_for_rotate | 400 | kid 不存在或已失效 |
通用错误(unauthenticated_request、permission_denied 等)见错误码说明。本接口无接口级限流,仅受全局限流保护。
