getConfig

Prev Next

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

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

클러스터의 DB 파라미터 설정을 조회합니다. 기본값에서 변경된 파라미터만 반환합니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
clusterName String Required 클러스터 이름

요청 예시

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

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

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
config Object - DB 파라미터 설정
config.parameters Object - 커스텀 파라미터 설정

응답 상태 코드

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

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

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

응답 예시

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

{
  "config": {
    "parameters": {
      "autocommit": "OFF",
      "binlog_expire_logs_seconds": "43200"
    }
  }
}