공간 목록(List Spaces) (V2)

프로젝트의 상위 컨테이너인 공간 목록을 조회합니다. 각 페이지의 항목 수는 요청한 pageSize보다 작거나 클 수 있습니다. 결과 수로 종료 여부를 판단하지 않고 nextPageToken을 사용합니다.

결과가 더 있으면 다음 토큰이 제공됩니다. 같은 요청에 직전 토큰을 pageToken으로 넣어 이어서 조회하고, 토큰이 없으면 마지막 페이지로 처리합니다.

HTTP 요청

GET /api/v2/filesystem/spaces

작업 식별자는 v2.listSpaces입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:filesystem-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.

경로 매개변수

지정할 경로 매개변수가 없습니다.

쿼리 매개변수

이름	자료형	필수 여부	의미와 조건	예시 값
`pageSize`	`integer`	선택	요청할 페이지 크기입니다.
`pageToken`	`string`	선택	페이지 조회를 시작할 위치입니다. 첫 요청에서는 생략하고, 다음 요청에서는 직전 응답의 `nextPageToken`을 `pageToken`으로 전달합니다.

요청 본문

요청 본문을 사용하지 않습니다.

응답

응답 형식은 ListSpacesResponse입니다.

data는 Space 목록입니다. fileSystemId, usageAccountRid, defaultRoleSetId는 응답에서 필수입니다. 이 필드 설명의 생략 시 기본값은 공간 설정에 관한 것이며, 조회 응답에서 해당 필드가 선택 사항이라는 뜻은 아닙니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`data`	`list<Space>`	선택
`nextPageToken`	`string`	선택	다음 페이지를 요청할 때 `pageToken`에 전달할 토큰입니다. 다음 토큰이 없으면 마지막 페이지입니다.

`data`의 구조

배열 항목은 Space이며 자료형은 object입니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`rid`	`string`	필수	공간의 고유 식별자(RID)입니다.	`ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791`
`displayName`	`string`	필수	리소스의 표시 이름입니다.	`My Space`
`description`	`string`	선택	공간의 설명입니다.	`This space is for xyz`
`path`	`string`	필수	리소스 이름 자체를 포함한 전체 경로입니다.	`/My space-576e4`
`fileSystemId`	`string`	필수	공간의 콘텐츠를 저장할 파일시스템 ID입니다. 공간 설정에서 값을 지정하지 않으면 플랫폼 인스턴스의 기본 파일시스템을 사용합니다.	`hdfs`
`usageAccountRid`	`string`	필수	공간의 사용량 계정(Usage Account) RID입니다. 이 공간의 프로젝트 사용량은 기본적으로 해당 계정에 귀속됩니다. 설정에서 지정하지 않으면 플랫폼 인스턴스의 기본 사용량 계정을 사용합니다.	`ri.resource-policy-manager.global.usage-account.0c91194d-b5e3-4c4f-b96f-7a7f3f50e95c`
`organizations`	`list<OrganizationRid>`	선택	공간 접근을 허용한 조직 목록입니다. 사용자에게는 이 조직 중 적어도 하나의 구성원 자격이 필요합니다.
`deletionPolicyOrganizations`	`list<OrganizationRid>`	선택	기본 Last Out 삭제 정책은 이 목록의 마지막 조직이 삭제될 때 공간과 그 프로젝트들을 삭제합니다. 같은 플랫폼 인스턴스에 속한 조직만 목록에 포함할 수 있습니다.
`defaultRoleSetId`	`string`	필수	공간의 프로젝트에서 사용할 역할을 정의하는 기본 역할 집합 ID입니다. 설정에서 지정하지 않으면 프로젝트용 기본 역할 집합을 사용합니다.	`3181190f-f6b8-4649-90ec-64fa2d847204`
`spaceMavenIdentifier`	`string`	선택	이 공간에서 게시한 리소스의 Maven 좌표에 붙이는 접두사입니다. Control Panel의 공간 설정에 구성했을 때만 제공됩니다.	`com.palantir.your-space`

`organizations`의 구조

배열 항목은 OrganizationRid이며 자료형은 string입니다.

`deletionPolicyOrganizations`의 구조

배열 항목은 OrganizationRid이며 자료형은 string입니다.

가상 공간 목록의 응답 예시입니다.

{
  "data": [
    {
      "path": "/My space-576e4",
      "usageAccountRid": "ri.resource-policy-manager.global.usage-account.0c91194d-b5e3-4c4f-b96f-7a7f3f50e95c",
      "fileSystemId": "hdfs",
      "displayName": "My Space",
      "organizations": [
        "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
      ],
      "description": "This space is for xyz",
      "deletionPolicyOrganizations": [
        "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
      ],
      "defaultRoleSetId": "3181190f-f6b8-4649-90ec-64fa2d847204",
      "spaceMavenIdentifier": "com.palantir.your-space",
      "rid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791"
    }
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

curl \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/filesystem/spaces"

Python

Requests 라이브러리가 설치된 Python 환경에서 사용합니다.

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "authorization": "Bearer {}".format(TOKEN)
}

response = requests.get('https://{}/api/v2/filesystem/spaces'.format(HOSTNAME), headers=headers)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ListSpacesExample.java 파일에서 사용합니다.

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

public class ListSpacesExample {
    public static void main(String[] args) throws Exception {
        String HOSTNAME = System.getenv("FOUNDRY_HOST");
        String TOKEN = System.getenv("FOUNDRY_TOKEN");

        try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
            HttpGet request = new HttpGet("https://" + HOSTNAME + "/api/v2/filesystem/spaces");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                System.out.println(response);
            }
        }
    }
}

JavaScript

fetch를 제공하는 Node.js 환경에서 사용합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

const HOSTNAME = process.env.FOUNDRY_HOST;
const TOKEN = process.env.FOUNDRY_TOKEN;

fetch(`https://${HOSTNAME}/api/v2/filesystem/spaces`, {
    method: 'GET',
    headers: {
        'Authorization': `Bearer ${TOKEN}`,
    }
}).then((response) => {
    console.log(response)
});

PowerShell

$ErrorActionPreference = 'Stop'
$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

$headers = @{
    "authorization" = "Bearer $TOKEN"
}

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/filesystem/spaces" `
	-Headers $headers

$response.content

팔란티어 플랫폼 한국어 해설