Apisドキュメンテーション
Cloudiway Rest API ドキュメント
APIは、Cloudiwayサービスへのプログラムアクセスを提供します。当該APIはREST原則に基づいており、アプリケーションの開発やテストが容易に行えます。
最初に、https://portal.cloudiway.com に有効なアカウントが必要です。
公開APIのSwagger定義は、こちらでご覧いただけます:https://api-production.cloudiway.com/index.html
リソースへのアクセスには、HTTPの動詞 – GET、POST、PUT、DELETE – が使用されます。リクエスト内のすべてのパラメータはform-urlでエンコードされる必要があります。
各API呼び出しにおいて使用されるURLベースは https://api-production.cloudiway.com/ap1 です。
Cloudiway APIがリクエストを処理できる場合、呼び出されたメソッドに応じて、対応するデータをJSON形式で返します。何らかの理由でCloudiway APIがリクエストを処理できない場合、適切なエラーメッセージが返されます。
また、標準的な操作を全て含むPowerShellライブラリも提供しています。各製品に対するサンプルへのアクセスが可能です。
このドキュメントの目的は、APIの使用を開始し、プロセスの概要を更に理解するのを容易にすることです。
以下に、ドキュメント、PowerShellサンプル、および以下を含むZIPファイルへのアクセスがあります:
- Classes and Functionsフォルダ:このフォルダには、全てのクラスと関数定義が含まれています。
- MainScript.ps1:実行し、目的に応じて更新する主要なスクリプトです。