콘텐츠로 이동

목록 조회



GET /api/v1/service_manage/list

개요

워크스페이스 내 서비스 목록 설정을 페이지 단위로 나열합니다.

호출 전 및 사용 단계

먼저 이름 또는 유형으로 필터링한 다음 content.data[].uuid를 사용하여 서비스 목록 상세를 호출합니다. 여러 필터를 동시에 제공하면 교집합을 적용하며, 동일한 쉼표 구분 필드 내의 옵션은 하나라도 일치하면 매칭됩니다. 기본적으로 즐겨찾기가 상단에 고정되고, 나머지는 생성 시간 내림차순으로 정렬됩니다. 응답 최상위의 pageInfo를 페이지별로 읽습니다. loading=true이면 서비스 상태 캐시가 아직 준비 중이며, dfStatus의 기본값 ok만으로는 수집이나 모니터링이 정상임을 확인할 수 없습니다.

요청 헤더

파라미터 이름 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예: <DF-API-KEY>
획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Query 요청 파라미터

파라미터 이름 유형 필수 설명
createType commaArray manual은 계정으로 생성, openapi는 API Key로 생성, automatic은 자동 검색입니다.
null 허용: False
예: openapi,manual
획득 또는 입력 방법: 목록 항목의 createType에서 하나 이상의 값을 선택하여 영문 쉼표로 연결합니다.
filter string 전체 목록, 현재 자격 증명의 즐겨찾기, 현재 자격 증명이 생성한 항목 또는 최근 자주 본 항목입니다. 생략하면 전체 목록입니다.
null 허용: False
선택 가능한 값: ['total', 'favorite', 'myCreate', 'oftenBrowse']
예: total
획득 또는 입력 방법: 대상 범위에 따라 total, favorite, myCreate 또는 oftenBrowse를 선택합니다.
originStr string 설정 반환 형식입니다. 기본값은 1이며 serviceCatelog가 TOML 문자열로 반환됩니다. 0이면 파싱된 객체로 반환됩니다. 서버는 정수로 읽으므로 0 또는 1을 사용합니다.
null 허용: False
예: 0
획득 또는 입력 방법: 프로그램에서 설정을 읽어야 할 때는 문자열 0을, TOML 원문을 유지해야 할 때는 문자열 1을 전달합니다.
pageIndex integer 페이지 번호, 기본값 1, 최소 1입니다.
null 허용: False
$minValue: 1
예: 1
획득 또는 입력 방법: 1부터 시작하여 반환된 pageInfo에 따라 다음 페이지로 진행합니다.
pageSize integer 페이지당 항목 수, 기본값 50, 범위 1~100입니다.
null 허용: False
$maxValue: 100
$minValue: 1
예: 20
획득 또는 입력 방법: 클라이언트 표시 개수에 맞춰 선택하며, 한 번에 100개를 초과하지 않습니다.
search string 서비스 이름 포함 매칭이며, 생략하거나 공백이면 이름으로 필터링하지 않습니다.
null 허용: False
예: checkout
획득 또는 입력 방법: 알려진 서비스 이름의 키워드를 입력합니다.
serviceType commaArray 서비스 분류 필터입니다. 예: app, framework, cache, message_queue, custom, db, web, aws_lambda.
null 허용: False
예: web,app
획득 또는 입력 방법: 목록 항목의 type에서 값을 가져와 영문 쉼표로 연결합니다.
teamUUID commaArray 소속 팀으로 필터링하며 팀 UUID를 입력합니다. 일치하는 팀이 없으면 빈 목록을 반환합니다.
null 허용: False
예: group_example
획득 또는 입력 방법: 팀 목록에서 팀 UUID를 가져오며, 여러 UUID는 영문 쉼표로 연결합니다.

파라미터 추가 설명

originStr=0이면 설정이 객체로 반환되며, 예제는 이 형식을 사용합니다. 일치하는 서비스가 없으면 data가 비어 있고 pageInfo.count와 totalCount는 모두 0이며, loading은 생략될 수 있습니다.

요청 예제

curl --get 'https://openapi.guance.com/api/v1/service_manage/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode originStr=0 \
  --data-urlencode search=checkout \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=20

응답

HTTP 200, application/json. 아래 예제는 직접 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content object 목록 데이터와 자동 검색 상태입니다.
content.automaticFoundTime string 또는 null 가장 최근 자동 검색 작업의 시작 시간(Unix 초 문자열)입니다. 아직 캐시가 없으면 비어 있을 수 있습니다.
content.loading boolean 상태 캐시가 아직 준비 중인지 여부입니다. 서비스 결과가 없으면 생략될 수 있습니다.
content.data array<object> 현재 페이지의 서비스 목록입니다.
content.data[].uuid string 서비스 목록 UUID로, 이후 상세 조회, 수정 및 삭제에 사용됩니다.
content.data[].service string 서비스 이름이며, 분산 추적 데이터의 service와 바인딩됩니다.
content.data[].type string 서비스 분류입니다.
content.data[].colour string 서비스 표시 색상입니다.
content.data[].language string 서비스 언어 식별자이며 빈 문자열일 수 있습니다.
content.data[].createAt number 생성 시간, Unix 초입니다.
content.data[].updateAt number 업데이트 시간, Unix 초입니다. 아직 업데이트되지 않았으면 -1일 수 있습니다.
content.data[].creatorInfo object 생성 자격 증명 정보이며, 조회되지 않으면 빈 객체입니다.
content.data[].updatorInfo object 최근 업데이트 자격 증명 정보이며, 조회되지 않으면 빈 객체입니다.
content.data[].creatorInfo.uuid string 해당 자격 증명이 조회되면 제공될 수 있습니다. 자격 증명 식별자입니다.
content.data[].creatorInfo.status integer 해당 자격 증명이 조회되면 제공될 수 있습니다. 계정 상태입니다.
content.data[].creatorInfo.wsAccountStatus integer 해당 자격 증명이 조회되면 제공될 수 있습니다. 워크스페이스 멤버 상태입니다.
content.data[].creatorInfo.username string 해당 자격 증명이 조회되면 제공될 수 있습니다. 로그인 이름입니다.
content.data[].creatorInfo.name string 해당 자격 증명이 조회되면 제공될 수 있습니다. 표시 이름입니다.
content.data[].creatorInfo.iconUrl string 해당 자격 증명이 조회되면 제공될 수 있습니다. 아바타 URL입니다.
content.data[].creatorInfo.email string 해당 자격 증명이 조회되면 제공될 수 있습니다. 계정 이메일입니다. API Key 자격 증명은 그 식별자를 반환할 수 있습니다.
content.data[].creatorInfo.mobile string 해당 자격 증명이 조회되면 제공될 수 있습니다. 연락처입니다.
content.data[].creatorInfo.countryCode string 해당 자격 증명이 조회되면 제공될 수 있습니다. 전화 국가 또는 지역 코드입니다.
content.data[].creatorInfo.acntWsNickname string 해당 자격 증명이 조회되면 제공될 수 있습니다. 워크스페이스 내 닉네임입니다.
content.data[].updatorInfo.uuid string 해당 자격 증명이 조회되면 제공될 수 있습니다. 자격 증명 식별자입니다.
content.data[].updatorInfo.status integer 해당 자격 증명이 조회되면 제공될 수 있습니다. 계정 상태입니다.
content.data[].updatorInfo.wsAccountStatus integer 해당 자격 증명이 조회되면 제공될 수 있습니다. 워크스페이스 멤버 상태입니다.
content.data[].updatorInfo.username string 해당 자격 증명이 조회되면 제공될 수 있습니다. 로그인 이름입니다.
content.data[].updatorInfo.name string 해당 자격 증명이 조회되면 제공될 수 있습니다. 표시 이름입니다.
content.data[].updatorInfo.iconUrl string 해당 자격 증명이 조회되면 제공될 수 있습니다. 아바타 URL입니다.
content.data[].updatorInfo.email string 해당 자격 증명이 조회되면 제공될 수 있습니다. 계정 이메일입니다. API Key 자격 증명은 그 식별자를 반환할 수 있습니다.
content.data[].updatorInfo.mobile string 해당 자격 증명이 조회되면 제공될 수 있습니다. 연락처입니다.
content.data[].updatorInfo.countryCode string 해당 자격 증명이 조회되면 제공될 수 있습니다. 전화 국가 또는 지역 코드입니다.
content.data[].updatorInfo.acntWsNickname string 해당 자격 증명이 조회되면 제공될 수 있습니다. 워크스페이스 내 닉네임입니다.
content.data[].serviceCatelog string 또는 object originStr=1이면 TOML 문자열을 반환하고, originStr=0이면 아래 설정 객체를 반환합니다.
content.data[].serviceCatelog.Team object 서비스 및 팀 설정입니다.
content.data[].serviceCatelog.Team.service string 서비스 이름입니다.
content.data[].serviceCatelog.Team.type string 서비스 분류입니다. 저장 시 유효하지 않은 분류는 인터페이스 규칙에 따라 처리됩니다.
content.data[].serviceCatelog.Team.colour string 서비스 표시 색상입니다.
content.data[].serviceCatelog.Team.team string 소속 팀 이름입니다.
content.data[].serviceCatelog.Team.oncall array<object> 연락처입니다.
content.data[].serviceCatelog.Team.oncall[].name string 연락처 표시 이름입니다.
content.data[].serviceCatelog.Team.oncall[].type string email, mobile 또는 slack입니다.
content.data[].serviceCatelog.Team.oncall[].emails array<string> email 연락 방법의 이메일 주소입니다.
content.data[].serviceCatelog.Team.oncall[].mobiles array<string> mobile 연락 방법의 전화번호입니다.
content.data[].serviceCatelog.Team.oncall[].slack string Slack 채널 주소입니다.
content.data[].serviceCatelog.Repos array<object> 코드 저장소 목록입니다.
content.data[].serviceCatelog.Repos[].name string 저장소 표시 이름입니다.
content.data[].serviceCatelog.Repos[].link string 저장소 URL입니다.
content.data[].serviceCatelog.Repos[].provider string 공급자 표시 이름입니다.
content.data[].serviceCatelog.Docs array<object> 운영 문서 목록입니다.
content.data[].serviceCatelog.Docs[].name string 문서 표시 이름입니다.
content.data[].serviceCatelog.Docs[].link string 문서 URL입니다.
content.data[].serviceCatelog.Docs[].provider string 문서 제공자 표시 이름입니다.
content.data[].serviceCatelog.Related object 연결된 애플리케이션, 내장 뷰 및 시나리오 태그입니다.
content.data[].serviceCatelog.Related.AppId string 실제 사용자 모니터링(RUM) 애플리케이션 ID이며, 비어 있을 수 있습니다.
content.data[].serviceCatelog.Related.DashboardUUIDs array<string> 연결된 내장 뷰 UUID입니다.
content.data[].serviceCatelog.Related.Tags array<string> 시나리오 태그 이름입니다.
content.data[].dfStatus string 연결된 이벤트 상태입니다. 캐시가 준비되지 않았거나 상태가 없으면 기본값 ok입니다.
content.data[].isFavorite boolean 현재 호출 자격 증명이 즐겨찾기했는지 여부입니다.
content.data[].createType string 생성 자격 증명을 기준으로 추론한 출처입니다. 일반적으로 manual, openapi, automatic이며, 과거의 다른 자격 증명인 경우 이 필드가 생략될 수 있습니다.
content.declaration object 또는 null 워크스페이스 공통 선언입니다.
pageInfo object 응답 최상위 페이지 정보입니다.
pageInfo.pageIndex integer 현재 페이지 번호입니다.
pageInfo.pageSize integer 페이지 크기입니다.
pageInfo.count integer 현재 페이지에서 반환된 항목 수입니다.
pageInfo.totalCount integer 필터 조건을 만족하는 전체 항목 수입니다.
{
  "code": 200,
  "content": {
    "automaticFoundTime": "1785427200",
    "data": [
      {
        "uuid": "sman_example",
        "createAt": 1785427200,
        "updateAt": -1,
        "creatorInfo": {},
        "colour": "#40C9C9",
        "updatorInfo": {},
        "dfStatus": "ok",
        "language": "",
        "isFavorite": false,
        "createType": "openapi",
        "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": []
          }
        }
      }
    ],
    "loading": false,
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 20,
    "count": 1,
    "totalCount": 1
  }
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하십시오.

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 선언되지 않은 Query 파라미터를 사용하거나 파라미터가 규칙을 위반함 파라미터 파싱 실패 Query 파라미터 표와 예제를 확인합니다.
500 ft.InternalServerError originStr을 정수로 변환할 수 없음 내부 오류 문자열 0 또는 1을 사용하고, traceId를 기록하여 원인을 파악합니다.

문서 평가

이 페이지가 도움이 되었나요?