API docs by Redocly

モニタリングスイート API ドキュメント (1.0.0)

Download OpenAPI specification:Download

License: Copyright(C) SAKURA internet Inc. all rights reserved.

「モニタリングスイート」が提供するAPIの利用方法とサンプルを公開しております。

基本的な使い方

APIキーの発行

APIを利用するためには、認証のための「APIキー」が必要です。事前にキーを発行しておきます。 APIキーは「ユーザーID」「パスワード」に相当する「トークン」と呼ばれる認証情報で構成されています。

項目名 APIキー発行時の項目名 このドキュメント内での例
ユーザーID アクセストークン(UUID) 01234567-89ab-cdef-0123-456789abcdef
パスワード アクセストークンシークレット SAMPLETOKENSAMPLETOKENSAMPLETOKENSAM
操作マニュアル

入力パラメータ

APIの入力には送信先URLに対して、いくつかのヘッダーとAPIキーを送信します。

  • 認証方式はHTTP Basic認証です。APIキーのアクセストークンをユーザーID、アクセストークンシークレットをパスワードとして指定します。
# 入力サンプル
curl -u '01234567-89ab-cdef-0123-456789abcdef:SAMPLETOKENSAMPLETOKENSAMPLETOKENSAM' \
     -x GET \
     'https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/logs/storages/'

出力結果と応答コード（HTTPステータスコード）

APIからの結果は、「応答コード（HTTPステータスコード）」と、「JSON形式(UTF-8)の結果」として出力されます。

応答コードは、リクエストが成功したのか、失敗したのか大まかな情報を判断することができるもので、例えば失敗したときには、なぜこのような結果になったのかなど、具体的な情報は応答コードと主に返された本文を見ることで把握することができます。

結果 応答コード/status
成功（要求を受け付けた） 2xx
失敗（要求が受け付けられなかった） 4xx, 5xx

アラート

アラートプロジェクト一覧取得API

アラートプロジェクトを管理するためのAPIエンドポイントです。

query Parameters
count
integer

Number of results to return per page.

from
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "from": 0,
  • "total": 123,
  • "is_ok": true,
  • "results": [
    ]
}

アラートプロジェクト作成API

アラートプロジェクトを管理するためのAPIエンドポイントです。

Request Body schema:
is_system
boolean
Default: false
name
required
string
description
required
string

Responses

Request samples

Content type
{
  • "is_system": false,
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "name": "string",
  • "description": "string",
  • "tags": [
    ],
  • "icon": {
    },
  • "account_id": "string",
  • "resource_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "is_system": true,
  • "rules_url": "string",
  • "notification_targets_url": "string",
  • "notification_routing_url": "string",
  • "histories_url": "string"
}

アラートプロジェクト詳細取得API

アラートプロジェクトを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Alert Project.

Responses

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "name": "string",
  • "description": "string",
  • "tags": [
    ],
  • "icon": {
    },
  • "account_id": "string",
  • "resource_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "is_system": true,
  • "rules_url": "string",
  • "notification_targets_url": "string",
  • "notification_routing_url": "string",
  • "histories_url": "string",
  • "is_ok": true
}

アラートプロジェクト更新API

アラートプロジェクトを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Alert Project.

Request Body schema:
name
string <= 256 characters
description
string <= 256 characters

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "name": "string",
  • "description": "string",
  • "tags": [
    ],
  • "icon": {
    },
  • "account_id": "string",
  • "resource_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "is_system": true,
  • "rules_url": "string",
  • "notification_targets_url": "string",
  • "notification_routing_url": "string",
  • "histories_url": "string",
  • "is_ok": true
}

アラートプロジェクト部分更新API

アラートプロジェクトを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Alert Project.

Request Body schema:
name
string <= 256 characters
description
string <= 256 characters

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "name": "string",
  • "description": "string",
  • "tags": [
    ],
  • "icon": {
    },
  • "account_id": "string",
  • "resource_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "is_system": true,
  • "rules_url": "string",
  • "notification_targets_url": "string",
  • "notification_routing_url": "string",
  • "histories_url": "string",
  • "is_ok": true
}

アラートプロジェクト削除API

アラートプロジェクトを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Alert Project.

Responses

アラート履歴一覧取得API

アラートプロジェクト内のアラート履歴を取得するAPIエンドポイントです。

path Parameters
project_pk
required
integer
query Parameters
count
integer

Number of results to return per page.

from
integer

The initial index from which to return the results.

open
boolean
severity
string
Enum: "critical" "warning"
  • warning - Warning
  • critical - Critical
startsAt
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "from": 0,
  • "total": 123,
  • "is_ok": true,
  • "results": [
    ]
}

アラート履歴詳細取得API

アラートプロジェクト内のアラート履歴を取得するAPIエンドポイントです。

path Parameters
id
required
integer

A unique integer value identifying this Alert History.

project_pk
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "project_id": 0,
  • "rule_id": 0,
  • "startsAt": "2019-08-24T14:15:22Z",
  • "endsAt": "2019-08-24T14:15:22Z",
  • "open": true,
  • "labels": "string",
  • "severity": "warning",
  • "query": "string",
  • "threshold": "string",
  • "value": 0
}

通知対象一覧取得API

アラートプロジェクト内の通知対象を管理するAPIエンドポイントです。

path Parameters
project_pk
required
integer
query Parameters
count
integer

Number of results to return per page.

from
integer

The initial index from which to return the results.

service_type
string
Value: "SAKURA_SIMPLE_NOTICE"
  • SAKURA_SIMPLE_NOTICE - Sakura cloud simple notice

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "from": 0,
  • "total": 123,
  • "is_ok": true,
  • "results": [
    ]
}

通知対象作成API

アラートプロジェクト内の通知対象を管理するAPIエンドポイントです。

path Parameters
project_pk
required
integer
Request Body schema:
service_type
required
string
Value: "SAKURA_SIMPLE_NOTICE"
  • SAKURA_SIMPLE_NOTICE - Sakura cloud simple notice
url
required
string <= 1024 characters
description
string <= 100 characters

Responses

Request samples

Content type
{
  • "service_type": "SAKURA_SIMPLE_NOTICE",
  • "url": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "project_id": 0,
  • "service_type": "SAKURA_SIMPLE_NOTICE",
  • "url": "string",
  • "config": { },
  • "description": "string"
}

通知対象詳細取得API

アラートプロジェクト内の通知対象を管理するAPIエンドポイントです。

path Parameters
id
required
integer

A unique integer value identifying this notification target.

project_pk
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "project_id": 0,
  • "service_type": "SAKURA_SIMPLE_NOTICE",
  • "url": "string",
  • "config": { },
  • "description": "string"
}

通知対象更新API

アラートプロジェクト内の通知対象を管理するAPIエンドポイントです。

path Parameters
id
required
integer

A unique integer value identifying this notification target.

project_pk
required
integer
Request Body schema:
service_type
required
string
Value: "SAKURA_SIMPLE_NOTICE"
  • SAKURA_SIMPLE_NOTICE - Sakura cloud simple notice
url
required
string <= 1024 characters
description
string <= 100 characters

Responses

Request samples

Content type
{
  • "service_type": "SAKURA_SIMPLE_NOTICE",
  • "url": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "project_id": 0,
  • "service_type": "SAKURA_SIMPLE_NOTICE",
  • "url": "string",
  • "config": { },
  • "description": "string"
}

通知対象部分更新API

アラートプロジェクト内の通知対象を管理するAPIエンドポイントです。

path Parameters
id
required
integer

A unique integer value identifying this notification target.

project_pk
required
integer
Request Body schema:
service_type
string
Value: "SAKURA_SIMPLE_NOTICE"
  • SAKURA_SIMPLE_NOTICE - Sakura cloud simple notice
url
string <= 1024 characters
description
string <= 100 characters

Responses

Request samples

Content type
{
  • "service_type": "SAKURA_SIMPLE_NOTICE",
  • "url": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "project_id": 0,
  • "service_type": "SAKURA_SIMPLE_NOTICE",
  • "url": "string",
  • "config": { },
  • "description": "string"
}

通知対象削除API

アラートプロジェクト内の通知対象を管理するAPIエンドポイントです。

path Parameters
id
required
integer

A unique integer value identifying this notification target.

project_pk
required
integer

Responses

アラートルール一覧取得API

アラートプロジェクト内のアラートルールを管理するためのAPIエンドポイントです。

path Parameters
project_pk
required
integer
query Parameters
count
integer

Number of results to return per page.

from
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "from": 0,
  • "total": 123,
  • "is_ok": true,
  • "results": [
    ]
}

アラートルール作成API

アラートプロジェクト内のアラートルールを管理するためのAPIエンドポイントです。

path Parameters
project_pk
required
integer
Request Body schema:
tank_id
required
integer or null <int64> (Cloud resource id)
name
string <= 256 characters
query
required
string <= 4096 characters
format
string <= 256 characters
template
string <= 256 characters
enabled_warning
boolean (Enabled)
enabled_critical
boolean
threshold_warning
string or null <= 256 characters
threshold_critical
string or null <= 256 characters
threshold_duration_warning
integer <int64> (Threshold duration)
threshold_duration_critical
integer <int64>

Responses

Request samples

Content type
{
  • "tank_id": 0,
  • "name": "string",
  • "query": "string",
  • "format": "string",
  • "template": "string",
  • "enabled_warning": true,
  • "enabled_critical": true,
  • "threshold_warning": "string",
  • "threshold_critical": "string",
  • "threshold_duration_warning": 0,
  • "threshold_duration_critical": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "project_id": 0,
  • "tank_id": 0,
  • "name": "string",
  • "query": "string",
  • "format": "string",
  • "template": "string",
  • "open": true,
  • "enabled_warning": true,
  • "enabled_critical": true,
  • "threshold_warning": "string",
  • "threshold_critical": "string",
  • "threshold_duration_warning": 0,
  • "threshold_duration_critical": 0,
  • "history_url": "string"
}

アラートルール詳細取得API

アラートプロジェクト内のアラートルールを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer

A unique integer value identifying this Alert Rule.

project_pk
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "project_id": 0,
  • "tank_id": 0,
  • "name": "string",
  • "query": "string",
  • "format": "string",
  • "template": "string",
  • "open": true,
  • "enabled_warning": true,
  • "enabled_critical": true,
  • "threshold_warning": "string",
  • "threshold_critical": "string",
  • "threshold_duration_warning": 0,
  • "threshold_duration_critical": 0,
  • "history_url": "string"
}

アラートルール更新API

アラートプロジェクト内のアラートルールを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer

A unique integer value identifying this Alert Rule.

project_pk
required
integer
Request Body schema:
tank_id
required
integer or null <int64> (Cloud resource id)
name
string <= 256 characters
query
required
string <= 4096 characters
format
string <= 256 characters
template
string <= 256 characters
enabled_warning
boolean (Enabled)
enabled_critical
boolean
threshold_warning
string or null <= 256 characters
threshold_critical
string or null <= 256 characters
threshold_duration_warning
integer <int64> (Threshold duration)
threshold_duration_critical
integer <int64>

Responses

Request samples

Content type
{
  • "tank_id": 0,
  • "name": "string",
  • "query": "string",
  • "format": "string",
  • "template": "string",
  • "enabled_warning": true,
  • "enabled_critical": true,
  • "threshold_warning": "string",
  • "threshold_critical": "string",
  • "threshold_duration_warning": 0,
  • "threshold_duration_critical": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "project_id": 0,
  • "tank_id": 0,
  • "name": "string",
  • "query": "string",
  • "format": "string",
  • "template": "string",
  • "open": true,
  • "enabled_warning": true,
  • "enabled_critical": true,
  • "threshold_warning": "string",
  • "threshold_critical": "string",
  • "threshold_duration_warning": 0,
  • "threshold_duration_critical": 0,
  • "history_url": "string"
}

アラートルール部分更新API

アラートプロジェクト内のアラートルールを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer

A unique integer value identifying this Alert Rule.

project_pk
required
integer
Request Body schema:
tank_id
integer or null <int64> (Cloud resource id)
name
string <= 256 characters
query
string <= 4096 characters
format
string <= 256 characters
template
string <= 256 characters
enabled_warning
boolean (Enabled)
enabled_critical
boolean
threshold_warning
string or null <= 256 characters
threshold_critical
string or null <= 256 characters
threshold_duration_warning
integer <int64> (Threshold duration)
threshold_duration_critical
integer <int64>

Responses

Request samples

Content type
{
  • "tank_id": 0,
  • "name": "string",
  • "query": "string",
  • "format": "string",
  • "template": "string",
  • "enabled_warning": true,
  • "enabled_critical": true,
  • "threshold_warning": "string",
  • "threshold_critical": "string",
  • "threshold_duration_warning": 0,
  • "threshold_duration_critical": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "project_id": 0,
  • "tank_id": 0,
  • "name": "string",
  • "query": "string",
  • "format": "string",
  • "template": "string",
  • "open": true,
  • "enabled_warning": true,
  • "enabled_critical": true,
  • "threshold_warning": "string",
  • "threshold_critical": "string",
  • "threshold_duration_warning": 0,
  • "threshold_duration_critical": 0,
  • "history_url": "string"
}

アラートルール削除API

アラートプロジェクト内のアラートルールを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer

A unique integer value identifying this Alert Rule.

project_pk
required
integer

Responses

アラートルール履歴一覧取得API

アラートプロジェクト内のルール履歴を取得するAPIエンドポイントです。

path Parameters
project_pk
required
integer
rule_pk
required
integer
query Parameters
count
integer

Number of results to return per page.

from
integer

The initial index from which to return the results.

open
boolean
severity
string
Enum: "critical" "warning"
  • warning - Warning
  • critical - Critical
startsAt
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "from": 0,
  • "total": 123,
  • "is_ok": true,
  • "results": [
    ]
}

アラートルール履歴詳細取得API

アラートプロジェクト内のルール履歴を取得するAPIエンドポイントです。

path Parameters
id
required
integer

A unique integer value identifying this Alert History.

project_pk
required
integer
rule_pk
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "project_id": 0,
  • "rule_id": 0,
  • "startsAt": "2019-08-24T14:15:22Z",
  • "endsAt": "2019-08-24T14:15:22Z",
  • "open": true,
  • "labels": "string",
  • "severity": "warning",
  • "query": "string",
  • "threshold": "string",
  • "value": 0
}

可視化

可視化プロジェクト一覧取得API

可視化プロジェクトを管理するためのAPIエンドポイントです。

query Parameters
count
integer

Number of results to return per page.

from
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "from": 0,
  • "total": 123,
  • "is_ok": true,
  • "results": [
    ]
}

可視化プロジェクト作成API

可視化プロジェクトを管理するためのAPIエンドポイントです。

Request Body schema:
is_system
boolean
Default: false
name
required
string
description
required
string

Responses

Request samples

Content type
{
  • "is_system": false,
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "name": "string",
  • "description": "string",
  • "is_system": true,
  • "tags": [
    ],
  • "icon": {
    },
  • "account_id": "string",
  • "resource_id": 0,
  • "created_at": "2019-08-24T14:15:22Z"
}

可視化プロジェクト詳細取得API

可視化プロジェクトを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Dashboard Project.

Responses

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "name": "string",
  • "description": "string",
  • "is_system": true,
  • "tags": [
    ],
  • "icon": {
    },
  • "account_id": "string",
  • "resource_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "is_ok": true
}

可視化プロジェクト更新API

可視化プロジェクトを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Dashboard Project.

Request Body schema:
name
string <= 256 characters
description
string <= 256 characters

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "name": "string",
  • "description": "string",
  • "is_system": true,
  • "tags": [
    ],
  • "icon": {
    },
  • "account_id": "string",
  • "resource_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "is_ok": true
}

可視化プロジェクト部分更新API

可視化プロジェクトを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Dashboard Project.

Request Body schema:
name
string <= 256 characters
description
string <= 256 characters

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "name": "string",
  • "description": "string",
  • "is_system": true,
  • "tags": [
    ],
  • "icon": {
    },
  • "account_id": "string",
  • "resource_id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "is_ok": true
}

可視化プロジェクト削除API

可視化プロジェクトを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Dashboard Project.

Responses

ログルーティング

ログルーティング一覧取得API

ログルーティングを管理するためのAPIエンドポイントです。

query Parameters
count
integer

Number of results to return per page.

from
integer

The initial index from which to return the results.

publisher__code
string
resource_id
integer
variant
string

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "from": 0,
  • "total": 123,
  • "is_ok": true,
  • "results": [
    ]
}

ログルーティング作成API

ログルーティングを管理するためのAPIエンドポイントです。

Request Body schema:
resource_id
integer or null <int64>
publisher_code
required
string
variant
required
string
log_storage_id
required
integer or null <int64> (Cloud resource id)

Responses

Request samples

Content type
{
  • "resource_id": 0,
  • "publisher_code": "string",
  • "variant": "string",
  • "log_storage_id": 0
}

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "resource_id": 0,
  • "publisher": {
    },
  • "variant": "string",
  • "log_storage": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_ok": true
}

ログルーティング詳細取得API

ログルーティングを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Routing log.

Responses

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "resource_id": 0,
  • "publisher": {
    },
  • "variant": "string",
  • "log_storage": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_ok": true
}

ログルーティング更新API

ログルーティングを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Routing log.

Request Body schema:
resource_id
integer or null <int64>
publisher_code
required
string
variant
required
string
log_storage_id
required
integer or null <int64> (Cloud resource id)

Responses

Request samples

Content type
{
  • "resource_id": 0,
  • "publisher_code": "string",
  • "variant": "string",
  • "log_storage_id": 0
}

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "resource_id": 0,
  • "publisher": {
    },
  • "variant": "string",
  • "log_storage": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_ok": true
}

ログルーティング部分更新API

ログルーティングを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Routing log.

Request Body schema:
resource_id
integer or null <int64>
publisher_code
string
variant
string
log_storage_id
integer or null <int64> (Cloud resource id)

Responses

Request samples

Content type
{
  • "resource_id": 0,
  • "publisher_code": "string",
  • "variant": "string",
  • "log_storage_id": 0
}

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "resource_id": 0,
  • "publisher": {
    },
  • "variant": "string",
  • "log_storage": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_ok": true
}

ログルーティング削除API

ログルーティングを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Routing log.

Responses

ログストレージ

ログストレージ一覧取得API

ログストレージを管理するためのAPIエンドポイントです。

query Parameters
account_id
string
bucket__classification
string
Enum: "separated" "shared"
  • shared - 共有
  • separated - 分離
count
integer

Number of results to return per page.

from
integer

The initial index from which to return the results.

is_system
boolean

Is system

resource_id
integer
status
string
Enum: "assigned" "deleted" "free" "init"
  • init - 初期化中
  • free - 未割り当て
  • assigned - 割り当て済み
  • deleted - 削除済み

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "from": 0,
  • "total": 123,
  • "is_ok": true,
  • "results": [
    ]
}

ログストレージ作成API

ログストレージを管理するためのAPIエンドポイントです。

Request Body schema:
classification
string
Default: "shared"
Enum: "shared" "separated"
  • shared - 共有
  • separated - 分離
is_system
required
boolean
name
required
string
description
required
string

Responses

Request samples

Content type
{
  • "classification": "shared",
  • "is_system": true,
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "tags": [
    ],
  • "icon": {
    },
  • "expire_day": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "endpoints": {
    },
  • "account_id": "string",
  • "resource_id": 0,
  • "is_system": true,
  • "usage": {
    }
}

ログストレージのアクセスキー一覧取得API

ログストレージのアクセスキーを管理するAPIエンドポイントです。

path Parameters
log_resource_id
required
integer <int64>
query Parameters
count
integer

Number of results to return per page.

from
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "from": 0,
  • "total": 123,
  • "is_ok": true,
  • "results": [
    ]
}

ログストレージのアクセスキー作成API

ログストレージのアクセスキーを管理するAPIエンドポイントです。

path Parameters
log_resource_id
required
integer <int64>
Request Body schema:
description
string <= 256 characters

Responses

Request samples

Content type
{
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
  • "description": "string",
  • "is_ok": true
}

ログストレージのアクセスキー詳細取得API

ログストレージのアクセスキーを管理するAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Logs AccessKey.

log_resource_id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
  • "description": "string",
  • "is_ok": true
}

ログストレージのアクセスキー更新API

ログストレージのアクセスキーを管理するAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Logs AccessKey.

log_resource_id
required
integer <int64>
Request Body schema:
description
string <= 256 characters

Responses

Request samples

Content type
{
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
  • "description": "string",
  • "is_ok": true
}

ログストレージのアクセスキー部分更新API

ログストレージのアクセスキーを管理するAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Logs AccessKey.

log_resource_id
required
integer <int64>
Request Body schema:
description
string <= 256 characters

Responses

Request samples

Content type
{
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
  • "description": "string",
  • "is_ok": true
}

ログストレージのアクセスキー削除API

ログストレージのアクセスキーを管理するAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Logs AccessKey.

log_resource_id
required
integer <int64>

Responses

ログストレージ詳細取得API

ログストレージを管理するためのAPIエンドポイントです。

path Parameters
resource_id
required
integer <int64> (Cloud resource id) [ 0 .. 999999999999 ]
Example: 110000000000

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "tags": [
    ],
  • "icon": {
    },
  • "expire_day": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "endpoints": {
    },
  • "account_id": "string",
  • "resource_id": 0,
  • "is_system": true,
  • "usage": {
    },
  • "is_ok": true
}

ログストレージ更新API

ログストレージを管理するためのAPIエンドポイントです。

path Parameters
resource_id
required
integer <int64> (Cloud resource id) [ 0 .. 999999999999 ]
Example: 110000000000
Request Body schema:
name
string <= 256 characters
description
string <= 256 characters
expire_day
integer <int64>

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "expire_day": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "tags": [
    ],
  • "icon": {
    },
  • "expire_day": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "endpoints": {
    },
  • "account_id": "string",
  • "resource_id": 0,
  • "is_system": true,
  • "usage": {
    },
  • "is_ok": true
}

ログストレージ部分更新API

ログストレージを管理するためのAPIエンドポイントです。

path Parameters
resource_id
required
integer <int64> (Cloud resource id) [ 0 .. 999999999999 ]
Example: 110000000000
Request Body schema:
name
string <= 256 characters
description
string <= 256 characters
expire_day
integer <int64>

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "expire_day": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "tags": [
    ],
  • "icon": {
    },
  • "expire_day": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "endpoints": {
    },
  • "account_id": "string",
  • "resource_id": 0,
  • "is_system": true,
  • "usage": {
    },
  • "is_ok": true
}

ログストレージ削除API

ログストレージを管理するためのAPIエンドポイントです。

path Parameters
resource_id
required
integer <int64> (Cloud resource id) [ 0 .. 999999999999 ]
Example: 110000000000

Responses

管理

リソース制限取得API

アカウントのリソース上限（ログストレージ、メトリクスストレージ、アラートプロジェクト、ダッシュボード）を取得するAPIエンドポイントです。

Responses

Response samples

Content type
application/json
{
  • "logs": {
    },
  • "metrics": {
    },
  • "alerts": {
    },
  • "dashboards": {
    }
}

プロビジョニング（初期化）API

リソース（ログストレージ、メトリクスストレージ）のプロビジョニング（初期化）を行うAPIエンドポイントです。指定した種別のリソースが存在しない場合のみ作成を行います。既存のリソースは変更されません。

Request Body schema:
object (ProvisioningExist)
object (ProvisioningExist)

Responses

Request samples

Content type
{
  • "logs": {
    },
  • "metrics": {
    }
}

Response samples

Content type
application/json
{
  • "logs": {
    },
  • "metrics": {
    }
}

プロビジョニング状態取得API

リソース（ログストレージ、メトリクスストレージ）のプロビジョニング状態を確認するAPIエンドポイントです。

Responses

Response samples

Content type
application/json
{
  • "logs": {
    },
  • "metrics": {
    }
}

メトリクスルーティング

メトリクスルーティング一覧取得API

メトリクスルーティングを管理するためのAPIエンドポイントです。

query Parameters
count
integer

Number of results to return per page.

from
integer

The initial index from which to return the results.

publisher__code
string
resource_id
integer
variant
string

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "from": 0,
  • "total": 123,
  • "is_ok": true,
  • "results": [
    ]
}

メトリクスルーティング作成API

メトリクスルーティングを管理するためのAPIエンドポイントです。

Request Body schema:
resource_id
integer or null <int64>
publisher_code
required
string
variant
required
string
metrics_storage_id
required
integer or null <int64> (Cloud resource id)

Responses

Request samples

Content type
{
  • "resource_id": 0,
  • "publisher_code": "string",
  • "variant": "string",
  • "metrics_storage_id": 0
}

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "resource_id": 0,
  • "publisher": {
    },
  • "variant": "string",
  • "metrics_storage": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_ok": true
}

メトリクスルーティング詳細取得API

メトリクスルーティングを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Routing metric.

Responses

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "resource_id": 0,
  • "publisher": {
    },
  • "variant": "string",
  • "metrics_storage": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_ok": true
}

メトリクスルーティング更新API

メトリクスルーティングを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Routing metric.

Request Body schema:
resource_id
integer or null <int64>
publisher_code
required
string
variant
required
string
metrics_storage_id
required
integer or null <int64> (Cloud resource id)

Responses

Request samples

Content type
{
  • "resource_id": 0,
  • "publisher_code": "string",
  • "variant": "string",
  • "metrics_storage_id": 0
}

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "resource_id": 0,
  • "publisher": {
    },
  • "variant": "string",
  • "metrics_storage": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_ok": true
}

メトリクスルーティング部分更新API

メトリクスルーティングを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Routing metric.

Request Body schema:
resource_id
integer or null <int64>
publisher_code
string
variant
string
metrics_storage_id
integer or null <int64> (Cloud resource id)

Responses

Request samples

Content type
{
  • "resource_id": 0,
  • "publisher_code": "string",
  • "variant": "string",
  • "metrics_storage_id": 0
}

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "resource_id": 0,
  • "publisher": {
    },
  • "variant": "string",
  • "metrics_storage": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_ok": true
}

メトリクスルーティング削除API

メトリクスルーティングを管理するためのAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Routing metric.

Responses

メトリクスストレージ

メトリクスストレージ一覧取得API

メトリクスストレージを管理するためのAPIエンドポイントです。

query Parameters
account_id
string
count
integer

Number of results to return per page.

from
integer

The initial index from which to return the results.

is_system
boolean

Is system

resource_id
integer

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "from": 0,
  • "total": 123,
  • "is_ok": true,
  • "results": [
    ]
}

メトリクスストレージ作成API

メトリクスストレージを管理するためのAPIエンドポイントです。

Request Body schema:
name
required
string
description
required
string
is_system
required
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "is_system": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "tags": [
    ],
  • "icon": {
    },
  • "is_system": true,
  • "account_id": "string",
  • "resource_id": 0,
  • "endpoints": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "usage": {
    }
}

メトリクスストレージのアクセスキー一覧取得API

メトリクスストレージのアクセスキーを管理するAPIエンドポイントです。

path Parameters
metrics_resource_id
required
integer <int64>
query Parameters
count
integer

Number of results to return per page.

from
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "from": 0,
  • "total": 123,
  • "is_ok": true,
  • "results": [
    ]
}

メトリクスストレージのアクセスキー作成API

メトリクスストレージのアクセスキーを管理するAPIエンドポイントです。

path Parameters
metrics_resource_id
required
integer <int64>
Request Body schema:
description
string <= 256 characters

Responses

Request samples

Content type
{
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
  • "description": "string",
  • "is_ok": true
}

メトリクスストレージのアクセスキー詳細取得API

メトリクスストレージのアクセスキーを管理するAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Metrics AccessKey.

metrics_resource_id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
  • "description": "string",
  • "is_ok": true
}

メトリクスストレージのアクセスキー更新API

メトリクスストレージのアクセスキーを管理するAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Metrics AccessKey.

metrics_resource_id
required
integer <int64>
Request Body schema:
description
string <= 256 characters

Responses

Request samples

Content type
{
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
  • "description": "string",
  • "is_ok": true
}

メトリクスストレージのアクセスキー部分更新API

メトリクスストレージのアクセスキーを管理するAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Metrics AccessKey.

metrics_resource_id
required
integer <int64>
Request Body schema:
description
string <= 256 characters

Responses

Request samples

Content type
{
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 110000000000,
  • "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
  • "description": "string",
  • "is_ok": true
}

メトリクスストレージのアクセスキー削除API

メトリクスストレージのアクセスキーを管理するAPIエンドポイントです。

path Parameters
id
required
integer <int64> [ 0 .. 999999999999 ]
Example: 110000000000

A unique integer value identifying this Metrics AccessKey.

metrics_resource_id
required
integer <int64>

Responses

メトリクスストレージ詳細取得API

メトリクスストレージを管理するためのAPIエンドポイントです。

path Parameters
resource_id
required
integer <int64> (Cloud resource id) [ 0 .. 999999999999 ]
Example: 110000000000

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "tags": [
    ],
  • "icon": {
    },
  • "is_system": true,
  • "account_id": "string",
  • "resource_id": 0,
  • "endpoints": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "usage": {
    },
  • "is_ok": true
}

メトリクスストレージ更新API

メトリクスストレージを管理するためのAPIエンドポイントです。

path Parameters
resource_id
required
integer <int64> (Cloud resource id) [ 0 .. 999999999999 ]
Example: 110000000000
Request Body schema:
name
string <= 256 characters
description
string <= 256 characters

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "tags": [
    ],
  • "icon": {
    },
  • "is_system": true,
  • "account_id": "string",
  • "resource_id": 0,
  • "endpoints": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "usage": {
    },
  • "is_ok": true
}

メトリクスストレージ部分更新API

メトリクスストレージを管理するためのAPIエンドポイントです。

path Parameters
resource_id
required
integer <int64> (Cloud resource id) [ 0 .. 999999999999 ]
Example: 110000000000
Request Body schema:
name
string <= 256 characters
description
string <= 256 characters

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "tags": [
    ],
  • "icon": {
    },
  • "is_system": true,
  • "account_id": "string",
  • "resource_id": 0,
  • "endpoints": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "usage": {
    },
  • "is_ok": true
}

メトリクスストレージ削除API

メトリクスストレージを管理するためのAPIエンドポイントです。

path Parameters
resource_id
required
integer <int64> (Cloud resource id) [ 0 .. 999999999999 ]
Example: 110000000000

Responses

連携サービス

連携サービス一覧取得API

連携サービス情報を取得するAPIエンドポイントです。

query Parameters
count
integer

Number of results to return per page.

from
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "from": 0,
  • "total": 123,
  • "is_ok": true,
  • "results": [
    ]
}

連携サービス詳細取得API

連携サービス情報を取得するAPIエンドポイントです。

path Parameters
code
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "description": "string",
  • "variants": [
    ],
  • "is_ok": true
}