조회¶
GET /api/v1/service_manage/{service_uuid}/get
개요¶
지정한 서비스 목록의 전체 구성과 연결된 모니터를 조회합니다.
호출 전 및 사용 단계¶
서비스 목록에서 UUID를 복사합니다. originStr=0을 사용하여 구조화된 구성을 읽거나, originStr=1을 사용하여 TOML 원문을 읽고 이를 기반으로 수정합니다. 대상이 없으면 성공 응답으로 content={}를 반환합니다.
경로 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| service_uuid | string | Y | 현재 워크스페이스의 서비스 목록 UUID이며 접두사는 sman_입니다. 빈 문자열 허용: False 예: sman_example조회 또는 입력 방법: 서비스 목록의 content.data[].uuid에서 가져오거나, 생성 응답의 content.uuid를 사용할 수도 있습니다. |
요청 헤더¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>조회 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Query 요청 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| originStr | string | 구성 반환 형식입니다. 기본값은 1이며 serviceCatelog는 TOML 문자열이고, 0은 파싱된 객체입니다. 서버는 정수로 읽으므로 0 또는 1을 사용합니다. null 허용: False 예: 0조회 또는 입력 방법: 프로그램에서 구성을 읽어야 할 때 문자열 0을 전달하고, TOML 원문을 유지할 때 문자열 1을 전달합니다. |
매개변수 추가 설명¶
반환된 serviceCatelog는 구성 내용을 유지합니다. originStr=0일 때 Related.Tags는 현재 서비스 태그 연결에 따라 다시 채워집니다. 필드명 serviceCatelog는 기존 철자를 유지합니다.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/service_manage/sman_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode originStr=0
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.uuid | string | 서비스 목록 UUID이며 이후 상세 조회, 수정 및 삭제에 사용됩니다. |
| content.service | string | 서비스 이름이며 트레이스 데이터의 service에 바인딩됩니다. |
| content.type | string | 서비스 분류입니다. |
| content.colour | string | 서비스 표시 색상입니다. |
| content.language | string | 서비스 언어 식별자이며 빈 문자열일 수 있습니다. |
| content.createAt | number | 생성 시간, Unix 초입니다. |
| content.updateAt | number | 업데이트 시간, Unix 초이며 아직 업데이트되지 않은 경우 -1일 수 있습니다. |
| content.creatorInfo | object | 생성자 ID 정보이며, 조회되지 않으면 빈 객체입니다. |
| content.updatorInfo | object | 최근 업데이트한 ID 정보이며, 조회되지 않으면 빈 객체입니다. |
| content.creatorInfo.uuid | string | 해당 ID를 조회한 경우 제공될 수 있습니다. ID 식별자입니다. |
| content.creatorInfo.status | integer | 해당 ID를 조회한 경우 제공될 수 있습니다. 계정 상태입니다. |
| content.creatorInfo.wsAccountStatus | integer | 해당 ID를 조회한 경우 제공될 수 있습니다. 워크스페이스 멤버 상태입니다. |
| content.creatorInfo.username | string | 해당 ID를 조회한 경우 제공될 수 있습니다. 로그인 이름입니다. |
| content.creatorInfo.name | string | 해당 ID를 조회한 경우 제공될 수 있습니다. 표시 이름입니다. |
| content.creatorInfo.iconUrl | string | 해당 ID를 조회한 경우 제공될 수 있습니다. 프로필 이미지 URL입니다. |
| content.creatorInfo.email | string | 해당 ID를 조회한 경우 제공될 수 있습니다. 계정 이메일입니다. API Key ID의 경우 해당 식별자가 반환될 수 있습니다. |
| content.creatorInfo.mobile | string | 해당 ID를 조회한 경우 제공될 수 있습니다. 연락처입니다. |
| content.creatorInfo.countryCode | string | 해당 ID를 조회한 경우 제공될 수 있습니다. 전화 국가 또는 지역 코드입니다. |
| content.creatorInfo.acntWsNickname | string | 해당 ID를 조회한 경우 제공될 수 있습니다. 워크스페이스 내 닉네임입니다. |
| content.updatorInfo.uuid | string | 해당 ID를 조회한 경우 제공될 수 있습니다. ID 식별자입니다. |
| content.updatorInfo.status | integer | 해당 ID를 조회한 경우 제공될 수 있습니다. 계정 상태입니다. |
| content.updatorInfo.wsAccountStatus | integer | 해당 ID를 조회한 경우 제공될 수 있습니다. 워크스페이스 멤버 상태입니다. |
| content.updatorInfo.username | string | 해당 ID를 조회한 경우 제공될 수 있습니다. 로그인 이름입니다. |
| content.updatorInfo.name | string | 해당 ID를 조회한 경우 제공될 수 있습니다. 표시 이름입니다. |
| content.updatorInfo.iconUrl | string | 해당 ID를 조회한 경우 제공될 수 있습니다. 프로필 이미지 URL입니다. |
| content.updatorInfo.email | string | 해당 ID를 조회한 경우 제공될 수 있습니다. 계정 이메일입니다. API Key ID의 경우 해당 식별자가 반환될 수 있습니다. |
| content.updatorInfo.mobile | string | 해당 ID를 조회한 경우 제공될 수 있습니다. 연락처입니다. |
| content.updatorInfo.countryCode | string | 해당 ID를 조회한 경우 제공될 수 있습니다. 전화 국가 또는 지역 코드입니다. |
| content.updatorInfo.acntWsNickname | string | 해당 ID를 조회한 경우 제공될 수 있습니다. 워크스페이스 내 닉네임입니다. |
| content.serviceCatelog | string 또는 object | originStr=1이면 TOML 문자열을 반환하고, originStr=0이면 아래 구성 객체를 반환합니다. |
| content.serviceCatelog.Team | object | 서비스 및 팀 구성입니다. |
| content.serviceCatelog.Team.service | string | 서비스 이름입니다. |
| content.serviceCatelog.Team.type | string | 서비스 분류이며, 저장 시 API 규칙에 따라 유효하지 않은 분류가 처리됩니다. |
| content.serviceCatelog.Team.colour | string | 서비스 표시 색상입니다. |
| content.serviceCatelog.Team.team | string | 소속 팀 이름입니다. |
| content.serviceCatelog.Team.oncall | array<object> |
연락처입니다. |
| content.serviceCatelog.Team.oncall[].name | string | 연락처 표시 이름입니다. |
| content.serviceCatelog.Team.oncall[].type | string | email, mobile 또는 slack입니다. |
| content.serviceCatelog.Team.oncall[].emails | array<string> |
email 연락처의 이메일 주소입니다. |
| content.serviceCatelog.Team.oncall[].mobiles | array<string> |
mobile 연락처의 전화번호입니다. |
| content.serviceCatelog.Team.oncall[].slack | string | Slack 채널 주소입니다. |
| content.serviceCatelog.Repos | array<object> |
코드 저장소 목록입니다. |
| content.serviceCatelog.Repos[].name | string | 저장소 표시 이름입니다. |
| content.serviceCatelog.Repos[].link | string | 저장소 URL입니다. |
| content.serviceCatelog.Repos[].provider | string | 제공자 표시 이름입니다. |
| content.serviceCatelog.Docs | array<object> |
운영 문서 목록입니다. |
| content.serviceCatelog.Docs[].name | string | 문서 표시 이름입니다. |
| content.serviceCatelog.Docs[].link | string | 문서 URL입니다. |
| content.serviceCatelog.Docs[].provider | string | 문서 제공자 표시 이름입니다. |
| content.serviceCatelog.Related | object | 연결된 애플리케이션, 내장 뷰 및 시나리오 태그입니다. |
| content.serviceCatelog.Related.AppId | string | 실제 사용자 모니터링(RUM) 애플리케이션 ID이며 비어 있을 수 있습니다. |
| content.serviceCatelog.Related.DashboardUUIDs | array<string> |
연결된 내장 뷰 UUID입니다. |
| content.serviceCatelog.Related.Tags | array<string> |
시나리오 태그 이름입니다. |
| content.extend | object | 서비스 목록 확장 정보입니다. |
| content.checkerInfo | array<object> |
서비스 이름, 시나리오 태그 등으로 연결된 모니터 요약입니다. |
| content.checkerInfo[].uuid | string | 모니터 UUID입니다. |
| content.checkerInfo[].name | string | 모니터 표시 이름입니다. |
| content.checkerInfo[].type | string | 모니터 유형입니다. |
| content.declaration | object 또는 null | 구성 객체가 있을 때 함께 제공될 수 있는 워크스페이스 공통 선언입니다. |
{
"code": 200,
"content": {
"uuid": "sman_example",
"createAt": 1785427200,
"updateAt": -1,
"creatorInfo": {},
"colour": "#40C9C9",
"updatorInfo": {},
"language": "",
"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": []
}
},
"extend": {},
"checkerInfo": [],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
대상이 없을 때의 HTTP 200 응답
{
"code": 200,
"content": {},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 선언되지 않은 Query 매개변수를 사용했거나 매개변수가 규칙을 위반한 경우 | 매개변수 파싱 실패 | Query 매개변수 표와 예시를 확인하세요. |
| 500 | ft.InternalServerError | originStr을 정수로 변환할 수 없음 | 내부 오류 | 문자열 0 또는 1을 사용하고, 문제 파악을 위해 traceId를 기록하세요. |