getCluster

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

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

클러스터의 상세 정보를 조회합니다.

요청

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

요청 헤더

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

요청 경로 파라미터

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

요청 예시

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

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

응답

응답 형식을 설명합니다.

응답 바디

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

endpoints

endpoints에 대한 설명은 다음과 같습니다.

응답 상태 코드

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

응답 예시

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

{
  "cluster": {
    "name": "test-cluster-01",
    "storageType": "CB2",
    "port": 3306,
    "vpcNo": 12345,
    "vpcName": "test-vpc",
    "writeEndpoint": "10.1.2.6",
    "readEndpoint": "10.1.2.7",
    "endpoints": [
      {
        "interfaceName": "cdbserverless-a1b2c3d4",
        "interfaceType": "READ_WRITE",
        "subnetNo": 67890,
        "subnetName": "test-subnet",
        "zoneCode": "KR-1",
        "accessControlGroupNo": 11111,
        "accessControlGroupName": "cdbserverless-c9d0e1f2"
      },
      {
        "interfaceName": "cdbserverless-e5f6a7b8",
        "interfaceType": "READ_ONLY",
        "subnetNo": 67890,
        "subnetName": "test-subnet",
        "zoneCode": "KR-1",
        "accessControlGroupNo": 11111,
        "accessControlGroupName": "cdbserverless-c9d0e1f2"
      }
    ],
    "multiZone": false,
    "primaryZoneCode": "KR-1",
    "backupZoneCode": null,
    "unit": {
      "min": 1,
      "max": 1
    },
    "replica": {
      "target": 0,
      "current": 0,
      "ready": 0,
      "min": 1,
      "max": 2
    },
    "autoScale": {
      "scaleOut": {
        "enabled": true,
        "thresholdConnection": null,
        "thresholdCpu": 30,
        "replica": {
          "min": 1,
          "max": 2
        }
      },
      "scaleUp": {
        "enabled": true,
        "unit": {
          "min": 1,
          "max": 1
        }
      }
    },
    "backupConfig": {
      "backupAuto": false,
      "backupTime": "02:00",
      "retentionDays": 1
    },
    "status": "RUNNING",
    "ready": true,
    "createdDateTime": "2026-10-13T09:15:00Z",
    "startDateTime": "2026-10-13T09:20:00Z",
    "highAvailability": true,
    "engineVersion": "8.4.5",
    "clusterNo": 1000001
  }
}