getDatabase

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

이 가이드는 API 명세를 기반으로 AI가 자동 생성했습니다.

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

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

지정한 Database의 존재를 확인하고 이름을 반환합니다.

요청

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

메서드	URI
GET	/clusters/{clusterName}/databases/{databaseName}

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`clusterName`	String	Required	클러스터 이름 (cluster의 name — 3~30자, 소문자/숫자/하이픈) 패턴: `^[a-z0-9-]+$` 길이: 3 ~ 30 <예시> new-cluster
`databaseName`	String	Required	Database 이름 (1~64자, 영문/숫자/underscore. 예약 스키마명 mysql·information_schema·performance_schema·sys 사용 불가) 패턴: `^[A-Za-z0-9_]+$` 길이: 1 ~ 64 <예시> db

요청 예시

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

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

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`database`	Database	-	Database 정보

Database

필드	타입	필수 여부	설명
`name`	String	-	Database 이름 (예약 스키마명 mysql·information_schema·performance_schema·sys 사용 불가) 패턴: `^[A-Za-z0-9_]+$` 길이: 1 ~ 64 <예시> db (읽기 전용)

응답 상태 코드

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

이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.

HTTP 상태 코드	코드	메시지	설명
200	-	-	Database 단건 조회
400	InvalidParameter	The specified parameter is invalid.	파라미터 값이 허용 범위나 형식을 벗어난 경우

응답 예시

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

{
  "database": {
    "name": "db"
  }
}