listConfigParameters

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

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

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

변경 가능한 파라미터의 타입/기본값/허용 범위/현재값을 조회합니다. 정렬 가능 키는 name이며 기본 정렬은 name,asc입니다. 정렬 키가 고유하지 않은 경우 name 기준으로 안정 정렬합니다.

요청

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

메서드	URI
GET	/clusters/{clusterName}/config/parameters

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`clusterName`	String	Required	클러스터 이름 (cluster의 name) 패턴: `^[a-z0-9-]+$` 길이: 3 ~ 30 <예시> new-cluster

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`name`	String	Optional	특정 파라미터만 조회 (생략 시 전체) <예시> max_connections
`pageNo`	Integer (int32)	Optional	페이지 번호 (0부터 시작) 범위: 0 ~ 기본값: 0 <예시> 0
`pageSize`	Integer (int32)	Optional	페이지 크기 범위: 1 ~ 100 기본값: 20 <예시> 20
`sort`	List<String>	Optional	정렬 기준 — `<field>,<asc\|desc>` 형식. 반복 지정으로 다중 정렬. 허용 정렬 키와 기본 정렬 순서는 각 operation 설명 참고. <예시> `["name,asc"]`

요청 예시

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

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

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`parameters`	List<ConfigParameter>	-	파라미터 목록
`pageNo`	Integer (int32)	-	페이지 번호 (0부터 시작) <예시> 0
`pageSize`	Integer (int32)	-	페이지 크기 <예시> 20
`totalElements`	Integer (int32)	-	전체 항목 수 <예시> 3
`totalPages`	Integer (int32)	-	전체 페이지 수 <예시> 1

ConfigParameter

변경 가능 파라미터 카탈로그 항목

필드	타입	필수 여부	설명
`name`	String	-	이름 <예시> max_connections
`valueType`	String	-	값 타입 `RANGE` \| `FLOAT_RANGE` \| `LIST` `RANGE`: 정수 범위. minValue~maxValue 사이의 정수를 문자열로 지정 `FLOAT_RANGE`: 실수 범위. minValue~maxValue 사이의 실수를 문자열로 지정 `LIST`: 허용 값 목록. valueList 중 하나를 지정하며, 여러 값을 허용하는 파라미터(예: sql-mode)는 쉼표로 구분해 지정 <예시> RANGE
`defaultValue`	String	-	파라미터 기본값 (문자열 표현. 예: max_connections는 "3000") <예시> 3000
`currentValue`	String \| null	-	현재 커스텀 값 (문자열 표현, 미변경 시 null) <예시> 5000
`minValue`	String \| null	-	허용 최솟값 (RANGE·FLOAT_RANGE의 문자열 표현. 예: "50", "0.0". 범위 제약이 없으면 null) <예시> 50
`maxValue`	String \| null	-	허용 최댓값 (RANGE·FLOAT_RANGE의 문자열 표현. 예: "100000", "100.0". 범위 제약이 없으면 null) <예시> 100000
`valueList`	List<String> \| null	-	LIST 타입의 허용 값 목록 (예: event_scheduler는 ["ON", "OFF"]). LIST가 아니면 null <예시> `["ON", "OFF"]`
`dynamic`	Boolean	-	재시작 없이 적용 가능한지 여부 `true` \| `false` `true`: DB 재시작 없이 동적 적용 가능 `false`: 적용 시 DB 재시작 필요 <예시> true

응답 상태 코드

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

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

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

응답 예시

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

{
  "parameters": [
    {
      "name": "max_connections",
      "valueType": "RANGE",
      "defaultValue": "3000",
      "currentValue": "5000",
      "minValue": "50",
      "maxValue": "100000",
      "valueList": [
        "ON",
        "OFF"
      ],
      "dynamic": true
    }
  ],
  "pageNo": 0,
  "pageSize": 20,
  "totalElements": 3,
  "totalPages": 1
}