エクスポート¶
GET /api/v1/service_manage/export
概要¶
現在のワークスペースのサービスリスト設定を JSON にエクスポートします。
呼び出し前の確認と使用手順¶
originStr の値に応じて、設定テキストまたはオブジェクトを選択します。サーバー側は固定で 1 ページ目、1 ページあたり 10000 件を取得します。成功レスポンスのルートノードはサービスオブジェクトの配列そのものです。レスポンス全体を保存した後、クライアント側で読み取ります。10000 件を超える完全な走査には、一覧 API のページネーションを使用してください。ワークスペースにサービスリストが存在しない場合、ルートノードは data と pageInfo を含む空のコレクションオブジェクトを返します。
リクエストヘッダー¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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 を渡します。 |
パラメーター補足説明¶
Content-Type は application/json です。originStr=0 の例では構造化された設定が返されます。エクスポートされるサービスのフィールドは一覧と同じで、現在のエクスポート上限は 10000 件です。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/service_manage/export' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode originStr=0
レスポンス¶
HTTP 200、Content-Type は application/json です。以下の例はレスポンスのルートノードです。配列または空のコレクションオブジェクトとして読み取ります。
| フィールド | 型 | 説明 |
|---|---|---|
| $ | オブジェクト配列またはオブジェクト | データがある場合はサービスオブジェクトの配列、空のコレクションの場合は後述のページネーションオブジェクトです。 |
| [].uuid | string | サービスリストの UUID。以降、詳細、変更、削除に使用します。 |
| [].service | string | サービス名。トレースデータ内の service に紐付けられます。 |
| [].type | string | サービスの分類。 |
| [].colour | string | サービスの表示色。 |
| [].language | string | サービスの言語識別子。空文字列の場合があります。 |
| [].createAt | number | 作成日時(Unix 秒)。 |
| [].updateAt | number | 更新日時(Unix 秒)。未更新の場合は -1 になることがあります。 |
| [].creatorInfo | object | 作成者のアイデンティティ情報。取得できない場合は空のオブジェクトです。 |
| [].updatorInfo | object | 最終更新者のアイデンティティ情報。取得できない場合は空のオブジェクトです。 |
| [].creatorInfo.uuid | string | 該当するアイデンティティが取得できた場合に提供されることがあります。アイデンティティ識別子。 |
| [].creatorInfo.status | integer | 該当するアイデンティティが取得できた場合に提供されることがあります。アカウントステータス。 |
| [].creatorInfo.wsAccountStatus | integer | 該当するアイデンティティが取得できた場合に提供されることがあります。ワークスペースメンバーのステータス。 |
| [].creatorInfo.username | string | 該当するアイデンティティが取得できた場合に提供されることがあります。ログイン名。 |
| [].creatorInfo.name | string | 該当するアイデンティティが取得できた場合に提供されることがあります。表示名。 |
| [].creatorInfo.iconUrl | string | 該当するアイデンティティが取得できた場合に提供されることがあります。アバター URL。 |
| [].creatorInfo.email | string | 該当するアイデンティティが取得できた場合に提供されることがあります。アカウントのメールアドレス。API Key のアイデンティティの場合は、その識別子が返されることがあります。 |
| [].creatorInfo.mobile | string | 該当するアイデンティティが取得できた場合に提供されることがあります。連絡先。 |
| [].creatorInfo.countryCode | string | 該当するアイデンティティが取得できた場合に提供されることがあります。電話番号の国または地域コード。 |
| [].creatorInfo.acntWsNickname | string | 該当するアイデンティティが取得できた場合に提供されることがあります。ワークスペース内のニックネーム。 |
| [].updatorInfo.uuid | string | 該当するアイデンティティが取得できた場合に提供されることがあります。アイデンティティ識別子。 |
| [].updatorInfo.status | integer | 該当するアイデンティティが取得できた場合に提供されることがあります。アカウントステータス。 |
| [].updatorInfo.wsAccountStatus | integer | 該当するアイデンティティが取得できた場合に提供されることがあります。ワークスペースメンバーのステータス。 |
| [].updatorInfo.username | string | 該当するアイデンティティが取得できた場合に提供されることがあります。ログイン名。 |
| [].updatorInfo.name | string | 該当するアイデンティティが取得できた場合に提供されることがあります。表示名。 |
| [].updatorInfo.iconUrl | string | 該当するアイデンティティが取得できた場合に提供されることがあります。アバター URL。 |
| [].updatorInfo.email | string | 該当するアイデンティティが取得できた場合に提供されることがあります。アカウントのメールアドレス。API Key のアイデンティティの場合は、その識別子が返されることがあります。 |
| [].updatorInfo.mobile | string | 該当するアイデンティティが取得できた場合に提供されることがあります。連絡先。 |
| [].updatorInfo.countryCode | string | 該当するアイデンティティが取得できた場合に提供されることがあります。電話番号の国または地域コード。 |
| [].updatorInfo.acntWsNickname | string | 該当するアイデンティティが取得できた場合に提供されることがあります。ワークスペース内のニックネーム。 |
| [].serviceCatelog | string または object | originStr=1 の場合は TOML 文字列を返し、originStr=0 の場合は以下の設定オブジェクトを返します。 |
| [].serviceCatelog.Team | object | サービスとチームの設定。 |
| [].serviceCatelog.Team.service | string | サービス名。 |
| [].serviceCatelog.Team.type | string | サービスの分類。書き込み時は API のルールに従って無効な分類が処理されます。 |
| [].serviceCatelog.Team.colour | string | サービスの表示色。 |
| [].serviceCatelog.Team.team | string | 所属チーム名。 |
| [].serviceCatelog.Team.oncall | array<object> |
連絡先。 |
| [].serviceCatelog.Team.oncall[].name | string | 連絡先の表示名。 |
| [].serviceCatelog.Team.oncall[].type | string | email、mobile または slack。 |
| [].serviceCatelog.Team.oncall[].emails | array<string> |
email 連絡先のメールアドレス。 |
| [].serviceCatelog.Team.oncall[].mobiles | array<string> |
mobile 連絡先の電話番号。 |
| [].serviceCatelog.Team.oncall[].slack | string | Slack チャンネルのアドレス。 |
| [].serviceCatelog.Repos | array<object> |
コードリポジトリのリスト。 |
| [].serviceCatelog.Repos[].name | string | リポジトリの表示名。 |
| [].serviceCatelog.Repos[].link | string | リポジトリ URL。 |
| [].serviceCatelog.Repos[].provider | string | プロバイダーの表示名。 |
| [].serviceCatelog.Docs | array<object> |
操作ドキュメントのリスト。 |
| [].serviceCatelog.Docs[].name | string | ドキュメントの表示名。 |
| [].serviceCatelog.Docs[].link | string | ドキュメント URL。 |
| [].serviceCatelog.Docs[].provider | string | ドキュメントプロバイダーの表示名。 |
| [].serviceCatelog.Related | object | 関連するアプリケーション、組み込みビュー、ユースケースタグ。 |
| [].serviceCatelog.Related.AppId | string | リアルユーザーモニタリング(RUM)アプリケーション ID。空の場合があります。 |
| [].serviceCatelog.Related.DashboardUUIDs | array<string> |
関連する組み込みビューの UUID。 |
| [].serviceCatelog.Related.Tags | array<string> |
ユースケースタグ名。 |
| [].dfStatus | string | 関連イベントのステータス。未読み込みまたは値がない場合のデフォルトは ok です。 |
| [].isFavorite | boolean | 現在のアイデンティティのお気に入りステータス。 |
| [].createType | string | 作成元。manual、openapi、automatic のいずれかです。その他のアイデンティティでは省略される場合があります。 |
| automaticFoundTime | string または null | 空のコレクションオブジェクト内の直近の自動検出タスク時刻。 |
| data | array<object> |
空のコレクションの分岐では [] です。 |
| pageInfo | object | 空のコレクションの分岐におけるページネーション情報。pageIndex=1、pageSize=10000 です。 |
| pageInfo.pageIndex | integer | 現在のページ番号。 |
| pageInfo.pageSize | integer | 1 ページのサイズ。 |
| pageInfo.count | integer | 現在のページで返された件数。 |
| pageInfo.totalCount | integer | フィルター条件に一致する総件数。 |
| レスポンスヘッダー | 型 | 説明 |
|---|---|---|
| Content-Type | string | 成功時は application/json です。 |
[
{
"uuid": "sman_example",
"createAt": 1785427200,
"updateAt": -1,
"creatorInfo": {},
"colour": "#40C9C9",
"updatorInfo": {},
"dfStatus": "ok",
"language": "",
"isFavorite": false,
"createType": "openapi",
"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": []
}
}
}
]
サービス設定がない場合の HTTP 200 レスポンス
{
"automaticFoundTime": null,
"data": [],
"pageInfo": {
"pageIndex": 1,
"pageSize": 10000,
"count": 0,
"totalCount": 0
}
}
エラーレスポンス¶
認証、レート制限、および共通リクエストのエラーについては、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメーターを使用した場合、またはパラメーターがルールに違反した場合 | パラメーターの解析に失敗しました | Query パラメーターの表と例を確認してください。 |
| 500 | ft.InternalServerError | originStr を整数に変換できない場合 | 内部エラー | 文字列 0 または 1 を使用してください。特定のために traceId を記録してください。 |