Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

资源池 (API)

本参考演示了对 UI 具有奇偶校验的用户组 API 用法。有关完整 API 文档,请查看 Apstra Web 界面下的 REST 平台 API 参考。

要列出蓝图中的用户组插槽,请执行经过身份验证的 HTTP GET 以 https://aos-server/api/blueprints/<blueprint_id>/resource_groups

必须同时分配 ASN 池IP 池 ,才能有一张蓝图来完成构建阶段。

API - ASN 池

创建 ASN 池

创建 ASN 池的有效负载示例:

如果未指定 ID,将在 HTTP 响应中创建并返回 ID。

要创建 ASN 池,请执行 HTTP POST 以 使用 JSON 有效负载 https://aos-server/api/resources/asn-pools。

列出 ASN 池

删除 ASN 池

要删除 ASN 池,请执行 HTTP DELETE 以 https://aos-server/resources/asn-pools/{pool_id}

成功删除将返回 HTTP 200 OK。

将 ASN 分配给蓝图

要为蓝图分配 IP 池,请执行 HTTP PUT 到 https://aos-server/blueprints/<blueprint_id>/resource_groups/ip/<pool_name>

例如,要将资源池发布到 spine_loopback_ips,首先获取资源池的 ID,并将其附加到用于插槽分配的列表中。更新 IP 池安全组时,请同时指定有效负载中的所有池。我们不能添加单个池,因此一次全部添加

负载:

成功的分配会返回 HTTP 200 OK。

从蓝图中取消分配 ASN

从蓝图中移除 IP 池需要用户将空的pool_id列表放入带有有效负载 []的蓝图中:

PUT 到 HTTP 端点 https://aos-server/api/blueprints/<blueprint_id>/resource_groups/asn/<pool_name>

使用有效负载:

如果请求成功,将没有响应。

列出分配给蓝图的 ASN

可用于分配的 ASN 池用户组可以通过 HTTP GET to https://aos-server/api/blueprints/ 显示<blueprint_id>/resource_groups

API - IP 池

创建 IP 池

用于创建 IP 池的 JSON 有效负载:

子网部分需要一个具有关键词网络和值匹配 CIDR 掩码的字典列表。子网不能在同一池中相互重叠。也就是说,无法在同一池中配置 192.168.10.0/24 和 192.168.0.0/16。

标记是可选的,目前在 Apstra 中未使用。如果指定了 ID,将保存 ID,否则创建池后,将在 HTTP 响应中返回 ID。

使用 JSON 有效负载 https://aos-server/api/resources/ip-pools 的 HTTP POST 将使用新 IP 池的 ID 进行回复。

列出 IP 池

执行 HTTP GET 以 https://aos-server/api/resources/ip-pools -

删除 IP 池

要删除 IP 池,请执行 HTTP DELETE 以 https://aos-server/resources/ip-pools/{pool_id}

成功删除将返回 HTTP 200 OK 和空 JSON 响应 {}

将 IP 分配给蓝图

要为蓝图分配 IP 池,请执行 HTTP PUT 以 https://aos-server/blueprints/<blueprint_id> /resource_groups/ip/<group_name>

例如,要将资源池 spine_loopback_ips 与蓝图相关联,首先获取资源池的 ID,并将其附加到用于插槽分配的列表中。更新 IP 池安全组时,请同时指定有效负载中的所有池。我们不能添加单个池,因此一次全部添加指示 Apstra 将 IP 池与 ID'ed7d830-c703-4ac0-8252-77e0f272a677'关联到蓝图。在添加新池之前,您可能需要获取现有池 ID,以避免删除现有池。

负载:

成功分配将返回 HTTP 200 OK。

从蓝图中移除 IP

要从蓝图中移除 IP 池,请把一个空 pool_id 列表放在带有有效负载 []的蓝图上:

PUT 到 HTTP 端点 https://aos-server/api/blueprints/<blueprint_id>/resource_groups/ip/<allocation_group_name>

使用有效负载:

CURL 示例

成功移除将返回空响应: {}

列出分配给蓝图的 IP