> For the complete documentation index, see [llms.txt](/llms.txt)
# GS2-Deploy SDK API 레퍼런스
각종 프로그래밍 언어용 GS2-Deploy SDK의 모델 사양과 API 레퍼런스
## 모델
### GitHubCheckoutSetting
GitHub에서 마스터 데이터를 체크아웃하는 설정
GitHub 리포지토리에서 템플릿 또는 마스터 데이터 파일을 직접 가져오기 위한 설정입니다. 커밋 해시, 브랜치 이름, 태그 이름으로 참조하는 것을 지원하며, 인증을 위해 GS2-Key의 GitHub API 키가 필요합니다.
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| apiKeyId | string | | ✓ | | ~ 1024자 | GitHub API 키의 GRN |
| repositoryName | string | | ✓ | | ~ 1024자 | 리포지토리 이름
파일을 가져올 GitHub 리포지토리 이름입니다. "owner/repo" 형식으로 지정합니다. |
| sourcePath | string | | ✓ | | ~ 1024자 | 마스터 데이터(JSON) 파일 경로
리포지토리 내 대상 파일의 파일 경로입니다. 예를 들어 "data/master.json"이나 "deploy/template.yaml"과 같이 지정합니다. |
| referenceType | 문자열 열거형
enum {
"commit_hash",
"branch",
"tag"
}
| | ✓ | | | 코드 취득 방식
파일을 체크아웃하는 데 사용할 Git 참조 유형입니다. `commit_hash`는 재현성을 위해 특정 커밋에서 가져오고, `branch`는 브랜치의 최신 상태를 가져오며, `tag`는 태그가 지정된 릴리스에서 가져옵니다.commit_hash: 커밋 해시 / branch: 브랜치 / tag: 태그 / |
| commitHash | string | {referenceType} == "commit_hash" | ✓※ | | ~ 1024자 | 커밋 해시
체크아웃할 Git 커밋의 전체 SHA입니다. 항상 동일한 버전의 파일이 취득되도록 보장하여 배포의 재현성을 제공합니다.
※ referenceType이(가) "commit_hash" 이면 필수 |
| branchName | string | {referenceType} == "branch" | ✓※ | | ~ 1024자 | 브랜치 이름
체크아웃할 Git 브랜치 이름입니다. 이 브랜치의 최신 커밋을 사용하여 파일을 가져옵니다.
※ referenceType이(가) "branch" 이면 필수 |
| tagName | string | {referenceType} == "tag" | ✓※ | | ~ 1024자 | 태그 이름
체크아웃할 Git 태그 이름입니다. 태그는 일반적으로 릴리스 버전을 표시하는 데 사용되며, 배포를 위한 안정적인 참조 지점을 제공합니다.
※ referenceType이(가) "tag" 이면 필수 |
**관련 메서드:**
createStackFromGitHub - GitHub에서 스택 신규 생성
updateStackFromGitHub - GitHub에서 스택 갱신
---
### Resource
리소스
리소스는 스택에서 관리하는 개별 GS2 서비스 엔티티를 나타냅니다.
각 리소스는 스택 템플릿에서 정의된 GS2 API 리소스(네임스페이스나 모델 등)에 대응합니다.
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| resourceId | string | | ※ | | ~ 1024자 | 리소스 GRN
※ 서버가 자동으로 설정 |
| type | string | | ✓ | | ~ 1024자 | 리소스 유형
GS2 리소스 유형 식별자입니다(예: "GS2::Inventory::Namespace", "GS2::Experience::ExperienceModel"). 이 리소스를 생성, 업데이트, 삭제할 때 어떤 GS2 API가 호출되는지를 결정합니다. |
| name | string | | ✓ | | ~ 128자 | 리소스 이름
스택 템플릿에서 이 리소스에 할당된 논리적 이름입니다. 템플릿 내에서 종속성 해결과 아웃풋 필드 매핑을 위해 리소스를 참조하는 데 사용됩니다. |
| request | string | | ✓ | | ~ 1048576자 | 리퀘스트 파라미터
이 리소스를 생성 또는 업데이트하는 데 사용되는 JSON으로 직렬화된 API 리퀘스트 파라미터입니다. |
| response | string | | ✓ | | ~ 1048576자 | 리소스 생성/업데이트에 대한 레스폰스
리소스 생성 또는 업데이트 시 반환된 JSON으로 직렬화된 API 레스폰스입니다. 생성된 ID나 기본값을 포함한 실제 리소스 상태가 저장됩니다. |
| rollbackContext | 문자열 열거형
enum {
"create",
"update",
"delete"
}
| | | | | 롤백 작업의 종류
이 리소스를 롤백할 때 수행할 작업의 종류입니다. `create`는 리소스가 새로 생성되었으므로 롤백 시 삭제됨을, `update`는 리소스가 변경되었으므로 원래대로 되돌림을, `delete`는 리소스가 삭제되었으므로 다시 생성됨을 의미합니다.create: Create / update: Update / delete: Delete / |
| rollbackRequest | string | | | | ~ 1048576자 | 롤백용 리퀘스트 파라미터
이 리소스를 롤백할 때 사용하는 JSON으로 직렬화된 API 리퀘스트 파라미터입니다. 업데이트된 리소스의 경우 복원할 이전 상태가, 삭제된 리소스의 경우 다시 생성하기 위한 생성 파라미터가 저장됩니다. |
| rollbackAfter | List<string> | | | [] | 0 ~ 1000 items | 롤백 시 의존하고 있는 리소스의 이름
이 리소스보다 먼저 롤백해야 하는 리소스 이름의 목록입니다. 정합성을 유지하기 위해 롤백 작업이 올바른 종속 순서로 실행되도록 보장합니다. |
| outputFields | [List<OutputField>](#outputfield) | | | [] | 0 ~ 1000 items | 리소스를 생성했을 때 Output에 기록할 필드
API 레스폰스에서 어떤 필드를 추출하여 스택의 아웃풋으로 저장할지 지정합니다. 각 항목은 아웃풋 이름을 레스폰스 내 필드 경로에 매핑하여, 다른 스택이나 외부 시스템이 생성된 리소스의 값을 참조할 수 있도록 합니다. |
| workId | string | | ✓ | | ~ 1024자 | 이 리소스가 생성되었을 때의 실행 ID
이 리소스를 프로비저닝한 스택 작업(생성/업데이트)의 고유 식별자입니다. |
| createdAt | long | | ※ | 현재 시각 | | 생성일시
UNIX 시간・밀리초
※ 서버가 자동으로 설정 |
**관련 메서드:**
describeResources - 리소스 목록 조회
getResource - 리소스 조회
---
### Event
이벤트
스택 내 리소스의 생성, 업데이트, 삭제 등의 작업이 수행될 때 정보를 제공하기 위해 이벤트가 생성됩니다.
개발자는 스택의 배포 프로세스와 리소스 변경이 어떻게 진행되고 있는지 모니터링하고 필요한 조치를 취할 수 있습니다.
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| eventId | string | | ※ | | ~ 1024자 | 이벤트 GRN
※ 서버가 자동으로 설정 |
| name | string | | ✓ | UUID | ~ 36자 | 이벤트 이름
각 이벤트의 고유한 이름을 유지합니다.
이름은 UUID(Universally Unique Identifier) 형식으로 자동 생성되며, 각 이벤트를 식별하는 데 사용됩니다. |
| resourceName | string | | ✓ | | ~ 128자 | 리소스 이름
스택 템플릿에서 이 리소스에 할당된 논리적 이름입니다. 템플릿 내에서 종속성 해결과 아웃풋 필드 매핑을 위해 리소스를 참조하는 데 사용됩니다. |
| type | 문자열 열거형
enum {
"CREATE_IN_PROGRESS",
"CREATE_COMPLETE",
"CREATE_FAILED",
"UPDATE_IN_PROGRESS",
"UPDATE_COMPLETE",
"UPDATE_FAILED",
"CLEAN_IN_PROGRESS",
"CLEAN_COMPLETE",
"CLEAN_FAILED",
"DELETE_IN_PROGRESS",
"DELETE_COMPLETE",
"DELETE_FAILED",
"ROLLBACK_IN_PROGRESS",
"ROLLBACK_COMPLETE",
"ROLLBACK_FAILED"
}
| | ✓ | | | 상태
리소스 작업의 현재 상태를 나타내는 이벤트 유형입니다. 개별 리소스에 대한 생성, 업데이트, 클린, 삭제, 롤백 작업의 진행 중, 완료, 실패 상태를 추적합니다.CREATE_IN_PROGRESS: 생성 중 / CREATE_COMPLETE: 생성 완료 / CREATE_FAILED: 생성 실패 / UPDATE_IN_PROGRESS: 업데이트 중 / UPDATE_COMPLETE: 업데이트 완료 / UPDATE_FAILED: 업데이트 실패 / CLEAN_IN_PROGRESS: 리소스 삭제 중 / CLEAN_COMPLETE: 리소스 삭제 완료 / CLEAN_FAILED: 리소스 삭제 실패 / DELETE_IN_PROGRESS: 삭제 중 / DELETE_COMPLETE: 삭제 완료 / DELETE_FAILED: 삭제 실패 / ROLLBACK_IN_PROGRESS: 롤백 중 / ROLLBACK_COMPLETE: 롤백 완료 / ROLLBACK_FAILED: 롤백 실패 / |
| message | string | | | | ~ 5242880자 | 메시지
이벤트를 설명하는 상세 메시지입니다. 작업이 실패한 경우 리소스 작업이 실패한 이유를 설명하는 오류 메시지가 포함됩니다. 작업이 성공한 경우 완료된 작업에 관한 추가 컨텍스트가 포함될 수 있습니다. |
| eventAt | long | | ※ | 현재 시각 | | 생성일시
UNIX 시간・밀리초
※ 서버가 자동으로 설정 |
| revision | long | | | 0 | 0 ~ 9223372036854775805 | 리비전 |
**관련 메서드:**
describeEvents - 이벤트 목록 조회
getEvent - 이벤트 조회
---
### Output
스택에 의해 생성되는 출력
스택의 Outputs 섹션에 기록하고 싶은 데이터를 기재함으로써 이 모델을 사용하여 출력을 생성할 수 있습니다.
예를 들어 크리덴셜을 작성할 때 클라이언트 시크릿은 작성한 순간에만 확인할 수 있지만, 그 내용을 출력으로 기록해 두면 나중에 클라이언트 시크릿의 값을 참조할 수 있게 됩니다.
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| outputId | string | | ※ | | ~ 1024자 | 아웃풋 GRN
※ 서버가 자동으로 설정 |
| name | string | | ✓ | | ~ 1024자 | 아웃풋 이름
스택 템플릿의 Outputs 섹션에 정의된 아웃풋의 논리적 이름입니다. 다른 스택이나 외부 시스템에서 이 아웃풋 값을 참조하기 위해 사용됩니다. |
| value | string | | | | ~ 1048576자 | 값
리소스의 API 응답에서 추출된 실제 아웃풋 값입니다. 예를 들어 리소스 생성 시 생성된 클라이언트 시크릿이나 리소스 ARN 등, 이후 참조 가능한 값이 저장됩니다. |
| createdAt | long | | ※ | 현재 시각 | | 생성일시
UNIX 시간・밀리초
※ 서버가 자동으로 설정 |
**관련 메서드:**
describeOutputs - 아웃풋 목록 조회
getOutput - 아웃풋 조회
---
### Stack
스택
스택이란 GS2-Deploy를 이용하여 GS2 상의 리소스를 설정하는 엔티티입니다.
스택에는 템플릿 파일을 지정하도록 되어 있으며, 템플릿 파일에는 GS2 상에서 필요한 리소스를 정의합니다.
GS2-Deploy는 스택을 신규 작성 또는 업데이트할 때 템플릿 파일의 변경 사항을 감지하여, 추가된 항목이 있으면 리소스를 생성하고, 변경된 항목이 있으면 리소스를 업데이트하며, 삭제된 항목이 있으면 리소스를 삭제합니다.
이 메커니즘을 이용함으로써 GS2 상의 리소스를 선언적으로 기술하고, 재현 가능한 상태로 관리할 수 있게 됩니다.
이러한 재현성이 있으면 개발 환경에서 프로덕션 환경으로 설정을 이관할 때 등에 실수 없이 실행할 수 있습니다.
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| stackId | string | | ※ | | ~ 1024자 | 스택 GRN
※ 서버가 자동으로 설정 |
| name | string | | ✓ | | ~ 128자 | 스택 이름
스택을 식별하는 고유한 이름입니다. 영숫자 및 -(하이픈), _(언더스코어), .(마침표)로 지정합니다. 생성·업데이트·삭제 조작 시 스택을 참조하기 위해 사용됩니다. |
| description | string | | | | ~ 1024자 | 설명문 |
| template | string | | ✓ | | ~ 5242880자 | 템플릿 데이터
프로비저닝할 GS2 리소스를 선언적으로 정의하는 YAML 또는 JSON 문서입니다. GS2-Deploy는 현재와 이전 템플릿의 차이를 감지하여 필요에 따라 리소스를 생성·업데이트·삭제합니다. 최대 크기는 5MB입니다. |
| status | 문자열 열거형
enum {
"CREATE_PROCESSING",
"CREATE_COMPLETE",
"UPDATE_PROCESSING",
"UPDATE_COMPLETE",
"CLEAN_PROCESSING",
"CLEAN_COMPLETE",
"DELETE_PROCESSING",
"DELETE_COMPLETE",
"ROLLBACK_INITIALIZING",
"ROLLBACK_PROCESSING",
"ROLLBACK_COMPLETE"
}
| | | "CREATE_PROCESSING" | | 실행 상태
스택 조작의 현재 라이프사이클 상태입니다. 생성·업데이트·클린(리소스 삭제)·삭제·롤백 조작의 처리 중 및 완료 상태를 전이합니다. 조작이 실패하면 롤백이 트리거되어 이전 상태로 복원되는 경우가 있습니다.CREATE_PROCESSING: 생성 중 / CREATE_COMPLETE: 생성 완료 / UPDATE_PROCESSING: 업데이트 중 / UPDATE_COMPLETE: 업데이트 완료 / CLEAN_PROCESSING: 리소스 삭제 중 / CLEAN_COMPLETE: 리소스 삭제 완료 / DELETE_PROCESSING: 삭제 중 / DELETE_COMPLETE: 삭제 완료 / ROLLBACK_INITIALIZING: 롤백 초기화 중 / ROLLBACK_PROCESSING: 롤백 중 / ROLLBACK_COMPLETE: 롤백 완료 / |
| createdAt | long | | ※ | 현재 시각 | | 생성일시
UNIX 시간・밀리초
※ 서버가 자동으로 설정 |
| updatedAt | long | | ※ | 현재 시각 | | 최종 갱신일시
UNIX 시간・밀리초
※ 서버가 자동으로 설정 |
| revision | long | | | 0 | 0 ~ 9223372036854775805 | 리비전 |
**관련 메서드:**
describeStacks - 스택 목록 조회
createStack - 스택 신규 생성
createStackFromGitHub - GitHub에서 스택 신규 생성
getStack - 스택 조회
updateStack - 스택 갱신
updateStackFromGitHub - GitHub에서 스택 갱신
deleteStack - 스택 삭제
forceDeleteStack - 스택 강제 삭제
deleteStackResources - 스택 리소스 삭제
deleteStackEntity - 스택 최종 삭제
---
### OutputField
아웃풋 필드
리소스의 API 레스폰스 필드에서 이름이 지정된 스택 아웃풋으로의 매핑을 정의합니다.
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string | | ✓ | | ~ 1024자 | 이름
추출된 값이 저장되는 아웃풋의 키 이름입니다. 스택의 Outputs에서 아웃풋 값을 참조할 때 이 이름이 사용됩니다. |
| fieldName | string | | ✓ | | ~ 1024자 | 필드 이름
값을 추출할 리소스의 API 레스폰스 내 필드 경로입니다. 생성 또는 업데이트된 리소스의 어떤 속성을 아웃풋으로 기록할지 지정합니다. |
**관련 모델:**
Resource - 리소스
---
### ChangeSet
변경 내용
현재 스택 템플릿과 새 템플릿을 비교했을 때 감지된 단일 리소스 변경 사항을 나타냅니다. 스택 업데이트를 실제로 실행하기 전에 어떤 리소스가 생성, 업데이트, 삭제되는지 미리 보기 위한 밸리데이션 작업에서 사용됩니다.
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| resourceName | string | | ✓ | | ~ 128자 | 리소스 이름
이 변경의 영향을 받는, 스택 템플릿에서 정의된 리소스의 논리적 이름입니다. |
| resourceType | string | | ✓ | | ~ 128자 | 리소스 유형
변경되는 리소스의 GS2 리소스 유형 식별자입니다(예: "GS2::Inventory::Namespace"). |
| operation | 문자열 열거형
enum {
"create",
"update",
"delete"
}
| | ✓ | | | 변경 내용
이 리소스에 적용되는 변경의 종류입니다. `create`는 새 리소스가 프로비저닝됨을, `update`는 기존 리소스가 변경됨을, `delete`는 리소스가 삭제됨을 나타냅니다.create: 생성 / update: 업데이트 / delete: 삭제 / |
**관련 메서드:**
changeSet - 변경 세트 조회
---
## 메서드
### describeResources
리소스 목록 조회
지정된 스택에서 관리하는 리소스의 페이지네이션 목록을 조회합니다.
각 리소스는 스택의 템플릿에 의해 프로비저닝된 GS2 서비스 컴포넌트(네임스페이스, 모델, 구성 등)를 나타냅니다.
리소스 정보에는 유형, 이름, 현재 리퀘스트 바디, 관련 속성이 포함됩니다.
#### Request
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| stackName | string | | ✓| | ~ 128자 | 스택 이름
스택을 식별하는 고유한 이름입니다. 영숫자 및 -(하이픈), _(언더스코어), .(마침표)로 지정합니다. 생성·업데이트·삭제 조작 시 스택을 참조하기 위해 사용됩니다. |
| pageToken | string | | | | ~ 1024자 | 데이터 취득을 시작할 위치를 지정하는 토큰 |
| limit | int | | | 30 | 1 ~ 1000 | 취득할 데이터 건수 |
#### Result
| | 타입 | 설명 |
| --- | --- | --- |
| items | [List<Resource>](#resource) | 리소스 목록 |
| nextPageToken | string | 목록의 나머지를 취득하기 위한 페이지 토큰 |
#### 구현 예제
**Go**
```go
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/deploy"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := deploy.Gs2DeployRestClient{
Session: &session,
}
result, err := client.DescribeResources(
&deploy.DescribeResourcesRequest {
StackName: pointy.String("stack-0001"),
PageToken: nil,
Limit: nil,
}
)
if err != nil {
panic("error occurred")
}
items := result.Items
nextPageToken := result.NextPageToken
```
**PHP**
```php
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Deploy\Gs2DeployRestClient;
use Gs2\Deploy\Request\DescribeResourcesRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2DeployRestClient(
$session
);
try {
$result = $client->describeResources(
(new DescribeResourcesRequest())
->withStackName("stack-0001")
->withPageToken(null)
->withLimit(null)
);
$items = $result->getItems();
$nextPageToken = $result->getNextPageToken();
} catch (Gs2Exception $e) {
exit("error occurred")
}
```
**Java**
```java
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.deploy.rest.Gs2DeployRestClient;
import io.gs2.deploy.request.DescribeResourcesRequest;
import io.gs2.deploy.result.DescribeResourcesResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
"your client id",
"your client secret"
)
);
session.connect();
Gs2DeployRestClient client = new Gs2DeployRestClient(session);
try {
DescribeResourcesResult result = client.describeResources(
new DescribeResourcesRequest()
.withStackName("stack-0001")
.withPageToken(null)
.withLimit(null)
);
List items = result.getItems();
String nextPageToken = result.getNextPageToken();
} catch (Gs2Exception e) {
System.exit(1);
}
```
**C#**
```csharp
using Gs2.Core;
using Gs2.Core.Model;
using Gs2.Core.Net;
using Gs2.Core.Exception;
var session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region.ApNortheast1
);
yield return session.OpenAsync(r => { });
var client = new Gs2DeployRestClient(session);
AsyncResult asyncResult = null;
yield return client.DescribeResources(
new Gs2.Gs2Deploy.Request.DescribeResourcesRequest()
.WithStackName("stack-0001")
.WithPageToken(null)
.WithLimit(null),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var items = result.Items;
var nextPageToken = result.NextPageToken;
```
**TypeScript**
```typescript
import Gs2Core from '@/gs2/core';
import * as Gs2Deploy from '@/gs2/deploy';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Deploy.Gs2DeployRestClient(session);
try {
const result = await client.describeResources(
new Gs2Deploy.DescribeResourcesRequest()
.withStackName("stack-0001")
.withPageToken(null)
.withLimit(null)
);
const items = result.getItems();
const nextPageToken = result.getNextPageToken();
} catch (e) {
process.exit(1);
}
```
**Python**
```python
from gs2 import core
from gs2 import deploy
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = deploy.Gs2DeployRestClient(session)
try:
result = client.describe_resources(
deploy.DescribeResourcesRequest()
.with_stack_name('stack-0001')
.with_page_token(None)
.with_limit(None)
)
items = result.items
next_page_token = result.next_page_token
except core.Gs2Exception as e:
exit(1)
```
**GS2-Script**
```lua
client = gs2('deploy')
api_result = client.describe_resources({
stackName="stack-0001",
pageToken=nil,
limit=nil,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['errorMessage'])
end
result = api_result.result
items = result.items;
nextPageToken = result.nextPageToken;
```
**GS2-Script(Async)**
```lua
client = gs2('deploy')
api_result_handler = client.describe_resources_async({
stackName="stack-0001",
pageToken=nil,
limit=nil,
})
api_result = api_result_handler() -- Call the handler to get the result
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['errorMessage'])
end
result = api_result.result
items = result.items;
nextPageToken = result.nextPageToken;
```
---
### getResource
리소스 조회
스택에서 관리하는 특정 리소스의 상세 정보를 조회합니다.
리소스 상세 정보에는 유형, 이름, 프로비저닝에 사용된 리퀘스트 바디, 생성 후 반환된 레스폰스 속성이 포함됩니다.
#### Request
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| stackName | string | | ✓| | ~ 128자 | 스택 이름
스택을 식별하는 고유한 이름입니다. 영숫자 및 -(하이픈), _(언더스코어), .(마침표)로 지정합니다. 생성·업데이트·삭제 조작 시 스택을 참조하기 위해 사용됩니다. |
| resourceName | string | | ✓| | ~ 128자 | 리소스 이름
스택 템플릿에서 이 리소스에 할당된 논리적 이름입니다. 템플릿 내에서 종속성 해결과 아웃풋 필드 매핑을 위해 리소스를 참조하는 데 사용됩니다. |
#### Result
| | 타입 | 설명 |
| --- | --- | --- |
| item | [Resource](#resource) | 리소스 |
#### 구현 예제
**Go**
```go
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/deploy"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := deploy.Gs2DeployRestClient{
Session: &session,
}
result, err := client.GetResource(
&deploy.GetResourceRequest {
StackName: pointy.String("stack-0001"),
ResourceName: pointy.String("resource-0001"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
```
**PHP**
```php
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Deploy\Gs2DeployRestClient;
use Gs2\Deploy\Request\GetResourceRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2DeployRestClient(
$session
);
try {
$result = $client->getResource(
(new GetResourceRequest())
->withStackName("stack-0001")
->withResourceName("resource-0001")
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
```
**Java**
```java
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.deploy.rest.Gs2DeployRestClient;
import io.gs2.deploy.request.GetResourceRequest;
import io.gs2.deploy.result.GetResourceResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
"your client id",
"your client secret"
)
);
session.connect();
Gs2DeployRestClient client = new Gs2DeployRestClient(session);
try {
GetResourceResult result = client.getResource(
new GetResourceRequest()
.withStackName("stack-0001")
.withResourceName("resource-0001")
);
Resource item = result.getItem();
} catch (Gs2Exception e) {
System.exit(1);
}
```
**C#**
```csharp
using Gs2.Core;
using Gs2.Core.Model;
using Gs2.Core.Net;
using Gs2.Core.Exception;
var session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region.ApNortheast1
);
yield return session.OpenAsync(r => { });
var client = new Gs2DeployRestClient(session);
AsyncResult asyncResult = null;
yield return client.GetResource(
new Gs2.Gs2Deploy.Request.GetResourceRequest()
.WithStackName("stack-0001")
.WithResourceName("resource-0001"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
```
**TypeScript**
```typescript
import Gs2Core from '@/gs2/core';
import * as Gs2Deploy from '@/gs2/deploy';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Deploy.Gs2DeployRestClient(session);
try {
const result = await client.getResource(
new Gs2Deploy.GetResourceRequest()
.withStackName("stack-0001")
.withResourceName("resource-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
```
**Python**
```python
from gs2 import core
from gs2 import deploy
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = deploy.Gs2DeployRestClient(session)
try:
result = client.get_resource(
deploy.GetResourceRequest()
.with_stack_name('stack-0001')
.with_resource_name('resource-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
```
**GS2-Script**
```lua
client = gs2('deploy')
api_result = client.get_resource({
stackName="stack-0001",
resourceName="resource-0001",
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['errorMessage'])
end
result = api_result.result
item = result.item;
```
**GS2-Script(Async)**
```lua
client = gs2('deploy')
api_result_handler = client.get_resource_async({
stackName="stack-0001",
resourceName="resource-0001",
})
api_result = api_result_handler() -- Call the handler to get the result
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['errorMessage'])
end
result = api_result.result
item = result.item;
```
---
### describeEvents
이벤트 목록 조회
스택 작업(생성, 업데이트, 삭제) 중에 발생한 이벤트의 페이지네이션 목록을 조회합니다.
이벤트에는 각 리소스 작업의 진행 상황과 결과(리소스 유형, 수행된 작업, 오류 메시지 등)가 기록됩니다.
진행 중인 작업 상태를 모니터링하거나 완료된 작업의 이력을 확인하는 데 유용합니다.
#### Request
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| stackName | string | | ✓| | ~ 128자 | 스택 이름
스택을 식별하는 고유한 이름입니다. 영숫자 및 -(하이픈), _(언더스코어), .(마침표)로 지정합니다. 생성·업데이트·삭제 조작 시 스택을 참조하기 위해 사용됩니다. |
| pageToken | string | | | | ~ 1024자 | 데이터 취득을 시작할 위치를 지정하는 토큰 |
| limit | int | | | 30 | 1 ~ 1000 | 취득할 데이터 건수 |
#### Result
| | 타입 | 설명 |
| --- | --- | --- |
| items | [List<Event>](#event) | 이벤트 목록 |
| nextPageToken | string | 목록의 나머지를 취득하기 위한 페이지 토큰 |
#### 구현 예제
**Go**
```go
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/deploy"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := deploy.Gs2DeployRestClient{
Session: &session,
}
result, err := client.DescribeEvents(
&deploy.DescribeEventsRequest {
StackName: pointy.String("stack-0001"),
PageToken: nil,
Limit: nil,
}
)
if err != nil {
panic("error occurred")
}
items := result.Items
nextPageToken := result.NextPageToken
```
**PHP**
```php
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Deploy\Gs2DeployRestClient;
use Gs2\Deploy\Request\DescribeEventsRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2DeployRestClient(
$session
);
try {
$result = $client->describeEvents(
(new DescribeEventsRequest())
->withStackName("stack-0001")
->withPageToken(null)
->withLimit(null)
);
$items = $result->getItems();
$nextPageToken = $result->getNextPageToken();
} catch (Gs2Exception $e) {
exit("error occurred")
}
```
**Java**
```java
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.deploy.rest.Gs2DeployRestClient;
import io.gs2.deploy.request.DescribeEventsRequest;
import io.gs2.deploy.result.DescribeEventsResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
"your client id",
"your client secret"
)
);
session.connect();
Gs2DeployRestClient client = new Gs2DeployRestClient(session);
try {
DescribeEventsResult result = client.describeEvents(
new DescribeEventsRequest()
.withStackName("stack-0001")
.withPageToken(null)
.withLimit(null)
);
List items = result.getItems();
String nextPageToken = result.getNextPageToken();
} catch (Gs2Exception e) {
System.exit(1);
}
```
**C#**
```csharp
using Gs2.Core;
using Gs2.Core.Model;
using Gs2.Core.Net;
using Gs2.Core.Exception;
var session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region.ApNortheast1
);
yield return session.OpenAsync(r => { });
var client = new Gs2DeployRestClient(session);
AsyncResult asyncResult = null;
yield return client.DescribeEvents(
new Gs2.Gs2Deploy.Request.DescribeEventsRequest()
.WithStackName("stack-0001")
.WithPageToken(null)
.WithLimit(null),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var items = result.Items;
var nextPageToken = result.NextPageToken;
```
**TypeScript**
```typescript
import Gs2Core from '@/gs2/core';
import * as Gs2Deploy from '@/gs2/deploy';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Deploy.Gs2DeployRestClient(session);
try {
const result = await client.describeEvents(
new Gs2Deploy.DescribeEventsRequest()
.withStackName("stack-0001")
.withPageToken(null)
.withLimit(null)
);
const items = result.getItems();
const nextPageToken = result.getNextPageToken();
} catch (e) {
process.exit(1);
}
```
**Python**
```python
from gs2 import core
from gs2 import deploy
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = deploy.Gs2DeployRestClient(session)
try:
result = client.describe_events(
deploy.DescribeEventsRequest()
.with_stack_name('stack-0001')
.with_page_token(None)
.with_limit(None)
)
items = result.items
next_page_token = result.next_page_token
except core.Gs2Exception as e:
exit(1)
```
**GS2-Script**
```lua
client = gs2('deploy')
api_result = client.describe_events({
stackName="stack-0001",
pageToken=nil,
limit=nil,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['errorMessage'])
end
result = api_result.result
items = result.items;
nextPageToken = result.nextPageToken;
```
**GS2-Script(Async)**
```lua
client = gs2('deploy')
api_result_handler = client.describe_events_async({
stackName="stack-0001",
pageToken=nil,
limit=nil,
})
api_result = api_result_handler() -- Call the handler to get the result
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['errorMessage'])
end
result = api_result.result
items = result.items;
nextPageToken = result.nextPageToken;
```
---
### getEvent
이벤트 조회
스택 내 특정 이벤트의 상세 정보를 조회합니다.
이벤트에는 리소스 유형, 작업(생성/업데이트/삭제), 상태, 작업 중에 발생한 오류 메시지가 포함됩니다.
#### Request
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| stackName | string | | ✓| | ~ 128자 | 스택 이름
스택을 식별하는 고유한 이름입니다. 영숫자 및 -(하이픈), _(언더스코어), .(마침표)로 지정합니다. 생성·업데이트·삭제 조작 시 스택을 참조하기 위해 사용됩니다. |
| eventName | string | | ✓| UUID | ~ 36자 | 이벤트 이름
각 이벤트의 고유한 이름을 유지합니다.
이름은 UUID(Universally Unique Identifier) 형식으로 자동 생성되며, 각 이벤트를 식별하는 데 사용됩니다. |
#### Result
| | 타입 | 설명 |
| --- | --- | --- |
| item | [Event](#event) | 이벤트 |
#### 구현 예제
**Go**
```go
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/deploy"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := deploy.Gs2DeployRestClient{
Session: &session,
}
result, err := client.GetEvent(
&deploy.GetEventRequest {
StackName: pointy.String("stack-0001"),
EventName: pointy.String("event-0001"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
```
**PHP**
```php
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Deploy\Gs2DeployRestClient;
use Gs2\Deploy\Request\GetEventRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2DeployRestClient(
$session
);
try {
$result = $client->getEvent(
(new GetEventRequest())
->withStackName("stack-0001")
->withEventName("event-0001")
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
```
**Java**
```java
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.deploy.rest.Gs2DeployRestClient;
import io.gs2.deploy.request.GetEventRequest;
import io.gs2.deploy.result.GetEventResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
"your client id",
"your client secret"
)
);
session.connect();
Gs2DeployRestClient client = new Gs2DeployRestClient(session);
try {
GetEventResult result = client.getEvent(
new GetEventRequest()
.withStackName("stack-0001")
.withEventName("event-0001")
);
Event item = result.getItem();
} catch (Gs2Exception e) {
System.exit(1);
}
```
**C#**
```csharp
using Gs2.Core;
using Gs2.Core.Model;
using Gs2.Core.Net;
using Gs2.Core.Exception;
var session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region.ApNortheast1
);
yield return session.OpenAsync(r => { });
var client = new Gs2DeployRestClient(session);
AsyncResult asyncResult = null;
yield return client.GetEvent(
new Gs2.Gs2Deploy.Request.GetEventRequest()
.WithStackName("stack-0001")
.WithEventName("event-0001"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
```
**TypeScript**
```typescript
import Gs2Core from '@/gs2/core';
import * as Gs2Deploy from '@/gs2/deploy';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Deploy.Gs2DeployRestClient(session);
try {
const result = await client.getEvent(
new Gs2Deploy.GetEventRequest()
.withStackName("stack-0001")
.withEventName("event-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
```
**Python**
```python
from gs2 import core
from gs2 import deploy
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = deploy.Gs2DeployRestClient(session)
try:
result = client.get_event(
deploy.GetEventRequest()
.with_stack_name('stack-0001')
.with_event_name('event-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
```
**GS2-Script**
```lua
client = gs2('deploy')
api_result = client.get_event({
stackName="stack-0001",
eventName="event-0001",
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['errorMessage'])
end
result = api_result.result
item = result.item;
```
**GS2-Script(Async)**
```lua
client = gs2('deploy')
api_result_handler = client.get_event_async({
stackName="stack-0001",
eventName="event-0001",
})
api_result = api_result_handler() -- Call the handler to get the result
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['errorMessage'])
end
result = api_result.result
item = result.item;
```
---
### describeOutputs
아웃풋 목록 조회
스택의 생성 또는 업데이트가 성공한 후 생성된 아웃풋 값의 페이지네이션 목록을 조회합니다.
아웃풋은 템플릿에서 정의된 키-값 쌍으로, 스택 프로비저닝 중에 생성된 리소스 식별자, 엔드포인트, 구성 값 등의 중요한 정보를 공개합니다.
아웃풋은 스택이 _COMPLETE 상태인 경우에만 사용할 수 있습니다.
#### Request
| | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| stackName | string | | ✓| | ~ 128자 | 스택 이름
스택을 식별하는 고유한 이름입니다. 영숫자 및 -(하이픈), _(언더스코어), .(마침표)로 지정합니다. 생성·업데이트·삭제 조작 시 스택을 참조하기 위해 사용됩니다. |
| pageToken | string | | | | ~ 1024자 | 데이터 취득을 시작할 위치를 지정하는 토큰 |
| limit | int | | | 30 | 1 ~ 1000 | 취득할 데이터 건수 |
#### Result
| | 타입 | 설명 |
| --- | --- | --- |
| items | [List<Output>](#output) | 아웃풋 목록 |
| nextPageToken | string | 목록의 나머지를 취득하기 위한 페이지 토큰 |
#### 구현 예제
**Go**
```go
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/deploy"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := deploy.Gs2DeployRestClient{
Session: &session,
}
result, err := client.DescribeOutputs(
&deploy.DescribeOutputsRequest {
StackName: pointy.String("stack-0001"),
PageToken: nil,
Limit: nil,
}
)
if err != nil {
panic("error occurred")
}
items := result.Items
nextPageToken := result.NextPageToken
```
**PHP**
```php
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Deploy\Gs2DeployRestClient;
use Gs2\Deploy\Request\DescribeOutputsRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2DeployRestClient(
$session
);
try {
$result = $client->describeOutputs(
(new DescribeOutputsRequest())
->withStackName("stack-0001")
->withPageToken(null)
->withLimit(null)
);
$items = $result->getItems();
$nextPageToken = $result->getNextPageToken();
} catch (Gs2Exception $e) {
exit("error occurred")
}
```
**Java**
```java
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.deploy.rest.Gs2DeployRestClient;
import io.gs2.deploy.request.DescribeOutputsRequest;
import io.gs2.deploy.result.DescribeOutputsResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
"your client id",
"your client secret"
)
);
session.connect();
Gs2DeployRestClient client = new Gs2DeployRestClient(session);
try {
DescribeOutputsResult result = client.describeOutputs(
new DescribeOutputsRequest()
.withStackName("stack-0001")
.withPageToken(null)
.withLimit(null)
);
List