查询组织的可信 IP 或 CIDR 网段配置,支持搜索和游标分页。返回的记录标识用于后续修改或删除网络范围。
所需权限
| 所需权限 | 资源 | Scope | 资源服务 |
|---|
| 可信网络读取(读取) | trusted-network | admin.v1.trusted-network.read | qwenwork-biz-service |
GET /api/openapi/v1/network-ranges
认证与请求头
使用应用 API Key 调用。当前接口校验上方独立 Scope;读取、管理与执行权限互不包含。
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|
| Authorization | header | string | 是 | 应用 API Key,使用 Bearer 方式传递。 | Bearer qwk_\\* |
| X-Request-Id | header | string | 否 | 可选的调用追踪标识;未传入时由服务端生成。 | req-20260831-001 |
请求参数
| 名称 | 位置 | 类型 | 必填 | 说明 | 示例 |
|---|
| search | query | string | 否 | 用于筛选可信网络记录的搜索内容。 | "<string>" |
| cursor | query | string | 否 | 上一页响应返回的 next_cursor;首次查询时不填写。 | "<string>" |
| limit | query | integer · int64 | 否 | 本次最多返回的可信网络记录数。 默认值:20。 最小值:1。 最大值:100。 | 20 |
请求示例
将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。
curl --request GET --url '<BASE_URL>/api/openapi/v1/network-ranges?search=<search>&cursor=<cursor>&limit=20' --header 'Authorization: Bearer <API_KEY>'
响应
200 请求成功,返回当前或更新后的数据。
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| items | array<OpenapifacadeTrustedNetworkResponse> | 是 | 符合查询条件的当前页记录列表。 | [{"cidr":"<string>","created_at":"2026-08-27T10:00:00Z","id":"<uuid>","name":"<string>","note":"<string>","updated_at":"2026-08-27T10:00:00Z"}] |
| items[].cidr | string | 是 | 可信 IP 地址或 CIDR 网段。 | "<string>" |
| items[].created_at | string · date-time | 是 | 此记录的创建时间。 | "2026-08-27T10:00:00Z" |
| items[].id | string · uuid | 是 | 此记录的唯一标识,查询、更新或删除对应记录时使用。 | "<uuid>" |
| items[].name | string | 是 | 用于识别此对象的名称。 | "<string>" |
| items[].note | string | null | 是 | 用于说明此可信网络记录用途的备注。 | "<string>" |
| items[].updated_at | string · date-time | 是 | 此记录最后一次更新的时间。 | "2026-08-27T10:00:00Z" |
| next_cursor | string | null | 是 | 继续读取下一批结果时使用的游标;没有后续结果时为空。 | "<string>" |
{
"items": [
{
"cidr": "<string>",
"created_at": "2026-08-27T10:00:00Z",
"id": "<uuid>",
"name": "<string>",
"note": "<string>",
"updated_at": "2026-08-27T10:00:00Z"
}
],
"next_cursor": "<string>"
}
default 请求失败,返回错误码和错误详情。
| 名称 | 类型 | 必填 | 说明 | 示例 |
|---|
| code | string | 否 | 用于程序判断错误原因的稳定业务错误码。 | "<string>" |
| detail | string | 是 | 便于阅读的错误说明。 | "<string>" |
| details | OpenapiErrorDetails | 否 | 字段校验失败时的详细信息。 | {"field":"<string>","reason":"<string>","suggestion":"<string>"} |
| details.field | string | 否 | 未通过校验的请求字段。 | "<string>" |
| details.reason | string | 否 | 稳定的校验失败原因,用于判断字段为何不合法。 | "<string>" |
| details.suggestion | string | 否 | 建议采用的规范化字段值。 | "<string>" |
| error | string | 是 | 稳定的 HTTP 错误类型。 | "<string>" |
{
"code": "<string>",
"detail": "<string>",
"details": {
"field": "<string>",
"reason": "<string>",
"suggestion": "<string>"
},
"error": "<string>"
}