サービス

サービスの一覧

GET /api/v0/services

APIキーに必要な権限

  • Read

応答

{
  "services": [<service>, <service>, ...]
}

<service> は以下のキーを持つオブジェクトです。

KEY TYPE DESCRIPTION
name string サービス名。
memo string このサービスに関するメモ。Web UI から編集できます。
roles array[string] サービスに属するロール名の配列。

配列の並び順はサービスの名前順です。

サービスの登録

POST /api/v0/services

APIキーに必要な権限

  • Read
  • Write

入力

KEY TYPE DESCRIPTION
name string サービス名。
memo string このサービスに関するメモ。

サービス名について

サービス名にはアルファベット(A-Za-z)、 数字(0-9)、ハイフン(-)、アンダースコア(_)が利用できます。 ただし、ハイフンとアンダースコアは先頭には使えず、2文字以上63文字以内に収める必要があります。

また、ひとつのオーガニゼーションの中に、同じ名前のサービスを複数つくることはできません。

入力例

{
  "name": "ExampleService",
  "memo": "This is an example."
}

応答

作成されたサービスが返却されます。フォーマットはサービスの一覧APIの<service>オブジェクトと同じ形式です。

成功時

{
    "name": <serviceName>,
    "memo": <memo>,
    "roles": []
}
KEY TYPE DESCRIPTION
name string サービス名。
memo string サービスに関するメモ。
roles array[string] サービスに属するロール名の配列。作成直後は空になっています。

失敗時

STATUS CODE DESCRIPTION
400 <serviceName>が上記のサービス名の制約を満たさなかったとき
403 APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合

サービスの削除

DELETE /api/v0/services/<serviceName>

サービスに紐付けられているロール、サービスメトリック、監視ルール、グラフアノテーションも同時に削除されます。

APIキーに必要な権限

  • Read
  • Write

応答

削除される直前のサービスの状態が返却されます。

成功時

{
    "name": <serviceName>,
    "memo": <memo>,
    "roles": [<roleName>, <roleName>, ...]
}
KEY TYPE DESCRIPTION
name string サービス名。
memo string サービスに関するメモ。
roles array[string] サービスに属していたロール名の配列。

配列の並び順はロールの名前順です。

失敗時

STATUS CODE DESCRIPTION
404 <serviceName>に対応するサービスが見つからないとき
403 APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合

ロールの一覧

GET /api/v0/services/<serviceName>/roles

APIキーに必要な権限

  • Read

応答

成功時

{
  "roles": [<role>, <role>, ...]
}

<role> は以下のキーを持つオブジェクトです。

KEY TYPE DESCRIPTION
name string ロール名。
memo string このロールに関するメモ。Web UI から編集できます。

配列の並び順はロールの名前順です。

失敗時

STATUS CODE DESCRIPTION
404 <serviceName>に対応するサービスが見つからないとき

ロールの登録

POST /api/v0/services/<serviceName>/roles

APIキーに必要な権限

  • Read
  • Write

入力

KEY TYPE DESCRIPTION
name string ロール名。
memo string このロールに関するメモ。

ロール名について

ロール名にはアルファベット(A-Za-z)、 数字(0-9)、ハイフン(-)、アンダースコア(_)が利用できます。 ただし、ハイフンとアンダースコアは先頭には使えず、2文字以上63文字以内に収める必要があります。

また、ひとつのサービスの中に、同じ名前のロールを複数つくることはできません。

入力例

{
  "name": "ExampleRole",
  "memo": "This is an example."
}

応答

作成されたロールが返却されます。フォーマットはロールの一覧APIの<role>オブジェクトと同じ形式です。

成功時

{
    "name": <roleName>,
    "memo": <memo>
}
KEY TYPE DESCRIPTION
name string ロール名。
memo string このロールに関するメモ。Web UI から編集できます。

失敗時

STATUS CODE DESCRIPTION
404 <serviceName>に対応するサービスが見つからないとき
400 <roleName>が上記のロール名の制約を満たさなかったとき
403 APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合

ロールの削除

DELETE /api/v0/services/<serviceName>/roles/<roleName>

APIキーに必要な権限

  • Read
  • Write

応答

削除される直前のロールの状態が返却されます。

成功時

{
    "name": <roleName>,
    "memo": <memo>
}
KEY TYPE DESCRIPTION
name string ロール名。
memo string ロールに関するメモ。

失敗時

STATUS CODE DESCRIPTION
404 <serviceName>に対応するサービスや<roleName>に対応するロールが見つからないとき
403 APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合

メトリック名の一覧

GET /api/v0/services/<serviceName>/metric-names

APIキーに必要な権限

  • Read

応答

成功時

{
  "names": [<metricName>, <metricName>, ...]
}
KEY TYPE DESCRIPTION
names array[string] サービスに投稿されているメトリック名。

失敗時

STATUS CODE DESCRIPTION
404 <serviceName>に対応するサービスが見つからないとき