コンテンツにスキップ

一覧取得



GET /api/v1/service_manage/list

概要

ワークスペース内のサービスリスト設定をページ単位で一覧表示します。

呼び出し前と使用手順

まず名前またはタイプで絞り込み、次に content.data[].uuid を使用してサービスリスト詳細を呼び出します。複数のフィルターを同時に指定した場合は積集合となり、同じカンマ区切りフィールド内のオプションはいずれかに一致するものとして扱われます。既定ではお気に入りが最上部に固定表示され、それ以外は作成時間の降順で並びます。レスポンス最上位の pageInfo をページごとに読み取ります。loading=true の場合はサービス状態のキャッシュがまだ準備中であり、dfStatus の既定値 ok だけでは収集やモニタリングが正常であることを確認できません。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Query リクエストパラメータ

パラメータ名 型 必須 説明
createType commaArray manual はアカウントによる作成、openapi は API Key による作成、automatic は自動検出です。
null の許可: False
例: openapi,manual
取得または入力方法: リスト項目の createType から 1 つ以上の値を選択し、半角カンマで連結します。
filter string 全体リスト、現在のアイデンティティのお気に入り、現在のアイデンティティによる作成、または最近よく閲覧したもの。省略した場合は全体リストになります。
null の許可: False
選択可能な値: ['total', 'favorite', 'myCreate', 'oftenBrowse']
例: total
取得または入力方法: 対象範囲に応じて total、favorite、myCreate、oftenBrowse のいずれかを選択します。
originStr string 設定の返却形式。既定値は 1 で、serviceCatelog は TOML 文字列です。0 の場合は解析済みのオブジェクトになります。サーバー側では整数として読み取るため、0 または 1 を使用します。
null の許可: False
例: 0
取得または入力方法: プログラムで設定を読み取る場合は文字列 0 を渡し、TOML の原文を保持する場合は文字列 1 を渡します。
pageIndex integer ページ番号。既定値は 1、最小値は 1 です。
null の許可: False
$minValue: 1
例: 1
取得または入力方法: 1 から開始し、返却された pageInfo に従って次のページへ進みます。
pageSize integer 1 ページあたりの件数。既定値は 50、範囲は 1~100 です。
null の許可: False
$maxValue: 100
$minValue: 1
例: 20
取得または入力方法: クライアントの表示件数に合わせて選択し、1 回あたり 100 を超えないようにします。
search string サービス名の部分一致で検索します。省略または空白の場合は、名前によるフィルタリングを行いません。
null の許可: False
例: checkout
取得または入力方法: 既知のサービス名に含まれるキーワードを入力します。
serviceType commaArray サービス分類によるフィルター。例: app、framework、cache、message_queue、custom、db、web、aws_lambda。
null の許可: False
例: web,app
取得または入力方法: リスト項目の type から値を取得し、半角カンマで連結します。
teamUUID commaArray 所属チームでフィルターします。チーム UUID を入力します。一致するチームがない場合は空のリストを返します。
null の許可: False
例: group_example
取得または入力方法: チームリストからチーム UUID を取得します。複数の UUID は半角カンマで連結します。

パラメータの補足説明

originStr=0 の場合、設定はオブジェクトとして返されます。例ではこの形式を使用しています。一致するサービスがない場合、data は空になり、pageInfo.count と totalCount はどちらも 0 になります。loading は省略できます。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/service_manage/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode originStr=0 \
  --data-urlencode search=checkout \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=20

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。

フィールド 型 説明
content object リストデータと自動検出状態。
content.automaticFoundTime string または null 直近の自動検出タスクの開始時間。Unix 秒の文字列です。キャッシュがまだない場合は空になることがあります。
content.loading boolean 状態キャッシュがまだ準備中かどうか。サービスの結果がない場合は省略できます。
content.data array<object> 現在のページのサービスリスト。
content.data[].uuid string サービスリストの UUID。以降、詳細取得、変更、削除に使用します。
content.data[].service string サービス名。トレースデータ内の service に紐付けられます。
content.data[].type string サービス分類。
content.data[].colour string サービスの表示色。
content.data[].language string サービスの言語識別子。空文字列になることがあります。
content.data[].createAt number 作成時間。Unix 秒。
content.data[].updateAt number 更新時間。Unix 秒。まだ更新されていない場合は -1 になることがあります。
content.data[].creatorInfo object 作成アイデンティティのプロフィール。見つからない場合は空オブジェクトになります。
content.data[].updatorInfo object 直近で更新したアイデンティティのプロフィール。見つからない場合は空オブジェクトになります。
content.data[].creatorInfo.uuid string 該当するアイデンティティが見つかった場合に提供されることがあります。アイデンティティ識別子。
content.data[].creatorInfo.status integer 該当するアイデンティティが見つかった場合に提供されることがあります。アカウント状態。
content.data[].creatorInfo.wsAccountStatus integer 該当するアイデンティティが見つかった場合に提供されることがあります。ワークスペースメンバー状態。
content.data[].creatorInfo.username string 該当するアイデンティティが見つかった場合に提供されることがあります。ログイン名。
content.data[].creatorInfo.name string 該当するアイデンティティが見つかった場合に提供されることがあります。表示名。
content.data[].creatorInfo.iconUrl string 該当するアイデンティティが見つかった場合に提供されることがあります。アバター URL。
content.data[].creatorInfo.email string 該当するアイデンティティが見つかった場合に提供されることがあります。アカウントのメールアドレス。API Key のアイデンティティの場合は、その識別子が返されることがあります。
content.data[].creatorInfo.mobile string 該当するアイデンティティが見つかった場合に提供されることがあります。連絡先。
content.data[].creatorInfo.countryCode string 該当するアイデンティティが見つかった場合に提供されることがあります。電話番号の国または地域コード。
content.data[].creatorInfo.acntWsNickname string 該当するアイデンティティが見つかった場合に提供されることがあります。ワークスペース内のニックネーム。
content.data[].updatorInfo.uuid string 該当するアイデンティティが見つかった場合に提供されることがあります。アイデンティティ識別子。
content.data[].updatorInfo.status integer 該当するアイデンティティが見つかった場合に提供されることがあります。アカウント状態。
content.data[].updatorInfo.wsAccountStatus integer 該当するアイデンティティが見つかった場合に提供されることがあります。ワークスペースメンバー状態。
content.data[].updatorInfo.username string 該当するアイデンティティが見つかった場合に提供されることがあります。ログイン名。
content.data[].updatorInfo.name string 該当するアイデンティティが見つかった場合に提供されることがあります。表示名。
content.data[].updatorInfo.iconUrl string 該当するアイデンティティが見つかった場合に提供されることがあります。アバター URL。
content.data[].updatorInfo.email string 該当するアイデンティティが見つかった場合に提供されることがあります。アカウントのメールアドレス。API Key のアイデンティティの場合は、その識別子が返されることがあります。
content.data[].updatorInfo.mobile string 該当するアイデンティティが見つかった場合に提供されることがあります。連絡先。
content.data[].updatorInfo.countryCode string 該当するアイデンティティが見つかった場合に提供されることがあります。電話番号の国または地域コード。
content.data[].updatorInfo.acntWsNickname string 該当するアイデンティティが見つかった場合に提供されることがあります。ワークスペース内のニックネーム。
content.data[].serviceCatelog string または object originStr=1 の場合は TOML 文字列を返し、originStr=0 の場合は以下の設定オブジェクトを返します。
content.data[].serviceCatelog.Team object サービスとチームの設定。
content.data[].serviceCatelog.Team.service string サービス名。
content.data[].serviceCatelog.Team.type string サービス分類。書き込み時は API のルールに従って無効な分類を処理します。
content.data[].serviceCatelog.Team.colour string サービスの表示色。
content.data[].serviceCatelog.Team.team string 所属チーム名。
content.data[].serviceCatelog.Team.oncall array<object> 連絡先。
content.data[].serviceCatelog.Team.oncall[].name string 連絡先の表示名。
content.data[].serviceCatelog.Team.oncall[].type string email、mobile、または slack。
content.data[].serviceCatelog.Team.oncall[].emails array<string> email 連絡先のメールアドレス。
content.data[].serviceCatelog.Team.oncall[].mobiles array<string> mobile 連絡先の電話番号。
content.data[].serviceCatelog.Team.oncall[].slack string Slack チャンネルの URL。
content.data[].serviceCatelog.Repos array<object> コードリポジトリのリスト。
content.data[].serviceCatelog.Repos[].name string リポジトリの表示名。
content.data[].serviceCatelog.Repos[].link string リポジトリ URL。
content.data[].serviceCatelog.Repos[].provider string プロバイダーの表示名。
content.data[].serviceCatelog.Docs array<object> 操作ドキュメントのリスト。
content.data[].serviceCatelog.Docs[].name string ドキュメントの表示名。
content.data[].serviceCatelog.Docs[].link string ドキュメント URL。
content.data[].serviceCatelog.Docs[].provider string ドキュメント提供元の表示名。
content.data[].serviceCatelog.Related object 関連付けられたアプリケーション、組み込みビュー、シナリオタグ。
content.data[].serviceCatelog.Related.AppId string リアルユーザーモニタリング(RUM)アプリケーション ID。空になることがあります。
content.data[].serviceCatelog.Related.DashboardUUIDs array<string> 関連付けられた組み込みビューの UUID。
content.data[].serviceCatelog.Related.Tags array<string> シナリオタグ名。
content.data[].dfStatus string 関連イベントの状態。キャッシュが準備できていない場合、または状態がない場合は既定で ok になります。
content.data[].isFavorite boolean 現在の呼び出しアイデンティティによってお気に入りに登録されているかどうか。
content.data[].createType string 作成アイデンティティに基づいて推定されたソース。一般的な値は manual、openapi、automatic です。過去のその他のアイデンティティの場合は、このフィールドが省略されることがあります。
content.declaration object または null ワークスペースの共通宣言。
pageInfo object レスポンス最上位のページネーション情報。
pageInfo.pageIndex integer 現在のページ番号。
pageInfo.pageSize integer 1 ページあたりのサイズ。
pageInfo.count integer 現在のページで返された件数。
pageInfo.totalCount integer フィルター条件を満たす総件数。
{
  "code": 200,
  "content": {
    "automaticFoundTime": "1785427200",
    "data": [
      {
        "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": []
          }
        }
      }
    ],
    "loading": false,
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 20,
    "count": 1,
    "totalCount": 1
  }
}

エラーレスポンス

認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed 宣言されていない Query パラメータを使用した場合、またはパラメータがルールに違反した場合 パラメータの解析に失敗しました Query パラメータ表と例を確認してください。
500 ft.InternalServerError originStr を整数に変換できない場合 内部エラー 文字列の 0 または 1 を使用してください。特定のために traceId を記録してください。

フィードバック

このページは役に立ちましたか?