Oracle Cloud Infrastructure Compute ClassicのREST API

コンテナ内のすべてのセキュリティ・アプリケーションに関する詳細の取得

get

/secapplication/{container}/

指定したコンテナ内の、指定した問合せ基準に一致するセキュリティ・アプリケーションの詳細を取得します。問合せ基準を指定しない場合は、コンテナ内のすべてのセキュリティ・アプリケーションの詳細が表示されます。このHTTPリクエストを使用して、POSTおよびPUT操作の結果を検証できます。

検索結果をフィルタリングするには、次の問合せパラメータの1つ以上を、次の構文のURIに追加することによって渡します。

?parameter1=value1&parameter2=value2&parameterN=valueN

必要なロール: このタスクを実行するには、Compute_MonitorまたはCompute_Operationsのロールが必要です。このロールが割り当てられていない、または割当てが不明な場合は、システム管理者に連絡してロールがユーザーにOracle Cloud My Servicesで割り当てられるようにしてください。 Oracle Cloudの管理および監視のユーザー・ロールの変更に関する項を参照してください。

リクエスト

サポートされるメディア・タイプ

application/oracle-compute-v3+json

パス・パラメータ

container: string

ユーザー作成のセキュリティ・アプリケーションの場合は/Compute-identity_domain/userまたは/Compute-identity_domain、システム提供のセキュリティ・アプリケーションの場合は/oracle/public。

問合せパラメータ

description(optional): string

セキュリティ・アプリケーションの説明。
dport(optional): string

TCPまたはUDP宛先ポート番号。
TCPの5900-5999など、ポート範囲も指定できます。
tcpまたはudpをプロトコルとして指定する場合、dportパラメータは必須となりますが、それ以外の場合はオプションです。
このパラメータは、icmpプロトコルには関連しません。
注意: 範囲の終了が範囲の開始よりも低い場合、このリクエストは失敗します。たとえば、5000-4000のポート範囲を指定する場合です。
icmpcode(optional): string
ICMPコード。
このパラメータは、icmpをプロトコルとして指定する場合にのみ関連します。次の値のいずれか1つを指定できます。
- network
- host
- protocol
- port
- df
- admin
icmpをプロトコルとして指定するが、icmptypeまたはicmpcodeを指定しない場合は、すべてのICMPパケットが一致します。
icmptype(optional): string
ICMPタイプ。
このパラメータは、icmpをプロトコルとして指定する場合にのみ関連します。次の値のいずれか1つを指定できます。
- echo
- reply
- ttl
- traceroute
- unreachable
icmpをプロトコルとして指定するが、icmptypeまたはicmpcodeを指定しない場合は、すべてのICMPパケットが一致します。
name(optional): string

オブジェクトの、3つの部分からなる名前(/Compute-identity_domain/user/object)。
protocol(optional): string

使用するプロトコル。
指定する値は、プロトコルのテキスト表現か、任意の符号なし8ビット割当てプロトコル番号(0-254の範囲)のいずれかになります。「割当済インターネット・プロトコル番号」を参照してください。
たとえば、tcpまたは番号6のいずれかを指定できます。
次のテキスト表現を使用できます。tcp、udp、icmp、igmp、ipip、rdp、esp、ah、gre、icmpv6、ospf、pim、sctp、mplsip、all。
すべてのプロトコルを指定するには、これをallに設定します。

ヘッダー・パラメータ

Cookie: string

Cookie:ヘッダーは、サービスに対するすべてのリクエストに含まれる必要があります。それをPOST /authenticate/コールに対して受信されたレスポンス内のset-cookieヘッダーの値に設定してください。

トップに戻る

レスポンス

サポートされるメディア・タイプ

application/oracle-compute-v3+json

200レスポンス

OK。返される可能性のあるその他のHTTPステータス・コードの詳細は、「ステータス・コード」を参照してください。

ヘッダー

set-cookie: string

セッションが拡張された場合、Cookie値が返されます。

ルート・スキーマ : SecApplication-list-response

型: object

ソースの表示

result(optional): array result

{
    "properties":{
        "result":{
            "items":{
                "$ref":"#/definitions/SecApplication-response"
            },
            "type":"array"
        }
    }
}

ネストされたスキーマ : result

型: array

ソースの表示

Array of: object SecApplication-response

{
    "items":{
        "$ref":"#/definitions/SecApplication-response"
    },
    "type":"array"
}

ネストされたスキーマ : SecApplication-response

型: object

ソースの表示

description(optional): string

セキュリティ・アプリケーションの説明。
dport(optional): string

TCPまたはUDP宛先ポート番号。
TCPの5900-5999など、ポート範囲も指定できます。
tcpまたはudpをプロトコルとして指定する場合、dportパラメータは必須となりますが、それ以外の場合はオプションです。
このパラメータは、icmpプロトコルには関連しません。
注意: 範囲の終了が範囲の開始よりも低い場合、このリクエストは失敗します。たとえば、5000-4000のポート範囲を指定する場合です。
icmpcode(optional): string
ICMPコード。
このパラメータは、icmpをプロトコルとして指定する場合にのみ関連します。次の値のいずれか1つを指定できます。
- network
- host
- protocol
- port
- df
- admin
icmpをプロトコルとして指定するが、icmptypeまたはicmpcodeを指定しない場合は、すべてのICMPパケットが一致します。
icmptype(optional): string
ICMPタイプ。
このパラメータは、icmpをプロトコルとして指定する場合にのみ関連します。次の値のいずれか1つを指定できます。
- echo
- reply
- ttl
- traceroute
- unreachable
icmpをプロトコルとして指定するが、icmptypeまたはicmpcodeを指定しない場合は、すべてのICMPパケットが一致します。
name(optional): string

オブジェクトの、3つの部分からなる名前(/Compute-identity_domain/user/object)。
protocol(optional): string

使用するプロトコル。
指定する値は、プロトコルのテキスト表現か、任意の符号なし8ビット割当てプロトコル番号(0-254の範囲)のいずれかになります。「割当済インターネット・プロトコル番号」を参照してください。
たとえば、tcpまたは番号6のいずれかを指定できます。
次のテキスト表現を使用できます。tcp、udp、icmp、igmp、ipip、rdp、esp、ah、gre、icmpv6、ospf、pim、sctp、mplsip、all。
すべてのプロトコルを指定するには、これをallに設定します。
uri(optional): string

Uniform Resource Identifier

{
    "properties":{
        "description":{
            "type":"string",
            "description":"<p>A description of the security application."
        },
        "dport":{
            "type":"string",
            "description":"<p>The TCP or UDP destination port number.<p>You can also specify a port range, such as 5900-5999 for TCP.<p>If you specify <code>tcp</code> or <code>udp</code> as the protocol, then the <code>dport</code> parameter is required; otherwise, it is optional.<p>This parameter isn't relevant to the <code>icmp</code> protocol.<p><b>Note:</b> This request fails if the range-end is lower than the range-start. For example, if you specify the port range as 5000-4000."
        },
        "icmpcode":{
            "type":"string",
            "description":"The ICMP code.<p>This parameter is relevant only if you specify <code>icmp</code> as the protocol. You can specify one of the following values:<ul><li><code>network</code></li><li><code>host</code></li><li><code>protocol</code></li><li><code>port</code></li><li><code>df</code></li><li><code>admin</code></li></ul><p>If you specify <code>icmp</code> as the protocol and don't specify <code>icmptype</code> or <code>icmpcode</code>, then all ICMP packets are matched."
        },
        "icmptype":{
            "type":"string",
            "description":"The ICMP type.<p>This parameter is relevant only if you specify <code>icmp</code> as the protocol. You can specify one of the following values:<ul><li><code>echo</code></li><li><code>reply</code></li><li><code>ttl</code></li><li><code>traceroute</code></li><li><code>unreachable</code></li></ul><p>If you specify <code>icmp</code> as the protocol and don't specify <code>icmptype</code> or <code>icmpcode</code>, then all ICMP packets are matched."
        },
        "name":{
            "type":"string",
            "description":"The three-part name of the object (<code>/Compute-<em>identity_domain</em>/<em>user</em>/<em>object</em></code>)."
        },
        "protocol":{
            "type":"string",
            "description":"The protocol to use.<p>The value that you specify can be either a text representation of a protocol or any unsigned 8-bit assigned protocol number in the range 0-254. See <a target=\"_blank\" href=\"http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml\">Assigned Internet Protocol Numbers</a>.<p>For example, you can specify either tcp or the number 6.<p>The following text representations are allowed: <code>tcp</code>, <code>udp</code>, <code>icmp</code>, <code>igmp</code>, <code>ipip</code>, <code>rdp</code>, <code>esp</code>, <code>ah</code>, <code>gre</code>, <code>icmpv6</code>, <code>ospf</code>, <code>pim</code>, <code>sctp</code>, <code>mplsip</code>, <code>all</code>.<p>To specify all protocols, set this to <code>all</code>."
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier"
        }
    }
}

トップに戻る

例

cURLコマンド

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、/Compute-acme/jack.jones@example.com/コンテナ内のすべてのセキュリティ・アプリケーションの詳細を取得する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください。

コマンドを1行で入力します。この例では、読みやすくするために改行が使用されています。

curl -X GET 
     -H "Cookie: $COMPUTE_COOKIE"
     -H "Accept: application/oracle-compute-v3+json"
     https://api-z999.compute.us0.oraclecloud.com/secapplication/Compute-acme/jack.jones@example.com/

COMPUTE_COOKIEは、前の手順で認証cookieを格納した変数の名前です。認証クッキーの取得および変数への格納の詳細は、認証を参照してください。
api-z999.compute.us0.oraclecloud.comはRESTエンドポイントURLの例です。この値をCompute ClassicサイトのRESTエンドポイントURLに変更します。サイトのRESTエンドポイントURLを見つける方法については、「リクエストの送信」を参照してください。
acmeおよびjack.jones@example.comは値の例です。 acmeをCompute Classicアカウントのアイデンティティ・ドメインIDに置き換え、jack.jones@example.comをユーザー名で置き換えます。

レスポンス本文の例

次の例は、レスポンス本文をJSON形式で示しています。

{
  "result": [
    {
      "protocol": "tcp",
      "name": "/Compute-acme/jack.jones@example.com/vnc",
      "uri": "https://api-z999.compute.us0.oraclecloud.com/secapplication/Compute-acme/jack.jones@example.com/vnc",
      "icmptype": "",
      "proxyuri": null,
      "dport": "5900-5999",
      "icmpcode": ""
    },
    {
      "protocol": "udp",
      "name": "/Compute-acme/jack.jones@example.com/video_streaming_udp",
      "uri": "https://api-z999.compute.us0.oraclecloud.com/secapplication/Compute-acme/jack.jones@example.com/video_streaming_udp",
      "icmptype": "",
      "proxyuri": null,
      "dport": "70",
      "icmpcode": ""
    }
  ]
}
}

トップに戻る