NRQL ルックアップ API

NRQL Lookups API を使用して、ルックアップテーブルを作成および管理します。

始める前に

NRQL Lookups API は、ルックアップテーブルをプログラムで管理できるようにする REST API です。別のオプションとして、 UI を通じてルックアップテーブルを管理することもできます。

HTTPエンドポイント

ベースURL

API 呼び出しでは、New Relic アカウントに適用できるベース URL を使用します。

米国（US）エンドポイント（デフォルト）：

https://nrql-lookup.service.newrelic.com

European Union (EU)のエンドポイントです。

https://nrql-lookup.service.eu.newrelic.com

日本（JP）エンドポイント：

https://nrql-lookup.service.jp.newrelic.com

エンドポイント

方法	終点	説明
`create`	`POST /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME`	新しいテーブルをアップロードします。
`update`	`PUT /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME`	既存のテーブルを置き換えます。
`read`	`GET /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME`	以前にアップロードされたテーブルをダウンロードします。
`delete`	`DELETE /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME`	指定されたテーブルを削除します。
`list`	`GET /v1/accounts/YOUR_ACCOUNT_ID`	このアカウントに対して以前に更新されたテーブルをリストします。

上記の NRQL Lookups API エンドポイントで必要な変数は以下で定義されています。

変数	タイプ	説明
`YOUR_ACCOUNT_ID`	`number`	テーブルが属するアカウント
`TABLE_NAME`	`string`	保存されているテーブルの名前。テーブル名は、カスタムイベントタイプの標準に準拠する必要があります。最大長さ: 255 英数字、アンダースコア、コロンを組み合わせて使用できます。

変数

タイプ

説明

YOUR_ACCOUNT_ID

number

テーブルが属するアカウント

TABLE_NAME

string

保存されているテーブルの名前。テーブル名は、カスタムイベントタイプの標準に準拠する必要があります。

最大長さ: 255
英数字、アンダースコア、コロンを組み合わせて使用できます。

認証

は NRQL Lookups API へのリクエストを認証するために使用され、HTTP ヘッダーとして渡す必要があります。

ヘッダー	対応値
`Api-Key`	New Relic 。

テーブルの作成/更新

HTTPエンドポイント

クリエイト

POST /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME

新しいテーブルをアップロードするために使用されます。テーブルがすでに存在していることはできません。存在する場合、この呼び出しにより400 Bad Request応答が返されます。

アップデート

PUT /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME

既存のテーブルを置き換えるために使用されます。テーブルが存在しない場合、この呼び出しにより404 Not Found応答が返されます。

リクエストクエリパラメータ

名前	タイプ	デフォルト	説明
`includeTable`	`boolean`	`false`	応答にテーブル値を含めるかどうかを示します。

HTTPヘッダー

HTTPヘッダーを作成する際には、以下のガイドラインを参考にしてください。

ヘッダー	対応値
`Content-Type`	`multipart/form-data` `application/json`
`Accept`	`application/json`

リクエストボディ

リクエスト本文で送信するデータは、 multipart/form-dataまたはapplication/jsonのいずれかです。

サポートされているフィールド

multipart/form-dataコンテンツを送信するときに、作成リクエストと更新リクエストに次のフィールドを指定できます。

フィールド	値のタイプ	必須	説明
`table`	CSVファイル	はい	CSV コンテンツを含むマルチパートフォームデータパーツ。CSV 解析ロジックの詳細は、ここで説明されています。
`description`	`string`	いいえ	テーブルの説明を含む 2 番目のマルチパートフォームデータパート。

ペイロードの例

--__X_BOUNDARY__
Content-Disposition: form-data; name="table"; filename="sample.csv"
Content-Type: text/csv

id,name,intvalue,floatvalue,boolvalue
'1,abc,27,2.7,true
'2,def,2622,26.22,false
'2a,"g,hi",1234,43.21,false
--__X_BOUNDARY__--
Content-Disposition: form-data; name="description"

A description of the table
--__X_BOUNDARY__--

サポートされているフィールド

application/jsonコンテンツを送信するときに、作成および更新で次のフィールドを指定できます。

フィールド

値のタイプ

必須

説明

table

JSON

はい

`headers`	テーブルの列名を表す`string`値の配列
`rows`	テーブルの値を表す配列の配列。すべての値は、 `string` 、 `number` 、または`boolean`値である必要があります。(複雑な JSON オブジェクトは許可されません。)

description

string

いいえ

テーブルの詳しい説明

ペイロードの例

{
  "table": {
    "headers": ["id", "name", "intvalue", "floatvalue", "boolvalue"],
    "rows": [
      ["1", "abc", 27, 2.7, true],
      ["2", "def", 2622, 26.22, false],
      ["2a", "d,ef", 1234, 43.21, false]
    ]
  },
  "description": "This is a description."
}

応答本文

リクエストが成功した場合、レスポンスの JSON ペイロードには次のフィールドが含まれる場合があります。

フィールド

値のタイプ

説明

accountId

number

テーブルが属するアカウント。これはパス内のアカウント値と一致します。

name

string

保存されているテーブルの名前。これはパス内の名前の値と一致します。

description

string

テーブルの詳しい説明

guid

string

作成時にテーブルに割り当てられる guid。

size

number

CSV 文字列としてのテーブルのサイズ。

rows

number

テーブルの行数（ヘッダー行を除く）

updatedBy

string

このテーブルを最後に作成または更新したユーザーのユーザー名/電子メールアドレス。

updatedAt

string

テーブルが作成されたとき、または最後に更新されたときのタイムスタンプ。これは、S3 オブジェクトの最後に更新されたタイムスタンプを反映します。値は標準の ISO 8601 日付時刻文字列 (例:2023-02-13T19:49:28.023Z)

table

JSON オブジェクトリテラル

`headers`	テーブルの列名を表す`string`値の配列
`rows`	テーブルの値を表す配列の配列。

応答の JSON ペイロードの例

{
  "accountId": YOUR_ACCOUNT_ID,
  "name": "sample",
  "guid": "eac37270-7c02-4ca9-b178-8be5748b5b09",
  "size": 120
  "rows": 3
  "updatedBy": "jondoe@example.com"
  "updatedAt": "2023-02-13T19:49:28.023Z",
  "table": {
    "headers": [
      "id", "name", "description", "intvalue", "floatvalue", "boolvalue"
    ],
    "rows": [
      [1, "abc", 27, 2.7, true],
      [2, "def", 2622, 26.22, false],
      ["2a", "d,ef", 1234, 43.21, false]
    ]
  }
}

リクエストの例

新しいルックアップテーブルを作成するには、ルックアップテーブルを記述する JSON ペイロードを含む POST リクエストを作成エンドポイントに送信します。

curlコマンドの例を次に示します。

bash

$curl -X "POST" "https://nrql-lookup.service.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME" \
>      -H 'Content-Type: application/json' \
>      -H 'Api-Key: YOUR_USER_KEY'\
>      -d $'{
$  "table": {
$  "headers": ["id", "name", "intvalue", "floatvalue", "boolvalue"],
$  "rows": [
$      ["1", "abc", 27, 2.7, true],
$      ["2", "def", 2622, 26.22, false]
$  ]
$  },
$  "description": "This is a description."
$  }'

既存のルックアップテーブルを置き換えるには、新しいテーブルを含むmultipart/form-dataリクエスト本文を含む PUT リクエストを更新エンドポイントに送信します。

bash

$curl -X "PUT" "https://nrql-lookup.service.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME" \
>   -H 'Api-Key: YOUR_USER_KEY'\
>   -H 'Content-Type: multipart/form-data; charset=utf-8; boundary=__X_PAW_BOUNDARY__' \
>   -F "table=id,name,description,intvalue,floatvalue,boolvalue
$      1,abc,desc1,27,2.7,true
$      2,def,desc2,2622,26.22,false
$      " \
>   -F "description=This is a description."

表を読む

HTTPエンドポイント

GET /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME

以前にアップロードされたテーブルをダウンロードするために使用されます。テーブルが存在しない場合、この呼び出しにより404 Not Found応答が返されます。このエンドポイントにはリクエストペイロードがありません。

リクエストクエリパラメータ

名前	タイプ	デフォルト	説明
`includeTable`	`boolean`	`false`	応答にテーブル値を含めるかどうかを示します。コンテンツタイプが`text/csv`の場合は無視されます。

HTTPヘッダー

HTTPヘッダーを作成する際には、以下のガイドラインを参考にしてください。

ヘッダー	対応値
`Accept`	`application/json` `text/csv`

応答本文

リクエストが成功した場合、レスポンスのタイプはapplication/jsonまたはtext/csvになります。

`application/json`タイプの応答

応答は、作成/更新応答ペイロードと同じになります。

`text/csv`タイプの応答

応答には CSV 形式のテーブルが含まれます。

リクエストの例

以前にアップロードされたテーブルをダウンロードするには、更新エンドポイントに GET リクエストを送信します。

curlコマンドの例を次に示します。

bash

$curl "https://nrql-lookup.service.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME" \
>     -H 'Accept: text/csv' \
>     -H 'Api-Key: YOUR_USER_KEY'

text/csv応答の例を次に示します。

id,name,intvalue,floatvalue,boolvalue
'1,abc,27,2.7,true
'2,def,2622,26.22,false
'2a,"g,hi",1234,43.21,false

テーブルの削除

HTTPエンドポイント

DELETE /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME

指定されたテーブルを削除するために使用されます。テーブルが存在しない場合、この呼び出しにより404 Not Found応答が返されます。このエンドポイントにはリクエストペイロードがありません。

重要

削除されたテーブルは回復できません。

リクエストクエリパラメータ

名前	タイプ	デフォルト	説明
`includeTable`	`boolean`	`false`	応答にテーブル値を含めるかどうかを示します。

HTTPヘッダー

HTTPヘッダーを作成する際には、以下のガイドラインを参考にしてください。

ヘッダー	対応値
`Accept`	`application/json`

応答本文

リクエストが成功し、 Acceptヘッダーがapplication/jsonに設定されている場合、レスポンス本文は作成/更新レスポンスペイロードと同じになります。

リクエストの例

以前にアップロードされたテーブルを削除するには、削除エンドポイントに DELETE リクエストを送信します。

curlコマンドの例を次に示します。

bash

$curl -X "DELETE" "https://nrql-lookup.service.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME" \
>     -H 'Accept: application/json' \
>     -H 'Api-Key: YOUR_USER_KEY'\

リストテーブル

HTTPエンドポイント

GET /v1/accounts/YOUR_ACCOUNT_ID

このアカウントに対して以前に更新されたテーブルをリストします。このエンドポイントにはリクエストペイロードがありません。

HTTPヘッダー

HTTPヘッダーを作成する際には、以下のガイドラインを参考にしてください。

ヘッダー	対応値
`Accept`	`application/json`

応答本文

リクエストが成功すると、レスポンスの JSON ペイロードはテーブル概要の配列で構成されます。各テーブルの概要には以下のフィールドを含めることができます。

フィールド	値のタイプ	説明
`accountId`	`number`	テーブルが属するアカウント。これはパス内のアカウント値と一致します。
`name`	`string`	保存されているテーブルの名前。これはパス内の名前の値と一致します。
`description`	`string`	テーブルの詳しい説明
`guid`	`string`	作成時にテーブルに割り当てられる guid。
`size`	`number`	CSV 文字列としてのテーブルのサイズ。
`rows`	`number`	テーブルの行数（ヘッダー行を除く）
`updateBy`	`string`	このテーブルを最後に更新したユーザーのユーザー名/電子メールアドレス。
`updatedAt`	`string`	テーブルが作成されたとき、または最後に更新されたときのタイムスタンプ。これは、S3 オブジェクトの最後に更新されたタイムスタンプを反映します。値は標準の ISO 8601 日付時刻文字列 (例:2023-02-13T19:49:28.023Z)

リクエストの例

アカウントのテーブルをリストするには、リストエンドポイントに GET リクエストを送信します。

curlコマンドの例を次に示します。

bash

$curl "https://nrql-lookup.service.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID" \
>     -H 'Accept: text/csv' \
>     -H 'Api-Key: YOUR_USER_KEY'

応答 JSON ペイロードの例を次に示します。

[
  {
    "accountId": YOUR_ACCOUNT_ID,
    "name": "sample",
    "guid": "eac37270-7c02-4ca9-b178-8be5748b5b09",
    "size": 120
    "rows": 3
    "updatedBy": "jondoe@example.com"
    "updatedAt": "2023-02-13T19:49:28.023Z"
  },
  {
    "accountId": YOUR_ACCOUNT_ID,
    "name": "sample2",
    "guid": "eac37270-7c02-4ca9-b178-8be5748b5b09",
    "size": 4096
    "rows": 2000
    "updatedBy": "janedoe@example.com"
    "updatedAt": "2023-02-14T13:30:21.100Z"
  }
]

エラーメッセージ

リクエストが失敗した場合、エラー応答ペイロードは次の形式になります。

{
  "code": HTTP_STATUS_CODE(same as status header),
  "message": ERROR_MESSAGE
}

この機械翻訳は、参考として提供されています。

始める前に.css-21sua1{background:none;border:none;width:0;padding:0;}

HTTPエンドポイント

ベースURL

エンドポイント

認証

テーブルの作成/更新

HTTPエンドポイント

クリエイト

アップデート

リクエストクエリパラメータ

HTTPヘッダー

リクエストボディ

application/json によるリクエスト

応答本文

応答の JSON ペイロードの例

リクエストの例

新しいテーブルを作成する

既存のテーブルを更新する

表を読む

HTTPエンドポイント

リクエストクエリパラメータ

HTTPヘッダー

応答本文

application/jsonタイプの応答

text/csvタイプの応答

リクエストの例

既存のテーブルをダウンロードする

テーブルの削除

HTTPエンドポイント

重要

リクエストクエリパラメータ

HTTPヘッダー

応答本文

リクエストの例

既存のテーブルを削除する

リストテーブル

HTTPエンドポイント

HTTPヘッダー

応答本文

リクエストの例

アカウント用に更新されたリストテーブル

エラーメッセージ

始める前に

`application/json`タイプの応答

`text/csv`タイプの応答