修正¶
POST /api/v1/service_manage/{service_uuid}/modify
概要¶
サービスリスト構成を修正します
ルートパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| service_uuid | string | Y | サービス UUID 例: sman_xxx 空欄不可: False |
Body リクエストパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| serviceCatelog | string | Y | サービスリスト構成、toml 構成文字列 $maxCustomLength: 65535 空欄不可: False |
パラメータ補足説明¶
リクエストボディ構造の説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| serviceCatelog | string | Y | サービスリスト構成の元の toml 形式文字列 |
serviceCatelog フィールドの説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| Team | dict | Y | サービス、チームなどの情報 |
| Repos | array | N | リポジトリ構成 |
| Docs | array | N | ヘルプ構成 |
| Related | array | N | 関連構成 |
Team フィールドの説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| 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 フィールドの説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| name | string | N | 連絡先名 |
| type | string | N | 連絡先タイプ、列挙値: email, mobile, slack |
| emails | array | N | メール |
| mobiles | array | N | 電話 |
| slack | string | N | Slack チャンネルアドレス |
Repos, Docs フィールドの説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| link | string | N | リポジトリコード URL/関連ドキュメント URL |
| name | string | N | 表示名 |
| provider | string | N | プロバイダ名 |
Related フィールドの説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| AppId | string | N | RUM アプリケーション ID |
| DashboardUUIDs | array | N | バインドされたビルトインビュー UUID |
| Tags | array | N | 関連タグ |
serviceCatelog フィールドの例:
[Team] # チーム
service = "test_02" # 必須
type = "db" # 必須、現在のサービスが属するタイプ
team = "開発チーム" # 現在のサービスが属するチーム名
colour = "#40C922" # 現在のサービスカラー情報
[[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"]
DashboardUUIDs = ["dsbd_xxxx32"]
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/service_manage/sman_xxxx32/modify' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-binary '{"serviceCatelog": "\n[Team] # Team\nservice = \"test_02\" # Required\ntype = \"db\" # Required,Current Service Type\nteam = \"Development Group\" # Current Service TeamUUID\ncolour = \"#40C922\" # Current Service Color Information\n\n[[Team.oncall]] # Contact Method Configuration\nname = \"example_yun\"\ntype = \"email\"\nemails = [\"xxx@guance.com\", \"xxx@guance.com\"]\n\n[[Team.oncall]] # Contact Method Configuration\nname = \"zhuyun\"\ntype = \"mobile\"\nmobiles = [\"xxxxxxx5786\", \"xxxxxxx4231\"]\n\n[[Team.oncall]] # Contact Method Configuration\nname = \"test\"\ntype = \"slack\"\nslack = \"#test\"\n\n[[Repos]] # Repository Configuration, # Fill in the provider and expected display text for the repository link\nlink = \"https://www.guance.com\"\nname = \"guance\"\nprovider = \"example_yun\"\n\n[[Repos]] # Repository Configuration\nlink = \"https://func.guance.com\"\nname = \"func\"\nprovider = \"example_yun\"\n\n\n[[Docs]] # Help, Fill in the content provider and expected display text for the help link\nlink = \"https://docs.guance.com/ja\"\nname = \"guance\"\nprovider = \"example_yun\"\n\n[[Docs]] # Help\nlink = \"https://func.guance.com/doc\"\nname = \"func\"\nprovider = \"example_yun\"\n\n\n[Related] # Associated Configuration\nAppId = \"a138bcb0_47ef_11ee_9d75_31ea50b9d85a\"\nTags = [\"test\"]\nDashboardUUIDs = [\"dsbd_xxxx32\"]\n\n\n"}' \
--compressed