getInstance

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

Ncloud 표준 표현을 적용한 API입니다.

인스턴스의 상세 정보를 조회합니다.

요청

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

메서드	URI
GET	/mysql/v1/clusters/{clusterName}/instances/{instanceName}

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`clusterName`	String	Required	클러스터 이름 listClusters 참조
`instanceName`	String	Required	인스턴스 이름 listInstances 참조

요청 예시

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

curl --location --request GET 'https://clouddb-serverless.apigw.ntruss.com/mysql/v1/clusters/test-cluster-01/instances/test-cluster-01-a1b2c3d4' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`instance`	Object	-	인스턴스 상세 정보
`instance.name`	String	-	인스턴스 이름 `{clusterName}-{xxxxxxxx}` 형식
`instance.role`	String	-	인스턴스 역할 `PRIMARY` \| `REPLICA` `PRIMARY`: 읽기 및 쓰기 `REPLICA`: 읽기 전용
`instance.unit`	Number	-	컴퓨팅 Unit
`instance.memoryGb`	Integer	-	할당 메모리 (GiB)
`instance.storageType`	String	-	데이터 스토리지 타입 `CB2` 현재 `CB2`만 제공
`instance.storageUsage`	Integer	-	스토리지 사용량 (Byte)
`instance.zoneCode`	String	-	인스턴스가 배치된 존 코드
`instance.status`	String	-	인스턴스 상태 `CREATING` \| `RUNNING` \| `MODIFYING` \| `PAUSED` \| `DELETING` \| `FAILED` `CREATING`: 생성 중인 상태 `RUNNING`: 정상 기동되어 접속 가능한 상태 `MODIFYING`: 설정 변경을 적용 중인 상태 `PAUSED`: 일시 정지된 상태 `DELETING`: 삭제 중인 상태 `FAILED`: 오류로 중단된 상태
`instance.createdDateTime`	String	-	인스턴스 생성 일시 ISO 8601 형식 (UTC)
`instance.startDateTime`	String	-	인스턴스 기동 일시 ISO 8601 형식 (UTC)

응답 상태 코드

응답 상태 코드에 대한 설명은 다음과 같습니다.

HTTP 상태 코드	코드	메시지	설명
200	-	-	인스턴스 상세 정보
400	`InvalidParameter`	`The specified parameter is invalid.`	파라미터 값이 허용 범위나 형식을 벗어난 경우

참고

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

응답 예시

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

{
  "instance": {
    "name": "test-cluster-01-a1b2c3d4",
    "role": "PRIMARY",
    "unit": 1,
    "memoryGb": 2,
    "storageType": "CB2",
    "storageUsage": 2779262976,
    "zoneCode": "KR-1",
    "status": "RUNNING",
    "createdDateTime": "2026-10-13T09:45:00Z",
    "startDateTime": "2026-10-13T09:50:00Z"
  }
}