콘텐츠로 이동

목록 조회¶

GET /api/v1/service_manage/list

개요¶

서비스 목록 정보를 조회합니다.

Query 요청 파라미터¶

파라미터명	유형	필수	설명
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		페이지당 반환 개수 빈 값 허용: 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	페이지당 반환 개수

응답 본문 구조 설명

파라미터명	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/ko",
                        "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
    }
}