Search Engine Service
    • PDF

    Search Engine Service

    • PDF

    기사 요약

    Search Engine Service 서버 인스턴스(VM) 목록을 조회합니다.

    요청

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

    메서드URI
    GET/api/{regionCode}-v1/vpc/servers/ses

    요청 헤더

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

    요청 경로 파라미터

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

    필드타입필수 여부설명
    regionCodeStringRequired리전 코드
    • fkr
      • fkr: 금융 리전

    요청 쿼리 파라미터

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

    필드타입필수 여부설명
    pageNoIntegerOptional페이지 번호
    • 1~100 (기본값: 1)
    pageSizeIntegerOptional페이지당 항목 수
    • 20~100 (기본값: 20)

    요청 예시

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

    curl --location --request GET 'https://cloudloganalytics.apigw.fin-ntruss.com/api/{regionCode}-v1/vpc/servers/ses' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
    --header 'Content-Type: application/json' \
    

    응답

    응답 형식을 설명합니다.

    응답 바디

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

    필드타입필수 여부설명
    codeInteger-응답 상태 코드
    messageString-응답 상태 메시지
    resultObject-응답 결과
    result.pageSizeInteger-페이지당 항목 수
    result.currentPageInteger-현재 페이지 번호
    result.totalPageInteger-전체 페이지 수
    result.totalCountInteger-전체 항목 수
    result.isPagedBoolean-페이징 여부
    • true | false
      • true: 페이징
      • false: 페이징 안 함
    result.clusterInfoListArray-서버 목록
    • 서버 정보
    참고

    Server 정보 관련 필드(clusterInfoList)에 대한 설명은 Search Engine Service API 가이드Search Engine Service 사용 가이드를 참조해 주십시오.

    응답 상태 코드

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

    응답 예시

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

    {
        "code": 0,
        "message": "요청이 정상적으로 처리되었습니다",
        "result": {
            "pageSize": 10,
            "currentPage": 1,
            "totalPage": 1,
            "totalCount": 1,
            "isPaged": true,
            "clusterInfoList": [
                {
                    "clusterName": "ses-test",
                    "serverStatus": "운영중",
                    "serverStatusColor": "green",
                    "elasticSearchVersion": "OpenSearch 2.14.0",
                    "vpcName": "test"
                }
            ]
        }
    }
    

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.