콘텐츠로 이동

조회¶

GET /api/v1/service_manage/{service_uuid}/get

개요¶

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

경로 매개변수¶

매개변수명	유형	필수	설명
service_uuid	string	Y	서비스에 해당하는 uuid 예시: xxxx 빈 문자열 허용: False

Query 요청 매개변수¶

매개변수명	유형	필수	설명
originStr	string		원시 문자열 전달 시 1, 구조화된 데이터 전달 시 0, 기본값은 1 빈 값 허용: False

매개변수 추가 설명¶

요청 본문 구조 설명

매개변수명	type	필수	설명
service_uuid	string	Y	서비스 목록의 고유 uuid, 접두사는 sman_
originStr	string	N	반환할 serviceCatelog가 원시 문자열인지 여부. 1이면 예, 0이면 아니요. 기본값은 1

응답 본문 구조 설명

매개변수명	type	설명
serviceCatelog	string,dict	서비스 목록의 원시 문자열 또는 구조화된 데이터
service	string	서비스 이름
type	string	서비스 유형

요청 예시¶

curl 'https://openapi.guance.com/api/v1/service_manage/sman_xxxx32/get?originStr=0' \
  -H 'Content-Type: application/json' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --compressed

응답¶

{
    "code": 200,
    "content": {
        "colour": "#40C9C9",
        "createAt": 1693798688,
        "creatorInfo": {
            "acntWsNickname": "",
            "email": "xxx",
            "iconUrl": "",
            "name": "Alibaba Cloud Monitoring Data Source",
            "username": "xxx"
        },
        "service": "test",
        "serviceCatelog": {
            "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",
                "DashboardUUIDs": [
                    "dsbd_xxxx32",
                    "dsbd_xxxx32"
                ],
                "Tags": [
                    "mysql",
                    "test"
                ]
            },
            "Repos": [
                {
                    "link": "https://www.guance.com",
                    "name": "guance",
                    "provider": "example_yun"
                },
                {
                    "link": "https://func.guance.com",
                    "name": "func",
                    "provider": "example_yun"
                }
            ],
            "Team": {
                "colour": "#40C9C9",
                "oncall": [
                    {
                        "emails": [
                            "xxx@guance.com",
                            "xxx@guance.com"
                        ],
                        "name": "example_yun",
                        "type": "email"
                    },
                    {
                        "mobiles": [
                            "xxxxxxx5786",
                            "xxxxxxx4231"
                        ],
                        "name": "zhuyun",
                        "type": "mobile"
                    },
                    {
                        "name": "test",
                        "slack": "#test",
                        "type": "slack"
                    }
                ],
                "service": "jinlei_1",
                "team": "group_xxxx32",
                "type": "db"
            }
        },
        "type": "db",
        "updateAt": 1693798688,
        "updatorInfo": {
            "acntWsNickname": "",
            "email": "xxx",
            "iconUrl": "",
            "name": "Alibaba Cloud Monitoring Data Source",
            "username": "xxx"
        },
        "uuid": "sman_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-1255F7E2-9035-4696-B7EE-9DDBB2BC13D2"
}