- ホーム
- API Enriched
- APIリファレンス
- 🌍 Sites API
🌍 Sites API
AWS、Azure、GCP VPCのトランジットゲートウェイとの統合。リージョン間のポリシー適用のためのラベルベース選択。
- カテゴリ: インフラストラクチャ
- 複雑度: 高度
- パス数: 133 | スキーマ数: 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/scroll | K8s 監査ログスクロールクエリ。 |
| POST | /api/data/namespaces/{namespace}/k8s_audit_logs/scroll | K8s 監査ログスクロールクエリ。 |
| GET | /api/data/namespaces/{namespace}/k8s_events/scroll | K8s イベントスクロールクエリ。 |
| POST | /api/data/namespaces/{namespace}/k8s_events/scroll | K8s イベントスクロールクエリ。 |
| 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_logs | K8s 監査ログクエリ。 |
| POST | /api/data/namespaces/{namespace}/site/{site}/k8s_audit_logs/aggregation | K8s 監査ログ集計クエリ。 |
| POST | /api/data/namespaces/{namespace}/site/{site}/k8s_events | K8s イベントクエリ。 |
| POST | /api/data/namespaces/{namespace}/site/{site}/k8s_events/aggregation | K8s イベント集計クエリ。 |
| POST | /api/data/namespaces/{namespace}/vk8s_audit_logs | VK8s 監査ログクエリ。 |
| POST | /api/data/namespaces/{namespace}/vk8s_audit_logs/aggregation | VK8s 監査ログ集計クエリ。 |
| GET | /api/data/namespaces/{namespace}/vk8s_audit_logs/scroll | VK8s 監査ログスクロールクエリ。 |
| POST | /api/data/namespaces/{namespace}/vk8s_audit_logs/scroll | VK8s 監査ログスクロールクエリ。 |
| POST | /api/data/namespaces/{namespace}/vk8s_events | VK8s イベントクエリ。 |
| POST | /api/data/namespaces/{namespace}/vk8s_events/aggregation | VK8s イベント集計クエリ。 |
| GET | /api/data/namespaces/{namespace}/vk8s_events/scroll | VK8s イベントスクロールクエリ。 |
| POST | /api/data/namespaces/{namespace}/vk8s_events/scroll | VK8s イベントスクロールクエリ。 |
| 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/configmaps | ConfigMap 一覧。 |
| GET | /api/data/namespaces/system/site/{site}/api/v1/endpoints | エンドポイント一覧。 |
| GET | /api/data/namespaces/system/site/{site}/api/v1/namespaces | ネームスペース一覧。 |
| GET | /api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/configmaps | ConfigMap 一覧。 |
| GET | /api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/endpoints | エンドポイント一覧。 |
| GET | /api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/persistentvolumeclaims | PersistentVolumeClaim 一覧。 |
| GET | /api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/pods | Pod 一覧 |
| GET | /api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/secrets | Secret 一覧。 |
| GET | /api/data/namespaces/system/site/{site}/api/v1/namespaces/{namespace}/services | Service 一覧。 |
| GET | /api/data/namespaces/system/site/{site}/api/v1/nodes | ネームスペース一覧。 |
| GET | /api/data/namespaces/system/site/{site}/api/v1/persistentvolumeclaims | PersistentVolumeClaim 一覧。 |
| GET | /api/data/namespaces/system/site/{site}/api/v1/persistentvolumes | PersistentVolume 一覧。 |
| GET | /api/data/namespaces/system/site/{site}/api/v1/pods | Pod 一覧 |
| GET | /api/data/namespaces/system/site/{site}/api/v1/secrets | Secret 一覧。 |
| GET | /api/data/namespaces/system/site/{site}/api/v1/services | Service 一覧。 |
| GET | /api/data/namespaces/system/site/{site}/apis/apps/v1/daemonsets | DaemonSet 一覧。 |
| GET | /api/data/namespaces/system/site/{site}/apis/apps/v1/deployments | Deployment 一覧。 |
| GET | /api/data/namespaces/system/site/{site}/apis/apps/v1/namespaces/{namespace}/daemonsets | DaemonSet 一覧。 |
| GET | /api/data/namespaces/system/site/{site}/apis/apps/v1/namespaces/{namespace}/deployments | Deployment 一覧。 |
| GET | /api/data/namespaces/system/site/{site}/apis/apps/v1/namespaces/{namespace}/replicasets | ReplicaSet 一覧。 |
| GET | /api/data/namespaces/system/site/{site}/apis/apps/v1/namespaces/{namespace}/statefulsets | StatefulSet 一覧。 |
| GET | /api/data/namespaces/system/site/{site}/apis/apps/v1/replicasets | ReplicaSet 一覧。 |
| GET | /api/data/namespaces/system/site/{site}/apis/apps/v1/statefulsets | StatefulSet 一覧。 |
| GET | /api/data/namespaces/system/site/{site}/apis/batch/v1/jobs | Job 一覧 |
| GET | /api/data/namespaces/system/site/{site}/apis/batch/v1/namespaces/{namespace}/jobs | Job 一覧 |
| GET | /api/data/namespaces/system/site/{site}/apis/batch/v1beta1/cronjobs | CronJob 一覧。 |
| GET | /api/data/namespaces/system/site/{site}/apis/batch/v1beta1/namespaces/{namespace}/cronjobs | CronJob 一覧。 |
| POST | /api/data/namespaces/system/site/{site}/namespaces/{namespace}/pods/metrics | Pod メトリクス。 |
| POST | /api/data/namespaces/system/site/{site}/namespaces/{namespace}/virtualmachineinstances/metrics | VirtualMachineInstances メトリクス。 |
| POST | /api/data/namespaces/system/site/{site}/pods/metrics | Pod メトリクス。 |
| POST | /api/data/namespaces/system/site/{site}/virtualmachineinstances/metrics | VirtualMachineInstances メトリクス。 |
| GET | /api/web/namespaces/system/sites/{site}/global-kubeconfigs | グローバル Kube Config を一覧表示する。 |
| POST | /api/web/namespaces/system/sites/{site}/global-kubeconfigs | グローバル Kube Config を作成する。 |
| 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 Config を作成する。 |
| GET | /api/config/namespaces/{namespace}/sites/{name}/local-kubeconfigs | ローカル Kube Config を一覧表示する。 |
| POST | /api/config/namespaces/{namespace}/sites/{name}/upgrade_os | OS をアップグレードする。 |
| POST | /api/config/namespaces/{namespace}/sites/{name}/upgrade_sw | 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_groups | DC クラスターグループサマリー。 |
| 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/metrics | PVC メトリクス。 |
| 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 | セレクティーを取得する。 |