重要
ラベル/タグへのRESTAPIの使用は、2022年3月31日にサポート終了に達し、それ以降は使用できなくなります。タグを追加する方法については、 タグを参照してください。
ラベルの作成
ラベル/タグにREST APIを使用することは非推奨です。 タグを追加する方法については、 タグ をご覧ください。
REST APIを使用してラベルを作成または適用するには、以下が必要です。
例題の
NEW_RELIC_USER_KEY
は、お客様の ユーザーキー を表しています。
このラベルは、既存の アプリケーション ID に適用する必要があります。
ラベルは、 guidelines for category labels に準拠する必要があります。
お客様のアカウントに存在するアプリケーションにラベルを適用するには、次の例のようなコマンドを使用します。この例では、お客様のユーザーキーと アプリケーションID を置き換えてください。
このコマンドを使うと、アプリケーションとホストに同時に同じラベルを適用することができます。また、必要なければ " applications":
の部分を省略することもできます。
curl -X PUT 'https://api.newrelic.com/v2/labels.json' \
-H "Api-Key:NEW_RELIC_USER_KEY" -i \
-H 'Content-Type: application/json' \
-d \
'{
"label": {
"category": "Production",
"name": "Web01",
"links": {
"applications": [
123456,7898765 <---<< application ids
],
}
}
}'
ラベルを作成します。出力を見る
ラベルを作成または適用する際の出力は、単一の適用の場合、以下の例のように表示されます。ラベルの出力には
- ラベルの完全なキー名(例:
Production:Main
)、キーのコンポーネントと名前 - アプリケーション
health_status
(red, orange, green, gray)と、各カテゴリのラベルのアプリケーションID。例えば、アプリID 546917のhealth statusはgreen(アプリは問題なし)。 - このラベルを持つアプリケーション。例えば、
Production:Main
というラベルが1つのアプリケーション(546917)に適用されています。
{ "label": { "key": "Production:Main", "category": "Production", "name": "Main", "application_health_status": { "green": [ 546917 <---application id ], "orange": [], "red": [], "gray": [] }, "links": { "applications": [ 546917 <--- application id ], } },...}
ラベル返却状況の作成
ラベルを作成する際のリターンステータスは2種類あります。
復帰状況 | 定義 |
---|---|
201 クリエイト | ラベルの作成に成功しました。 |
304 変更なし | 既存のラベルを再作成する試みがありましたが、変更の必要はありませんでした。 |
既存ラベルの一覧表示
ラベル/タグのREST APIの使用は非推奨です。 タグの使用方法については、 タグ をご覧ください。
アカウントに存在するラベルを一覧表示するには、このコマンドを使用します。
curl 'https://api.newrelic.com/v2/labels.json' \
-H "Api-Key:NEW_RELIC_USER_KEY" -i
出力を見る
このレーベルのアウトプットには
- ラベルの完全なキー名(例:
Staging:Test1
)、キーのコンポーネントと名前。 - アプリケーション
health_status
(赤、オレンジ、緑、グレー)、各カテゴリーのラベルのアプリケーションID - このラベルを持つアプリケーション。例えば、
Staging:Test1
というラベルが、1つのアプリケーション(4937390)と2つのホスト(3801143と5879721)に適用されている場合。
ラベルリストの出力は以下のようになります。
{ "labels": [ { "key": "Production:Main", "category": "Production", "name": "Main", "application_health_status": { "green": [], "orange": [], "red": [], "gray": [] }, "links": { "applications": [], } }, { "key": "Staging:Test1", "category": "Staging", "name": "Test1", "application_health_status": { "green": [], "orange": [], "red": [ 4937390 ], "gray": [] }, "links": { "applications": [ 4937390 ], } },...}
ラベルの削除
ラベル/タグのREST APIの使用は非推奨です。 タグの使用方法については、 タグ をご覧ください。
注意
この API コールは、アプリケーションとホストの両方から ラベルのすべての インスタンスを削除します。特定のアプリケーションやホストからラベルを削除したい場合は、 New Relic UI を使用する必要があります。
アカウントからラベルを削除するには、次の例のようなコマンドを使用します。
curl -X DELETE 'https://api.newrelic.com/v2/labels/Production:Main.json' \
-H "Api-Key:NEW_RELIC_USER_KEY" -i
また、New Relic REST API Explorer (v2) を使用して、 ラベルの削除 を行うことができます。
Deleting: 出力を見る
ラベルを削除する際の出力は、単一のアプリケーションの場合、次の例のように表示されます。この例では、 Production:Main
というラベルを、そのアカウントの REST API キー で適用されたすべての場所から削除します。
ラベルを削除する際の出力には
- ラベルの完全なキー名(例:
Production:Main
)、キーのコンポーネントと名前 - アプリケーション
health_status
(red, orange, green, gray)と、各カテゴリのラベルのID。例えば、アプリID 546917のhealth statusはgreen(アプリは問題なし) - このラベルを持つアプリケーション。例えば、
Production:Main
というラベルは、あるアプリケーションから削除されています(546917)。
{ "label": { "key": "Production:Main", "category": "Production", "name": "Main", "application_health_status": { "green": [ 546917 ], "orange": [], "red": [], "gray": [] }, "links": { "applications": [ 546917 ], } }, ....}
返品ステータスの削除
ラベルを削除したときのリターンステータスは2種類あります。
復帰状況 | 定義 |
---|---|
200 OK | ラベルの削除に成功しました。 |
404 変更なし | 存在しないラベルを削除しようとしました。 |