取得¶
GET /api/v1/service_manage/{service_uuid}/get
概要¶
指定したサービスリストの完全な設定および関連モニターを取得します。
呼び出し前の準備と使用手順¶
サービスリストから UUID をコピーします。originStr=0 を使用して構造化設定を読み取るか、originStr=1 を使用して TOML 原文を読み取り、それに基づいて変更します。対象が存在しない場合も成功として content={} を返します。
パスパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| service_uuid | string | Y | 現在のワークスペース内のサービスリスト UUID。プレフィックスは sman_ です。空文字列を許可: False 例: sman_example取得または入力方法: サービスリストの content.data[].uuid から取得します。新規作成レスポンスの content.uuid も使用できます。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| originStr | string | 設定の返却形式。デフォルトは 1 で、serviceCatelog は TOML 文字列です。0 は解析後のオブジェクトです。サーバー側では整数として読み取るため、0 または 1 を使用します。null を許可: False 例: 0取得または入力方法: プログラムで設定を読み取る場合は文字列 0 を渡し、TOML 原文を保持する場合は文字列 1 を渡します。 |
パラメータ補足説明¶
返される serviceCatelog は設定内容を保持します。originStr=0 の場合、Related.Tags は現在のサービスタグの関連付けに基づいて補完されます。フィールド名 serviceCatelog は過去のスペルを保持しています。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/service_manage/sman_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode originStr=0
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.uuid | string | サービスリスト UUID。以降、詳細取得、変更、削除に使用します。 |
| content.service | string | サービス名。分散型トレーシングデータ内の service にバインドされます。 |
| content.type | string | サービス分類。 |
| content.colour | string | サービスの表示色。 |
| content.language | string | サービスの言語識別子。空文字列の場合があります。 |
| content.createAt | number | 作成時間。Unix 秒。 |
| content.updateAt | number | 更新時間。Unix 秒。まだ更新されていない場合は -1 になることがあります。 |
| content.creatorInfo | object | 作成者のプロフィール。取得できない場合は空オブジェクトです。 |
| content.updatorInfo | object | 最終更新者のプロフィール。取得できない場合は空オブジェクトです。 |
| content.creatorInfo.uuid | string | 該当するアイデンティティを確認できた場合に提供されることがあります。アイデンティティ識別子。 |
| content.creatorInfo.status | integer | 該当するアイデンティティを確認できた場合に提供されることがあります。アカウントステータス。 |
| content.creatorInfo.wsAccountStatus | integer | 該当するアイデンティティを確認できた場合に提供されることがあります。ワークスペースメンバーステータス。 |
| content.creatorInfo.username | string | 該当するアイデンティティを確認できた場合に提供されることがあります。ログイン名。 |
| content.creatorInfo.name | string | 該当するアイデンティティを確認できた場合に提供されることがあります。表示名。 |
| content.creatorInfo.iconUrl | string | 該当するアイデンティティを確認できた場合に提供されることがあります。アバターURL。 |
| content.creatorInfo.email | string | 該当するアイデンティティを確認できた場合に提供されることがあります。アカウントのメールアドレス。API Key のアイデンティティの場合は、その識別子が返されることがあります。 |
| content.creatorInfo.mobile | string | 該当するアイデンティティを確認できた場合に提供されることがあります。連絡先。 |
| content.creatorInfo.countryCode | string | 該当するアイデンティティを確認できた場合に提供されることがあります。電話の国または地域コード。 |
| content.creatorInfo.acntWsNickname | string | 該当するアイデンティティを確認できた場合に提供されることがあります。ワークスペース内のニックネーム。 |
| content.updatorInfo.uuid | string | 該当するアイデンティティを確認できた場合に提供されることがあります。アイデンティティ識別子。 |
| content.updatorInfo.status | integer | 該当するアイデンティティを確認できた場合に提供されることがあります。アカウントステータス。 |
| content.updatorInfo.wsAccountStatus | integer | 該当するアイデンティティを確認できた場合に提供されることがあります。ワークスペースメンバーステータス。 |
| content.updatorInfo.username | string | 該当するアイデンティティを確認できた場合に提供されることがあります。ログイン名。 |
| content.updatorInfo.name | string | 該当するアイデンティティを確認できた場合に提供されることがあります。表示名。 |
| content.updatorInfo.iconUrl | string | 該当するアイデンティティを確認できた場合に提供されることがあります。アバターURL。 |
| content.updatorInfo.email | string | 該当するアイデンティティを確認できた場合に提供されることがあります。アカウントのメールアドレス。API Key のアイデンティティの場合は、その識別子が返されることがあります。 |
| content.updatorInfo.mobile | string | 該当するアイデンティティを確認できた場合に提供されることがあります。連絡先。 |
| content.updatorInfo.countryCode | string | 該当するアイデンティティを確認できた場合に提供されることがあります。電話の国または地域コード。 |
| content.updatorInfo.acntWsNickname | string | 該当するアイデンティティを確認できた場合に提供されることがあります。ワークスペース内のニックネーム。 |
| content.serviceCatelog | string または object | originStr=1 の場合は TOML 文字列を返し、originStr=0 の場合は以下の設定オブジェクトを返します。 |
| content.serviceCatelog.Team | object | サービスおよびチームの設定。 |
| content.serviceCatelog.Team.service | string | サービス名。 |
| content.serviceCatelog.Team.type | string | サービス分類。書き込み時はインターフェースのルールに従って無効な分類を処理します。 |
| content.serviceCatelog.Team.colour | string | サービスの表示色。 |
| content.serviceCatelog.Team.team | string | 所属チーム名。 |
| content.serviceCatelog.Team.oncall | array<object> |
オンコール連絡先。 |
| content.serviceCatelog.Team.oncall[].name | string | オンコール連絡先の表示名。 |
| content.serviceCatelog.Team.oncall[].type | string | email、mobile、または slack。 |
| content.serviceCatelog.Team.oncall[].emails | array<string> |
email 連絡先のメールアドレス。 |
| content.serviceCatelog.Team.oncall[].mobiles | array<string> |
mobile 連絡先の電話番号。 |
| content.serviceCatelog.Team.oncall[].slack | string | Slack チャンネルのアドレス。 |
| content.serviceCatelog.Repos | array<object> |
コードリポジトリのリスト。 |
| content.serviceCatelog.Repos[].name | string | リポジトリの表示名。 |
| content.serviceCatelog.Repos[].link | string | リポジトリ URL。 |
| content.serviceCatelog.Repos[].provider | string | プロバイダーの表示名。 |
| content.serviceCatelog.Docs | array<object> |
運用ドキュメントのリスト。 |
| content.serviceCatelog.Docs[].name | string | ドキュメントの表示名。 |
| content.serviceCatelog.Docs[].link | string | ドキュメント URL。 |
| content.serviceCatelog.Docs[].provider | string | ドキュメント提供元の表示名。 |
| content.serviceCatelog.Related | object | 関連するアプリケーション、組み込みビュー、シーンタグ。 |
| content.serviceCatelog.Related.AppId | string | リアルユーザーモニタリング(RUM)アプリID。空の場合があります。 |
| content.serviceCatelog.Related.DashboardUUIDs | array<string> |
関連付けられた組み込みビュー UUID。 |
| content.serviceCatelog.Related.Tags | array<string> |
シーンタグ名。 |
| content.extend | object | サービスリストの拡張情報。 |
| content.checkerInfo | array<object> |
サービス名やシーンタグなどで関連付けられたモニターの概要。 |
| content.checkerInfo[].uuid | string | モニター UUID。 |
| content.checkerInfo[].name | string | モニターの表示名。 |
| content.checkerInfo[].type | string | モニタータイプ。 |
| content.declaration | object または null | 設定オブジェクトがある場合に付随する可能性があるワークスペース共通宣言。 |
{
"code": 200,
"content": {
"uuid": "sman_example",
"createAt": 1785427200,
"updateAt": -1,
"creatorInfo": {},
"colour": "#40C9C9",
"updatorInfo": {},
"language": "",
"service": "checkout",
"type": "web",
"serviceCatelog": {
"Team": {
"service": "checkout",
"type": "web",
"team": "team-commerce",
"colour": "#40C9C9",
"oncall": [
{
"name": "值班邮箱",
"type": "email",
"emails": [
"xxx@guance.com"
]
}
]
},
"Repos": [
{
"name": "业务仓库",
"link": "https://example.invalid/repos/checkout",
"provider": "Git"
}
],
"Docs": [
{
"name": "操作手册",
"link": "https://example.invalid/help/checkout",
"provider": "Wiki"
}
],
"Related": {
"AppId": "",
"Tags": [
"team:commerce"
],
"DashboardUUIDs": []
}
},
"extend": {},
"checkerInfo": [],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
対象が存在しない場合の HTTP 200 レスポンス
{
"code": 200,
"content": {},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答の説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した場合、またはパラメータがルールに違反している場合 | パラメータの解析に失敗 | Query パラメータ表と例を確認します。 |
| 500 | ft.InternalServerError | originStr を整数に変換できない場合 |
内部エラー | 文字列 0 または 1 を使用します。特定できるよう traceId を記録します。 |