Skip to content

[Service List] Listed¶

GET /api/v1/service_manage/list

Overview¶

List service list information

Query Request Parameters¶

Parameter Name	Type	Required	Description
search	string		Search for service name Example: mysql Can be empty: False
originStr	string		Pass 1 for original string, pass 0 for structured data, default is 1 Can be empty: False
filter	string		Filter condition Example: total Can be empty: False Optional values: ['total', 'favorite', 'myCreate', 'oftenBrowse']
createType	commaArray		Creation type Example: openapi,manual,automatic Can be empty: False
serviceType	commaArray		Service type Example: web,custom Can be empty: False
teamUUID	commaArray		Team UUID Example: group_x,group_y Can be empty: False
pageIndex	integer		Page number Can be empty: False Example: 1 $minValue: 1
pageSize	integer		Number of returns per page Can be empty: False Example: 10 $minValue: 1 $maxValue: 100

Additional Parameter Notes¶

Request Body Structure Description

Parameter Name	type	Required	Description
search	string	N	Search for service name
originStr	string	N	Whether the returned serviceCatelog needs to be an original string, 1 for yes, 0 for no. Default is 1
filter	string	N	Filter condition
createType	string	N	Filter service creation types, separated by ',', manual,openapi,automatic
serviceType	string	N	Filter service types, separated by ',', app,framework,cache,message_queue,custom,db,web
teamUUID	string	N	Filter teams, separated by ','
pageIndex	string	N	Pagination page number
pageSize	string	N	Number of returns per page

Response Body Structure Description

Parameter Name	type	Description
serviceCatelog	string,dict	Original string or structured data of the service list
service	string	Service name
type	string	Service type
dfStatus	string	Service status
creatorInfo	dict	Creator information of the service list
updatorInfo	dict	Updater information of the service list

Request Example¶

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

Response¶

{
    "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": "Guance",
                            "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": "Guance"
                    },
                    {
                        "link": "https://func.guance.com",
                        "name": "func",
                        "provider": "Guance"
                    }
                ],
                "Docs": [
                    {
                        "link": "https://docs.guance.com/en",
                        "name": "guance",
                        "provider": "Guance"
                    },
                    {
                        "link": "https://func.guance.com/doc",
                        "name": "func",
                        "provider": "Guance"
                    }
                ],
                "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
    }
}