読者です 読者をやめる 読者になる 読者になる

メタデータ

ホストメタデータ

このAPIを用いると、各ホストに任意のJSONデータを登録することができます。ホストの管理用IDや、その他運用上の管理データなど、様々な情報を登録してご利用いただけます。

ネームスペースとは、メタデータの種類を特定する識別子です。例えばprojectenvironmentなど、各ホストで一貫した識別子を用いることを推奨します。メタデータの取得・登録・更新・削除のエンドポイントは一貫して以下のURLとなっています。

/api/v0/hosts/<hostId>/metadata/<namespace>

このエンドポイントにJSON (オブジェクト・配列・文字列・数字・真偽値・null) を登録し、取得することができます。

{
  "type": 12345,
  "region": "jp",
  "env": "staging",
  "instance_type": "c4.xlarge"
}

ネームスペースにはアルファベットと数字、_-を用いることができます ([-a-zA-Z0-9_]+)。ただしmackerelから始まるネームスペースは、Mackerelのシステムが利用します。

ホストメタデータの取得

登録されたメタデータを取得します。

GET /api/v0/hosts/<hostId>/metadata/<namespace>

APIキーに必要な権限

  • Read

応答

登録されているデータのJSONが返されます

失敗時
STATUS CODE DESCRIPTION
400 ホストが退役して一週間以上経過している時
404 ホストが存在しない時
404 ホストに指定されたメタデータが存在しない時

ホストメタデータの登録・更新

任意のJSONをホストのメタデータとして登録と更新を行います。

PUT /api/v0/hosts/<hostId>/metadata/<namespace>

APIキーに必要な権限

  • Read
  • Write

入力

任意のJSONを指定できます。ただしデータのサイズは100KBまでに制限されています。

応答

{
  "success": true
}

失敗時

STATUS CODE DESCRIPTION
400 ホストがすでに退役している時
400 ネームスペースが不正な値の時
400 ホストあたりのメタデータの制限 (1ホストあたり50個) を超過して登録しようとした時
404 ホストが存在しない時
403 必要な権限がないとき
413 メタデータが100KBを超過している時

ホストメタデータの削除

DELETE /api/v0/hosts/<hostId>/metadata/<namespace>

APIキーに必要な権限

  • Read
  • Write

応答

成功時

{
  "success": true
}

失敗時

STATUS CODE DESCRIPTION
400 ホストがすでに退役している時
404 ホストが存在しない時
404 ホストに指定されたメタデータが存在しない時
403 必要な権限がないとき