作成¶
POST /api/v1/service_manage/add
概要¶
サービスリストの設定を新規追加します。
Body リクエストパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| serviceCatelog | string | Y | サービスリスト設定。toml 設定文字列 $maxCustomLength: 65535 空の許可: False |
パラメータ補足説明¶
リクエストボディの構造説明
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| serviceCatelog | string | Y | サービスリスト設定の生の toml 形式文字列 |
serviceCatelog フィールドの説明
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| Team | dict | Y | サービス、チームなどの情報 |
| Repos | array | N | リポジトリ設定 |
| Docs | array | N | ヘルプ設定 |
| Related | array | N | 関連設定 |
Team フィールドの説明
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| service | string | Y | サービス名 |
| type | string | N | サービス種別。列挙型 (app, framework, cache, message_queue, custom, db, web) |
| team | string | N | チーム名 |
| colour | string | N | サービスの色 |
| oncall | array | N | 連絡先 |
colour フィールドの列挙型は次のとおりです '#C75BC9', '#DE5565', '#C43243', '#D77D3D', '#2EB2EE', '#A7D650', '#417C51', '#40C9C9', '#6454CB', '#E8C035', '#36AEAE', '#FDA82D', '#FFD33B', '#196AAB', '#993C7E', '#6C7AEB', '#49B566', '#9E7EDD', '#8EB743', '#D47FD6', '#289ED4', '#3F94DC', '#8934A4', '#1A9A82', '#AC8AF0', '#F19AF2'
oncall フィールドの説明
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| name | string | N | 連絡先名 |
| type | string | N | 連絡先種別。列挙値: email, mobile, slack |
| emails | array | N | メールアドレス |
| mobiles | array | N | 電話番号 |
| slack | string | N | Slack チャンネルアドレス |
Repos, Docs フィールドの説明
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| link | string | N | リポジトリコード URL / 関連ドキュメント URL |
| name | string | N | 表示名 |
| provider | string | N | プロバイダ名 |
Related フィールドの説明
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| AppId | string | N | RUM アプリケーション ID |
| DashboardUUIDs | array | N | ビルトインビュー UUID をバインド |
| Tags | array | N | 関連タグ |
serviceCatelog フィールドの例:
[Team] # チーム
service = "jinlei_1" # 必須
type = "db" # 必須、現在のサービスの所属種別
team = "テストグループ" # 現在のサービスの所属チーム名
colour = "#40C9C9" # 現在のサービスの色情報
[[Team.oncall]] # 連絡先設定
name = "example_yun"
type = "email"
emails = ["xxx@guance.com", "xxx@guance.com"]
[[Team.oncall]] # 連絡先設定
name = "zhuyun"
type = "mobile"
mobiles = ["xxxxxxx5786", "xxxxxxx4231"]
[[Team.oncall]] # 連絡先設定
name = "test"
type = "slack"
slack = "#test"
[[Repos]] # リポジトリ設定、# リポジトリリンクに対応するプロバイダと表示テキストを入力
link = "https://www.guance.com"
name = "guance"
provider = "example_yun"
[[Repos]] # リポジトリ設定
link = "https://func.guance.com"
name = "func"
provider = "example_yun"
[[Docs]] # ヘルプ、ヘルプリンの内容提供元と表示テキストを入力
link = "https://docs.guance.com/ja"
name = "guance"
provider = "example_yun"
[[Docs]] # ヘルプ
link = "https://func.guance.com/doc"
name = "func"
provider = "example_yun"
[Related] # 関連設定
AppId = "a138bcb0_47ef_11ee_9d75_31ea50b9d85a"
Tags = ["test", "mysql"]
DashboardUUIDs = ["dsbd_xxxx32", "dsbd_xxxx32"]
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/service_manage/add' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-binary '{"serviceCatelog": "\n[Team] # チーム\nservice = \"test\" # 必須\ntype = \"db\" # 必須、現在のサービスの種別\nteam = \"テストグループ\" # 現在のサービスのチーム名\ncolour = \"#40C9C9\" # 現在のサービスの色情報\n\n[[Team.oncall]] # 連絡先設定\nname = \"example_yun\"\ntype = \"email\"\nemails = [\"xxx@guance.com\", \"xxx@guance.com\"]\n\n[[Team.oncall]] # 連絡先設定\nname = \"zhuyun\"\ntype = \"mobile\"\nmobiles = [\"xxxxxxx5786\", \"xxxxxxx4231\"]\n\n[[Team.oncall]] # 連絡先設定\nname = \"test\"\ntype = \"slack\"\nslack = \"#test\"\n\n[[Repos]] # リポジトリ設定、# リポジトリリンクに対応するプロバイダと表示テキストを入力\nlink = \"https://www.guance.com\"\nname = \"guance\"\nprovider = \"example_yun\"\n\n[[Repos]] # リポジトリ設定\nlink = \"https://func.guance.com\"\nname = \"func\"\nprovider = \"example_yun\"\n\n\n[[Docs]] # ヘルプ、ヘルプリンの内容提供元と表示テキストを入力\nlink = \"https://docs.guance.com/ja\"\nname = \"guance\"\nprovider = \"example_yun\"\n\n[[Docs]] # ヘルプ\nlink = \"https://func.guance.com/doc\"\nname = \"func\"\nprovider = \"example_yun\"\n\n\n[Related] # 関連設定\nAppId = \"a138bcb0_47ef_11ee_9d75_31ea50b9d85a\"\nTags = [\"test\", \"mysql\"]\nDashboardUUIDs = [\"dsbd_xxxx32\", \"dsbd_xxxx32\"]"}' \
--compressed