View a markdown version of this page

Gremlin クエリステータス API - Amazon Neptune
クエリの一覧表示単一クエリのステータス

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Gremlin クエリステータス API

すべてのアクティブな Gremlin クエリを一覧表示したり、特定のクエリのステータスを取得したりできます。両方のオペレーションの基盤となる HTTP エンドポイントは ですhttps://your-neptune-endpoint:port/gremlin/status。

アクティブな Gremlin クエリの一覧表示

アクティブな Gremlin クエリをすべて一覧表示するには、queryIdパラメータなしでエンドポイントを呼び出します。

リクエストパラメータ

  • includeWaiting (オプション)   –   に設定するとTRUE、クエリの実行に加えて待機中のクエリもレスポンスに含まれます。

レスポンスの構文

{
  "acceptedQueryCount": integer,
  "runningQueryCount": integer,
  "queries": [
    {
      "queryId": "guid",
      "queryEvalStats": {
        "waited": integer,
        "elapsed": integer,
        "cancelled": boolean
      },
      "queryString": "string"
    }
  ]
}

  • acceptedQueryCount   –   受け入れられながらもまだ完了していないクエリの数 (キュー内のクエリを含む)。

  • runningQueryCount   –   現在実行されている Gremlin クエリの数。

  • queries   –   現在の Gremlin クエリのリスト。

例

AWS CLI
aws neptunedata list-gremlin-queries \
  --endpoint-url https://your-neptune-endpoint:port

詳細については、 AWS CLI 「 コマンドリファレンス」のlist-gremlin-queries」を参照してください。

SDK
import boto3
from botocore.config import Config

client = boto3.client(
    'neptunedata',
    endpoint_url='https://your-neptune-endpoint:port',
    config=Config(read_timeout=None, retries={'total_max_attempts': 1})
)

response = client.list_gremlin_queries()

print(response)

Java、.NET などの他の言語の AWS SDK の例については、「」を参照してくださいAWS SDK。

awscurl
awscurl https://your-neptune-endpoint:port/gremlin/status \
  --region us-east-1 \
  --service neptune-db
注記

この例では、 AWS 認証情報が 環境で設定されていることを前提としています。us-east-1 を Neptune クラスターのリージョンに置き換えます。

IAM 認証awscurlで を使用する方法の詳細については、「」を参照してください一時的な認証情報で awscurl を使用して、IAM 認証が有効になっている DB クラスターに安全に接続する。

curl
curl https://your-neptune-endpoint:port/gremlin/status

次の出力は、実行中の単一のクエリを示しています。

{
  "acceptedQueryCount": 9,
  "runningQueryCount": 1,
  "queries": [
    {
      "queryId": "fb34cd3e-f37c-4d12-9cf2-03bb741bf54f",
      "queryEvalStats": {
        "waited": 0,
        "elapsed": 23,
        "cancelled": false
      },
      "queryString": "g.V().out().count()"
    }
  ]
}

特定の Gremlin クエリのステータスの取得

特定の Gremlin クエリのステータスを取得するには、 queryIdパラメータを指定します。

リクエストパラメータ

レスポンスの構文

{
  "queryId": "guid",
  "queryString": "string",
  "queryEvalStats": {
    "waited": integer,
    "elapsed": integer,
    "cancelled": boolean,
    "subqueries": document
  }
}

  • queryId   –   クエリの ID。

  • queryString   –   送信されたクエリ。それより長い場合、これは 1024 文字に切り捨てられます。

  • queryEvalStats   – クエリの 統計。これには、 waited (ミリ秒単位の待機時間）、 elapsed (ミリ秒単位の実行時間）、 cancelled (クエリがキャンセルされたかどうか）、 subqueries (サブクエリの数) が含まれます。

例

AWS CLI
aws neptunedata get-gremlin-query-status \
  --endpoint-url https://your-neptune-endpoint:port \
  --query-id "fb34cd3e-f37c-4d12-9cf2-03bb741bf54f"

詳細については、 AWS CLI 「 コマンドリファレンス」のget-gremlin-query-status」を参照してください。

SDK
import boto3
from botocore.config import Config

client = boto3.client(
    'neptunedata',
    endpoint_url='https://your-neptune-endpoint:port',
    config=Config(read_timeout=None, retries={'total_max_attempts': 1})
)

response = client.get_gremlin_query_status(
    queryId='fb34cd3e-f37c-4d12-9cf2-03bb741bf54f'
)

print(response)

Java、.NET などの他の言語の AWS SDK の例については、「」を参照してくださいAWS SDK。

awscurl
awscurl https://your-neptune-endpoint:port/gremlin/status/fb34cd3e-f37c-4d12-9cf2-03bb741bf54f \
  --region us-east-1 \
  --service neptune-db
注記

この例では、 AWS 認証情報が 環境で設定されていることを前提としています。us-east-1 を Neptune クラスターのリージョンに置き換えます。

IAM 認証awscurlで を使用する方法の詳細については、「」を参照してください一時的な認証情報で awscurl を使用して、IAM 認証が有効になっている DB クラスターに安全に接続する。

curl
curl https://your-neptune-endpoint:port/gremlin/status/fb34cd3e-f37c-4d12-9cf2-03bb741bf54f

以下に、レスポンスの例を示します。

{
  "queryId": "fb34cd3e-f37c-4d12-9cf2-03bb741bf54f",
  "queryString": "g.V().out().count()",
  "queryEvalStats": {
    "waited": 0,
    "elapsed": 23,
    "cancelled": false
  }
}