跳转到内容
API Enriched

🌍 站点 API

AWS、Azure、GCP VPC 与中转网关的集成。基于标签的选择，用于跨区域应用策略。

  • 类别：基础设施
  • 复杂度：高级
  • 路径数：133 | Schema 数：1015
  • 层级：标准
  • 相关域：cloud_infrastructure、customer_edge、managed_kubernetes

使用场景

Section titled “使用场景”
  • 跨云提供商（AWS、Azure、GCP）部署 F5 XC
  • 管理 XCKS（托管 Kubernetes）站点部署（原 AppStack）
  • 为以网络为中心的边缘部署部署 Secure Mesh 站点
  • 将外部 Kubernetes 集群集成为 Customer Edge
  • 配置 AWS VPC、Azure VNet 和 GCP VPC 站点
  • 管理虚拟站点和站点策略

主要资源

Section titled “主要资源”
  • site：边缘服务的物理或云部署位置
  • virtual_site：使用标签选择器对站点进行逻辑分组
  • site_mesh_group：多站点之间的网格连接配置

端点

Section titled “端点”
方法路径描述
POST/api/config/namespaces/{metadata.namespace}/aws_tgw_sites创建 AWS TGW 站点。
PUT/api/config/namespaces/{metadata.namespace}/aws_tgw_sites/{metadata.name}替换 AWS TGW 站点。
POST/api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_tgw_info配置 TGW 信息。
POST/api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_vip_info配置 AWS TGW 站点 VIP 信息。
POST/api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_vpc_ip_prefixes配置 VPC IP 前缀。
POST/api/config/namespaces/{namespace}/aws_tgw_site/{name}/set_vpn_tunnels配置 VPN 隧道。
POST/api/config/namespaces/{namespace}/aws_tgw_site/{name}/validate_config验证 AWS TGW 配置。
GET/api/config/namespaces/{namespace}/aws_tgw_sites列出配置 AWS TGW 站点。
GET/api/config/namespaces/{namespace}/aws_tgw_sites/{name}获取 AWS TGW 站点。
DELETE/api/config/namespaces/{namespace}/aws_tgw_sites/{name}删除配置 AWS TGW 站点。
POST/api/config/namespaces/{metadata.namespace}/aws_vpc_sites创建 AWS VPC 站点。
PUT/api/config/namespaces/{metadata.namespace}/aws_vpc_sites/{metadata.name}替换 AWS VPC 站点。
POST/api/config/namespaces/{namespace}/aws_vpc_site/{name}/set_cloud_site_info配置 AWS VPC 站点信息。
POST/api/config/namespaces/{namespace}/aws_vpc_site/{name}/set_vip_info配置 AWS VPC 站点 VIP 信息。
POST/api/config/namespaces/{namespace}/aws_vpc_site/{name}/storage/set_vpc_k8s_hostnames配置 VPC K8s 主机名。
POST/api/config/namespaces/{namespace}/aws_vpc_site/{name}/validate_config验证 AWS VPC 站点配置。
GET/api/config/namespaces/{namespace}/aws_vpc_sites列出配置 AWS VPC 站点。
GET/api/config/namespaces/{namespace}/aws_vpc_sites/{name}获取 AWS VPC 站点。
DELETE/api/config/namespaces/{namespace}/aws_vpc_sites/{name}删除配置 AWS VPC 站点。
POST/api/config/namespaces/{metadata.namespace}/voltstack_sites创建 App Stack 站点。
PUT/api/config/namespaces/{metadata.namespace}/voltstack_sites/{metadata.name}替换 App Stack 站点。
GET/api/config/namespaces/{namespace}/voltstack_sites列出配置 App Stack 站点。
GET/api/config/namespaces/{namespace}/voltstack_sites/{name}获取 App Stack 站点。
DELETE/api/config/namespaces/{namespace}/voltstack_sites/{name}删除配置 App Stack 站点。
POST/api/config/namespaces/{metadata.namespace}/azure_vnet_sites创建 Azure VNet 站点。
PUT/api/config/namespaces/{metadata.namespace}/azure_vnet_sites/{metadata.name}替换 Azure VNet 站点。
POST/api/config/namespaces/{namespace}/azure_vnet_site/{name}/set_cloud_site_info配置 Azure VNet 站点信息。
POST/api/config/namespaces/{namespace}/azure_vnet_site/{name}/set_vip_info配置 Azure VNet 站点 VIP 信息。
POST/api/config/namespaces/{namespace}/azure_vnet_site/{name}/validate_config验证 Azure VNet 站点配置。
GET/api/config/namespaces/{namespace}/azure_vnet_sites列出配置 Azure VNet 站点。
GET/api/config/namespaces/{namespace}/azure_vnet_sites/{name}获取 Azure VNet 站点。
DELETE/api/config/namespaces/{namespace}/azure_vnet_sites/{name}删除配置 Azure VNet 站点。
POST/api/config/namespaces/{metadata.namespace}/gcp_vpc_sites创建 GCP VPC 站点。
PUT/api/config/namespaces/{metadata.namespace}/gcp_vpc_sites/{metadata.name}替换 GCP VPC 站点。
POST/api/config/namespaces/{namespace}/gcp_vpc_site/{name}/set_cloud_site_info配置 GCP VPC 站点信息。
POST/api/config/namespaces/{namespace}/gcp_vpc_site/{name}/validate_config验证 GCP VPC 站点配置。
GET/api/config/namespaces/{namespace}/gcp_vpc_sites列出配置 GCP VPC 站点。
GET/api/config/namespaces/{namespace}/gcp_vpc_sites/{name}获取 GCP VPC 站点。
DELETE/api/config/namespaces/{namespace}/gcp_vpc_sites/{name}删除配置 GCP VPC 站点。
POST/api/config/namespaces/{metadata.namespace}/securemesh_sites创建 Secure Mesh 站点。
PUT/api/config/namespaces/{metadata.namespace}/securemesh_sites/{metadata.name}替换 Secure Mesh 站点。
GET/api/config/namespaces/{namespace}/securemesh_sites列出配置 Secure Mesh 站点。
GET/api/config/namespaces/{namespace}/securemesh_sites/{name}获取 Secure Mesh 站点。
DELETE/api/config/namespaces/{namespace}/securemesh_sites/{name}删除配置 Secure Mesh 站点。
POST/api/config/namespaces/{metadata.namespace}/securemesh_site_v2s创建 Secure Mesh 站点。
PUT/api/config/namespaces/{metadata.namespace}/securemesh_site_v2s/{metadata.name}替换 Secure Mesh 站点。
GET/api/config/namespaces/{namespace}/securemesh_site_v2s列出配置 Secure Mesh 站点。
GET/api/config/namespaces/{namespace}/securemesh_site_v2s/{name}获取 Secure Mesh 站点。
DELETE/api/config/namespaces/{namespace}/securemesh_site_v2s/{name}删除配置 Secure Mesh 站点。
POST/api/config/namespaces/{metadata.namespace}/k8s_clusters创建配置规范。
PUT/api/config/namespaces/{metadata.namespace}/k8s_clusters/{metadata.name}替换配置规范。
GET/api/config/namespaces/{namespace}/k8s_clusters列出 K8s 集群。
GET/api/config/namespaces/{namespace}/k8s_clusters/{name}获取配置规范。
DELETE/api/config/namespaces/{namespace}/k8s_clusters/{name}删除 K8s 集群。
POST/api/data/namespaces/{namespace}/firewall_logs防火墙日志查询。
POST/api/data/namespaces/{namespace}/firewall_logs/aggregation防火墙日志聚合查询。
GET/api/data/namespaces/{namespace}/firewall_logs/scroll防火墙日志滚动查询。
POST/api/data/namespaces/{namespace}/firewall_logs/scroll防火墙日志滚动查询。
GET/api/data/namespaces/{namespace}/k8s_audit_logs/scrollK8s 审计日志滚动查询。
POST/api/data/namespaces/{namespace}/k8s_audit_logs/scrollK8s 审计日志滚动查询。
GET/api/data/namespaces/{namespace}/k8s_events/scrollK8s 事件滚动查询。
POST/api/data/namespaces/{namespace}/k8s_events/scrollK8s 事件滚动查询。
POST/api/data/namespaces/{namespace}/platform_events平台事件查询。
POST/api/data/namespaces/{namespace}/platform_events/aggregation平台事件聚合查询。
GET/api/data/namespaces/{namespace}/platform_events/scroll平台事件滚动查询。
POST/api/data/namespaces/{namespace}/platform_events/scroll平台事件滚动查询。
POST/api/data/namespaces/{namespace}/site/{site}/external_connector/{external_connector}/logs外部连接器日志查询。
POST/api/data/namespaces/{namespace}/site/{site}/k8s_audit_logsK8s 审计日志查询。
POST/api/data/namespaces/{namespace}/site/{site}/k8s_audit_logs/aggregationK8s 审计日志聚合查询。
POST/api/data/namespaces/{namespace}/site/{site}/k8s_eventsK8s 事件查询。
POST/api/data/namespaces/{namespace}/site/{site}/k8s_events/aggregationK8s 事件聚合查询。
POST/api/data/namespaces/{namespace}/vk8s_audit_logsVK8s 审计日志查询。
POST/api/data/namespaces/{namespace}/vk8s_audit_logs/aggregationVK8s 审计日志聚合查询。
GET/api/data/namespaces/{namespace}/vk8s_audit_logs/scrollVK8s 审计日志滚动查询。
POST/api/data/namespaces/{namespace}/vk8s_audit_logs/scrollVK8s 审计日志滚动查询。
POST/api/data/namespaces/{namespace}/vk8s_eventsVK8s 事件查询。
POST/api/data/namespaces/{namespace}/vk8s_events/aggregationVK8s 事件聚合查询。
GET/api/data/namespaces/{namespace}/vk8s_events/scrollVK8s 事件滚动查询。
POST/api/data/namespaces/{namespace}/vk8s_events/scrollVK8s 事件滚动查询。
POST/api/web/namespaces/system/revoke/global-kubeconfigs撤销全局 Kubeconfig。
POST/api/data/namespaces/system/site/{name}/status检查站点是否存在。
GET/api/data/namespaces/system/site/{site}/api/v1/configmapsConfigMap 列表。
GET/api/data/namespaces/system/site/{site}/api/v1/endpointsEndpoints 列表。
GET/api/data/namespaces/system/site/{site}/api/v1/namespacesNamespace 列表。
GET/api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/configmapsConfigMap 列表。
GET/api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/endpointsEndpoints 列表。
GET/api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/persistentvolumeclaimsPersistentVolumeClaim 列表。
GET/api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/podsPod 列表
GET/api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/secretsSecret 列表。
GET/api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/servicesService 列表。
GET/api/data/namespaces/system/site/{site}/api/v1/nodesNamespace 列表。
GET/api/data/namespaces/system/site/{site}/api/v1/persistentvolumeclaimsPersistentVolumeClaim 列表。
GET/api/data/namespaces/system/site/{site}/api/v1/persistentvolumesPersistentVolume 列表。
GET/api/data/namespaces/system/site/{site}/api/v1/podsPod 列表
GET/api/data/namespaces/system/site/{site}/api/v1/secretsSecret 列表。
GET/api/data/namespaces/system/site/{site}/api/v1/servicesService 列表。
GET/api/data/namespaces/system/site/{site}/apis/apps/v1/daemonsetsDaemonSet 列表。
GET/api/data/namespaces/system/site/{site}/apis/apps/v1/deploymentsDeployment 列表。
GET/api/data/namespaces/system/site/{site}/apis/apps/v1/namespaces/{namespace}/daemonsetsDaemonSet 列表。
GET/api/data/namespaces/system/site/{site}/apis/apps/v1/namespaces/{namespace}/deploymentsDeployment 列表。
GET/api/data/namespaces/system/site/{site}/apis/apps/v1/namespaces/{namespace}/replicasetsReplicaSet 列表。
GET/api/data/namespaces/system/site/{site}/apis/apps/v1/namespaces/{namespace}/statefulsetsStatefulSet 列表。
GET/api/data/namespaces/system/site/{site}/apis/apps/v1/replicasetsReplicaSet 列表。
GET/api/data/namespaces/system/site/{site}/apis/apps/v1/statefulsetsStatefulSet 列表。
GET/api/data/namespaces/system/site/{site}/apis/batch/v1/jobsJob 列表
GET/api/data/namespaces/system/site/{site}/apis/batch/v1/namespaces/{namespace}/jobsJob 列表
GET/api/data/namespaces/system/site/{site}/apis/batch/v1beta1/cronjobsCronJob 列表。
GET/api/data/namespaces/system/site/{site}/apis/batch/v1beta1/namespaces/{namespace}/cronjobsCronJob 列表。
POST/api/data/namespaces/system/site/{site}/namespaces/{namespace}/pods/metricsPod 指标。
POST/api/data/namespaces/system/site/{site}/namespaces/{namespace}/virtualmachineinstances/metricsVirtualMachineInstances 指标。
POST/api/data/namespaces/system/site/{site}/pods/metricsPod 指标。
POST/api/data/namespaces/system/site/{site}/virtualmachineinstances/metricsVirtualMachineInstances 指标。
GET/api/web/namespaces/system/sites/{site}/global-kubeconfigs列出全局 Kube 配置。
POST/api/web/namespaces/system/sites/{site}/global-kubeconfigs创建全局 Kube 配置。
PUT/api/config/namespaces/{metadata.namespace}/sites/{metadata.name}替换站点。
POST/api/register/namespaces/{namespace}/site/{name}/state设置站点状态。
POST/api/data/namespaces/{namespace}/site/{site}/status/metrics站点状态指标。
GET/api/config/namespaces/{namespace}/sites列出站点
GET/api/config/namespaces/{namespace}/sites/{name}获取站点
POST/api/config/namespaces/{namespace}/sites/{name}/local-kubeconfig创建 K8s 集群本地 Kube 配置。
GET/api/config/namespaces/{namespace}/sites/{name}/local-kubeconfigs列出本地 Kube 配置。
POST/api/config/namespaces/{namespace}/sites/{name}/upgrade_os升级操作系统。
POST/api/config/namespaces/{namespace}/sites/{name}/upgrade_sw升级软件。
GET/api/config/namespaces/{namespace}/sites/{site}/global_networks全局网络列表。
GET/api/config/namespaces/{namespace}/sites/{site}/segments网段列表。
POST/api/data/namespaces/{namespace}/graph/site站点图查询。
POST/api/data/namespaces/{namespace}/graph/site/edge站点边缘查询。
POST/api/data/namespaces/{namespace}/graph/site/node站点节点查询。
GET/api/config/namespaces/{namespace}/sites/{site}/interface接口列表。
POST/api/data/namespaces/system/topology/dc_cluster_group/{dc_cluster_group}DC 集群拓扑。
GET/api/data/namespaces/system/topology/dc_cluster_groupsDC 集群组摘要。
GET/api/data/namespaces/system/topology/network/{id}/route_tables获取网络路由表。
GET/api/data/namespaces/system/topology/route_table/{name}获取路由表。
GET/api/data/namespaces/system/topology/site/{name}/networks获取站点网络。
POST/api/data/namespaces/system/topology/site/{site}站点拓扑。
POST/api/data/namespaces/system/topology/site_mesh_group/{site_mesh_group}站点网格拓扑。
GET/api/data/namespaces/system/topology/site_mesh_groups站点网格组摘要。
GET/api/data/namespaces/system/topology/tgw/{id}/route_tables获取 TGW 路由表。
POST/api/config/namespaces/{metadata.namespace}/virtual_k8ss创建虚拟 Kubernetes。
PUT/api/config/namespaces/{metadata.namespace}/virtual_k8ss/{metadata.name}替换虚拟 Kubernetes。
POST/api/data/namespaces/{namespace}/virtual_k8s/pvc/metricsPVC 指标。
GET/api/config/namespaces/{namespace}/virtual_k8ss列出虚拟 Kubernetes。
GET/api/config/namespaces/{namespace}/virtual_k8ss/{name}获取虚拟 Kubernetes。
DELETE/api/config/namespaces/{namespace}/virtual_k8ss/{name}删除虚拟 Kubernetes。
POST/api/config/namespaces/{metadata.namespace}/virtual_sites创建虚拟站点。
PUT/api/config/namespaces/{metadata.namespace}/virtual_sites/{metadata.name}替换虚拟站点。
GET/api/config/namespaces/{namespace}/virtual_sites列出虚拟站点。
GET/api/config/namespaces/{namespace}/virtual_sites/{name}获取虚拟站点。
DELETE/api/config/namespaces/{namespace}/virtual_sites/{name}删除虚拟站点。
GET/api/config/namespaces/{namespace}/virtual_sites/{name}/selectees获取被选对象。

链接

Section titled “链接”