一覧表示¶
GET /api/v1/service_manage/list
概要¶
サービスリスト情報を取得します。
クエリリクエストパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| search | string | サービス名を検索 例: mysql 空の許可: False |
|
| originStr | string | 生文字列の場合は1、構造化データの場合は0を指定します。デフォルトは1です。 空の許可: False |
|
| filter | string | フィルター条件 例: total 空の許可: False 選択可能な値: ['total', 'favorite', 'myCreate', 'oftenBrowse'] |
|
| createType | commaArray | 作成タイプ 例: openapi,manual,automatic 空の許可: False |
|
| serviceType | commaArray | サービス種別 例: web,custom 空の許可: False |
|
| teamUUID | commaArray | チーム UUID 例: group_x,group_y 空の許可: False |
|
| pageIndex | integer | ページ番号 空の許可: False 例: 1 $minValue: 1 |
|
| pageSize | integer | 1ページあたりの表示数 空の許可: False 例: 10 $minValue: 1 $maxValue: 100 |
パラメータ補足説明¶
リクエストボディの構造
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| search | string | N | サービス名を検索 |
| originStr | string | N | 返却される serviceCatelog を生文字列にするかどうか。1 の場合ははい、0 の場合はいいえ。デフォルトは 1 です。 |
| filter | string | N | フィルター条件 |
| createType | string | N | サービスの作成タイプでフィルターします。カンマ区切り。manual, openapi, automatic |
| serviceType | string | N | サービスの種別でフィルターします。カンマ区切り。app, framework, cache, message_queue, custom, db, web |
| teamUUID | string | N | チームでフィルターします。カンマ区切り。 |
| pageIndex | string | N | ページ番号 |
| pageSize | string | N | 1ページあたりの表示数 |
レスポンスボディの構造
| パラメータ名 | type | 説明 |
|---|---|---|
| serviceCatelog | string,dict | サービスリストの生文字列または構造化データ |
| service | string | サービス名 |
| type | string | サービス種別 |
| dfStatus | string | サービスステータス |
| creatorInfo | dict | サービスリストの作成者情報 |
| updatorInfo | dict | サービスリストの更新者情報 |
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/service_manage/list?originStr=0' \
-H 'Content-Type: application/json' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed
レスポンス¶
{
"automaticFoundTime": "1693807201",
"data": [
{
"uuid": "sman_xxxx32",
"createAt": 1693798688,
"updateAt": 1693805504,
"creatorInfo": {
"username": "xxx",
"name": "Alibaba Cloud Monitoring Data Source",
"iconUrl": "",
"email": "wsak_xxxxx",
"acntWsNickname": ""
},
"colour": "#40C922",
"updatorInfo": {
"username": "xxx",
"name": "Alibaba Cloud Monitoring Data Source",
"iconUrl": "",
"email": "wsak_xxxxx",
"acntWsNickname": ""
},
"dfStatus": "ok",
"isFavorite": false,
"createType": "openapi",
"service": "test_02",
"type": "db",
"serviceCatelog": {
"Team": {
"service": "test_02",
"type": "db",
"team": "group_xxxx32",
"colour": "#40C922",
"oncall": [
{
"name": "example_yun",
"type": "email",
"emails": [
"xxx@guance.com",
"xxx@guance.com"
]
},
{
"name": "zhuyun",
"type": "mobile",
"mobiles": [
"xxxxxxx5786",
"xxxxxxx4231"
]
},
{
"name": "test",
"type": "slack",
"slack": "#test"
}
]
},
"Repos": [
{
"link": "https://www.guance.com",
"name": "guance",
"provider": "example_yun"
},
{
"link": "https://func.guance.com",
"name": "func",
"provider": "example_yun"
}
],
"Docs": [
{
"link": "https://docs.guance.com/ja",
"name": "guance",
"provider": "example_yun"
},
{
"link": "https://func.guance.com/doc",
"name": "func",
"provider": "example_yun"
}
],
"Related": {
"AppId": "a138bcb0_47ef_11ee_9d75_31ea50b9d85a",
"Tags": [
"test"
],
"DashboardUUIDs": [
"dsbd_xxxx32"
]
}
}
},
{
"uuid": "sman_xxxx32",
"createAt": 1693728357,
"updateAt": 1693728357,
"creatorInfo": {
"username": "xxx@guance.com",
"name": "test",
"iconUrl": "",
"email": "xxx@guance.com",
"acntWsNickname": ""
},
"colour": "",
"updatorInfo": {
"username": "xxx@guance.com",
"name": "test",
"iconUrl": "",
"email": "xxx@guance.com",
"acntWsNickname": ""
},
"dfStatus": "ok",
"isFavorite": false,
"createType": "manual",
"service": "test-lml3",
"type": "custom",
"serviceCatelog": {
"Team": {
"service": "test-lml3",
"type": "custom",
"colour": "",
"team": "",
"oncall": []
},
"Related": {
"Tags": []
}
}
}
],
"pageInfo": {
"pageIndex": 1,
"pageSize": 50,
"count": 2,
"totalCount": 2
}
}