ngx_http_api_module

ngx_http_api_module 모듈(1.13.3)은 다양한 상태 정보에 액세스하고 업스트림 서버 그룹을 즉시 구성하고 nginx를 다시 구성할 필요 없이 키-값 쌍을 관리하기 위해 REST API를 제공합니다.

모듈은 ngx_http_status_module 및 ngx_http_upstream_conf_module 모듈을 대체합니다.

PATCH 또는 POST 메서드를 사용하는 경우 페이로드가 클라이언트 요청 본문을 읽기 위한 버퍼 크기를 초과하지 않는지 확인하고 초과하는 경우 413(요청 엔티티가 너무 큼) 오류가 반환될 수 있습니다.

이 모듈은 상업용 구독의 일부로 사용 가능합니다.

예제 구성

http {
    upstream backend {
        zone http_backend 64k;

        server backend1.example.com weight=5;
        server backend2.example.com;
    }

    proxy_cache_path /data/nginx/cache_backend keys_zone=cache_backend:10m;

    server {
        server_name backend.example.com;

        location / {
            proxy_pass  http://backend;
            proxy_cache cache_backend;

            health_check;
        }

        status_zone server_backend;
    }

    keyval_zone zone=one:32k state=one.keyval;
    keyval $arg_text $text zone=one;

    server {
        listen 127.0.0.1;

        location /api {
            api write=on;
            allow 127.0.0.1;
            deny all;
        }
    }
}

stream {
    upstream backend {
        zone stream_backend 64k;

        server backend1.example.com:12345 weight=5;
        server backend2.example.com:12345;
    }

    server {
        listen      127.0.0.1:12345;
        proxy_pass  backend;
        status_zone server_backend;
        health_check;
    }
}

모든 API 요청은 URI에서 지원되는 API 버전을 포함합니다. 이 구성을 가진 API 요청의 예:

http://127.0.0.1/api/7/
http://127.0.0.1/api/7/nginx
http://127.0.0.1/api/7/connections
http://127.0.0.1/api/7/http/requests
http://127.0.0.1/api/7/http/server_zones/server_backend
http://127.0.0.1/api/7/http/caches/cache_backend
http://127.0.0.1/api/7/http/upstreams/backend
http://127.0.0.1/api/7/http/upstreams/backend/servers/
http://127.0.0.1/api/7/http/upstreams/backend/servers/1
http://127.0.0.1/api/7/http/keyvals/one?key=arg1
http://127.0.0.1/api/7/stream/
http://127.0.0.1/api/7/stream/server_zones/server_backend
http://127.0.0.1/api/7/stream/upstreams/
http://127.0.0.1/api/7/stream/upstreams/backend
http://127.0.0.1/api/7/stream/upstreams/backend/servers/1

Directives

Syntax:  api [write=on|off];
Default: —
Context: location

주변 위치에서 REST API 인터페이스를 켭니다. 이 위치에 대한 액세스는 제한되어야 합니다.

write 매개변수는 API가 읽기 전용인지 읽기-쓰기인지 결정합니다. 기본적으로 API는 읽기 전용입니다.

모든 API 요청은 URI의 지원되는 API 버전을 포함해야 합니다. 요청 URI가 위치 접두사와 같으면 지원되는 API 버전의 목록이 반환됩니다. 현재 API 버전은 “7”입니다.

요청 행의 “fields” 인수 옵션은 요청된 개체의 어떤 필드가 출력될지 지정합니다.

http://127.0.0.1/api/7/nginx?fields=version,build

Syntax:  status_zone zone;
Default: —
Context: server, location, if in location
This directive appeared in version 1.13.12.

지정된 영역의 가상 http 또는 스트림 서버 상태 정보의 수집을 활성화합니다. 여러 서버가 동일한 영역을 공유할 수 있습니다.

1.17.0부터 위치별로 상태 정보를 수집할 수 있습니다. 특수 값 off는 중첩된 위치 블록의 통계 컬렉션을 비활성화합니다. 통계는 처리가 끝나는 위치의 컨텍스트에서 수집됩니다. 내부 리디렉션이 요청 처리 중에 발생하는 경우 원래 위치와 통계가 다를 수 있습니다.

호환성

• 각 HTTP 업스트림, 서버 영역 및 위치 영역에 대한 응답의 코드 데이터는 버전 7에서 추가되었습니다.
• /stream/limit_conns/ 데이터는 버전 6에서 추가되었습니다.
• /http/limit_conns/ 데이터는 버전 6에서 추가되었습니다.
• /http/limit_reqs/ 데이터는 버전 6에서 추가되었습니다.
• 키-값 쌍의 “expire” 매개변수는 버전 5 이후에 설정하거나 변경할 수 있습니다.
• /resolvers/ 데이터는 버전 5에서 추가되었습니다.
• /http/location_zones/ 데이터는 버전 5에서 추가되었습니다.
• nginx error object의 path 및 method 필드는 버전 4에서 제거되었습니다. 이러한 필드는 이전 api 버전에 계속 존재하지만 비어 있는 값을 표시합니다.
• /stream/zone_sync/ 데이터 버전 3에 추가되었습니다.
• drain 매개변수는 버전 2에서 추가되었습니다.
• /stream/keyvals/ 데이터는 버전 2에서 추가되었습니다.

엔드포인트

/

지원되는 메서드:

• GET – 루트 엔드포인트의 목록 반환

루트 엔드포인트의 목록을 반환합니다.

가능한 응답:

• 200 – 성공, 문자열의 어레이 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환

/nginx

지원되는 메서드:

• GET – 인스턴스를 실행하는 nginx의 상태 반환

nginx 버전, 빌드 이름, 주소, 구성 재로드 수, 마스터 및 작업자 프로세스의 ID를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 인스턴스 실행 nginx의 필드를 제한합니다.

가능한 응답:

• 200 – 성공, nginx 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환

/processes

지원되는 메서드:

• GET – nginx 프로세스 상태 반환

비정상적으로 종료되거나 재생성된 하위 프로세스의 수를 반환합니다.

가능한 응답:

• 200 – 성공, 프로세스 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환
• DELETE – nginx 프로세스 통계 재설정

비정상적으로 종료되거나 재생성된 하위 프로세스의 카운터를 반환합니다.

가능한 응답:

• 204 – 성공
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환

/connections

지원되는 메서드:

• GET – 클라이언트 연결 통계 반환

클라이언트 연결의 통계를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 연결 통계의 필드를 제한합니다.

가능한 응답:

• 200 – 성공, 연결 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환
• DELETE – 클라이언트 연결 통계 재설정

수락된 클라이언트 연결과 삭제된 클라이언트 연결의 통계를 재설정합니다.

가능한 응답:

• 204 – 성공
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환

/slabs/

지원되는 메서드:

• GET – 모든 슬래브의 상태 반환

슬래브 할당자를 포함하는 각 공유 메모리 영역에 대한 슬래브의 상태를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 슬래브 영역의 필드를 제한합니다. “fields” 값이 비어 있으면 영역 이름만 출력됩니다.

가능한 응답:

• 200 – 성공, 모든 슬래브에 대해 “슬래브 할당자를 포함하는 공유 메모리 영역” 개체의 컬렉션을 반환합니다.
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환

/slabs/{slabZoneName}

모든 메서드에 공통된 매개변수:

slabZoneName (string, required)

슬래브 할당자를 포함하는 공유 메모리 영역의 이름.

지원되는 메서드:

• GET – 슬래브의 상태 반환

슬래브 할당자를 포함하는 특정한 공유 메모리 영역에 대한 슬래브 상태를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 슬래브 영역의 필드를 제한합니다.

가능한 응답:

• 200 – 성공, 슬래브 할당자를 포함하는 공유 메모리 영역 반환
• 404 – 슬래브를 찾을 수 없음(SlabNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• DELETE – 슬래브 통계 재설정

각 메모리 슬롯에 대한 “reqs” 및 “fails” 메트릭을 반환합니다.

가능한 응답:

• 204 – 성공
• 404 – 슬래브를 찾을 수 없음(SlabNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환

/http/

지원되는 메서드:

• GET – HTTP 관련 엔드포인트 목록 반환

첫 번째 수준 HTTP 엔드포인트의 목록을 반환합니다.

가능한 응답:

• 200 – 성공, 문자열의 어레이 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환

/http/requests

지원되는 메서드:

• GET – HTTP 요청 통계 반환

클라이언트 HTTP 요청의 상태를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 클라이언트 HTTP 요청 통계의 필드를 제한합니다.

가능한 응답:

• 200 – 성공, HTTP 요청 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환
• DELETE – HTTP 요청 통계 재설정

총 클라이언트 HTTP 요청 수를 재설정합니다.

가능한 응답:

• 204 – 성공
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환

/http/server_zones/

지원되는 메서드:

• GET – 모든 HTTP 서버 영역의 상태 반환

각 HTTP 서버 영역에 대한 상태 정보를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 서버 영역의 필드를 제한합니다. “fields” 값이 비어 있으면 서버 영역 이름만 출력됩니다.

가능한 응답:

• 200 – 성공, 모든 HTTP 서버 영역에 대한 “HTTP 서버 영역” 개체의 컬렉션 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환

/http/server_zones/{httpServerZoneName}

모든 메서드에 공통된 매개변수:

httpServerZoneName (string, required)

HTTP 서버 영역의 이름.

지원되는 메서드:

• GET – HTTP 서버 영역의 상태 반환

특정한 HTTP 서버 영역의 상태를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 서버 영역의 필드를 제한합니다.

가능한 응답:

• 200 – 성공, HTTP 서버 영역 반환
• 404 – 서버 영역을 찾을 수 없음(ServerZoneNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• DELETE – HTTP 서버 영역의 통계 반환

특정 HTTP 서버 영역에서 수락한 요청 및 버린 요쳥, 응답, 수신한 바이트 및 전송한 바이트의 통계를 반환합니다.

가능한 응답:

• 204 – 성공
• 404 – 서버 영역을 찾을 수 없음(ServerZoneNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환

/http/location_zones/

지원되는 메서드:

• GET – 모든 HTTP 위치 영역의 통계 반환

각 HTTP 위치 영역에 대한 상태 정보를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 위치 영역의 필드를 제한합니다. “fields” 값이 비어 있으면 영역 이름만 출력됩니다.

가능한 응답:

• 200 – 성공, 모든 HTTP 위치 영역에 대한 “HTTP 위치 영역” 개체의 컬렉션 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환

/http/location_zones/{httpLocationZoneName}

모든 메서드에 공통된 매개변수:

httpLocationZoneName (string, required)

HTTP 위치 영역의 이름.

지원되는 메서드:

• GET – HTTP 위치 영역의 상태 반환

특정 HTTP 위치 영역의 상태를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 위치 영역의 필드를 제한합니다.

가능한 응답:

• 200 – 성공, HTTP 위치 영역 반환
• 404 – 위치 영역을 찾을 수 없음(LocationZoneNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• DELETE – 위치 영역에 대한 통계를 재설정합니다.

특정 위치 영역에서 수락한 요청 및 버린 요쳥, 응답, 수신한 바이트 및 전송한 바이트의 통계를 반환합니다.

가능한 응답:

• 204 – 성공
• 404 – 위치 영역을 찾을 수 없음(LocationZoneNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환

/http/caches/

지원되는 메서드:

• GET – 모든 캐시의 상태 반환

proxy_cache_path 및 기타 “*_cache_path” 명령으로 구성된 각 캐시의 상태를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 캐시 영역의 필드를 제한합니다. “fields” 값이 비어 있으면 캐시 영역의 이름만 출력됩니다.

가능한 응답:

• 200 – 성공, 모든 HTTP 캐시에 대한 “HTTP 캐시” 개체의 컬렉션 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환

/http/caches/{httpCacheZoneName}

모든 메서드에 공통된 매개변수:

httpCacheZoneName (string, required)

캐시 영역의 이름.

지원되는 메서드:

• GET – 캐시의 상태 반환

특정한 캐시의 상태를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 캐시 영역의 필드를 제한합니다.

가능한 응답:

• 200 – 성공, HTTP 캐시 반환
• 404 – 캐시를 찾을 수 없음(CacheNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• DELETE – 캐시 통계 재설정

특정 캐시 영역에서 캐시 적중/누락의 통계를 재설정합니다.

가능한 응답:

• 204 – 성공
• 404 – 캐시를 찾을 수 없음(CacheNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환

/http/limit_conns/

지원되는 메서드:

• GET – 모든 HTTP limit_conn 영역의 통계 반환

각 HTTP limit_conn zone에 대한 상태 정보를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 limit_conn 영역의 필드를 제한합니다. “fields” 값이 비어 있으면 영역 이름만 출력됩니다.

가능한 응답:

• 200 – 성공, 모든 HTTP limit conn에 대한 “HTTP 연결 제한” 개체의 컬렉션 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환

/http/limit_conns/{httpLimitConnZoneName}

모든 메서드에 공통된 매개변수:

httpLimitConnZoneName (string, required)

limit_conn zone의 이름.

지원되는 메서드:

• GET – HTTP limit_conn 영역의 상태 반환

특정 HTTP limit_conn zone의 상태를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 limit_conn zone의 필드를 제한합니다.

가능한 응답:

• 200 – 성공, HTTP 연결 제한 반환
• 404 – limit_conn을 찾을 수 없음(LimitConnNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• DELETE – HTTP limit_conn 영역의 통계 반환

연결 제한 통계를 반환합니다.

가능한 응답:

• 204 – 성공
• 404 – limit_conn을 찾을 수 없음(LimitConnNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환

/http/limit_reqs/

지원되는 메서드:

• GET – 모든 HTTP limit_req 영역의 통계 반환

각 HTTP limit_req zone에 대한 상태 정보를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 limit_req 영역의 필드를 제한합니다. “fields” 값이 비어 있으면 영역 이름만 출력됩니다.

가능한 응답:

• 200 – 성공, 모든 HTTP limit reqs에 대한 “HTTP 요청 속도 제한” 개체의 컬렉션 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환

/http/limit_reqs/{httpLimitReqZoneName}

모든 메서드에 공통된 매개변수:

httpLimitReqZoneName (string, required)

limit_req zone의 이름.

지원되는 메서드:

• GET – HTTP limit_req 영역의 상태 반환

특정 HTTP limit_req zone의 상태를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 limit_req zone의 필드를 제한합니다.

가능한 응답:

• 200 – 성공, HTTP 요청 속도 제한 반환
• 404 – limit_req를 찾을 수 없음(LimitReqNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• DELETE – HTTP limit_req 영역의 통계 재설정

요청 제한 통계를 재설정합니다.

가능한 응답:

• 204 – 성공
• 404 – limit_req를 찾을 수 없음(LimitReqNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환

/http/upstreams/

지원되는 메서드:

• GET – 모든 HTTP 업스트림 서버 그룹의 상태 반환

각 HTTP 업스트림 서버 그룹 및 해당 서버의 상태를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 업스트림 서버 그룹의 필드를 제한합니다. “fields” 값이 비어 있으면 업스트림 이름만 출력됩니다.

가능한 응답:

• 200 – 성공, 모든 HTTP 업스트림에 대한 “HTTP 업스트림” 개체의 컬렉션 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환

/http/upstreams/{httpUpstreamName}/

모든 메서드에 공통된 매개변수:

httpUpstreamName (string, required)

HTTP 업스트림 서버 그룹의 이름.

지원되는 메서드:

• GET – HTTP 업스트림 서버 그룹의 상태 반환

특정 HTTP 업스트림 서버 그룹 및 해당 서버의 상태를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 업스트림 서버 그룹의 필드를 제한합니다.

가능한 응답:

• 200 – 성공, HTTP 업스트림 반환
• 400 – 업스트림이 정적임(UpstreamStatic), 오류 반환
• 404 – 알 수 없는 버전(UnknownVersion), 업스트림을 찾을 수 없음(UpstreamNotFound), Error 반환
• DELETE – HTTP 업스트림 서버 그룹의 상태 재설정

업스트림 서버 그룹 및 대기열 통계에서 각 업스트림 서버에 대한 통계를 재설정합니다.

가능한 응답:

• 204 – 성공
• 400 – 업스트림이 정적임(UpstreamStatic), 오류 반환
• 404 – 알 수 없는 버전(UnknownVersion), 업스트림을 찾을 수 없음(UpstreamNotFound), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환

/http/upstreams/{httpUpstreamName}/servers/

모든 메서드에 공통된 매개변수:

httpUpstreamName (string, required)

업스트림 서버 그룹의 이름.

지원되는 메서드:

• GET – HTTP 업스트림 서버 그룹의 모든 서버의 구성 반환

특정 HTTP 업스트림 서버 그룹의 각 서버의 구성을 반환합니다.

가능한 응답:

• 200 – 성공, HTTP 업스트림 서버의 어레이 반환
• 400 – 업스트림이 정적임(UpstreamStatic), 오류 반환
• 404 – 알 수 없는 버전(UnknownVersion), 업스트림을 찾을 수 없음(UpstreamNotFound), Error 반환
• POST – HTTP 업스트림 서버 그룹에 서버 추가

HTTP 업스트림 서버 그룹에 새로운 서버를 추가합니다. 서버 매개변수는 JSON 형식으로 지정됩니다.

요청 매개변수:

postHttpUpstreamServer(HTTP 업스트림 서버, 필수)

JSON 형식의 새 서버의 주소 및 기타 매개변수 옵션. “ID”, “backup” 및 “service” 매개변수는 변경할 수 없습니다.

가능한 응답:

• 201 – 생성됨, HTTP 업스트림 서버 반환
• 400 – 업스트림이 정적임(UpstreamStatic), 잘못된 “parameter” 값(UpstreamConfFormatError), 누락된 “server” 인수(UpstreamConfFormatError), 알 수 없는 매개변수 “name” (UpstreamConfFormatError), 중첩된 개체 또는 목록(UpstreamConfFormatError), 구문 분석 중 “error”(UpstreamBadAddress), 서비스 업스트림 “host”에 포트가 없을 수 있음(UpstreamBadAddress), 서비스 업스트림 “host”에 도메인 이름이 필요함(UpstreamBadAddress), 잘못된 “weight”(UpstreamBadWeight), 잘못된 “max_conns”(UpstreamBadMaxConns), 잘못된 “max_fails”(UpstreamBadMaxFails), 잘못된 “fail_timeout”(UpstreamBadFailTimeout), 잘못된 “slow_start”(UpstreamBadSlowStart), 요청 본문 읽기 실패(BodyReadError), 경로가 너무 김(UpstreamBadRoute), “service”가 비어 있음(UpstreamBadService), 확인하도록 정의된 확인자 없음(UpstreamConfNoResolver), 업스트림 “name“에 백업 없음(UpstreamNoBackup), 업스트림 “name” 메모리 소진(UpstreamOutOfMemory), 오류 반환
• 404 – 알 수 없는 버전(UnknownVersion), 업스트림을 찾을 수 없음(UpstreamNotFound), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환
• 409 – 항목 있음(EntryExists), 오류 반환
• 415 – JSON 오류(JsonError), 오류 반환

/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}

모든 메서드에 공통된 매개변수:

httpUpstreamName (string, required)

업스트림 서버 그룹의 이름.

httpUpstreamServerId(string, required)

서버의 ID.

지원되는 메서드:

• GET – HTTP 업스트림 서버 그룹의 서버의 구성 반환

HTTP 업스트림 서버 그룹의 특정 서버의 구성을 반환합니다.

가능한 응답:

• 200 – 성공, HTTP 업스트림 서버 반환
• 400 – 업스트림이 정적임(UpstreamStatic), 잘못된 서버 ID(UpstreamBadServerId), 오류 반환
• 404 – ID가 “id“인 서버가 없음(UpstreamServerNotFound), 알 수 없는 버전(UnknownVersion), 업스트림을 찾을 수 없음(UpstreamNotFound), Error 반환
• PATCH – HTTP 업스트림 서버 그룹의 서버 수정

HTTP 업스트림 서버 그룹의 특정 서버의 설정을 수정합니다. 서버 매개변수는 JSON 형식으로 지정됩니다.

요청 매개변수:

patchHttpUpstreamServer(HTTP 업스트림 서버, 필수)

서버 매개변수, JSON 형식으로 지정됩니다. “ID”, “backup” 및 “service” 매개변수는 변경할 수 없습니다.

가능한 응답:

• 200 – 성공, HTTP 업스트림 서버 반환
• 400 – 업스트림이 정적임(UpstreamStatic), 잘못된 “parameter” 값(UpstreamConfFormatError), 알 수 없는 매개변수 “name“(UpstreamConfFormatError), 중첩된 개체 또는 목록(UpstreamConfFormatError), 구문 분석 중 “error”(UpstreamBadAddress), 잘못된 “server” 인수(UpstreamBadAddress), 잘못된 서버 ID(UpstreamBadServerId), 잘못된 “weight”(UpstreamBadWeight), 잘못된 “max_conns”(UpstreamBadMaxConns), 잘못된 “max_fails”(UpstreamBadMaxFails), 잘못된 “fail_timeout”(UpstreamBadFailTimeout), 잘못된 “slow_start”(UpstreamBadSlowStart), 요청 본문 읽기 실패(BodyReadError), 경로가 너무 김(UpstreamBadRoute), “service”가 비어 있음(UpstreamBadService), 서버 “ID” 주소가 변경 불가능함(UpstreamServerImmutable), 서버 “ID” 가중치가 변경 불가능함(UpstreamServerWeightImmutable), 업스트림 “name” 메모리 소진(UpstreamOutOfMemory), 오류 반환
• 404 – ID가 “id“인 서버가 없음(UpstreamServerNotFound), 알 수 없는 버전(UnknownVersion), 업스트림을 찾을 수 없음(UpstreamNotFound), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환
• 415 – JSON 오류(JsonError), 오류 반환
• DELETE – HTTP 업스트림 서버 그룹에서 서버 제거

HTTP 업스트림 서버 그룹에서 서버를 제거합니다.

가능한 응답:

• 200 – 성공, HTTP 업스트림 서버의 어레이 반환
• 400 – 업스트림이 정적임(UpstreamStatic), 잘못된 서버 ID(UpstreamBadServerId), 서버 “id” 제거 불가(UpstreamServerImmutable), 오류 반환
• 404 – ID가 “id“인 서버가 없음(UpstreamServerNotFound), 알 수 없는 버전(UnknownVersion), 업스트림을 찾을 수 없음(UpstreamNotFound), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환

/http/keyvals/

지원되는 메서드:

• GET – 모든 HTTP keyval 영역에서 키-값 쌍 반환

각 HTTP keyval 공유 메모리 영역에 대한 키-값 쌍을 반환합니다.

요청 매개변수:

fields(string, 옵션)

“fields” 값이 비어 있으면 HTTP keyval 영역 이름만 출력됩니다.

가능한 응답:

• 200 – 성공, 모든 HTTP keyvals에 대한 “HTTP Keyval 공유 메모리 영역” 개체의 컬렉션 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환

/http/keyvals/{httpKeyvalZoneName}

모든 메서드에 공통된 매개변수:

httpKeyvalZoneName(string, required)

HTTP keyval 공유 메모리 영역의 이름.

지원되는 메서드:

• GET – HTTP keyval 영역에서 키-값 쌍 반환

특정 HTTP keyval 공유 메모리 영역에 저장된 키-값 쌍을 반환합니다.

요청 매개변수:

key(string, 옵션)

HTTP keyval 영역에서 특정 키-값 쌍을 가져옵니다.

가능한 응답:

• 200 – 성공, HTTP Keyval 공유 메모리 영역 반환
• 404 – Keyval을 찾을 수 없음(KeyvalNotFound), keyval 키를 찾을 수 없음(KeyvalKeyNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• POST – HTTP keyval 영역에 키-값 쌍 추가

HTTP keyval 공유 메모리 영역에 새로운 키-값 쌍을 추가합니다. HTTP keyval 공유 메모리 영역이 비어 있는 경우 여러 키-값 쌍을 입력할 수 있습니다.

요청 매개변수:

Key-value(HTTP Keyval Shared Memory Zone, required)

키-값 쌍이 JSON 형식으로 지정됩니다. HTTP keyval 공유 메모리 영역이 비어 있는 경우 여러 키-값 쌍을 입력할 수 있습니다. 밀리초 단위의 만료 시간은 keyval_zone 명령의 timeout 매개변수를 재정의하는 expire 매개변수로 키-값 쌍에 대해 지정할 수 있습니다.

가능한 응답:

• 201 – 생성됨
• 400 – 잘못된 JSON(KeyvalFormatError), 잘못된 키 형식(KeyvalFormatError), 키 필수(KeyvalFormatError), keyval 시간제한이 활성화되지 않음(KeyvalFormatError), 한 개 키만 추가할 수 있음(KeyvalFormatError), 요청 본문 읽기 실패(BodyReadError), 오류 반환
• 404 – Keyval을 찾을 수 없음(KeyvalNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환
• 409 – 항목이 있음(EntryExists), 키가 이미 있음(KeyvalKeyExists), 오류 반환
• 413 – 요청 엔티티가 너무 큼, 오류 반환
• 415 – JSON 오류(JsonError), 오류 반환
• PATCH – 키-값을 수정하거나 키 삭제

키-값 쌍에서 선택된 키의 값을 변경하고 키 값을 null로 설정하여 키를 삭제하고 키-값 쌍의 만료 시간을 변경합니다. 클러스터의 keyval 영역의 동기화가 활성화되면 대상 클러스터 노드에서 키만 삭제합니다. 밀리초 단위의 만료 시간은 keyval_zone 명령의 timeout 매개변수를 재정의하는 expire 매개변수로 키-값 쌍에 대해 지정할 수 있습니다.

요청 매개변수:

httpKeyvalZoneKeyValue(HTTP Keyval Shared Memory Zone, 필수)

키의 새로운 값은 JSON 형식으로 지정됩니다.

가능한 응답:

• 204 – 성공
• 400 – 잘못된 JSON(KeyvalFormatError), 키 필수(KeyvalFormatError), keyval 시간제한이 활성화되지 않음(KeyvalFormatError), 1개 값만 업데이트할 수 있음(KeyvalFormatError), 요청 본문 읽기 실패(BodyReadError), 오류 반환
• 404 – Keyval을 찾을 수 없음(KeyvalNotFound), keyval 키를 찾을 수 없음(KeyvalKeyNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환
• 413 – 요청 엔티티가 너무 큼, 오류 반환
• 415 – JSON 오류(JsonError), 오류 반환
• DELETE – HTTP keyval 영역 비우기

HTTP keyval 공유 메모리 영역에서 모든 키-값 쌍을 삭제합니다. 클러스터의 keyval 영역의 동기화가 활성화되면 대상 클러스터 노드에서 키 영역만 비웁니다.

가능한 응답:

• 204 – 성공
• 404 – Keyval을 찾을 수 없음(KeyvalNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환

/stream/

지원되는 메서드:

• GET – 스트림 관련 엔드포인트 목록 반환

첫 번째 수준 스트림 엔드포인트의 목록을 반환합니다.

가능한 응답:

• 200 – 성공, 문자열의 어레이 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환

/stream/server_zones/

지원되는 메서드:

• GET – 모든 스트림 서버 영역의 상태 반환

각 스트림 서버 영역에 대한 상태 정보를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 서버 영역의 필드를 제한합니다. “fields” 값이 비어 있으면 서버 영역 이름만 출력됩니다.

가능한 응답:

• 200 – 성공, 모든 스트림 서버 영역에 대한 “스트림 서버 영역” 개체의 컬렉션 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환

/stream/server_zones/{streamServerZoneName}

모든 메서드에 공통된 매개변수:

streamServerZoneName(string, required)

스트림 서버 영역의 이름.

지원되는 메서드:

• GET – 스트림 서버 영역의 상태 반환

특정한 스트림 서버 영역의 상태를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 서버 영역의 필드를 제한합니다.

가능한 응답:

• 200 – 성공, 스트림 서버 영역 반환
• 404 – 서버 영역을 찾을 수 없음(ServerZoneNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• DELETE – 스트림 서버 영역의 통계 반환

특정 스트림 서버 영역에서 수락한 연결 및 버린 연결, 세션, 수신한 바이트 및 전송한 바이트의 통계를 반환합니다.

가능한 응답:

• 204 – 성공
• 404 – 서버 영역을 찾을 수 없음(ServerZoneNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환

/stream/limit_conns/

지원되는 메서드:

• GET – 모든 스트림 limit_conn 영역의 상태 반환

각 스트림 limit_conn zone에 대한 상태 정보를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 limit_conn 영역의 필드를 제한합니다. “fields” 값이 비어 있으면 영역 이름만 출력됩니다.

가능한 응답:

• 200 – 성공, 모든 스트림 limit conn에 대한 “스트림 연결 제한” 개체의 컬렉션 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환

/stream/limit_conns/{streamLimitConnZoneName}

모든 메서드에 공통된 매개변수:

streamLimitConnZoneName(string, 필수)

limit_conn zone의 이름.

지원되는 메서드:

• GET – 스트림 limit_conn 영역의 상태 반환

특정 스트림 limit_conn zone.의 상태를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 limit_conn zone의 필드를 제한합니다.

가능한 응답:

• 200 – 성공, 스트림 연결 제한 반환
• 404 – limit_conn을 찾을 수 없음(LimitConnNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• DELETE – 스트림 limit_conn 영역의 통계 반환

연결 제한 통계를 반환합니다.

가능한 응답:

• 204 – 성공
• 404 – limit_conn을 찾을 수 없음(LimitConnNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환

/stream/upstreams/

지원되는 메서드:

• GET – 모든 스트림 업스트림 서버 그룹의 상태 반환

각 스트림 업스트림 서버 그룹 및 해당 서버의 상태를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 업스트림 서버 그룹의 필드를 제한합니다. “fields” 값이 비어 있으면 업스트림 이름만 출력됩니다.

가능한 응답:

• 200 – 성공, 모든 HTTP 업스트림에 대한 “스트림 업스트림” 개체의 컬렉션 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환

/stream/upstreams/{streamUpstreamName}/

모든 메서드에 공통된 매개변수:

streamUpstreamName(string, 필수)

스트림 업스트림 서버 그룹의 이름.

지원되는 메서드:

• GET – 스트림 업스트림 서버 그룹의 상태 반환

특정 스트림 업스트림 서버 그룹 및 해당 서버의 상태를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 업스트림 서버 그룹의 필드를 제한합니다.

가능한 응답:

• 200 – 성공, 스트림 업스트림 반환
• 400 – 업스트림이 정적임(UpstreamStatic), 오류 반환
• 404 – 알 수 없는 버전(UnknownVersion), 업스트림을 찾을 수 없음(UpstreamNotFound), Error 반환
• DELETE – 스트림 업스트림 서버 그룹의 상태 재설정

업스트림 서버 그룹의 각 업스트림 서버에 대한 통계를 재설정합니다.

가능한 응답:

• 204 – 성공
• 400 – 업스트림이 정적임(UpstreamStatic), 오류 반환
• 404 – 알 수 없는 버전(UnknownVersion), 업스트림을 찾을 수 없음(UpstreamNotFound), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환

/stream/upstreams/{streamUpstreamName}/servers/

모든 메서드에 공통된 매개변수:

streamUpstreamName(string, 필수)

업스트림 서버 그룹의 이름.

지원되는 메서드:

• GET – 스트림 업스트림 서버 그룹의 모든 서버의 구성 반환

특정 스트림 업스트림 서버 그룹의 각 서버의 구성을 반환합니다.

가능한 응답:

• 200 – 성공, 스트림 업스트림 서버의 어레이 반환
• 400 – 업스트림이 정적임(UpstreamStatic), 오류 반환
• 404 – 알 수 없는 버전(UnknownVersion), 업스트림을 찾을 수 없음(UpstreamNotFound), Error 반환
• POST – 스트림 업스트림 서버 그룹에 서버 추가

스트림 업스트림 서버 그룹에 새로운 서버를 추가합니다. 서버 매개변수는 JSON 형식으로 지정됩니다.

요청 매개변수:

postStreamUpstreamServer(Stream Upstream Server, 필수)

JSON 형식의 새 서버의 주소 및 기타 매개변수 옵션. “ID”, “backup” 및 “service” 매개변수는 변경할 수 없습니다.

가능한 응답:

• 201 – 생성됨, 스트림 업스트림 서버 반환
• 400 – 업스트림이 정적임(UpstreamStatic), 잘못된 “parameter” 값(UpstreamConfFormatError), 누락된 “server” 인수(UpstreamConfFormatError), 알 수 없는 매개변수 “name“(UpstreamConfFormatError), 중첩된 개체 또는 목록(UpstreamConfFormatError), 구문 분석 중 “error”(UpstreamBadAddress), 서버 “host”의 포트 없음(UpstreamBadAddress), 서비스 업스트림 “host”에 포트가 없을 수 있음(UpstreamBadAddress), 서비스 업스트림 “host”에 도메인 이름 필요(UpstreamBadAddress), 잘못된 “weight”(UpstreamBadWeight), 잘못된 “max_conns”(UpstreamBadMaxConns), 잘못된 “max_fails”(UpstreamBadMaxFails), 잘못된 “fail_timeout”(UpstreamBadFailTimeout), 잘못된 “slow_start”(UpstreamBadSlowStart), “service”가 비어 있음(UpstreamBadService), 확인하도록 정의된 확인자 없음(UpstreamConfNoResolver), 업스트림 “name“에 백업 없음(UpstreamNoBackup), 업스트림 “name” 메모리 소진(UpstreamOutOfMemory), 요청 본문 읽기 실패(BodyReadError), 오류 반환
• 404 – 알 수 없는 버전(UnknownVersion), 업스트림을 찾을 수 없음(UpstreamNotFound), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환
• 409 – 항목 있음(EntryExists), 오류 반환
• 415 – JSON 오류(JsonError), 오류 반환 

/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}

모든 메서드에 공통된 매개변수:

streamUpstreamName(string, required)

업스트림 서버 그룹의 이름.

streamUpstreamServerId(string, required)

서버의 ID.

지원되는 메서드:

• GET – 스트림 업스트림 서버 그룹의 서버의 구성 반환

스트림 업스트림 서버 그룹의 특정 서버의 구성을 반환합니다.

가능한 응답:

• 200 – 성공, 스트림 업스트림 서버 반환
• 400 – 업스트림이 정적임(UpstreamStatic), 잘못된 서버 ID(UpstreamBadServerId), 오류 반환
• 404 – 알 수 없는 버전(UnknownVersion), 업스트림을 찾을 수 없음(UpstreamNotFound), ID가 “id“인 서버가 없음(UpstreamServerNotFound), Error 반환
• PATCH – 스트림 업스트림 서버 그룹의 서버 수정

스트림 업스트림 서버 그룹의 특정 서버의 설정을 수정합니다. 서버 매개변수는 JSON 형식으로 지정됩니다.

요청 매개변수:

patchStreamUpstreamServer(Stream Upstream Server, 필수)

서버 매개변수, JSON 형식으로 지정됩니다. “ID”, “backup” 및 “service” 매개변수는 변경할 수 없습니다.

가능한 응답:

• 200 – 성공, 스트림 업스트림 서버 반환
• 400 – 업스트림이 정적임(UpstreamStatic), 잘못된 “parameter” 값(UpstreamConfFormatError), 알 수 없는 매개변수 “name“(UpstreamConfFormatError), 중첩된 개체 또는 목록(UpstreamConfFormatError), 구문 분석 중 “error(UpstreamBadAddress), 잘못된 “server” 인수(UpstreamBadAddress), 서버 “host”에 포트 없음(UpstreamBadAddress), 잘못된 서버 ID(UpstreamBadServerId), 잘못된 “weight” (UpstreamBadWeight), 잘못된 “max_conns”(UpstreamBadMaxConns), 잘못된 “max_fails”(UpstreamBadMaxFails), 잘못된 “fail_timeout”(UpstreamBadFailTimeout), 잘못된 “slow_start”(UpstreamBadSlowStart), 요청 본문 읽기 실패(BodyReadError), “service”가 비어 있음(UpstreamBadService), 서버 “ID” 주소가 변경 불가능함(UpstreamServerImmutable), 서버 “ID” 가중치가 변경 불가능함(UpstreamServerWeightImmutable), 업스트림 “name” 메모리 소진(UpstreamOutOfMemory), 오류 반환
• 404 – ID가 “id“인 서버가 없음(UpstreamServerNotFound), 알 수 없는 버전(UnknownVersion), 업스트림을 찾을 수 없음(UpstreamNotFound), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환
• 415 – JSON 오류(JsonError), 오류 반환
• DELETE – 스트림 업스트림 서버 그룹에서 서버 제거

스트림 서버 그룹에서 서버를 제거합니다.

가능한 응답:

• 200 – 성공, 스트림 업스트림 서버의 어레이 반환
• 400 – 업스트림이 정적임(UpstreamStatic), 잘못된 서버 ID(UpstreamBadServerId), 서버 “id” 제거 불가(UpstreamServerImmutable), 오류 반환
• 404 – ID가 “id“인 서버가 없음(UpstreamServerNotFound), 알 수 없는 버전(UnknownVersion), 업스트림을 찾을 수 없음(UpstreamNotFound), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환 

/stream/keyvals/

지원되는 메서드:

• GET – 모든 스트림 keyval 영역에서 키-값 쌍 반환

각 스트림 keyval 공유 메모리 영역에 대한 키-값 쌍을 반환합니다.

요청 매개변수:

fields(string, 옵션)

“fields” 값이 비어 있으면 스트림 keyval 영역 이름만 출력됩니다.

가능한 응답:

• 200 – 성공, 모든 스트림 keyvals에 대한 “스트림 Keyval 공유 메모리 영역” 개체의 컬렉션 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환

/stream/keyvals/{streamKeyvalZoneName}

모든 메서드에 공통된 매개변수:

streamKeyvalZoneName(string, 필수)

스트림 keyval 공유 메모리 영역의 이름.

지원되는 메서드:

• GET – 스트림 keyval 영역에서 키-값 쌍 반환

특정 스트림 keyval 공유 메모리 영역에 저장된 키-값 쌍을 반환합니다.

요청 매개변수:

key(string, 옵션)

스트림 keyval 영역에서 특정 키-값 쌍을 가져옵니다.

가능한 응답:

• 200 – 성공, 스트림 Keyval 공유 메모리 영역 반환
• 404 – Keyval을 찾을 수 없음(KeyvalNotFound), keyval 키를 찾을 수 없음(KeyvalKeyNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• POST – 스트림 keyval 영역에 키-값 쌍 추가

스트림 keyval 공유 메모리 영역에 새로운 키-값 쌍을 추가합니다. 스트림 keyval 공유 메모리 영역이 비어 있는 경우 여러 키-값 쌍을 입력할 수 있습니다.

요청 매개변수:

Key-value(Stream Keyval Shared Memory Zone, 필수)

키-값 쌍이 JSON 형식으로 지정됩니다. 스트림 keyval 공유 메모리 영역이 비어 있는 경우 여러 키-값 쌍을 입력할 수 있습니다. 밀리초 단위의 만료 시간은 keyval_zone 명령의 timeout 매개변수를 재정의하는 expire 매개변수로 키-값 쌍에 대해 지정할 수 있습니다.

가능한 응답:

• 201 – 생성됨
• 400 – 잘못된 JSON(KeyvalFormatError), 잘못된 키 형식(KeyvalFormatError), 키 필수(KeyvalFormatError), keyval 시간제한이 활성화되지 않음(KeyvalFormatError), 한 개 키만 추가할 수 있음(KeyvalFormatError), 요청 본문 읽기 실패(BodyReadError), 오류 반환
• 404 – Keyval을 찾을 수 없음(KeyvalNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환
• 409 – 항목이 있음(EntryExists), 키가 이미 있음(KeyvalKeyExists), 오류 반환
• 413 – 요청 엔티티가 너무 큼, 오류 반환
• 415 – JSON 오류(JsonError), 오류 반환
• PATCH – 키-값을 수정하거나 키 삭제

키-값 쌍에서 선택된 키의 값을 변경하고 키 값을 null로 설정하여 키를 삭제하고 키-값 쌍의 만료 시간을 변경합니다. 클러스터의 keyval 영역의 동기화가 활성화되면 대상 클러스터 노드에서 키만 삭제합니다. 만료 시간은 keyval_zone 명령의 timeout 매개변수를 재정의하는 expire 매개변수로 밀리초 단위로 지정됩니다.

요청 매개변수:

streamKeyvalZoneKeyValue(Stream Keyval Shared Memory Zone, 필수)

키의 새로운 값은 JSON 형식으로 지정됩니다.

가능한 응답:

• 204 – 성공
• 400 – 잘못된 JSON(KeyvalFormatError), 키 필수(KeyvalFormatError), keyval 시간제한이 활성화되지 않음(KeyvalFormatError), 1개 값만 업데이트할 수 있음(KeyvalFormatError), 요청 본문 읽기 실패(BodyReadError), 오류 반환
• 404 – Keyval을 찾을 수 없음(KeyvalNotFound), keyval 키를 찾을 수 없음(KeyvalKeyNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환
• 413 – 요청 엔티티가 너무 큼, 오류 반환
• 415 – JSON 오류(JsonError), 오류 반환
• DELETE – 스트림 keyval 영역 비우기

스트림 keyval 공유 메모리 영역에서 모든 키-값 쌍을 삭제합니다. 클러스터의 keyval 영역의 동기화가 활성화되면 대상 클러스터 노드에서 키 영역만 비웁니다.

가능한 응답:

• 204 – 성공
• 404 – Keyval을 찾을 수 없음(KeyvalNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환

/stream/zone_sync/

지원되는 메서드:

• GET – 노드의 동기화 상태 반환

클러스터 노드의 동기화 상태를 반환합니다.

가능한 응답:

• 200 – 성공, Stream Zone Sync Node 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환

/resolvers/

지원되는 메서드:

• GET – 모든 확인자 영역의 상태 반환

각 확인자 영역에 대한 상태 정보를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 확인자 통계의 필드를 제한합니다.

가능한 응답:

• 200 – 성공, 모든 확인자에 대한 “확인자 영역” 개체의 컬렉션 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환

/resolvers/{resolverZoneName}

모든 메서드에 공통된 매개변수:

resolverZoneName(string, 필수)

확인자 영역의 이름.

지원되는 메서드:

• GET – 확인자 영역의 통계 반환

특정 확인자 영역에 저장된 통계를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 확인자 영역의 필드를 제한합니다(요청, 응답 또는 둘 다).

가능한 응답:

• 200 – 성공, 확인자 영역 반환
• 404 – 확인자 영역을 찾을 수 없음(ResolverZoneNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• DELETE – 확인자 영역에 대한 통계를 재설정합니다.

특정 확인자 영역의 통계를 반환합니다.

가능한 응답:

• 204 – 성공
• 404 – 확인자 영역을 찾을 수 없음(ResolverZoneNotFound), 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환

/ssl

지원되는 메서드:

• GET – SSL 통계 반환

SSL 통계를 반환합니다.

요청 매개변수:

fields(string, 옵션)

출력될 SSL 통계의 필드를 제한합니다.

가능한 응답:

• 200 – 성공, SSL 반환
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환
• DELETE – SSL 통계 재설정

SSL 핸드셰이크 카운터 및 세션 재사용을 재설정합니다.

가능한 응답:

• 204 – 성공
• 404 – 알 수 없는 버전(UnknownVersion), Error 반환
• 405 – 메서드 비활성화됨(MethodDisabled), 오류 반환

응답 개체

• nginx:

nginx에 대한 일반 정보:

version(string)

nginx의 버전.

build(string)

nginx 빌드의 이름.

address(string)

상태 요청을 수락한 서버의 주소.

generation(integer)

전체 구성 재로드 수

load_timestamp(string)

밀리 초 해상도의 ISO 8601 형식으로 마지막 구성 재로드 시간.

timestamp(string)

밀리 초 해상도의 ISO 8601 형식으로 현재 시간.

pid(integer)

상태 요청을 처리한 작업자 프로세스의 ID.

ppid(integer)

작업자 프로세스를 시작한 마스터 프로세스의 ID.

예:

{
  "nginx" : {
    "version" : "1.17.3",
    "build" : "nginx-plus-r19",
    "address" : "206.251.255.64",
    "generation" : 6,
    "load_timestamp" : "2019-10-01T11:15:44.467Z",
    "timestamp" : "2019-10-01T09:26:07.305Z",
    "pid" : 32212,
    "ppid" : 32210
  }
}

• 프로세스:

respawned (integer)

비정상적으로 종료되거나 재생성된 하위 프로세스의 전체 수.

예:

{
  "respawned" : 0
}

• 연결:

수락된 연결, 삭제된 연결, 활성 연결 및 유휴 연결 수.

accepted(integer)

전체 수락된 클라이언트 연결 수.

dropped(integer)

전체 삭제된 클라이언트 연결 수.

active(integer)

현재 활성 클라이언트 연결 수.

idle(integer)

현재 유휴 클라이언트 연결 수.

예:

{
  "accepted" : 4968119,
  "dropped" : 0,
  "active" : 5,
  "idle" : 117
}

• SSL:

handshakes(integer)

전체 성공한 SSL 핸드셰이크의 수.

handshakes_failed(integer)

전체 실패한 SSL 핸드셰이크의 수.

session_reuses(integer)

SSL 핸드셰이크 동안 전체 세션 재사용 수.

예:

{
  "handshakes" : 79572,
  "handshakes_failed" : 21025,
  "session_reuses" : 15762
}

• 슬래브 할당자를 포함하는 공유 메모리 영역:

pages

사용 가능한 메모리 페이지와 사용된 메모리 페이지의 수

used(integer)

현재 사용된 메모리 페이지 수

free(integer)

현재 사용 가능한 메모리 페이지 수

slots

메모리 슬롯의 상태 데이터(8, 16, 32, 64, 128 등)

“Memory Slot” 개체의 컬렉션

예:

{
  "pages" : {
    "used" : 1143,
    "free" : 2928
  },
  "slots" : {
    "8" : {
      "used" : 0,
      "free" : 0,
      "reqs" : 0,
      "fails" : 0
    },
    "16" : {
      "used" : 0,
      "free" : 0,
      "reqs" : 0,
      "fails" : 0
    },
    "32" : {
      "used" : 0,
      "free" : 0,
      "reqs" : 0,
      "fails" : 0
    },
    "64" : {
      "used" : 1,
      "free" : 63,
      "reqs" : 1,
      "fails" : 0
    },
    "128" : {
      "used" : 0,
      "free" : 0,
      "reqs" : 0,
      "fails" : 0
    },
    "256" : {
      "used" : 18078,
      "free" : 178,
      "reqs" : 1635736,
      "fails" : 0
    }
  }
}

• 메모리 슬롯:

used(integer)

현재 사용된 메모리 슬롯 수

free(integer)

현재 사용 가능한 메모리 슬롯 수

reqs(integer)

지정된 크기의 메모리를 할당하려는 전체 시도 수.

fails(integer)

지정된 크기의 메모리를 할당하려는 전체 실패한 시도 수.

• HTTP 요청:

total (integer)

전체 클라이언트 요청 수.

current (integer)

현재 클라이언트 요청 수.

예:

{
  "total" : 10624511,
  "current" : 4
}

HTTP 서버 영역:

processing (integer)

현재 처리되고 있는 클라이언트 요청 수.

requests (integer)

클라이언트에서 수신된 전체 클라이언트 요청 수.

responses

클라이언트에 전송한 전체 응답 수, 상태 코드 “1xx”, “2xx”, “3xx”, “4xx”, “5xx”를 포함하는 응답 수 및 각 상태 코드당 응답 수.

1xx (integer)

“1xx” 상태 코드를 포함하는 응답 수.

2xx (integer)

“2xx” 상태 코드를 포함하는 응답 수.

3xx (integer)

“3xx” 상태 코드를 포함하는 응답 수.

4xx (integer)

“4xx” 상태 코드를 포함하는 응답 수.

5xx (integer)

“5xx” 상태 코드를 포함하는 응답 수.

codes

각 상태 코드당 응답 수.

codeNumber (integer)

이 특정 상태 코드를 포함하는 응답 수.

total (integer)

클라이언트에 전송된 전체 응답 수.

discarded (integer)

응답을 전송하지 않고 완료된 전체 요청 수.

received (integer)

클라이언트에서 수신된 전체 바이트 수.

sent (integer)

클라이언트에 전송된 전체 바이트 수.

예:

{
  "processing" : 1,
  "requests" : 706690,
  "responses" : {
    "1xx" : 0,
    "2xx" : 699482,
    "3xx" : 4522,
    "4xx" : 907,
    "5xx" : 266,
    "codes" : {
      "200" : 699482,
      "301" : 4522,
      "404" : 907,
      "503" : 266
    },
    "total" : 705177
  },
  "discarded" : 1513,
  "received" : 172711587,
  "sent" : 19415530115
}

• HTTP 위치 영역:

requests (integer)

클라이언트에서 수신된 전체 클라이언트 요청 수.

responses

클라이언트에 전송한 전체 응답 수, 상태 코드 “1xx”, “2xx”, “3xx”, “4xx”, “5xx”를 포함하는 응답 수 및 각 상태 코드당 응답 수.

1xx (integer)

“1xx” 상태 코드를 포함하는 응답 수.

2xx (integer)

“2xx” 상태 코드를 포함하는 응답 수.

3xx (integer)

“3xx” 상태 코드를 포함하는 응답 수.

4xx (integer)

“4xx” 상태 코드를 포함하는 응답 수.

5xx (integer)

“5xx” 상태 코드를 포함하는 응답 수.

codes

각 상태 코드당 응답 수.

codeNumber (integer)

이 특정 상태 코드를 포함하는 응답 수.

total (integer)

클라이언트에 전송된 전체 응답 수.

discarded (integer)

응답을 전송하지 않고 완료된 전체 요청 수.

received (integer)

클라이언트에서 수신된 전체 바이트 수.

sent (integer)

클라이언트에 전송된 전체 바이트 수.

예:

{
  "requests" : 706690,
  "responses" : {
    "1xx" : 0,
    "2xx" : 699482,
    "3xx" : 4522,
    "4xx" : 907,
    "5xx" : 266,
    "codes" : {
      "200" : 112674,
      "301" : 4522,
      "404" : 2504,
      "503" : 266
    },
    "total" : 705177
  },
  "discarded" : 1513,
  "received" : 172711587,
  "sent" : 19415530115
}

• HTTP 캐시:

size (integer)

캐시의 현재 크기.

max_size (integer)

구성에 지정된 캐시의 최대 크기에 대한 제한.

cold (boolean)

“캐시 로더” 프로세스가 아직 디스크에서 캐시로 데이터를 로드 중인지를 나타내는 부울 값.

hit

responses (integer)

캐시에서 읽은 전체 올바른 응답 수.

bytes (integer)

캐시에서 읽은 전체 바이트 수.

stale

responses (integer)

캐시에서 읽은 전체 만료된 응답 수(proxy_cache_use_stale 및 기타 “*_cache_use_stale” 명령 참조).

bytes (integer)

캐시에서 읽은 전체 바이트 수.

updating

responses (integer)

응답이 업데이트되고 있는 동안 캐시에서 읽은 전체 만료된 응답 수(proxy_cache_use_stale 및 기타 “*_cache_use_stale” 명령 참조).

bytes (integer)

캐시에서 읽은 전체 바이트 수.

revalidated

responses (integer)

캐시에서 읽은 만료된 응답 및 유효성이 다시 확인된 응답의 전체 수(proxy_cache_revalidate 및 기타 “*_cache_use_stale” 명령 참조).

bytes (integer)

캐시에서 읽은 전체 바이트 수.

miss

responses (integer)

캐시에서 찾을 수 없는 전체 응답 수.

bytes (integer)

프록시 설정된 서버에서 읽은 전체 바이트 수.

responses_written (integer)

캐시에 기록된 전체 응답 수.

bytes_written (integer)

캐시에 기록된 전체 바이트 수.

expired

responses (integer)

캐시에서 가져오지 않은 전체 만료된 응답 수.

bytes (integer)

프록시 설정된 서버에서 읽은 전체 바이트 수.

responses_written (integer)

캐시에 기록된 전체 응답 수.

bytes_written (integer)

캐시에 기록된 전체 바이트 수.

bypass

responses (integer)

proxy_cache_bypass 및 기타 “*_cache_bypass” 명령으로 인해 캐시에서 조회되지 않은 전체 응답 수.

bytes (integer)

프록시 설정된 서버에서 읽은 전체 바이트 수.

responses_written (integer)

캐시에 기록된 전체 응답 수.

bytes_written (integer)

캐시에 기록된 전체 바이트 수.

예:

{
  "size" : 530915328,
  "max_size" : 536870912,
  "cold" : false,
  "hit" : {
    "responses" : 254032,
    "bytes" : 6685627875
  },
  "stale" : {
    "responses" : 0,
    "bytes" : 0
  },
  "updating" : {
    "responses" : 0,
    "bytes" : 0
  },
  "revalidated" : {
    "responses" : 0,
    "bytes" : 0
  },
  "miss" : {
    "responses" : 1619201,
    "bytes" : 53841943822
  },
  "expired" : {
    "responses" : 45859,
    "bytes" : 1656847080,
    "responses_written" : 44992,
    "bytes_written" : 1641825173
  },
  "bypass" : {
    "responses" : 200187,
    "bytes" : 5510647548,
    "responses_written" : 200173,
    "bytes_written" : 44992
  }
}

• HTTP 연결 제한:

passed (integer)

제한되지도 않고 제한된 것으로 간주되지도 않은 전체 연결 수.

rejected (integer)

거부된 전체 연결 수.

rejected_dry_run (integer)

dry run 모드에서 거부된 것으로 간주된 전체 연결 수.

예:

{
  "passed" : 15,
  "rejected" : 0,
  "rejected_dry_run" : 2
}

• HTTP 요청 속도 제한:

passed (integer)

제한되지도 않고 제한된 것으로 간주되지도 않은 전체 요청 수.

delayed (integer)

지연된 전체 요청 수.

rejected (integer)

거부된 전체 요청 수.

delayed_dry_run (integer)

dry run 모드에서 지연된 것으로 간주된 전체 요청 수.

rejected_dry_run (integer)

dry run 모드에서 거부된 것으로 간주된 전체 요청 수.

예:

{
  "passed" : 15,
  "delayed" : 4,
  "rejected" : 0,
  "delayed_dry_run" : 1,
  "rejected_dry_run" : 2
}

• HTTP 업스트림:

peers

다음의 어레이:

id (integer)

서버의 ID.

server (string)

서버의 주소.

service (string)

서버 명령의 service 매개변수 값.

name (string)

서버 명령에 지정된 서버의 이름.

backup (boolean)

서버가 백업 서버인지를 나타내는 부울 값.

weight (integer)

서버의 가중치.

state (string)

“up”, “draining”, “down”, “unavail”, “checking” 및 “unhealthy” 중 하나일 수 있는 현재 상태.

active(integer)

현재 활성 연결 수.

max_conns (integer)

서버에 대한 max_conns 제한.

requests (integer)

이 서버에 전달된 전체 클라이언트 요청 수.

responses

1xx (integer)

“1xx” 상태 코드를 포함하는 응답 수.

2xx (integer)

“2xx” 상태 코드를 포함하는 응답 수.

3xx (integer)

“3xx” 상태 코드를 포함하는 응답 수.

4xx (integer)

“4xx” 상태 코드를 포함하는 응답 수.

5xx (integer)

“5xx” 상태 코드를 포함하는 응답 수.

codes

각 상태 코드당 응답 수.

codeNumber (integer)

이 특정 상태 코드를 포함하는 응답 수.

total (integer)

이 서버에 얻은 전체 응답 요청 수.

sent (integer)

이 서버에 전송된 전체 바이트 수.

received (integer)

이 서버에서 수신된 전체 바이트 수.

fails(integer)

서버와 통신하는 데 실패한 전체 시도 수.

unavail (integer)

max_fails 임계값에 도달한 실패한 시도 수로 인해 서버가 클라이언트 요청에 대해 사용 불가능하게 된 횟수(“unavail” 상태).

health_checks

checks (integer)

수행된 전체 상태 검사 수.

fails(integer)

실패한 상태 검사 수.

unhealthy (integer)

서버가 비정상이 된 횟수(상태 “unhealthy”).

last_passed (boolean)

상태 검사 요청이 성공했고 테스트를 통과했는지를 나타내는 부울.

downtime (integer)

서버가 “unavail”, “checking” 및 “unhealthy” 상태였던 전체 시간.

downstart (string)

서버가 밀리초 해상도의 ISO 8601 형식으로 “unavail”, “checking” 또는 “unhealthy”가 된 시간.

selected (string)

서버가 밀리초 해상도의 ISO 8601 형식으로 요청을 처리하도록 마지막으로 선택된 시간.

header_time (integer)

서버에서 응답 헤더를 가져오는 평균 시간.

response_time (integer)

서버에서 전체 응답을 가져오는 평균 시간.

keepalive (integer)

현재 유휴 keepalive 연결 수.

zombies (integer)

그룹에서 제거되었지만 계속 활성 클라이언트 요청을 처리 중인 현재 서버 수.

zone (string)

그룹의 구성과 런타임 상태를 유지하는 공유 메모리 영역의 이름.

대기열

요청 대기열의 경우 다음 데이터가 제공됩니다.

size (integer)

대기열의 현재 요청 수.

max_size (integer)

동시에 대기열에 있을 수 있는 최대 요청 수.

overflows (integer)

대기열 오버플로로 인해 거부된 전체 요청 수.

예:

{
  "upstream_backend" : {
    "peers" : [
      {
        "id" : 0,
        "server" : "10.0.0.1:8088",
        "name" : "10.0.0.1:8088",
        "backup" : false,
        "weight" : 5,
        "state" : "up",
        "active" : 0,
        "max_conns" : 20,
        "requests" : 667231,
        "header_time" : 20,
        "response_time" : 36,
        "responses" : {
          "1xx" : 0,
          "2xx" : 666310,
          "3xx" : 0,
          "4xx" : 915,
          "5xx" : 6,
          "codes" : {
            "200" : 666310,
            "404" : 915,
            "503" : 6
          },
          "total" : 667231
        },
        "sent" : 251946292,
        "received" : 19222475454,
        "fails" : 0,
        "unavail" : 0,
        "health_checks" : {
          "checks" : 26214,
          "fails" : 0,
          "unhealthy" : 0,
          "last_passed" : true
        },
        "downtime" : 0,
        "downstart" : "2019-10-01T11:09:21.602Z",
        "selected" : "2019-10-01T15:01:25.000Z"
      },
      {
        "id" : 1,
        "server" : "10.0.0.1:8089",
        "name" : "10.0.0.1:8089",
        "backup" : true,
        "weight" : 1,
        "state" : "unhealthy",
        "active" : 0,
        "max_conns" : 20,
        "requests" : 0,
        "responses" : {
          "1xx" : 0,
          "2xx" : 0,
          "3xx" : 0,
          "4xx" : 0,
          "5xx" : 0,
          "codes" : {
          },
          "total" : 0
        },
        "sent" : 0,
        "received" : 0,
        "fails" : 0,
        "unavail" : 0,
        "health_checks" : {
          "checks" : 26284,
          "fails" : 26284,
          "unhealthy" : 1,
          "last_passed" : false
        },
        "downtime" : 262925617,
        "downstart" : "2019-10-01T11:09:21.602Z",
        "selected" : "2019-10-01T15:01:25.000Z"
      }
    ],
    "keepalive" : 0,
    "zombies" : 0,
    "zone" : "upstream_backend"
  }
}

•  HTTP 업스트림 서버:

HTTP 업스트림 서버의 동적으로 구성 가능한 매개변수:

id (integer)

HTTP 업스트림 서버의 ID. ID는 자동으로 할당되고 변경할 수 없습니다.

server (string)

HTTP 업스트림 서버의 address 매개변수와 동일합니다. 서버를 추가하는 경우 서버를 도메인 이름으로 지정할 수 있습니다. 이 경우 도메인 이름에 해당하는 IP 주소의 변경 사항이 모니터링되고 nginx를 재시작할 필요 없이 업스트림 구성에 자동으로 적용됩니다. 이를 위해서는 “http” 블록의 확인자 명령이 필요합니다. HTTP 업스트림 서버의 resolve 매개변수도 참조하십시오.

service (string)

HTTP 업스트림 서버의 service 매개변수와 동일합니다. 이 매개변수는 변경할 수 없습니다.

weight (integer)

HTTP 업스트림 서버의 weight 매개변수와 동일합니다.

max_conns (integer)

HTTP 업스트림 서버의 max_conns 매개변수와 동일합니다.

max_fails (integer)

HTTP 업스트림 서버의 max_fails 매개변수와 동일합니다.

fail_timeout (string)

HTTP 업스트림 서버의 fail_timeout 매개변수와 동일합니다.

slow_start (string)

HTTP 업스트림 서버의 slow_start 매개변수와 동일합니다.

route (string)

HTTP 업스트림 서버의 route 매개변수와 동일합니다.

backup (boolean)

true인 경우 백업 서버를 추가합니다. 이 매개변수는 변경할 수 없습니다.

down (boolean)

HTTP 업스트림 서버의 down 매개변수와 동일합니다.

drain (boolean)

HTTP 업스트림 서버의 drain 매개변수와 동일합니다.

parent (string)

확인된 서버의 상위 서버 ID. ID는 자동으로 할당되고 변경할 수 없습니다.

host (string)

확인된 서버의 호스트 이름. 호스트 이름은 자동으로 할당되고 변경할 수 없습니다.

예:

{
  "id" : 1,
  "server" : "10.0.0.1:8089",
  "weight" : 4,
  "max_conns" : 0,
  "max_fails" : 0,
  "fail_timeout" : "10s",
  "slow_start" : "10s",
  "route" : "",
  "backup" : true,
  "down" : true
}

• HTTP Keyval 공유 메모리 영역:

GET 메서드를 사용하는 경우 HTTP keyval 공유 메모리 영역의 콘텐츠.

예:

{
  "key1" : "value1",
  "key2" : "value2",
  "key3" : "value3"
}

• HTTP Keyval 공유 메모리 영역:

POST 또는 PATCH 메서드를 사용하는 경우 HTTP keyval 공유 메모리 영역의 콘텐츠.

예:

{
  "key1" : "value1",
  "key2" : "value2",
  "key3" : {
    "value" : "value3",
    "expire" : 30000
  }
}

• 스트림 서버 영역:

processing (integer)

현재 처리되고 있는 클라이언트 연결 수.

connections (integer)

클라이언트에서 수락된 전체 연결 수.

sessions

전체 완료된 세션 수와 상태 코드 “2xx”, “4xx” 또는 “5xx”로 완료된 세션 수.

2xx (integer)

상태 코드 “2xx”로 완료된 전체 세션 수.

4xx (integer)

상태 코드 “4xx”로 완료된 전체 세션 수.

5xx (integer)

상태 코드 “5xx”로 완료된 전체 세션 수.

total (integer)

전체 완료된 클라이언트 세션 수.

discarded (integer)

세션을 생성하지 않고 완료된 전체 연결 수.

received (integer)

클라이언트에서 수신된 전체 바이트 수.

sent (integer)

클라이언트에 전송된 전체 바이트 수.

예:

{
  "dns" : {
    "processing" : 1,
    "connections" : 155569,
    "sessions" : {
      "2xx" : 155564,
      "4xx" : 0,
      "5xx" : 0,
      "total" : 155569
    },
    "discarded" : 0,
    "received" : 4200363,
    "sent" : 20489184
  }
}

• 스트림 연결 제한:

passed (integer)

제한되지도 않고 제한된 것으로 간주되지도 않은 전체 연결 수.

rejected (integer)

거부된 전체 연결 수.

rejected_dry_run (integer)

dry run 모드에서 거부된 것으로 간주된 전체 연결 수.

예:

{
  "passed" : 15,
  "rejected" : 0,
  "rejected_dry_run" : 2
}

• 스트림 업스트림:

peers

다음의 어레이:

id (integer)

서버의 ID.

server (string)

서버의 주소.

service (string)

서버 명령의 service 매개변수 값.

name (string)

서버 명령에 지정된 서버의 이름.

backup (boolean)

서버가 백업 서버인지를 나타내는 부울 값.

weight (integer)

서버의 가중치.

state (string)

“up”, “down”, “unavail”, “checking” 또는 “unhealthy” 중 하나일 수 있는 현재 상태.

active(integer)

현재 연결 수.

max_conns (integer)

서버에 대한 max_conns 제한.

connections (integer)

이 서버에 전달된 전체 클라이언트 연결 수.

connect_time (integer)

업스트림 서버에 연결하는 평균 시간.

first_byte_time (integer)

첫 번째 데이터 바이트를 수신하는 평균 시간.

response_time (integer)

마지막 데이터 바이트를 수신하는 평균 시간.

sent (integer)

이 서버에 전송된 전체 바이트 수.

received (integer)

이 서버에서 수신된 전체 바이트 수.

fails(integer)

서버와 통신하는 데 실패한 전체 시도 수.

unavail (integer)

max_fails 임계값에 도달한 실패한 시도 수로 인해 서버가 클라이언트 연결에 대해 사용 불가능하게 된 횟수(“unavail” 상태).

health_checks

checks (integer)

수행된 전체 상태 검사 수.

fails(integer)

실패한 상태 검사 수.

unhealthy (integer)

서버가 비정상이 된 횟수(상태 “unhealthy”).

last_passed (boolean)

상태 검사 요청이 성공했고 테스트를 통과했는지를 나타내는 부울.

downtime (integer)

서버가 “unavail”, “checking” 및 “unhealthy” 상태였던 전체 시간.

downstart (string)

서버가 밀리초 해상도의 ISO 8601 형식으로 “unavail”, “checking” 또는 “unhealthy”가 된 시간.

selected (string)

서버가 밀리초 해상도의 ISO 8601 형식으로 연결을 처리하도록 마지막으로 선택된 시간.

zombies (integer)

그룹에서 제거되었지만 계속 활성 클라이언트 연결을 처리 중인 현재 서버 수.

zone (string)

그룹의 구성과 런타임 상태를 유지하는 공유 메모리 영역의 이름.

예:

{
  "dns" : {
    "peers" : [
      {
        "id" : 0,
        "server" : "10.0.0.1:12347",
        "name" : "10.0.0.1:12347",
        "backup" : false,
        "weight" : 5,
        "state" : "up",
        "active" : 0,
        "max_conns" : 50,
        "connections" : 667231,
        "sent" : 251946292,
        "received" : 19222475454,
        "fails" : 0,
        "unavail" : 0,
        "health_checks" : {
          "checks" : 26214,
          "fails" : 0,
          "unhealthy" : 0,
          "last_passed" : true
        },
        "downtime" : 0,
        "downstart" : "2019-10-01T11:09:21.602Z",
        "selected" : "2019-10-01T15:01:25.000Z"
      },
      {
        "id" : 1,
        "server" : "10.0.0.1:12348",
        "name" : "10.0.0.1:12348",
        "backup" : true,
        "weight" : 1,
        "state" : "unhealthy",
        "active" : 0,
        "max_conns" : 50,
        "connections" : 0,
        "sent" : 0,
        "received" : 0,
        "fails" : 0,
        "unavail" : 0,
        "health_checks" : {
          "checks" : 26284,
          "fails" : 26284,
          "unhealthy" : 1,
          "last_passed" : false
        },
        "downtime" : 262925617,
        "downstart" : "2019-10-01T11:09:21.602Z",
        "selected" : "2019-10-01T15:01:25.000Z"
      }
    ],
    "zombies" : 0,
    "zone" : "dns"
  }
}

스트림 업스트림 서버:

스트림 업스트림 서버의 동적으로 구성 가능한 매개변수:

id (integer)

스트림 업스트림 서버의 ID. ID는 자동으로 할당되고 변경할 수 없습니다.

server (string)

스트림 업스트림 서버의 address 매개변수와 동일합니다. 서버를 추가하는 경우 서버를 도메인 이름으로 지정할 수 있습니다. 이 경우 도메인 이름에 해당하는 IP 주소의 변경 사항이 모니터링되고 nginx를 재시작할 필요 없이 업스트림 구성에 자동으로 적용됩니다. 이를 위해서는 “stream” 블록의 확인자 명령이 필요합니다. 스트림 업스트림 서버의 resolve 매개변수도 참조하십시오.

service (string)

스트림 업스트림 서버의 service 매개변수와 동일합니다. 이 매개변수는 변경할 수 없습니다.

weight (integer)

스트림 업스트림 서버의 weight 매개변수와 동일합니다.

max_conns (integer)

스트림 업스트림 서버의 max_conns 매개변수와 동일합니다.

max_fails (integer)

스트림 업스트림 서버의 max_fails 매개변수와 동일합니다.

fail_timeout (string)

스트림 업스트림 서버의 fail_timeout 매개변수와 동일합니다.

slow_start (string)

스트림 업스트림 서버의 slow_start 매개변수와 동일합니다.

backup (boolean)

true인 경우 백업 서버를 추가합니다. 이 매개변수는 변경할 수 없습니다.

down (boolean)

스트림 업스트림 서버의 down 매개변수와 동일합니다.

parent (string)

확인된 서버의 상위 서버 ID. ID는 자동으로 할당되고 변경할 수 없습니다.

host (string)

확인된 서버의 호스트 이름. 호스트 이름은 자동으로 할당되고 변경할 수 없습니다.

예:

{
  "id" : 0,
  "server" : "10.0.0.1:12348",
  "weight" : 1,
  "max_conns" : 0,
  "max_fails" : 1,
  "fail_timeout" : "10s",
  "slow_start" : 0,
  "backup" : false,
  "down" : false
}

• 스트림 Keyval 공유 메모리 영역:

GET 메서드를 사용하는 경우 스트림 keyval 공유 메모리 영역의 콘텐츠.

예:

{
  "key1" : "value1",
  "key2" : "value2",
  "key3" : "value3"
}

• 스트림 Keyval 공유 메모리 영역:

POST 또는 PATCH 메서드를 사용하는 경우 스트림 keyval 공유 메모리 영역의 콘텐츠.

예:

{
  "key1" : "value1",
  "key2" : "value2",
  "key3" : {
    "value" : "value3",
    "expire" : 30000
  }
}

• 스트림 영역 동기화 노드:

zones

각 공유 메모리 영역당 동기화 정보.

“Sync Zone” 개체의 컬렉션

status

클러스터의 노드당 동기화 정보.

bytes_in (integer)

이 노드에 수신된 바이트 수.

msgs_in (integer)

이 노드에 수신된 메시지 수.

msgs_out (integer)

이 노드에서 전송된 메시지 수.

bytes_out (integer)

이 노드에서 전송된 바이트 수.

nodes_online (integer)

이 노드가 연결된 피어 수.

예:

{
  "zones" : {
    "zone1" : {
      "records_pending" : 2061,
      "records_total" : 260575
    },
    "zone2" : {
      "records_pending" : 0,
      "records_total" : 14749
    }
  },
  "status" : {
    "bytes_in" : 1364923761,
    "msgs_in" : 337236,
    "msgs_out" : 346717,
    "bytes_out" : 1402765472,
    "nodes_online" : 15
  }
}

• 동기화 영역:

공유 메모리 영역의 동기화 상태.

records_pending (integer)

클러스터에 전송되어야 하는 레코드 수.

records_total (integer)

공유 메모리 영역에 저장된 전체 레코드 수.

• 확인자 영역:

특정 확인자 영역당 DNS 요청 및 응답의 통계.

requests

name (integer)

이름을 주소로 확인할 전체 요청 수.

srv (integer)

SRV 레코드를 확인할 전체 요청 수.

addr (integer)

주소를 이름으로 확인할 전체 요청 수.

responses

noerror (integer)

전체 성공한 응답 수.

formerr (integer)

전체 FORMERR(Format error) 응답 수.

servfail (integer)

전체 SERVFAIL(Server failure) 응답 수.

nxdomain (integer)

전체 NXDOMAIN(Host not found) 응답 수.

notimp (integer)

전체 NOTIMP(Unimplemented) 응답 수.

refused (integer)

전체 REFUSED(Operation refused) 응답 수.

timedout (integer)

전체 시간제한된 요청 수.

unknown (integer)

알 수 없는 오류와 함께 완료된 전체 요청 수.

예:

{
  "resolver_zone1" : {
    "requests" : {
      "name" : 25460,
      "srv" : 130,
      "addr" : 2580
    },
    "responses" : {
      "noerror" : 26499,
      "formerr" : 0,
      "servfail" : 3,
      "nxdomain" : 0,
      "notimp" : 0,
      "refused" : 0,
      "timedout" : 243,
      "unknown" : 478
    }
  }
}

• 오류:

nginx 오류 개체.

error

status (integer)

HTTP 오류 코드.

text (string)

오류 설명.

code (string)

내부 nginx 오류 코드.

request_id (string)

요청의 ID는 $request_id 변수의 값과 같습니다.

href (string)

참조 설명서에 대한 링크.