この記事では、Cato APIを用いてアカウント内の設定や項目を監視・設定する方法を紹介します。
Cato APIは、Cato Cloudとシームレスに統合するための主な自動化インターフェースです。 Cato APIsを使用して、展開や設定などの効率的な運用ワークフローを構築し、ネットワークとセキュリティ管理を円滑にするための包括的なステータス監視、統計とデータ収集、分析を行うことができます。
APIエンドポイントとスキーマのURLは、Cato管理アプリケーション（CMA）インスタンスのホスト場所に固有です。 CMAアカウントのURLおよびAPIエンドポイントとスキーマには、<prefix>値を付加することがあります。
APIエンドポイントのURLは、https://api.<prefix>.catonetworks.com/api/v1/graphql2の形式です。
APIスキーマのURLは、https://api.<prefix>.catonetworks.com/api/schemaの形式です。
APIエンドポイントのURL
-
プレフィックス（
cc.catonetworks.com）がない場合、次のURLを使用します：https://api.catonetworks.com/api/v1/graphql2 -
プレフィックス（例：
cc.us1.catonetworks.com）がある場合、異なる場所に応じてプレフィックスを変更して次のURLを使用します：https://api.us1.catonetworks.com/api/v1/graphql2
APIスキーマのURL
-
プレフィックス（
cc.catonetworks.com）がない場合は、次のURLを使用します：https://api.catonetworks.com/api/schema -
プレフィックス（例：
cc.us1.catonetworks.com）がある場合、異なる場所に応じてプレフィックスを変更して次のURLを使用します：https://api.us1.catonetworks.com/api/schema
Cato APIsはGraphQLを基盤として構築されており、RESTful APIツールおよびクライアントと完全に互換性のある直感的なインターフェースを提供します。 GraphQLはまた、必要なデータを正確にクエリする追加の柔軟性を提供し、過剰取得を減らし効率を改善します。
Cato APIドキュメンテーションは、Cato Networks GraphQL APIリファレンスで利用可能であり、以下を含みます：
-
スキーマ定義とドキュメンテーション
-
API呼び出し例と対応するサンプルレスポンス
-
インタラクティブなプレイグラウンドを備えたGraphQL APIエンドポイントでAPIを探索・テストできます
このセクションでは、特定のAPIの成熟度と利用可能性に基づくさまざまなライフサイクルステージについて説明します。
すべての新しいAPIは最初にベータ版としてリリースされます。 ベータ版からGAへの移行は、APIが安定しており本番環境対応可能であることを確認するための社内レビューと検討が必要です。 通常、ベータ版からGAへの移行には約1年かかります。
注意
注意: 以下で説明するライフサイクルは、Cato Networks GraphQL APIリファレンスで定義されている正式なCato APIのみに関連します。 追加のツールや参考例はカバーしていません。
例えば、Cato GitHubアカウントで利用可能なオープンソースの例やユーティリティはカバーしていません。 これらのリソースは、さらなる開発、メンテナンス、またはサポートの保証や義務なく「そのまま」の形で提供されます。
これらはライフサイクルステージの一環としてのAPIの成熟度レベルです：
-
ベータ版: ベータ段階のAPIはすべての機能が備わっており、完全に運用できるため、本番環境での使用に適しています。 ただし、ユーザーフィードバックや追加の考慮事項に基づいて変更が加えられる可能性があります。 これらの変更には、APIスキーマへの重大な変更も含まれ、短期間での通知があり、クライアントコードの更新が必要になる場合があります。
-
GA（一般公開）: GAのAPIは安定しており、本番環境対応可能で、長期的なサポートおよび後方互換性の約束が付いています。 APIスキーマへの重大な変更はまれであり、クライアントコード調整のための充分な時間を提供するために事前にお知らせします。
ベータ版と明示されていないAPIはGAと見なされます。 GA API内の個々のフィールド、タイプ、入力はベータ版としてマークされる場合があります。
これらはライフサイクルステージの一環としてのAPIの利用可能レベルです：
-
EA（早期利用可能）: EAのAPIは、限定されたユーザーグループにテストとフィードバックのために提供され、以降の広範囲リリース前に使用されます。 アクセスには特別な承認や条件が必要になる場合があります。
-
段階的展開: クラウドベースサービスの業界標準ベストプラクティスに従い、Cato APIsは安定性を確保し性能を監視しつつ、全アカウントにわたって徐々に展開されます。
EAまたは段階的展開でマークされていないAPIは、完全に展開され、全ユーザーにアクセス可能と見なされます。
このセクションは、成熟度と利用可能レベルに基づくAPIのドキュメンテーションで使用されるラベルをまとめたものです。
ラベルがないAPIは、全アカウントで完全に利用可能であり、スキーマの重大な変更はまれです。 そのような変更は数ヶ月前に告知されます。 これらの変更について詳しくは、以下のスキーマ変更の可能性を参照してください。
-
EA
-
CatoのEAプログラムに参加する顧客のみに利用可能です。参加希望の方は、ea@catonetworks.comまでご連絡ください。
-
-
ベータ
-
スキーマが変更される可能性があります
-
重大な変更の通知は限られた期間で行われ、最短で2週間かかる場合があります
-
ベータAPIは完全な機能をサポートします
-
-
ロールアウト
-
これらのGA APIは、数週間かけてすべてのアカウントに徐々に展開されます
-
ロールアウト状態のAPIを呼び出すと、そのAPIがまだアカウントで利用できないためエラーメッセージが表示される可能性があります
-
このセクションでは、CatoがGraphQL APIスキーマに変更を加え、それがAPI呼び出しの動作や結果に影響を与える場合について説明します。
GraphQLにおけるスキーマ変更の可能性は、APIがクライアントアプリケーションによるクエリやロジックの更新を必要とし、機能を維持するための変更が生じるときに発生します。 例としては以下があります：
-
フィールド、タイプ、または引数の削除。
-
フィールド、タイプ、または引数の名前変更。
-
引数のデフォルト値を変更し、クエリやミューテーションの予期される結果を変えるような変更。
-
フィールドのタイプや動作を変更し、互換性に影響を与えるような変更。 例えば、フィールドのタイプを変更する（例：IntからStringへ）または引数のヌラビリティを変更する（例：可nullから非nullへ）。
重大なスキーマ変更を回避するためにできる限り努力します。 しかしながら、そのような変更がある場合には、EoL APIの通知で説明するように顧客に通知されます。
これらの変更は、ベータAPIでは頻繁に発生することがありますが、GA APIではまれです。
非推奨としてマークされたAPIまたはフィールドの使用はもはや推奨されず、より良い代替手段が存在することを示します。 非推奨のAPIおよびフィールドを使用しないようにスクリプトやプロセスを更新し、期待どおりの動作と機能を維持することをお勧めします。
APIまたはフィールドが削除または置き換え予定である場合、エンド・オブ・ライフ（EoL）プロセスを経ることになります。 このプロセスには以下のステップが含まれます：
-
APIまたはフィールドを非推奨としてマーク
-
削除予定のAPIまたはフィールドは、非推奨としてCato Networks GraphQL APIリファレンスにマークされます。
-
このラベルには、該当する場合には代替APIまたはフィールドを指定し、予定されたEoL日を示すメッセージが添付されます。
-
-
EoL通知
-
Cato API Potentially Breaking Changes and EoL記事は、スキーマが変更される具体的な日付で更新されます。
-
通知とスキーマ変更の間の期間は次のとおりです：
-
GA API：最低3ヶ月前に、一般に6ヶ月前に通知されます
-
ベータAPI：通常は2週間前に通知されます
-
-
EoL通知とEoL日付の間に、顧客はGraphQLスキーマの変更に対応するためにクライアントコードを更新することが期待されます。
-
新しいAPIやフィールドなど、GraphQLへの変更が重大でなく重大な場合でも、Cato API変更ログ記事で告知されます。
Cato Networks GraphQL APIリファレンスは常に最新のサポートされているGraphQLスキーマを含んでいます。
0件のコメント
サインインしてコメントを残してください。