서비스 목록 조회

Classic/VPC 환경에서 이용 가능합니다.

생성된 서비스의 전체 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/services

요청 헤더

AiTEMS API에서 공통으로 사용하는 헤더에 대한 정보는 AiTEMS 공통 헤더를 참조해 주십시오.

요청 쿼리 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`offset`	Integer	Optional	조회 데이터의 시작 위치 기본값: 0
`limit`	Integer	Optional	조회 데이터의 최대 개수 기본값: 1,000

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/services' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`services`	Array	-	서비스 정보
`offset`	Integer	-	조회 데이터의 시작 위치
`limit`	Integer	-	조회 데이터의 최대 개수

`services`

services에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`serviceId`	String	-	서비스 ID
`name`	String	-	서비스 이름
`status`	String	-	서비스 상태 `scheduled` \| `scheduledLearning` \| `learnable` \| `learning` \| `deleting` \| `deleted` \| `disable` \| `drafted` \| `requestLearning` \| `datasetRequired` `scheduled`: 예약됨 `scheduledLearning`: 예약된 학습 중 `learnable`: 학습 가능 `learning`: 학습 진행 중 `deleting`: 삭제 중 `deleted`: 삭제됨 `disable`: 학습 불가 `drafted`: 임시 저장 상태 `requestLearning`: 학습 요청 상태 `datasetRequired`: 서비스 생성 후 데이터셋을 지정하지 않은 상태
`createdDate`	String	-	서비스 생성 일시
`updatedDate`	String	-	서비스 최종 업데이트 일시
`actionName`	String	-	조회한 항목에 대한 Sub Account 권한
`permission`	String	-	Sub Account 권한 허용 여부

응답 상태 코드

AiTEMS API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 AiTEMS API 공통 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "services": [
        {
            "serviceId": "b28ao******",
            "name": "String",
            "status": "datasetRequired",
            "createdDate": "2024-07-29T17:28:39.698",
            "updatedDate": "2024-07-29T17:28:39.698",
            "actionName": "View/getServiceDetail",
            "permission": "Allow"
        },
        {
            "serviceId": "fboyb******",
            "name": "service",
            "status": "datasetRequired",
            "createdDate": "2024-07-29T16:17:37.235",
            "updatedDate": "2024-07-29T16:17:37.235",
            "actionName": "View/getServiceDetail",
            "permission": "Allow"
        }
    ],
    "offset": 0,
    "limit": 1000
}