VPC 환경에서 이용 가능합니다.
계정 내 워크스페이스 목록을 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET | /api/v1/workspaces |
요청 헤더
Media Intelligence API에서 공통으로 사용하는 헤더에 대한 정보는 Media Intelligence 요청 헤더를 참조해 주십시오.
요청 쿼리 파라미터
파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
pageNum |
Integer | Required | 조회할 페이지 번호 |
pageSize |
Integer | Optional | 페이지당 조회 항목 수
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://mi.apigw.ntruss.com/api/v1/workspaces?pageNum=1&pageSize=100' \
--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'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
code |
String | Required | API 처리 결과 코드 |
message |
String | Required | API 처리 결과 메시지 |
result |
Object | Required | API 반환 정보 |
result.totalCount |
Integer | Required | 전체 워크스페이스 수 |
result.totalPage |
Integer | Required | 전체 페이지 수 |
result.pageNo |
Integer | Required | 요청한 페이지 번호 |
result.pageSize |
Integer | Required | 요청한 페이지 크기 |
result.content |
Array | Required | 워크스페이스 목록 |
result.content
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
workspaceName |
String | Required | 워크스페이스 이름 |
workspaceUrl |
String | Required | 워크스페이스 URL |
bucketName |
String | Optional | 연동된 Object Storage 버킷 이름 |
createdUserName |
String | Required | 생성자 이름 |
createdTime |
String | Required | 생성 일시
|
updatedUserName |
String | Required | 수정자 이름 |
updatedTime |
String | Required | 수정 일시
|
응답 상태 코드
Media Intelligence API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Media Intelligence 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"code": "0",
"message": "success",
"result": {
"totalCount": 2,
"totalPage": 1,
"pageNo": 1,
"pageSize": 100,
"content": [
{
"workspaceName": "my-workspace",
"workspaceUrl": "https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace",
"bucketName": "my-bucket",
"createdUserName": "user123",
"createdTime": "2026-03-18T10:30:00",
"updatedUserName": "user123",
"updatedTime": "2026-03-18T10:30:00"
},
{
"workspaceName": "test-workspace",
"workspaceUrl": "https://mi.apigw.ntruss.com/api/v1/workspaces/test-workspace",
"bucketName": "test-bucket",
"createdUserName": "user456",
"createdTime": "2026-03-17T09:00:00",
"updatedUserName": "user456",
"updatedTime": "2026-03-17T09:00:00"
}
]
}
}