要求/リクエスト

内容
casp1032
DX NetOps Spectrum
Web サービス API を使用するには、レスポンスで結果を受信する OneClick サーバへの要求を生成します。 要求は、URL の形式にすることも、XML コンテンツに埋め込むこともできます。
RESTful Web サービスの URL は名詞指向であり、HTTP 操作自体は動詞を表します。
DX NetOps Spectrum
Web サービス API を使用して要求を生成するときのベース URL を以下に示します。
http://<hostname><:portnumber>/spectrum/restful/<request>
  • request
    DX NetOps Spectrum
    Web サービス API RESTful リソース
    を指定します。 本体を必要とする要求は、Request.xsd で定義されたタイプを使用します。
    RESTful アーキテクチャおよびアプリケーションはステートレスであるため、要求間でクライアント コンテキストは保存されません。 各要求には、URL または XML コンテンツの要求を処理するために必要なすべての情報が含まれています。
要求タイプ
DX NetOps Spectrum
Web サービス API で使用される要求には 2 つのタイプがあります。 いずれの要求タイプも、パフォーマンスは同じです。
  • URL 要求
    リソースが特定のモデルをターゲットにするときに使用されます。 たとえば、DELETE <
    mh
    > は、特定のモデルを削除します。 このタイプの要求は、パラメータの数が少ない単純な要求で正常に機能し、本体のテキストが必要なく、ブラウザ URL として使用できます。
    いずれの URL 要求にも、GET トンネリングに相当するものがあります。
  • GET トンネリング要求
    リソースが複雑なパラメータを使用して複数のモデルをターゲットにするときに使用されます。 HTTP GET コマンドでは、URL で限られた数のパラメータのみをサポートでき、本体はサポートしません。 GET トンネリング操作は、POST 本体で GET 要求をトンネリングするため、複雑な要求を作成できます。 新規および既存の検索条件および事前定義のアラーム フィルタを使用して、XML 本体にリッチ フィルタを含めることができます。 GET トンネリング要求のセマンティクスは、Request.xsd スキーマおよび Filter.xsd スキーマによって定義され、手動で作成したり、要求ビーンから生成したりできます。
一般的な URL パラメータ
アプリケーションに応じて、一部のリソースでサポートされている一般的なパラメータを以下に示します。 一般に、リスト内の URL パラメータの順序は関係ありません。 すべての例外が記録されます。
パラメータの前には ? または & を指定します。 標準の HTTP 構文に従って、最初に指定するパラメータの前には ? を指定し、後続のパラメータの前には & を指定する必要があります。 以下のすべてのパラメータの前には & が指定されています。 リスト内のパラメータの位置に応じて適切なプレフィックスを使用してください。
  • &attr=<
    attr_ID
    >&val=<
    num
    >
    クエリの実行対象であるリソースの特定の属性値を取得するために使用される属性値ペアを指定します。 たとえば、アラームを取得する場合、デフォルトではアラーム ID のみが取得されます。 ただし、指定した属性を持つアラームを取得する場合は、その特定の属性値を持つアラーム ID が取得されます。
    属性と値のペアを指定する場合、特に属性値を更新する場合は、以下のように、属性 ID と値が適切にバインドされるように ID と値を順序正しく指定する必要があります。
    ?attr=0x10062&val=text&attr=0x10001&val=12334
    この組み合わせは、属性の値を更新するときに、属性 ID の後にその ID の目的の値が続くことを RESTful サーブレットに通知します。
    複数の属性値のペアを指定することができます。
  • &landscape=<
    landscape_handle
    >
    クエリに含めるランドスケープを指定します。 複数のランドスケープ パラメータを指定できます。
  • &mh=<
    model_handle
    >
    モデル ハンドルを指定します。
  • &throttlesize=<
    num
    >
    レスポンスごとに結果セットから取得する項目の数を指定します。 throttlesize 値が結果セット内の項目の合計数よりも小さい場合は、結果に[次へ]リンクが含まれています。 このリンクを使用すると、さらに結果を取得できます。 「スロットルと次への使用」を参照してください。
    すべてのリソースが throttlesize パラメータをサポートしているわけでありません。