リクエストの送信

GoldenGate Stream Analytics REST APIを使用してリクエストを送信する前に、次の情報を確認してください。

URLの構造

リクエストのURL構造は次のとおりです:

https://<subdomain>.<domain>.com:<port>/<context-path>/<resource-path>
説明:
  • context-pathは、ユーザー管理APIの/osa/adminです

  • context-pathは、パイプライン管理APIの/osaです

サポートされるメソッド

標準HTTPリクエスト・メソッドを使用して、GoldenGate Stream Analyticsサービスに対して基本的なCRUD操作(作成、読取り、更新および削除)を実行します。

ノート:

複数の操作を単一のHTTPリクエストにまとめてパフォーマンスを向上させることができます。
HTTPメソッド 説明
GET サービス・インスタンスに関する情報を取得します。
HEAD サービス・インスタンスに関するヘッダー情報を取得します。
POST サービス・インスタンスを作成、スケーリング、バックアップ、起動または停止します。
PUT サービス・インスタンスを更新します。
PATCH サービス・インスタンスにパッチを適用します。
OPTIONS サービス・インスタンスのオプションおよび要件に関する情報を取得します。
DELETE サービス・インスタンスを削除します。

メディア・タイプ

GoldenGate Stream Analytics REST APIでは、次のメディア・タイプがサポートされています:

  • application/json

サポートされるヘッダー

GoldenGate Stream Analytics REST APIでは、HTTPリクエストまたはレスポンスのヘッダー・セクションで渡される可能性のある次のヘッダーをサポートしています。

ヘッダー 説明
Accept レスポンスの本文のメディア・タイプ。 Accept application/json
Content-Type リクエストの本体のメディア・タイプ。POSTおよびPUTリクエストの場合、必須です。 Content-Type: application/json