ドキュメントを参照してRackspaceCloud製品のAPIコマンドを実行するインタラクティブな方法が必要な場合、製品をすばやく操作する必要がある場合、またはコントロールパネルで利用できない新製品や機能を利用したい場合は、Pitchforkがあなた。
Pitchforkは、ユーザーがRackspaceCloud製品とすばやく対話できるようにするインタラクティブなWebAPIアプリケーションです。コマンドプロンプトを表示したり、cURLコマンドを使用してデータオブジェクトを送信する方法を調べたりする必要はありません。アプリケーションはこれらすべてを処理し、クラウドアカウントに対して行った製品APIリクエストからの結果と応答を表示します。
Pitchforkは、API呼び出しを行い、API呼び出しに必要なものを表示して、他のツールやメソッドを使用して実行できるように設計されています。モック機能を使用して、呼び出しのデータ構造を確認できます。これは、RackspaceAPIプログラムの参照ツールとして機能します。
APIは初心者にとって混乱を招く可能性があります。 Pitchforkはあなたに代わってcallstructureをレイアウトするので、あなたははるかに速く学ぶことができます。たとえば、APIがロードバランサーやクラウドデータベースの構成を変更する唯一の方法である場合があります。Pitchforkは、呼び出しを行う方法と実行する方法の両方を示します。
Pitchforkの場所
次のアドレスでPitchforkにアクセスできます:https://pitchfork.rax.io
GitHubのコードを見てください。
API呼び出しをモックまたは参照するために、アプリケーションにログインする必要はありません。アカウントに対してこれらの呼び出しを実行する場合にのみ、ログインする必要があります。
ログインするには、ログインをクリックします 認証資格情報を入力します。
Pitchforkは、RackspaceCloudへのAPI認証リクエストで使用するものと同じクレデンシャルを使用します。ユーザー名とAPIキーを指定すると、システムがHTTPS経由で認証要求を行います。リクエストが成功すると、アプリケーションは返されたトークンとサービスカタログを保存し、時間になるとトークンとともにセッションを終了します。
Pitchforkを使用してAPI呼び出しを送信します
ログイン後、次の手順を使用して、Pitchforkを使用してAPI呼び出しを送信します。
- いずれかの製品を参照して、実行する呼び出しを見つけます。
- やり取りする地域を選択してください。
- 詳細strong>をクリックします 。
- 呼び出しに変数がある場合は、それらを入力します。
- [API呼び出しの送信]をクリックします 。
アプリケーションは次の情報を表示します:
-
リクエストURL: 呼び出しを送信した完全に構築されたURL。
-
リクエストヘッダー: APIに送信したリクエストのヘッダー部分。
-
リクエストデータオブジェクト: 呼び出し用に作成されたデータオブジェクトがある場合は、指定した値を含めて表示されます。
-
応答ヘッダー: APIからの応答で受信したヘッダー。
-
応答本文: APIサーバーからの応答データ。この応答には、ステータスコード、返されたオブジェクト、またはエラーメッセージが含まれる可能性があります。
-
注: 応答ヘッダーと応答本文は、実行された呼び出しに対してのみ表示され、呼び出しモックに対しては表示されません。モックは実行されないため、表示する応答はありません。
モックオプションを使用すると、呼び出しを実行せずに呼び出しを作成できるため、呼び出しがどのように構成されているかを確認できます。 模擬API呼び出しをクリックします 通話のリクエストの詳細をすべて表示したい場合。リクエストデータオブジェクトがある場合は、呼び出しに使用できるすべてのオプションとともに表示されます。参照用に、オブジェクトがどのように構成されているかを確認できます。
ログインすると、クラウドアカウントに対して通話が実行されます。請求に影響を与える何かをしているときに警告するための呼び出しに関する注記がありますので、呼び出しを実行するときは注意してください。
呼び出しをモックする場合、API呼び出しは実行されないため、アカウントに影響はありません。
履歴をクリックすると、発信した通話の履歴を簡単に確認できます。 メニューで。履歴には、行った通話とすべての詳細が表示されます。応答に関係なく、APIに対して実行した呼び出しの履歴が保存されます。模擬API呼び出しは履歴に記録されません。履歴を表示するには、ログインする必要があります。
通話履歴は保存され、システム内で行われた過去の通話を監査または参照できるようになります。これは、複数のユーザーが同じ資格情報のセットを使用している場合に役立ちます。通話履歴には次の要素が含まれます。
-
完了: 呼び出しが行われたときのタイムスタンプ(UTCタイムゾーン)。
-
通話の詳細: 説明、ドキュメントのURL、タイトルなど、通話の詳細。
-
地域: DFWやORDなど、通話を実行した地域。
-
リクエスト: 参照用に保存されるリクエストの部分には、URL、動詞、APIに渡されるデータオブジェクトが含まれます。
-
応答: 応答本文、応答ヘッダー、および応答コード。
-
ユーザー名: APIに対して呼び出しを実行しているユーザーのユーザー名。
-
アカウント番号: クラウドアカウント番号。
頻繁に実行する通話がある場合は、通話の横にある星のアイコンをクリックします。これによりお気に入りに追加され、フロントページまたはお気に入りからこれらの通話にアクセスできます メニューで。アプリケーションにログインしている場合にのみ、お気に入りを追加または表示できます。