Skip to main content

读取完整可信网络白名单

查询组织的可信 IP 或 CIDR 网段配置，支持搜索和游标分页。返回的记录标识用于后续修改或删除网络范围。

  • Scope：admin.v1.trusted-network.read
  • 权限项：可信网络读取（trusted-network）
  • 权限类型：读取
  • 接口：GET/api/openapi/v1/network-ranges

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope；读取、管理与执行权限互不隐含。
名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key，使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识；未传入时由服务端生成。req-20260831-001

请求参数

此接口没有额外请求参数。

请求示例

curl --request GET \
  --url 'https://example.invalid/api/openapi/v1/network-ranges' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
ip_whitelistarray<string>是已保存的公网白名单；公网模式下空数组表示解除本功能的 IP 限制。["<string>"]
access_modestring是中心已确认的模式：public 为公网，private 为私网；私网名单仅供查看，不表示公网已开放。"public"
网络切换期间返回切换前已确认模式，成功完成后才更新。无法确认模式时返回 HTTP 503 / tenant_network_config_unavailable。模式缺失时不能默认公网。 
{
  "ip_whitelist": [
    "<string>"
  ],
  "access_mode": "public"
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否错误详情-
errorstring是Stable HTTP error type"<string>"

details 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}