GraphiQL ツール

GraphiQL を使用して、スキーマを検討し、GraphQL エンドポイント用の照会をテストすることができます。

1. ダウンロードとインストールGraphiQL。
2. GraphiQL アプリケーションを開き、許可する HTTP ヘッダーを入力します。
3. **「GraphQl エンドポイント (GraphQl Endpoint)」**フィールドに正しいエンドポイントを入力します。 使用https://api.cis.cloud.ibm.com/v1/<crn>/zones/<zoneid>/graphql

ウィンドウは照会ペインと応答ペインに分割されています。 照会ペインで、照会に挿入される照会変数を定義できます。

照会を構築するには、以下の手順に従います。

1. POST「メソッド」**リスト・メニューで ** を選択します。
2. **「HTTP ヘッダーの編集 (Edit HTTP Headers)」**をクリックします。
3. X-Auth-User-Token または許可トークンを入力し、Content-Type を application/json に設定します。 それらを保存してください。

照会ペインで照会の構築を開始します。 Document Explorer を使用して、スキーマと文書を検討します。 Document Explorer には、データ・セット、ディメンション、運用、および関数についての使用可能なさまざまなオプションが表示されます。 Document Explorer で、「ゾーン」と「ドメイン」という語は同義語です。

以下のテスト・スニペットを照会ペインに貼り付け、応答ペインでの応答を監視します。datetime は必要に合わせて調整してください。

query {
   viewer {
      zones(filter: {zoneTag: "<your domain ID>"}) {
         httpRequests1hGroups(limit: 5, filter: { datetime_gt: "2020-08-30T04:00:00Z", datetime_lt: "2020-08-31T06:00:00Z"}) {
            sum {
              countryMap {
                bytes
                clientCountryName
              }
            }
            dimensions {
              date
              datetime
             }
          }
         firewallEventsAdaptiveGroups(limit: 10, filter: { datetime_gt: "2020-08-30T04:00:00Z", datetime_lt: "2020-08-31T06:00:00Z"}) {
               count
               dimensions {
                  clientCountryName
                  clientAsn
                  datetimeHour
               }
             }
          }
       }
     }

アカウント制限のための照会設定

データ・ノードの制限に関する特定の情報を取得するには、settings ノードを使用します。

照会の例を以下に示します。

{
  viewer {
    zones(filter: { zoneTag: $zoneTag }) {
      settings {
        browserInsightsAdaptiveGroups {
          maxDuration
          maxNumberOfFields
          maxPageSize
          enabled
          notOlderThan
        }
      }
    }
  }
}

照会応答は以下のとおりです。

{
  "data": {
    "viewer": {
      "zones": [
        {
          "settings": {
            "browserInsightsAdaptiveGroups": {
              "enabled": true,
              "maxDuration": 2592000,
              "maxNumberOfFields": 30,
              "maxPageSize": 10000,
              "notOlderThan": 2595600
            }
          }
        }
      ]
    }
  },
  "errors": null
}

照会の制限

1 つの照会で戻すことのできるデータのボリュームは制限されており、ユーザーの日次のデータ・ボリュームには制限があります。 API によって適用される一般的なレート制限に加えて、以下の制限が適用されます。

• ゾーンを範囲とする照会には、最大 10 のゾーンを含めることができます。
• maxNumberOfFields の settings に示されているように、照会は最大 30 のフィールドを要求できます。
• 応答は最大 10,000 のレコードを戻すことができます。 この制限は、maxPageSize の settings に示されています。

照会で戻すレコードの上限は、limit 引数を使用して明示的に指定する必要があります。

ソートの例

生データのソート

firewallEventsAdaptive (orderBy: [clientCountryName_ASC]) {
    clientCountryName
}

複数のフィールドを使用した生データのソート

firewallEventsAdaptive (orderBy: [clientCountryName_ASC, datetime_DESC]) {
    clientCountryName
    datetime
}

集約関数によるグループ・ソート

httpRequests1hGroups (orderBy: [sum_bytes_DESC]){
    sum {
        bytes
        requests
    }
    dimensions {
        datetime
    }
}

カーソルのない照会ページ

以下の例では、date と clientCountryName の関係が一意であると想定しています。

照会の最初の N 件の結果を取得します。

結果の数を制限するには、limit パラメーターを追加します。 例えば、最初の 2 つのレコードを照会することができます。

firewallEventsAdaptive (limit: 2, orderBy: [datetime_ASC, clientCountryName_ASC]) {
    datetime
    clientCountryName
}

日付によるソート順を指定する場合は、日付と国の両方によるソート順を指定する場合よりも、戻される結果が明確ではなくなります。

照会応答は以下のとおりです。

{
  "firewallEventsAdaptive" : [
    {
      "datetime": "2018-11-12T00:00:00Z",
      "clientCountryName": "UM"
    },
    {
      "datetime": "2018-11-12T00:00:00Z",
      "clientCountryName": "US"
    }
  ]
}

フィルターを使用した次のページの照会

次の N 件の結果を取得するには、前の照会の最後の結果を除外するフィルターを指定します。 前の例を使用し、「より大」の演算子 (_gt) を clientCountryName フィールドに付加し、「以上」の演算子を datetime フィールドに付加することができます。 具体的に指定することにより、最適な結果を取得することができます。

firewallEventsAdaptive (limit: 2, orderBy: [datetime_ASC, clientCountryName_ASC], filter: {date_geq: "2018-11-12T00:00:00Z", clientCounterName_gt: "US"}) {
    date
    clientCountryName
}

照会応答は以下のとおりです。

{
  "firewallEventsAdaptive" : [
    {
      "datetime": "2018-11-12T00:00:00Z",
      "clientCountryName": "UY"
    },
    {
      "datetime": "2018-11-12T00:00:00Z",
      "clientCountryName": "UZ"
    }
  ]
}

前のページの照会

以前の N 件の結果を取得するには、フィルターとソート順を逆にします。

firewallEventsAdaptive (limit: 2, orderBy: [datetime_DESC, clientCountryName_DESC, filter: {date_leq: "2018-11-12T00:00:00Z", clientCountryName_lt: "UY"}]) {
  datetime
  clientCountryName
}

照会応答は以下のとおりです。

{
  "firewallEventsAdaptive" : [
    {
      "datetime": "2018-11-12T00:00:00Z",
      "clientCountryName": "US"
    },
    {
      "datetime": "2018-11-12T00:00:00Z",
      "clientCountryName": "UM"
    }
  ]
}

構造

GraphQL フィルタは、 GraphQL 入力オブジェクトによって表されます。

以下のリソースでは、フィルターを引数として使用できます。

• ゾーン (ドメイン)
• テーブル (データ・セット)
• アカウント

ゾーン (ドメイン) フィルター

ゾーン・フィルターを使用すると、ゾーンに関連したデータをゾーン (ドメイン) ID (zoneTag) によって照会できます。

zones(filter: {zoneTag: "your domain (zone) ID"}) {
    ...
}

ゾーン・フィルターは、以下の文法に準拠している必要があります。

filter
    { zoneTag: t }
    { zoneTag_gt: t }
    { zoneTag_in: [t, ...] }

複合フィルター (コンマ区切り、AND、OR) はサポートされていません。 ゾーンは常に英数字に基づいてソートされます。

テーブル (データ・セット) フィルター

テーブル・フィルターでは、少なくとも 1 つのノードを照会することが必要です。 AND 演算子を使用して、マルチノード・フィルターを作成し、結合することができます。

アカウント・フィルター

アカウント・レベルのフィルタリングがサポートされています。必須のフィルター・パラメーターがあります。 以下に例を示します。

accounts(filter: {accountTag: $accountTag}) {
    ...
}

オペレーター

演算子のサポートは、ノード・タイプとノード名に応じてさまざまです。 以下の演算子は、すべてのタイプでサポートされています。

例

一般的な例:

{
  myQuery(
    filter: {
      clientCountry: "UK" # all objects having client country equal to "UK"
      datetime_gt: "2020-01-01 10:00:00" # all object having datetime greater than "2020-01-01 10:00:00"
    }
  )
}

特定のノードのフィルタリング:

httpRequests1hGroups(filter: {datetime: "2020-01-01 10:00:00"}) {
    ...
}

複数のフィールドでのフィルタリング:

httpRequests1hGroups(filter: {datetime_gt: "2018-01-01 10:00:00", datetime_lt: "2018-01-01 11:00:00"}) {
    ...
}

OR 演算子を使用したフィルタリング:

httpRequests1hGroups(filter: {
    datetime: "2020-01-01 10:00:00",
    OR:[{clientCountryName: "US"}, {clientCountryName: "UK"}]) {
    ...
}