콘텐츠로 이동

내보내기



GET /api/v1/service_manage/export

개요

현재 워크스페이스의 서비스 목록 구성을 JSON으로 내보냅니다.

호출 전 및 사용 단계

originStr에 따라 구성 텍스트 또는 객체를 선택합니다. 서버는 첫 페이지에서 페이지당 10,000건을 고정적으로 가져옵니다. 성공 응답의 루트 노드는 서비스 객체 배열이며, 전체 응답을 저장한 후 클라이언트에서 읽습니다. 10,000건을 초과하는 전체 순회에는 목록 API의 페이지네이션을 사용하십시오. 워크스페이스에 서비스 목록이 없으면 루트 노드는 data와 pageInfo를 포함하는 빈 컬렉션 객체를 반환합니다.

요청 헤더

파라미터 이름 타입 필수 설명
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을 전달합니다.

파라미터 추가 설명

Content-Type은 application/json입니다. originStr=0 예시는 구조화된 구성을 반환합니다. 내보내는 서비스 필드는 목록과 동일하며, 현재 내보내기 상한은 10,000건입니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/service_manage/export' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode originStr=0

응답

HTTP 200, Content-Type은 application/json입니다. 아래 예시는 응답 루트 노드이며, 배열 또는 빈 컬렉션 객체로 읽습니다.

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

서비스 구성이 없을 때의 HTTP 200 응답

{
  "automaticFoundTime": null,
  "data": [],
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 10000,
    "count": 0,
    "totalCount": 0
  }
}

오류 응답

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

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

문서 평가

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