Zevenet 커뮤니티 에디션 API v3.1
ZAPI (Zevenet Application Programming Interface)는 시스템 관리자가 Zevenet로드 밸런서를 제어 할 수있는 도구입니다.
그것은 사용하기 전에 웹 인터페이스에서 zapi 사용자가 활성화해야합니다. 시스템 / 사용자.
zapi 사용자가 생성되면 URL (https : // (zevenet_server) : 444 / zapi / v3.1 / zapi.cgi / (URI_path))에 요청을 보낼 수 있습니다. zevenet_server HTTP 서비스가 수신중인 IP입니다.
URI_path 행동 할 대상이나 행동을 정의합니다. 그의 행동과 그의 매개 변수는 각각의 하나의 교리 섹션 안에서 정의 될 것입니다.
이 API에 사용 된 동사는 바로, POST, PUT or 삭제. PUT 또는 POST 요청에는 필수 매개 변수가 필요하지 않지만 항상 거의 매개 변수가 필요합니다.
인증서
Zevenet은 PEM 형식의 인증서를 HTTPS Listener가있는 HTTP 팜에서 사용할 수 있도록 지원합니다. PEM 인증서를 만드는 방법에 대한 자세한 내용은 다음 문서를 참조하십시오. PEM 형식의 인증서 생성
모든 인증서 나열
모든 인증서 나열
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/certificates
GET /certificates
인증서 저장소에있는 모든 CSR 및 PEM 인증서를 나열하면 해당 인증서를 HTTPS 팜과 함께 사용할 수 있습니다.
응답은 JSON 객체가 될 것입니다. 매개 변수. 이 값은 아래의 키 속성을 포함하는 인증서 객체의 배열입니다.
응답 예 :
{
"description" : "List all certificates",
"params" : [
{
"CN" : "Zen Load Balancer",
"creation" : "Jan 12 14:49:03 2011 GMT",
"expiration" : "Jan 9 14:49:03 2021 GMT",
"file" : "zencert.pem",
"issuer" : "Zen Load Balancer",
"type" : "Certificate"
}
]
}
응답 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 매개 변수 | 개체 [] | 인증서 개체 목록입니다. |
인증서 개체
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| CN | 끈 | 도메인 공통 이름. |
| 창조 | 끈 | 제작 일. |
| 만료 | 끈 | 만료일. |
| 파일 | 끈 | 인증서의 파일 이름, 고유 ID. |
| 발행자 | 끈 | 인증서에 서명 한 공인 기관. |
| 유형 | 끈 | CSR 또는 인증서. |
인증서 다운로드
인증서 다운로드
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/certificates/example.pem
GET /certificates/<file>
인증서 저장소에 설치된 인증서를 다운로드하고 요청의 파일 이름을 사용하여 인증서 저장소를 식별합니다.
응답에는 파일에 대한 정보와 함께 아래에 표시된 헤더가 포함됩니다. 응답의 본문은 파일의 내용이됩니다.
응답 헤더 :
HTTP/1.1 200 OK
Date: Thu, 22 Dec 2016 09:27:47 GMT
Content-Disposition: attachment; filename="example.pem"
Content-Type: application/x-download; charset=ISO-8859-1
Content-Length: 2359
인증서 삭제
인증서 삭제
요청 예 :
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/certificates/example.pem
DELETE /certificates/<file>
인증서 저장소의 파일 이름으로 인증서를 삭제합니다.
응답 예 :
{
"description" : "Delete certificate",
"message" : "The Certificate example.pem has been deleted.",
"success" : "true"
}
CSR 인증서 만들기
CSR 인증서 만들기
요청 예 :
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: application/json'
-d '{"name":"NewCSR","fqdn":"host.domain.com","division":"IT","organization":"Example Corp.",
"locality":"Madrid","state":"Madrid","country":"ES","mail":"info@domain.com"}'
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/certificates
POST /certificates
인증서 서명 요청 (CSR 파일)을 만듭니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| name | 끈 | 인증서 ID 이름. | 참된 |
| fqdn | 끈 | 서버의 정규화 된 도메인 이름입니다. | 참된 |
| 분할 | 끈 | 인증서를 처리하는 조직의 부서. | 참된 |
| 조직 | 끈 | 조직의 법적 이름. | 참된 |
| 소재지 | 끈 | 조직이 위치한 도시입니다. | 참된 |
| 상태 | 끈 | 조직이 위치한 주 / 지역. | 참된 |
| 국가 | 끈 | 조직이 소재한 국가의 두 자리 ISO 코드입니다. | 참된 |
| 우편 | 끈 | 조직에 연락하는 데 사용되는 전자 메일 주소입니다. | 참된 |
응답 예 :
{
"description" : "Create CSR",
"message" : "Certificate NewCSR created",
"success" : "true"
}
인증서 업로드
인증서 업로드
요청 예 :
curl -k -X POST -H "ZAPI_KEY: <ZAPI_KEY_STRING>" -H 'Content-Type: text/plain'
--tcp-nodelay --data-binary @/local_path/to/example.pem
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/certificates/example.pem
POST /certificates/<file>
HTTPS 수신기를 사용하여 HTTP 팜에 대한 PEM 인증서를 업로드합니다.
매개 변수가 필요합니다. --tcp-nodelay --data-binary 바이너리 모드로 파일을 업로드 할 수 있습니다.
URI 매개 변수 요청
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| 파일 | 끈 | 인증서 저장소에 업로드하고 저장할 인증서 파일 이름입니다. | 참된 |
응답 예 :
{
"description" : "Upload PEM certificate",
"message" : "Certificate uploaded",
"success" : "true"
}
목록 암호
목록 암호
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/ciphers
GET /ciphers
HTTPS 팜에서 사용할 수있는 암호를 나열하십시오.
응답은 JSON 객체가 될 것입니다. 매개 변수. 이 값은 아래의 키 속성을 포함하는 인증서 객체의 배열입니다.
응답 예 :
{
"description" : "Get the ciphers available",
"params" : [
{
"ciphers" : "all",
"description" : "All"
},
{
"ciphers" : "highsecurity",
"description" : "High security"
},
{
"ciphers" : "customsecurity",
"description" : "Custom security"
}
]
}
응답 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 매개 변수 | 개체 [] | 인증서 개체 목록입니다. |
인증서 개체
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 암호 | 끈 | 고유 식별자로 사용됩니다. |
| 설명 | 끈 | 친근감있는 이름. |
농장
Zevenet은 서로 다른 세 가지 방법으로 트래픽을 관리 할 수 있습니다. 각 방법은 다른 모듈, 로컬 서비스로드 밸런서 또는 LSLB 모듈 및 Datalink Service로드 밸런서 또는 DSLB 모듈로 관리됩니다.
모든 모듈은 팜 프로필 개념과 함께 작동하며 팜 프로필은 네트워크 트래픽과 관련하여 특별한 조치를 취할 준비가 된 매개 변수 그룹이므로 Zevenet의 최상의 결과를 얻으려면 각 팜 프로필을 수행 할 수있는 기능을 이해하는 것이 중요합니다 ADC.
- LSLB :이 모듈은 HTTP 및 l4xnat 프로필 농장. 웹 역 프록시 또는 라우터로 작동합니다.
- DSLB :이 모듈은 데이터 링크 프로필 팜. 그것은 게이트웨이로 작동합니다.
모든 농장 목록보기
모든 농장 목록보기
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms
GET /farms
사용 가능한 모든 팜 나열
응답은 JSON 객체가 될 것입니다. 매개 변수. 이 값은 팜 재개 개체의 배열이며 각 개체에는 아래의 키 특성이 포함됩니다.
농장 개체
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 농장 이름 | 끈 | 농장 설명 이름입니다. 고유 식별 자로 사용됩니다. |
| 윤곽 | 끈 | 프로파일 유형, 사용 가능한 프로파일 값은 다음과 같습니다. HTTP, HTTPS or l4xnat LSLB 모듈 및 데이터 링크 DSLB 모듈 용 |
| 지위 | 끈 | 농장 상태. 사용 가능한 상태 값은 다음과 같습니다. 아래 (down), 팜이 실행되고 있지 않습니다. 재시작 필요, 팜이 가동되었지만 다시 시작 작업이 보류 중입니다. 임계, 팜이 가동되고 모든 백엔드에 도달 할 수 없거나 유지 관리되고 있습니다. 문제, 팜이 가동 중이고 일부 백엔드에 연결할 수 없지만 거의 백엔드가 상태에 있습니다. 유지, 팜이 가동 중이고 백엔드 상태에 있지만 거의 백엔드가 유지 관리 모드에 있습니다. up, 농장이 가동되고 모든 백엔드가 성공적으로 작동합니다. |
| VIP | 끈 | 팜에서 트래픽을 수신하는 가상 IP |
| vport | 끈 | 팜이 트래픽을 수신하는 가상 포트, 사용 가능한 포트 값 : http [s] 및 l4xnat의 포트 번호, ","로 구분 된 포트 그룹 또는 l4xnat 프로필의 경우 ":"로 구분 된 포트 범위, l4xnat 모두 구분 기호 값 ( ","및 ":")은 동일한 필드에서 사용할 수 있습니다. |
응답 예 :
{
"description" : "List farms",
"params" : [
{
"farmname" : "httpFarm",
"profile" : "http",
"status" : "up",
"vip" : "192.168.101.146",
"vport" : "81"
}
]
}
팜 삭제
팜 삭제
요청 예 :
curl --tlsv1 -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP
DELETE /farms/<farmname>
해당 팜 이름 식별자를 통해 팜을 삭제합니다.
응답 예 :
{
"description" : "Delete farm FarmHTTP",
"message" : "The Farm FarmHTTP has been deleted.",
"success" : "true"
}
팜에서 작업 설정
팜에서 작업 설정
요청 예 :
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"stop"}' https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/FarmTCP/actions
PUT /farms/<farmname>/actions
팜에 작업을 적용하려면 요청 매개 변수 테이블에서 작업을 참조하십시오.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 동작 | 끈 | 원하는 동작을 설정하십시오. 조치는 다음과 같습니다. 중지, 팜이 중지됩니다. 스타트, 팜이 시작되고 다시 시작, 팜이 자동으로 중지되고 시작됩니다. |
응답 예 :
{
"description" : "Set a new action in FarmHTTP",
"params" : [
{
"action" : "stop"
}
]
}
응답 매개 변수
구성에 문제가 없으면 zapi는 요청 된 조치를 리턴합니다.
HTTP 팜
HTTP 프로필은 프록시 특유의 고급 레이어 7로드 균형 조정 (또는 Application Delivery Controller)입니다. 이 프로파일은 HTTPS 계층 7로드 k 런스와 같은 일부 기능을 제공합니다. 이 프로필은 웹 서비스 (웹 응용 프로그램 서버 포함) 및 WebDav, HTTP를 통한 RDP, HTTP를 통한 ICA 등과 같은 HTTP 및 HTTPS 프로토콜을 기반으로하는 모든 응용 프로그램 프로토콜에 적합합니다.이 팜 프로필을 구성하기 위해 가상 IP 주소와 가상 TCP 포트가 필요합니다.
이름으로 팜 검색
이름으로 팜 검색
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/httpFarm
GET /farms/<farmname>
지정된 팜에 대한 모든 구성을 표시합니다.
응답 예 :
{
"description" : "List farm httpFarm",
"params" : {
"certlist" : [
{
"file" : "zencert.pem",
"id" : 1
}
],
"cipherc" : "ALL",
"ciphers" : "all",
"contimeout" : 20,
"disable_sslv2" : "true",
"disable_sslv3" : "false",
"disable_tlsv1" : "false",
"disable_tlsv1_1" : "true",
"disable_tlsv1_2" : "false",
"error414" : "Request URI is too long.",
"error500" : "An internal server error occurred. Please try again later.",
"error501" : "This method may not be used.",
"error503" : "The service is not available. Please try again later.",
"httpverb" : "MSRPCext",
"listener" : "https",
"reqtimeout" : 30,
"restimeout" : 45,
"resurrectime" : 10,
"rewritelocation" : "enabled",
"status" : "up",
"vip" : "192.168.100.211",
"vport" : 200
},
"services" : [
{
"backends" : [],
"fgenabled" : "false",
"fglog" : "false",
"fgscript" : "",
"fgtimecheck" : 5,
"httpsb" : "false",
"id" : "service3",
"leastresp" : "false",
"persistence" : "",
"redirect" : "",
"redirecttype" : "",
"sessionid" : "",
"ttl" : 0,
"urlp" : "",
"vhost" : ""
},
{
"backends" : [
{
"id" : 0,
"ip" : "192.168.0.168",
"port" : 80,
"status" : "up",
"timeout" : null,
"weight" : null
}
],
"fgenabled" : "false",
"fglog" : "false",
"fgscript" : "tcp_check",
"fgtimecheck" : 5,
"httpsb" : "false",
"id" : "srv",
"leastresp" : "false",
"persistence" : "",
"redirect" : "",
"redirecttype" : "",
"sessionid" : "",
"ttl" : 0,
"urlp" : "",
"vhost" : ""
},
]
}
응답 매개 변수
응답은 아래 형식의 JSON 객체가 될 것입니다.
농장 개체 :
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 매개 변수 | 목적 | 팜 구성의 매개 변수입니다. |
| 서비스 | 목적[] | 이 팜에서 생성 된 모든 서비스와 구성으로 구성됩니다. |
HTTP 팜의 매개 변수 객체 :
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 인증 목록 | 목적[] | https 프로필에만 있습니다. 팜에서 활성화 된 인증서는 팜 형식으로 하나의 팜에 하나의 팜 인증서 만 추가 할 수 있습니다. https 값이있는 리스너가 필요합니다. 인증서 저장소에있는 모든 pem 인증서를 여기에서 사용할 수 있습니다. |
| 암호 | 끈 | https 리스너에서만. SSL 연결에서 허용 할 수있는 암호화 된 사용자 지정 목록입니다.이 문자열은 OpenSSL 암호와 같은 형식의 문자열입니다. 이 공헌은 암호 필드의 값은 sutomsecurity입니다. |
| 암호 | 끈 | https 값을 가진 리스너에서만. SSL 연결을 강화하기 위해 SSL 연결에서 허용하는 암호 목록을 작성하는 데 사용됩니다. 옵션은 다음과 같습니다. 모든, 모든 암호가 허용됩니다; 높은 보안 성높은 보안을위한 암호 만 허용됩니다. 또는 맞춤 보안,로드 된 암호 만 암호 필드가 허용됩니다. |
| contimeout | 번호 | 팜이 초 단위로 백엔드에 대한 TCP 연결을 대기하는 기간. |
| disable_sslv2 | 끈 | https 리스너에서만. 이 필드에 값이있는 경우 참된 2 버전의 SSL 보안 프로토콜을 사용하는 연결은 허용되지 않습니다. 또는 그릇된 프로토콜 SSLv2가 허가되고있는 경우. |
| disable_sslv3 | 끈 | https 리스너에서만. 이 필드에 값이있는 경우 참된 3 버전의 SSL 보안 프로토콜을 사용하는 연결은 허용되지 않습니다. 또는 그릇된 프로토콜 SSLv3가 허가되고있는 경우. |
| disable_tlsv1 | 끈 | https 리스너에서만. 이 필드에 값이있는 경우 참된 버전 1의 TLS 보안 프로토콜을 사용하는 연결은 허용되지 않습니다. 또는 그릇된 TLSv1 프로토콜이 허용되면. |
| disable_tlsv1_1 | 끈 | https 리스너에서만. 이 필드에 값이있는 경우 참된 버전 1.1의 TLS 보안 프로토콜을 사용하는 연결은 허용되지 않습니다. 또는 그릇된 TLSv1.1 프로토콜이 허용되면. |
| disable_tlsv1_2 | 끈 | https 리스너에서만. 이 필드에 값이있는 경우 참된 버전 1.2의 TLS 보안 프로토콜을 사용하는 연결은 허용되지 않습니다. 또는 그릇된 TLSv1.2 프로토콜이 허용되면. |
| error414 | 끈 | 414 HTTP 오류 코드로 응답하는 맞춤 메시지. |
| error500 | 끈 | 500 HTTP 오류 코드로 응답하는 맞춤 메시지. |
| error501 | 끈 | 501 HTTP 오류 코드로 응답하는 맞춤 메시지. |
| error503 | 끈 | 503 HTTP 오류 코드로 응답하는 맞춤 메시지. |
| httpverb | 끈 | 이 필드는 HTTP 클라이언트 요청에 허용 할 작업을 나타냅니다. 사용할 수있는 값은 다음과 같습니다. 표준 HTTP, naccepted http 요청 GET, POST, HEAD. extendedHTTP, 이전 HTTP 요청 플러스 PUT, DELETE. standardWebDAV이전 HTTP 요청 및 LOCK, UNLOCK, PROPFIND, PROPPATCH, SEARCH, MKCOL, MOVE, COPY, OPTIONS, TRACE, MKACTIVITY, CHECKOUT, MERGE, REPORT, MSextWebDAV 이전 HTTP 요청 및 가입, 취소, 알림, BPROPFIND, BPROPPATCH, POLL, BMOVE, BCOPY, BDELETE, CONNECT 또는 MSRPCext, 이전 HTTP 요청 플러스 RPC_IN_DATA, RPC_OUT_DATA. 이 값은 대소 문자를 구별합니다. |
| 경청자 | 끈 | 수신기는 클라이언트의 요청으로 팜을 재생하는 방법을 정의합니다. 옵션은 다음과 같습니다. HTTP 보안되지 않은 프로토콜 또는 HTTPS 보안 프로토콜 용. |
| reqtimeout | 번호 | 팜이 클라이언트 요청을 몇 초 만에 기다릴 시간. |
| restimeout | 번호 | 팜이 백엔드의 응답을 몇 초 만에 기다릴 예정입니다. |
| 부활 | 번호 | 이 기간이 지나면 실제 서버가 살아 있는지 (초)로드 밸런서가 검사합니다. |
| 재기록 | 끈 | 이 옵션을 사용하면 가상 호스트가있는 클라이언트에 대한 응답에서 Location : 및 Content-location : 헤더가 팜에서 강제로 수정됩니다. 옵션은 다음과 같습니다. 사용 가능, 활성화 됨 사용, 비활성 또는 enabled-backends 백엔드 주소 만 비교됩니다. |
| 지위 | 끈 | 농장 상태. 사용 가능한 상태 값은 다음과 같습니다. 아래 (down), 팜이 실행되고 있지 않습니다. 재시작 필요, 팜이 가동되었지만 다시 시작 작업이 보류 중입니다. 임계, 팜이 가동되고 모든 백엔드에 도달 할 수 없거나 유지 관리되고 있습니다. 문제, 팜이 가동 중이고 일부 백엔드에 연결할 수 없지만 거의 백엔드가 상태에 있습니다. 유지, 팜이 가동 중이고 백엔드 상태에 있지만 거의 백엔드가 유지 관리 모드에 있습니다. up, 농장이 가동되고 모든 백엔드가 성공적으로 작동합니다. |
| VIP | 끈 | 가상 서비스가 수신하는 팜의 IP |
| vport | 번호 | 가상 서비스가 수신하는 팜의 포트 |
Certlist 객체 :
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 파일 | 끈 | 인증서 이름, 인증서 저장소의 인증서에 대한 참조입니다. |
| id | 번호 | 인증서 ID. |
HTTP 팜용 서비스 개체 :
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 백엔드 | 목적[] | 서비스에 정의 된 백엔드. |
| fgenabled | 끈 | 농장 보호자의 사용을 활성화하십시오. 참된 팜 보호자가 활성화되어 백엔드 상태를 확인하고, 그릇된 팜 보호자가 비활성화되어 백엔드 상태를 확인하지 않습니다. HTTP 프로파일에서 check_tcp는 기본적으로 팜 보호자가 비활성화 된 경우에도 실행됩니다. |
| fglog | 끈 | 팜 보호자의 로그 사용을 활성화합니다. 참된 사용 가능, 그릇된, 장애인. fgenabled 필요합니다. |
| fgscript | 끈 | 농장 보호자가 백엔드 상태를 확인하는 데 사용할 명령. 참된 사용 가능, 그릇된, 장애인. fgenabled 필요합니다. |
| fgtimecheck | 번호 | 농장 보호자는 백엔드 상태를 '확인할 시간'초마다 확인합니다. fgenabled 필요합니다. |
| httpsb | 끈 | 이 매개 변수는 현재 서비스에 정의 된 백엔드 서버가 HTTPS 언어를 사용하고 있으며 데이터가 전송되기 전에 암호화된다는 것을 팜에 나타냅니다. 참된, 프로파일은 HTTPS 프로토콜로 트래픽을 백엔드로 보냅니다. 그릇된, 프로파일은 HTTP 프로토콜로 트래픽을 백엔드로 보냅니다. |
| id | 끈 | 서비스 이름입니다. 서비스가 생성되면 수정할 수 없습니다. |
| 최소값 | 끈 | 그것은 최소한 응답 균형 방법을 가능하게합니다. 참된 자유롭게 프로필은이 백엔드에 더 많은 연결을 보내기 위해 어느 백엔드가 응답하는데 더 적은 시간이 걸리는지 확인합니다. 그릇된 프로필은 응답하는 데 시간이 덜 걸리는 백엔드를 확인하지 않습니다. |
| 고집 | 끈 | 이 매개 변수는 HTTP 서비스가 클라이언트 세션을 관리하는 방법을 정의합니다. 옵션은 다음과 같습니다. "" 빈 문자열, 아무 조치도 취하지 않고, IP 지속성 세션은 클라이언트 IP의 기반으로 이루어지며, BASIC 퍼시스턴스 세션은 BASIC 헤더의 기반으로 이루어지며, URL 영속 세션은 URI의 필드의 기저로 이루어지며, 파름 영속 세션은 URI의 끝에있는 값을 기반으로 이루어지며, COOKIE 지속성 세션은 쿠키 이름을 기반으로 이루어지며,이 쿠키는 백엔드에 의해 만들어 져야하며, 머리글지속성 세션은 헤더 이름을 기반으로 수행됩니다. |
| 리디렉션 | 끈 | 클라이언트 요청이 새 URL로 자동 리디렉션되어 자동으로 응답되므로 특수 백엔드로 작동합니다. 리디렉션이 구성된 경우 요청이 백엔드로 전달되지 않고 리디렉션이 클라이언트에 대신 응답됩니다. |
| redirecttype | 끈 | 리디렉션이 어떻게 수행 될지, 두 가지 옵션 : 디폴트 값, URL은 리다이렉트 할 절대 호스트 및 경로로 간주되며, 추가원래 요청 경로 또는 URI가 기본 옵션으로 지정된 호스트 및 경로에 추가됩니다. 만약 리디렉션 필드가 구성되어 있지 않으면이 필드는 빈 문자열이됩니다. |
| sessionid | 끈 | 다음과 같은 경우 사용 가능합니다. 고집 필드가 URL, COOKIE 또는 HEADER 인 경우 매개 변수 값은 http 헤더에서 팜에 의해 검색되고 클라이언트 세션을 관리합니다. |
| TTL | 번호 | 지속성 만 있으면. 이 값은 비활성 클라이언트 세션 (최대 세션 수명)의 최대 수명 (초)을 나타냅니다. |
| urlp | 끈 | 구문 적으로 검사 할 특정 URL 패턴을 통해 클라이언트가 요청한 URL과 관련된 웹 서비스를 결정할 수 있습니다. PCRE 정규 표현식이 지원됩니다. |
| 유령 | 끈 | HTTP 가상 서버가 정의한 동일한 가상 IP 및 포트를 통해 도메인 이름에 의해 결정되는 조건을 지정합니다. PCRE 정규 표현식이 지원됩니다. |
HTTP 팜의 백엔드 개체 :
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| id | 번호 | 지정된 서비스 내부의 백엔드 식별자. |
| ip | 끈 | 실제 서비스가 실행되는 백엔드의 IP입니다. |
| 포트 | 번호 | 실제 서비스가 실행되는 백엔드의 포트입니다. |
| 지위 | 끈 | 백엔드 상태. 가능한 값은 다음과 같습니다. up, 팜이 실행 중이고 백엔드가 연결을받을 준비가되었습니다. 아래 (down), 팜이 실행 중이고 백 엔드가 작동하지 않는 것으로 서비스에서 감지했습니다. 유지, 백엔드는 관리자가 연결을 수신 할 준비가되지 않은 것으로 표시됩니다.이 옵션은 백엔드의 유지 관리 작업에 유용합니다. 정의되지 않은, 백엔드 상태가 점검되지 않았습니다. |
| 시간 제한 | 번호 | 몇 초 안에 특정 요청에 응답하는 것이 백엔드 시간 초과입니다. 널 시스템이 전역 매개 변수 백엔드 시간 초과를 사용할 경우. |
| 무게 | 번호 | 현재 실제 서버의 가중치 값이며 가중치 값이 높은 백엔드는 더 많은 연결을 수신합니다. 이 백엔드에 사용되는 특수 가중치가 아닌 기본값은 null입니다. |
새 팜 만들기
새 팜 만들기
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"newHTTPfarm", "profile":"http", "vip":"192.168.100.23",
"vport":80}' https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms
POST /farms
새 HTTP 팜을 만듭니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| 농장 이름 | 끈 | 농장 설명 이름입니다. 고유 식별자로 사용됩니다. | 참된 |
| 윤곽 | 끈 | 생성 된 팜의 프로필입니다. http 농장의 경우 HTTP. | 참된 |
| VIP | 끈 | 가상 서비스가 실행될 팜의 IP 표시된 IP가 시스템에 구성되어 있고 UP | 참된 |
| vport | 번호 | 가상 서비스가 수신 대기중인 팜의 포트입니다. 동일한 가상 포트 및 가상 IP를 다른 팜에서 사용하지 않아야합니다. | 참된 |
응답 예 :
{
"description" : "Creating farm 'newHTTPfarm'",
"params" : {
"farmname" : "newHTTPfarm",
"profile" : "http",
"vip" : "192.168.100.23",
"vport" : 80
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
농장 수정
농장 수정
요청 예 :
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"contimeout":22,"newfarmname":"FarmHTTP2","vip":"178.62.126.152","vport":88,"ignore_100_continue":"true",
"restimeout":47,"resurrectime":12,"reqtimeout":32,"rewritelocation":"enabled","httpverb":"standardHTTP",
"error414":"Message error 414","error500":"Message error 500","error501":"Message error 501",
"error503":"Message error 503","listener":"https","ciphers":"customsecurity","disable_sslv2":"true",
"disable_sslv3":"false","disable_tlsv1":"false","disable_tlsv1_1":"true","disable_tlsv1_2":"false",
"cipherc":"TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*"}' https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP
PUT /farms/<farmname>
지정된 HTTP 팜에 대한 전역 매개 변수를 수정합니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| contimeout | 번호 | 팜이 백엔드에 대한 연결을 몇 초 만에 기다릴 시간. |
| restimeout | 번호 | 팜이 백엔드의 응답을 몇 초 만에 기다릴 예정입니다. |
| 부활 | 번호 | 이 값은 블랙리스트에 기록 된 백엔드를 얻는 기간이며, 살아 있는지 확인합니다. |
| reqtimeout | 번호 | 팜이 클라이언트 요청을 몇 초 만에 기다릴 시간. |
| disable_sslv2 | 끈 | https 리스너에서만. 이 필드에 값이있는 경우 참된 2 버전의 SSL 보안 프로토콜을 사용하는 연결은 허용되지 않습니다. 또는 그릇된 프로토콜 SSLv2가 허가되고있는 경우. |
| disable_sslv3 | 끈 | https 리스너에서만. 이 필드에 값이있는 경우 참된 3 버전의 SSL 보안 프로토콜을 사용하는 연결은 허용되지 않습니다. 또는 그릇된 프로토콜 SSLv3가 허가되고있는 경우. |
| disable_tlsv1 | 끈 | https 리스너에서만. 이 필드에 값이있는 경우 참된 버전 1의 TLS 보안 프로토콜을 사용하는 연결은 허용되지 않습니다. 또는 그릇된 TLSv1 프로토콜이 허용되면. |
| disable_tlsv1_1 | 끈 | https 리스너에서만. 이 필드에 값이있는 경우 참된 버전 1.1의 TLS 보안 프로토콜을 사용하는 연결은 허용되지 않습니다. 또는 그릇된 TLSv1.1 프로토콜이 허용되면. |
| disable_tlsv1_2 | 끈 | https 리스너에서만. 이 필드에 값이있는 경우 참된 버전 1.2의 TLS 보안 프로토콜을 사용하는 연결은 허용되지 않습니다. 또는 그릇된 경우 |
| 재기록 | 끈 | 이 옵션을 사용하면 가상 호스트가있는 클라이언트에 대한 응답에서 Location : 및 Content-location : 헤더가 팜에서 강제로 수정됩니다. 옵션은 다음과 같습니다. 사용 가능, 활성화 됨 사용, 비활성 또는 enabled-backends 백엔드 주소 만 비교됩니다. |
| httpverb | 끈 | 이 필드는 HTTP 클라이언트 요청에 허용 할 작업을 나타냅니다. 사용할 수있는 값은 다음과 같습니다. 표준 HTTP, naccepted http 요청 GET, POST, HEAD. extendedHTTP, 이전 HTTP 요청 플러스 PUT, DELETE. standardWebDAV이전 HTTP 요청 및 LOCK, UNLOCK, PROPFIND, PROPPATCH, SEARCH, MKCOL, MOVE, COPY, OPTIONS, TRACE, MKACTIVITY, CHECKOUT, MERGE, REPORT, MSextWebDAV 이전 HTTP 요청 및 가입, 취소, 알림, BPROPFIND, BPROPPATCH, POLL, BMOVE, BCOPY, BDELETE, CONNECT 또는 MSRPCext, 이전 HTTP 요청 플러스 RPC_IN_DATA, RPC_OUT_DATA. 이 값은 대소 문자를 구별합니다. |
| error414 | 끈 | 맞춤 메시지 오류 414. |
| error500 | 끈 | 맞춤 메시지 오류 500. |
| error501 | 끈 | 맞춤 메시지 오류 501. |
| error503 | 끈 | 맞춤 메시지 오류 503. |
| 경청자 | 끈 | 수신기는 클라이언트의 요청으로 팜을 재생하는 방법을 정의합니다. 옵션은 다음과 같습니다. HTTP 보안되지 않은 프로토콜 또는 HTTPS 보안 프로토콜 용. |
| 암호 | 끈 | https 값을 가진 리스너에서만. SSL 연결을 강화하기 위해 SSL 연결에서 허용하는 암호 목록을 작성하는 데 사용됩니다. 옵션은 다음과 같습니다. 모든, 모든 암호가 허용됩니다; 높은 보안 성높은 보안을위한 암호 만 허용됩니다. 또는 맞춤 보안,로드 된 암호 만 암호 필드가 허용됩니다. |
| 암호 | 끈 | https 리스너에서만. SSL 연결에서 허용 할 수있는 암호화 된 사용자 지정 목록입니다.이 문자열은 OpenSSL 암호와 같은 형식의 문자열입니다. 이 공헌은 암호 필드의 값은 sutomsecurity입니다. |
| newfarmname | 끈 | 새 농장의 이름. 농장을 중지해야합니다. |
| vport | 번호 | 가상 서비스가 수신하는 팜의 포트 |
| VIP | 끈 | 가상 서비스가 수신 대기중인 팜의 IP.이 IP는 시스템에 구성되어 있어야합니다. |
응답 예 :
{
"description" : "Modify farm FarmHTTP",
"params" : {
"cipherc" : "TLSv1+SSLv3+HIGH:-MEDIUM:-LOW*:-ADH*",
"ciphers" : "customsecurity",
"contimeout" : 22,
"disable_sslv2" : "true",
"disable_sslv3" : "false",
"disable_tlsv1" : "false",
"disable_tlsv1_1" : "true",
"disable_tlsv1_2" : "false",
"error414" : "Message error 414",
"error500" : "Message error 500",
"error501" : "Message error 501",
"error503" : "Message error 503",
"httpverb" : "standardHTTP",
"listener" : "https",
"newfarmname" : "FarmHTTP",
"reqtimeout" : 32,
"restimeout" : 47,
"resurrectime" : 12,
"rewritelocation" : "enabled",
"vip" : "178.62.126.152",
"vport" : 88
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
인증서 추가
인증서 추가
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"file":"example.pem"}' https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/httpFarm/certificates
POST /farms/<farmname>/certificates
HTTPS 수신기가있는 HTTP 팜의 PEM 인증서를 변경합니다. 사용 된 인증서는 이미 시스템에 업로드되어 있어야합니다. 인증서> 모든 인증서 나열 사용 가능한 인증서 목록.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| 파일 | 끈 | 인증서 파일 이름은 이전에 인증서가 시스템에 업로드되어야합니다. | 참된 |
응답 예 :
{
"description" : "Add certificate",
"message" : "The certificate example.pem has been added to the farm httpFarm, you need restart the farm to apply",
"success" : "true",
"status": "needed restart"
}
HTTP - 서비스
HTTP 프로필 팜 내의 서비스는 모든 클라이언트 요청에 대해 올바른 서비스를 일치시키기 위해 팜 핵심에서 사용되는 결정적 조건을 통해 여러 속성, 백엔드 또는 지속성 방법을 사용하여 여러 웹 서비스를 제공하는 콘텐츠 전환 방법을 제공합니다. 이 서비스 정의는 클라이언트에 응답을 제공 할 수있는 백엔드 서버를 결정하기 위해 팜에서 사용됩니다.
내부 서비스 객체에는 두 가지 종류의 값이 있습니다 : 서비스 관련 및 Farmguardian 관련.
Farmguardian은 백엔드의 고급 모니터링 상태에 사용되고 현재 서비스에 대한 사용자 고유의 스크립트로 완전히 맞춤화됩니다. Farmguardian에서 문제를 감지하면 실제 서버가 자동으로 비활성화되고 블랙리스트로 표시됩니다.
ID로 서비스 검색
ID로 서비스 검색
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/cookiefarm/services/serv
GET /farms/<farmname>/services/<id>
특정 서비스에 대한 모든 구성을 표시합니다.
응답 예 :
{
"description" : "Get services of a farm",
"services" : {
"backends" : [
{
"id" : 0,
"ip" : "192.168.100.254",
"port" : 80,
"status" : "up",
"timeout" : 20,
"weight" : null
},
{
"id" : 0,
"ip" : "192.168.100.254",
"port" : 80,
"status" : "up",
"timeout" : null,
"weight" : null
}
],
"fgenabled" : "false",
"fglog" : "false",
"fgscript" : "check_tcp -H HOST -p PORT",
"fgtimecheck" : 5,
"httpsb" : "false",
"id" : "serv",
"leastresp" : "false",
"persistence" : "COOKIE",
"redirect" : "",
"redirecttype" : "",
"sessionid" : "JSESSIONID",
"ttl" : 18,
"urlp" : "(?i)^/music$",
"vhost" : ""
}
}
응답 매개 변수
응답은 아래 형식의 JSON 객체가 될 것입니다.
HTTP 팜용 서비스 개체 :
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 백엔드 | 목적[] | 서비스에 정의 된 백엔드. |
| fgenabled | 끈 | 농장 보호자의 사용을 활성화하십시오. 참된 팜 보호자가 활성화되어 백엔드 상태를 확인하고, 그릇된 팜 보호자가 비활성화되어 백엔드 상태를 확인하지 않습니다. HTTP 프로파일에서 check_tcp는 기본적으로 팜 보호자가 비활성화 된 경우에도 실행됩니다. |
| fglog | 끈 | 팜 보호자의 로그 사용을 활성화합니다. 참된 사용 가능, 그릇된, 장애인. fgenabled 필요합니다. |
| fgscript | 끈 | 농장 보호자가 백엔드 상태를 확인하는 데 사용할 명령. 참된 사용 가능, 그릇된, 장애인. fgenabled 필요합니다. |
| fgtimecheck | 번호 | 농장 보호자는 백엔드 상태를 '확인할 시간'초마다 확인합니다. fgenabled 필요합니다. |
| httpsb | 끈 | 이 매개 변수는 현재 서비스에 정의 된 백엔드 서버가 HTTPS 언어를 사용하고 있으며 데이터가 전송되기 전에 암호화된다는 것을 팜에 나타냅니다. 참된, 프로파일은 HTTPS 프로토콜로 트래픽을 백엔드로 보냅니다. 그릇된, 프로파일은 HTTP 프로토콜로 트래픽을 백엔드로 보냅니다. |
| id | 끈 | 서비스 이름입니다. 서비스가 생성되면 수정할 수 없습니다. |
| 최소값 | 끈 | 그것은 최소한 응답 균형 방법을 가능하게합니다. 참된 자유롭게 프로필은이 백엔드에 더 많은 연결을 보내기 위해 어느 백엔드가 응답하는데 더 적은 시간이 걸리는지 확인합니다. 그릇된 프로필은 응답하는 데 시간이 덜 걸리는 백엔드를 확인하지 않습니다. |
| 고집 | 끈 | 이 매개 변수는 HTTP 서비스가 클라이언트 세션을 관리하는 방법을 정의합니다. 옵션은 다음과 같습니다. "" 빈 문자열, 아무 조치도 취하지 않고, IP 지속성 세션은 클라이언트 IP의 기반으로 이루어지며, BASIC 퍼시스턴스 세션은 BASIC 헤더의 기반으로 이루어지며, URL 영속 세션은 URI의 필드의 기저로 이루어지며, 파름 영속 세션은 URI의 끝에있는 값을 기반으로 이루어지며, COOKIE 지속성 세션은 쿠키 이름을 기반으로 이루어지며,이 쿠키는 백엔드에 의해 만들어 져야하며, 머리글지속성 세션은 헤더 이름을 기반으로 수행됩니다. |
| 리디렉션 | 끈 | 클라이언트 요청이 새 URL로 자동 리디렉션되어 자동으로 응답되므로 특수 백엔드로 작동합니다. 리디렉션이 구성된 경우 요청이 백엔드로 전달되지 않고 리디렉션이 클라이언트에 대신 응답됩니다. |
| redirecttype | 끈 | 리디렉션이 어떻게 수행 될지, 두 가지 옵션 : 디폴트 값, URL은 리다이렉트 할 절대 호스트 및 경로로 간주되며, 추가원래 요청 경로 또는 URI가 기본 옵션으로 지정된 호스트 및 경로에 추가됩니다. 만약 리디렉션 필드가 구성되어 있지 않으면이 필드는 빈 문자열이됩니다. |
| sessionid | 끈 | 다음과 같은 경우 사용 가능합니다. 고집 필드가 URL, COOKIE 또는 HEADER 인 경우 매개 변수 값은 http 헤더에서 팜에 의해 검색되고 클라이언트 세션을 관리합니다. |
| TTL | 번호 | 지속성 만 있으면. 이 값은 비활성 클라이언트 세션 (최대 세션 수명)의 최대 수명 (초)을 나타냅니다. |
| urlp | 끈 | 구문 적으로 검사 할 특정 URL 패턴을 통해 클라이언트가 요청한 URL과 관련된 웹 서비스를 결정할 수 있습니다. PCRE 정규 표현식이 지원됩니다. |
| 유령 | 끈 | HTTP 가상 서버가 정의한 동일한 가상 IP 및 포트를 통해 도메인 이름에 의해 결정되는 조건을 지정합니다. PCRE 정규 표현식이 지원됩니다. |
HTTP 팜의 백엔드 개체 :
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| id | 번호 | 지정된 서비스 내부의 백엔드 식별자. |
| ip | 끈 | 실제 서비스가 실행되는 백엔드의 IP입니다. |
| 포트 | 번호 | 실제 서비스가 실행되는 백엔드의 포트입니다. |
| 지위 | 끈 | 백엔드 상태. 가능한 값은 다음과 같습니다. up, 팜이 실행 중이고 백엔드가 연결을받을 준비가되었습니다. 아래 (down), 팜이 실행 중이고 백 엔드가 작동하지 않는 것으로 서비스에서 감지했습니다. 유지, 백엔드는 관리자가 연결을 수신 할 준비가되지 않은 것으로 표시됩니다.이 옵션은 백엔드의 유지 관리 작업에 유용합니다. 정의되지 않은, 백엔드 상태가 점검되지 않았습니다. |
| 시간 제한 | 번호 | 몇 초 안에 특정 요청에 응답하는 것이 백엔드 시간 초과입니다. 널 시스템이 전역 매개 변수 백엔드 시간 초과를 사용할 경우. |
| 무게 | 번호 | 현재 실제 서버의 가중치 값이며 가중치 값이 높은 백엔드는 더 많은 연결을 수신합니다. 이 백엔드에 사용되는 특수 가중치가 아닌 기본값은 null입니다. |
새 서비스 만들기
새 서비스 만들기
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"id":"newserv"}' https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP/services
POST /farms/<farmname>/services
주어진 HTTP 프로필 Farm에서 서비스를 만듭니다. 이 변경 내용을 적용하려면 팜에서 다시 시작 작업이 필요합니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| id | 끈 | 고유 식별자로 사용되는 서비스 이름. 영숫자 값만 허용됩니다. | 참된 |
응답 예 :
{
"description" : "New service newserv",
"params" : {
"id" : "newserv"
},
"status" : "needed restart"
}
서비스 수정
서비스 수정
요청 예 :
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"vhost":"www.mywebserver.com","urlp":"^/myapp1$","persistence":"URL",
"redirect":"http://zenloadbalancer.com","ttl":125,"sessionid":"sid","leastresp":"true",
"httpsb":"true"}' https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP/services/sev2
PUT /farms/<farmname>/services/<id>
HTTP 프로파일에서 서비스의 매개 변수를 수정하십시오. id 수정 될 서비스 고유 식별자입니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 유령 | 끈 | HTTP 프로필 팜에서 정의한 동일한 가상 IP 및 포트를 통해 도메인 이름에 의해 결정되는 조건을 지정합니다. PCRE 정규 표현식이 지원됩니다. |
| urlp | 끈 | 구문 적으로 검사 할 특정 URL 패턴을 통해 클라이언트가 요청한 URL과 관련된 웹 서비스를 결정할 수 있습니다. PCRE 정규 표현식이 지원됩니다. |
| 리디렉션 | 끈 | 특별한 백엔드로 작동하며 클라이언트 요청은 새 URL로 자동으로 리디렉션됩니다. |
| redirecttype | 끈 | 리디렉션이 어떻게 수행 될지, 두 가지 옵션 : 디폴트 값, URL은 리다이렉트 할 절대 호스트 및 경로로 간주되며, 추가, 원래 요청 경로 또는 URI가 호스트에 추가되고에서 지정한 경로 리디렉션 들. 이 동작은 다음 경우에만 적용됩니다. 리디렉션 빈 값이 아닙니다. |
| 고집 | 끈 | 이 매개 변수는 HTTP 서비스가 클라이언트 세션을 관리하는 방법을 정의합니다. 옵션은 다음과 같습니다. "" 빈 문자열, 아무 조치도 취하지 않고, IP 지속성 세션은 클라이언트 IP의 기반으로 이루어지며, BASIC 퍼시스턴스 세션은 BASIC 헤더의 기반으로 이루어지며, URL 영속 세션은 URI의 필드의 기저로 이루어지며, 파름 지속성 세션은 ";"로 구분 된 값을 기준으로 수행됩니다. URI 끝에서 COOKIE 지속성 세션은 쿠키 이름을 기반으로 이루어지며,이 쿠키는 백엔드에 의해 만들어 져야하며, 머리글지속성 세션은 헤더 이름을 기반으로 수행됩니다. |
| TTL | 번호 | 지속성 만 있으면. 비활성 클라이언트 세션의 최대 수명 (최대 세션 수명) (초). |
| sessionid | 끈 | 다음과 같은 경우 사용 가능합니다. 고집 필드 URL, COOKIE or 머리글매개 변수 값은 http 헤더의 프로필에 의해 검색되고 클라이언트 세션을 관리합니다. |
| 최소값 | 끈 | 그것은 최소한 응답 균형 방법을 가능하게합니다. 참된, 더 많은 연결을 보내려면 백엔드가 응답하는 데 걸리는 시간이 짧아지는 프로필 검사가 자유 롭습니다. 그릇된, 프로필은 응답하는 데 시간이 덜 걸리는 백엔드를 확인하지 않습니다. |
| httpsb | 끈 | 팜에 현재 서비스에 정의 된 백엔드 서버가 HTTPS 언어를 사용 중임을 나타내면 데이터가 전송되기 전에 암호화됩니다. 참된, 프로파일은 HTTPS 프로토콜로 트래픽을 백엔드로 보냅니다. 그릇된, 프로파일은 HTTP 프로토콜로 트래픽을 백엔드로 보냅니다. |
응답 예 :
{
"description" : "Modify service newsrv in farm newHTTPfarm",
"info" : "There're changes that need to be applied, stop and start farm to apply them!",
"params" : {
"backends" : [],
"fgenabled" : "false",
"fglog" : "false",
"fgscript" : "",
"fgtimecheck" : 5,
"httpsb" : "true",
"id" : "newsrv",
"leastresp" : "true",
"persistence" : "",
"redirect" : "http://zenloadbalancer.com",
"redirecttype" : "default",
"sessionid" : "sid",
"ttl" : 125,
"urlp" : "^/myapp1$",
"vhost" : "www.mywebserver.com"
},
"status" : "needed restart"
}
응답 매개 변수
응답은 요청 된 매개 변수가 업데이트 된 json이고 지위 필드 재시작 필요 값. 변경 사항을 적용하려면 다시 시작 작업을 수행해야합니다.
농장 보호자 수정
농장 보호자 수정
요청 예 :
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"fgtimecheck":5,"fgscript":"check_tcp","fgenabled":"true",
"fglog":"true","service":"service1"}' https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP/fg
Farmguardian은 백엔드의 고급 모니터링 상태에 사용되고 현재 서비스에 대한 사용자 고유의 스크립트로 완전히 맞춤화됩니다. Farmguardian에서 문제를 감지하면 실제 서버가 자동으로 비활성화되고 블랙리스트로 표시됩니다.
PUT /farms/<farmname>/fg
지정된 HTTP 프로필에서 팜 보호자의 매개 변수를 수정합니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| fgtimecheck | 번호 | 농장 보호자는 '확인할 시간'초마다 백엔드 상태를 확인합니다. | |
| fgscript | 끈 | 백 엔드의 상태를 확인하기 위해 팜 보호자가 실행할 명령 | |
| fgenabled | 끈 | 지정된 서비스에서 농장 보호자를 허용합니다. 참된 농장 보호자는 백엔드 상태를 확인하는 데 사용됩니다. 그릇된 농장 수호자가 사용할 수 없게 될 것입니다. | |
| fglog | 끈 | 팜 보호자의 로그 사용을 활성화합니다. 참된 농장 보호자는 어떤 행동을 기록 할 것입니다. 그릇된 농장 수호자는 어떤 행동을 기록하지 않을 것이므로, fglog 문제 해결을 위해서만 사용하십시오. | |
| 서비스 | 끈 | 고유 식별자로 사용되는 서비스 이름입니다. | 참된 |
응답 예 :
{
"description" : "Modify farm FarmHTTP",
"params" : {
"fgenabled" : "true",
"fglog" : "true",
"fgscript" : "checktcp",
"fgtimecheck" : 5,
"service" : "service1"
}
}
서비스 삭제
서비스 삭제
요청 예 :
curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP/services/service1
DELETE /farms/<farmname>/services/<id>
http 프로필의 지정된 서비스를 삭제합니다. id 삭제 될 서비스 고유 식별자입니다.
응답 예 :
{
"description" : "Delete service service1 in farm FarmHTTP",
"message" : "The service service1 in farm FarmHTTP has been deleted.",
"success" : "true",
"status": "needed restart"
}
HTTP - 서비스 - 백엔드
백엔드 나열
백엔드 나열
요청 예 :
curl -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/httpfarm/services/service1/backends
GET /farms/<farmname>/services/<id>/backends
서비스에서 백엔드 목록을 가져옵니다. id 서비스 고유 식별자입니다.
응답 예 :
{
"description" : "List service backends",
"params" : [
{
"id" : 0,
"ip" : "192.168.0.10",
"port" : 88,
"status" : "up",
"timeout" : 12,
"weight" : 1
},
{
"id" : 1,
"ip" : "192.168.102.245",
"port" : 80,
"status" : "up",
"timeout" : 22,
"weight" : 2
}
]
}
응답 매개 변수
이 호출은 벨로우즈 매개 변수가있는 백엔드 객체 배열을 반환합니다.
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| id | 번호 | 서비스의 백엔드에 대한 고유 식별자입니다. 이 식별자는 시스템에 의해 생성됩니다. |
| ip | 끈 | 실제 서비스가 수신하는 백엔드의 IP입니다. |
| 포트 | 번호 | 실제 서비스가 수신하는 백엔드의 포트입니다. |
| 시간 제한 | 번호 | 몇 초 안에 특정 요청에 응답하는 것이 백엔드 시간 초과입니다. |
| 무게 | 번호 | 현재 백엔드의 가중치 값입니다. |
| 지위 | 끈 | 백엔드 상태. 가능한 값은 다음과 같습니다. up, 팜이 실행 중이고 백엔드가 연결을받을 준비가되었습니다. 아래 (down), 팜이 실행 중이고 백 엔드가 작동하지 않는 것으로 서비스에서 감지했습니다. 유지, 백엔드는 관리자가 연결을 수신 할 준비가되지 않은 것으로 표시됩니다.이 옵션은 백엔드의 유지 관리 작업에 유용합니다. 정의되지 않은, 백엔드 상태가 점검되지 않았습니다. |
새 백엔드 만들기
새 백엔드 만들기
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.102.244","port":80, "weight":2,"timeout":2}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/httpfarm/services/newsrv/backends
POST /farms/<farmname>/services/<id>/backends
주어진 HTTP 프로파일에 새 백엔드를 작성하십시오. id 서비스 고유 식별자입니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| ip | 끈 | 실제 서비스가 수신하는 백엔드의 IP입니다. | 참된 |
| 포트 | 번호 | 실제 서비스가 수신하는 백엔드의 포트입니다. | 참된 |
| 시간 제한 | 번호 | 특정 요청에 응답하는 것은 백엔드 시간 초과입니다. | |
| 무게 | 번호 | 현재 백엔드의 가중치 값입니다. |
응답 예 :
{
"description" : "New service backend",
"message" : "Added backend to service succesfully",
"params" : {
"id" : 0,
"ip" : "192.168.102.244",
"port" : 80,
"timeout" : 2,
"weight" : 2
},
"status" : "needed restart"
}
응답 매개 변수
응답은 요청 된 매개 변수가 업데이트 된 json이고 지위 필드 재시작 필요 팜을 다시 시작해야하는 경우 값입니다. 변경 사항을 적용하려면 다시 시작 작업을 수행해야합니다.
백엔드 수정
백엔드 수정
요청 예 :
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.0.10","port":88,"timeout":12,"service":"sev2", "weight":1}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/FarmHTTP/service/service1/backends/1
PUT /farms/<farmname>/service/<id>/backends/<id>
HTTP 프로파일의 서비스에서 i 엔드의 매개 변수를 수정하십시오.
이름 id 서비스 고유 식별자입니다. id 백엔드 고유 식별자입니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| ip | 끈 | 실제 서비스가 수신하는 백엔드의 IP입니다. |
| 포트 | 번호 | 실제 서비스가 수신하는 백엔드의 포트입니다. |
| 시간 제한 | 번호 | 몇 초 안에 특정 요청에 응답하는 것이 백엔드 시간 초과입니다. |
| 무게 | 번호 | 현재 백엔드의 가중치 값입니다. |
응답 예 :
{
"description" : "Modify service backend",
"info" : "There're changes that need to be applied, stop and start farm to apply them!",
"message" : "Backend modified",
"params" : {
"ip" : "192.168.0.10",
"port" : 88,
"timeout" : 12,
"weight" : 1
},
"status" : "needed restart"
}
응답 매개 변수
응답은 요청 된 매개 변수가 업데이트 된 json이고 지위 필드 재시작 필요 팜을 다시 시작해야하는 경우 값입니다. 변경 사항을 적용하려면 다시 시작 작업을 수행해야합니다.
유지 보수의 백엔드
유지 보수의 백엔드
요청 예 :
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"maintenance","mode":"cut"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/httpfarm/services/newsrv/backends/0/maintenance
PUT /farms/<farmname>/services/<id>/backends/<id>/maintenance
HTTP 팜의 백엔드에서 특정 동작을 설정하면 사용 가능한 동작이 아래에 설명되어 있습니다.
이름 id 서비스 고유 식별자입니다. id 백엔드 고유 식별자입니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| 동작 | 끈 | 원하는 동작을 설정하십시오. 조치는 다음과 같습니다. up 백엔드는 클라이언트 요청을 수신 할 준비가되어 있으며, 유지 백엔드가 클라이언트 요청을 수신 할 준비가되지 않은 경우이 작업은 클라이언트에 영향을 미치지 않고 백엔드 서버를 중지 할 때 유용합니다. | 참된 |
| 모드 | 끈 | 유지 관리 모드를 선택하십시오. 사용 가능한 옵션은 다음과 같습니다. 배수, 백엔드는 새 연결을 허용하지 않지만 현재 연결을 계속 처리합니다. 또는 절단현재 연결이 닫힙니다. | 이 필드를 지정하지 않으면 기본 모드가됩니다. 배수. |
응답 예 :
{
"description" : "Set service backend status",
"params" : {
"action" : "maintenance",
"mode" : "cut"
}
}
백엔드 삭제
백엔드 삭제
요청 예 :
curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/newfarmHTTP/services/service1/backends/4
DELETE /farms/<farmname>/services/<id>/backends/<id>
HTTP 프로파일의 서비스에서 주어진 백엔드를 삭제하십시오.
이름 id 서비스 고유 식별자입니다. id 백엔드 고유 식별자입니다.
응답 예 :
{
"description" : "Delete service backend",
"message" : "Backend removed",
"success" : "true"
}
L4xNAT 농장
L4xNAT 프로필 팜은 HTTP 팜 프로필과 같은 4 계층의 부하 분산 장치 코어보다 훨씬 높은 성능과 동시 연결을 사용하는 L7 팜을 만들 수 있습니다. 이 레이어의 4 성능 향상은 7 프로필이 관리 할 수있는 고급 콘텐츠 처리를 방해합니다.
또한 L4xNAT 팜은 다른 계층 7 프로필과 함께 사용되는 하나의 가상 포트뿐만 아니라 다양한 포트를 바인딩 할 수 있습니다. L4xNAT 팜에서 가상 포트 범위 또는 특정 가상 포트를 선택할 수 있으려면 프로토콜 유형을 선택해야합니다. 다른 경우 팜은 가상 IP의 모든 포트에서 수신 대기합니다 (문자 ''). TCP 또는 UDP 프로토콜이 선택되면 포트를 지정할 수있게되며 ','사이의 여러 포트와 ':'사이의 포트 범위 또는 ''. 이들 모두의 조합도 유효합니다.
이름으로 팜 검색
이름으로 팜 검색
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm
GET /farms/<farmname>
지정된 팜에 대한 모든 구성을 표시합니다.
응답 BODY :
{
"backends" : [
{
"id" : 0,
"ip" : "192.168.55.40",
"max_conns" : 0,
"port" : "88",
"priority" : 2,
"status" : "undefined",
"weight" : 1
},
{
"id" : 1,
"ip" : "192.168.55.41",
"max_conns" : 0,
"port" : "88",
"priority" : 3,
"status" : "undefined",
"weight" : 2
}
],
"description" : "List farm l4farm",
"params" : {
"algorithm" : "weight",
"fgenabled" : "false",
"fglog" : "false",
"fgscript" : "",
"fgtimecheck" : 5,
"listener" : "l4xnat",
"nattype" : "nat",
"persistence" : "",
"protocol" : "tcp",
"status" : "down",
"ttl" : 120,
"vip" : "192.168.100.241",
"vport" : "88"
}
}
응답 매개 변수
응답은 아래 형식의 JSON 객체가 될 것입니다.
농장 개체 :
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 매개 변수 | 목적 | 팜 구성의 매개 변수입니다. |
| 백엔드 | 목적[] | 이 팜에서 생성 된 모든 실제 서버 및 해당 구성. |
L4xNAT 팜의 매개 변수 개체 :
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 연산 | 끈 | 팜에서 사용되는로드 균형 조정 알고리즘의 유형입니다. 옵션은 다음과 같습니다. 최소 접속 항상 최소 연결 서버에 연결, 무게 연결 선형 파견, 프리 오 연결은 항상 가장 중요한 프리 오가 있습니다. |
| 경청자 | 끈 | 리스너는 팜이 클라이언트의 요청을 처리하는 방법을 정의합니다. 정보 필드는 수정할 수 없습니다. |
| Nattype | 끈 | 로드 밸런서 레이어 4 코어가 작동하는 방법. 옵션은 다음과 같습니다. NAT sNAT 모드라고도하는 백엔드는 클라이언트에 응답을 보내려면로드 밸런서에 응답하고, 담낭 백엔드가 클라이언트에 직접 응답하므로로드 밸런서를 백엔드 서버에 게이트웨이로 구성해야합니다. |
| 고집 | 끈 | 동일한 IP 주소가 동일한 서버에 연결됩니다. 옵션은 다음과 같습니다. "" 빈 값, 지속성이 비활성화 됨, ip 지속성이 활성화되면 원본 IP가 세션의 고유 ID처럼 사용됩니다. |
| 프로토콜 | 끈 | 4 계층에서 균형을 유지할 프로토콜. 옵션은 다음과 같습니다. 모든 프로필은 모든 L4 프로토콜의로드 균형을 조정합니다. TCP 로드 밸런서 만 TCP L4 프로토콜의 균형을 유지합니다. udp 로드 밸런서 만 UDP L4 프로토콜의 균형을 유지합니다. 한모금 로드 밸런서 만 SIP 또는 VoIP L7 프로토콜의 균형을 유지하며, FTP 로드 밸런서 만 FTP L7 프로토콜의 균형을 유지합니다. TFTP 로드 밸런서 만 TFTP L7 프로토콜과 균형을 유지합니다. |
| 지위 | 끈 | 농장 상태. 사용 가능한 상태 값은 다음과 같습니다. 아래 (down), 팜이 실행되고 있지 않습니다. 재시작 필요, 팜이 가동되었지만 다시 시작 작업이 보류 중입니다. 임계, 팜이 가동되고 모든 백엔드에 도달 할 수 없거나 유지 관리되고 있습니다. 문제, 팜이 가동 중이고 일부 백엔드에 연결할 수 없지만 거의 백엔드가 상태에 있습니다. 유지, 팜이 가동 중이고 백엔드 상태에 있지만 거의 백엔드가 유지 관리 모드에 있습니다. up, 농장이 가동되고 모든 백엔드가 성공적으로 작동합니다. |
| TTL | 번호 | 이 필드 값은 클라이언트 소스와 백엔드 간의 지속성이 할당되는 초 수를 초 단위로 나타냅니다. 지속성을 구성해야합니다. |
| VIP | 끈 | 가상 서비스가 수신하는 팜의 IP |
| vport | 끈 | 가상 서비스가 수신하는 팜의 포트 고유 한 포트를 지정할 수 있으며, 범위 포트는 분리 자로 구체화 할 수 있습니다 : 분리기로 여러 개의 포트를 지정할 수 있습니다. ,. |
| fgenabled | 끈 | 농장 보호자의 사용을 활성화합니다. 참된 농장 보호자가 활성화되면, 그릇된 농장 보호자는 사용할 수 없습니다. |
| fglog | 끈 | 팜 보호자의 로그 사용을 활성화합니다. fgenabled 사용하도록 설정해야합니다. |
| fgscript | 끈 | 농장 수호자가 확인할 명령. 사용 가능한 명령은 libexec 경로에 있습니다. fgenabled 사용하도록 설정해야합니다. |
| fgtimecheck | 번호 | 농장 보호자는 각 '체크 시간'초를 확인합니다. fgenabled 사용하도록 설정해야합니다. |
L4xNAT 팜의 백 엔드 개체 :
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| id | 번호 | ID는 팜의 백엔드를 식별합니다. |
| ip | 끈 | 실제 서비스가 수신하는 백엔드의 IP입니다. |
| max_conns | 번호 | 백엔드에 대한 최대 동시 연결 수입니다. 이 필드의 값이 0이면 백엔드가 연결 제한을 구성하지 않은 것입니다. |
| 포트 | 번호 | 실제 서비스가 수신하는 백엔드의 포트입니다. 빈 값이 허용되며 가상 포트와 동일한 구성을 사용합니다. |
| 지위 | 끈 | 백엔드 상태. 가능한 값은 다음과 같습니다. up, 팜이 실행 중이고 백엔드가 연결을받을 준비가되었습니다. 아래 (down), 팜이 실행 중이고 백 엔드가 작동하지 않는 것으로 서비스에서 감지했습니다. 유지, 백엔드는 관리자가 연결을 수신 할 준비가되지 않은 것으로 표시됩니다.이 옵션은 백엔드의 유지 관리 작업에 유용합니다. 정의되지 않은, 백엔드 상태가 점검되지 않았습니다. |
| 우선 | 번호 | 현재 실제 서버의 우선 순위 값입니다. 1이 가장 우선 순위가 높은 곳에서 항상 가장 가능성있는 연결로 연결합니다. |
| 무게 | 번호 | 현재 실제 서버의 가중치 값입니다. 가중치가 더 큰 백엔드는 더 많은 연결을 수신합니다. |
새 팜 만들기
새 팜 만들기
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"profile":"l4xnat", "vip":"192.168.100.241", "vport":"88","farmname":"newl4farm"}'
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms
POST /farms
새 L4xNAT 팜을 만듭니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| 농장 이름 | 끈 | 농장 이름, 고유 식별자. | 참된 |
| 윤곽 | 끈 | 생성 된 팜의 프로필입니다. L4xNAT 농장의 경우 l4xnat, 정보 메시지,이 값은 변경할 수 없습니다. | 참된 |
| VIP | 끈 | 가상 서비스가 수신하는 팜의 IP | 참된 |
| vport | 끈 | 가상 서비스가 수신하는 팜의 포트 L4xNAT 팜은 다음에 의해 구분 된 다중 포트를 허용합니다. , 또는로 구분 된 범위 포트 :. | 참된 |
응답 예 :
{
"description" : "Creating farm 'newl4farm'",
"params" : {
"farmname" : "newl4farm",
"interface" : "eth0",
"profile" : "l4xnat",
"vip" : "192.168.100.241",
"vport" : "88"
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
농장 수정
농장 수정
요청 예 :
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"algorithm":"weight","persistence":"","newfarmname":"l4farm", "protocol":"tcp",
"nattype":"nat","ttl":125,"vip":"178.62.126.152","vport":"81"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/newfarml4
PUT /farms/<farmname>
L4xNAT 팜의 구성을 수정합니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| newfarmname | 끈 | 새 농장의 이름. 농장을 중지해야합니다. |
| 연산 | 끈 | 팜에서 사용되는로드 균형 조정 알고리즘의 유형입니다. 옵션은 다음과 같습니다. 최소 접속 항상 최소 연결 서버에 연결, 무게 연결 선형 파견, 프리 오 연결은 항상 가장 중요한 프리 오가 있습니다. |
| Nattype | 끈 | 로드 밸런서 레이어 4 코어가 작동하는 방법. 옵션은 다음과 같습니다. NAT sNAT 모드라고도하는 백엔드는 클라이언트에 응답을 보내려면로드 밸런서에 응답하고, 담낭 백엔드가 클라이언트에 직접 응답하므로로드 밸런서를 백엔드 서버에 게이트웨이로 구성해야합니다. |
| 고집 | 끈 | 동일한 IP 주소가 동일한 서버에 연결됩니다. 옵션은 다음과 같습니다. "" 빈 값, 지속성이 비활성화 됨, ip 지속성이 활성화되면 원본 IP가 세션의 고유 ID처럼 사용됩니다. |
| 프로토콜 | 끈 | 4 계층에서 균형을 유지할 프로토콜. 옵션은 다음과 같습니다. 모든 프로필은 모든 L4 프로토콜의로드 균형을 조정합니다. TCP 로드 밸런서 만 TCP L4 프로토콜의 균형을 유지합니다. udp 로드 밸런서 만 UDP L4 프로토콜의 균형을 유지합니다. 한모금 로드 밸런서 만 SIP 또는 VoIP L7 프로토콜의 균형을 유지하며, FTP 로드 밸런서 만 FTP L7 프로토콜의 균형을 유지합니다. TFTP 로드 밸런서 만 TFTP L7 프로토콜과 균형을 유지합니다. |
| TTL | 번호 | 이 필드 값은 클라이언트 소스와 백엔드 간의 지속성이 할당되는 초 수를 초 단위로 나타냅니다. 지속성을 구성해야합니다. |
| VIP | 끈 | 가상 서비스가 수신하는 팜의 IP |
| vport | 끈 | 가상 서비스가 수신하는 팜의 포트 고유 한 포트를 지정할 수 있으며, 범위 포트는 분리 자로 구체화 할 수 있습니다 : 분리기로 여러 개의 포트를 지정할 수 있습니다. ,. |
응답 예 :
{
"description" : "Modify farm l4farm",
"params" : {
"algorithm" : "weight",
"nattype" : "nat",
"newfarmname" : "l4farm",
"persistence" : "",
"protocol" : "tcp",
"ttl" : 125,
"vip" : "178.62.126.152",
"vport" : "81"
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
농장 보호자 수정
농장 보호자 수정
요청 예 :
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"fgtimecheck":5,"fgscript":"Command of Farm Guardian","fgenabled":"true",
"fglog":"true","service":"service1"}' https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/fg
Farmguardian은 백엔드의 고급 모니터링 상태에 사용되고 현재 서비스에 대한 사용자 고유의 스크립트로 완전히 맞춤화됩니다. Farmguardian에서 문제를 감지하면 실제 서버가 자동으로 비활성화되고 블랙리스트로 표시됩니다.
PUT /farms/<farmname>/fg
L4xNAT 서비스에서 팜 보호자의 매개 변수를 수정합니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| fgenabled | 끈 | 농장 보호자의 사용을 활성화합니다. 참된 농장 보호자가 활성화되면, 그릇된 농장 보호자는 사용할 수 없습니다. |
| fglog | 끈 | 팜 보호자의 로그 사용을 활성화합니다. fgenabled 사용하도록 설정해야합니다. |
| fgscript | 끈 | 농장 수호자가 확인할 명령. 사용 가능한 명령은 libexec 경로에 있습니다. fgenabled 사용하도록 설정해야합니다. |
| fgtimecheck | 번호 | 농장 보호자는 각 '체크 시간'초를 확인합니다. fgenabled 사용하도록 설정해야합니다. |
응답 예 :
{
"description" : "Modify farm guardian",
"message" : "Success, some parameters have been changed in farm guardian in farm l4farm.",
"params" : {
"fgenabled" : "true",
"fglog" : "true",
"fgscript" : "check_tcp",
"fgtimecheck" : 5
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
L4xNAT - 백엔드
백엔드 나열
백엔드 나열
요청 예 :
curl -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/backends
GET /farms/<farmname>/backends
서비스에서 백엔드 목록을 가져옵니다.
응답 예 :
{
"description" : "List backends",
"params" : [
{
"id" : 0,
"ip" : "192.5.1.1",
"max_conns" : 400,
"port" : 787,
"priority" : 1,
"status" : "up",
"weight" : 1
},
{
"id" : 1,
"ip" : "192.5.1.3",
"max_conns" : 200,
"port" : 787,
"priority" : 2,
"status" : "up",
"weight" : 1
},
]
}
응답 매개 변수
이 호출은 벨로우즈 매개 변수가있는 백엔드 객체 배열을 반환합니다.
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| id | 번호 | ID는 팜의 백엔드를 식별합니다. |
| ip | 끈 | 실제 서비스가 수신하는 백엔드의 IP입니다. |
| 포트 | 번호 | 실제 서비스가 수신하는 백엔드의 포트입니다. 빈 값이 허용되며 가상 포트와 동일한 구성을 사용합니다. |
| 지위 | 끈 | 백엔드 상태. 가능한 값은 다음과 같습니다. up, 팜이 실행 중이고 백엔드가 연결을받을 준비가되었습니다. 아래 (down), 팜이 실행 중이고 백 엔드가 작동하지 않는 것으로 서비스에서 감지했습니다. 유지, 백엔드는 관리자가 연결을 수신 할 준비가되지 않은 것으로 표시됩니다.이 옵션은 백엔드의 유지 관리 작업에 유용합니다. 정의되지 않은, 백엔드 상태가 점검되지 않았습니다. |
| max_conns | 번호 | 백엔드에 대한 최대 동시 연결 수입니다. 이 필드의 값이 0이면 백엔드가 연결 제한을 구성하지 않은 것입니다. |
| 우선 | 번호 | 현재 실제 서버의 우선 순위 값입니다. 1이 가장 우선 순위가 높은 곳에서 항상 가장 가능성있는 연결로 연결합니다. |
| 무게 | 번호 | 현재 실제 서버의 가중치 값입니다. 가중치가 더 큰 백엔드는 더 많은 연결을 수신합니다. |
새 백엔드 만들기
새 백엔드 만들기
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.5.100","port":8080,"max_conns":400}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/backends
POST /farms/<farmname>/backends
주어진 L4xNAT Farm에 새 백엔드를 작성하십시오.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| ip | 끈 | 실제 서비스가 수신하는 백엔드의 IP입니다. | 참된 |
| 포트 | 번호 | 실제 서비스가 수신하는 백엔드의 포트입니다. 빈 값이 허용되며 가상 포트와 동일한 구성을 사용합니다. | |
| max_conns | 번호 | 백엔드에 대한 최대 동시 연결 수입니다. 이 필드의 값이 0이면 백엔드가 연결 제한을 구성하지 않은 것입니다. | |
| 우선 | 번호 | 현재 실제 서버의 우선 순위 값입니다. 1이 가장 우선 순위가 높은 곳에서 항상 가장 가능성있는 연결로 연결합니다. 기본값은 1입니다. | |
| 무게 | 번호 | 현재 실제 서버의 가중치 값입니다. 가중치가 더 큰 백엔드는 더 많은 연결을 수신합니다. 기본값은 1입니다. |
응답 예 :
{
"description" : "New farm backend",
"message" : "Backend added",
"params" : {
"id" : 5,
"ip" : "192.168.5.100",
"port" : 8080,
"max_conns" : 400,
"priority" : null,
"weight" : null
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
백엔드 수정
백엔드 수정
요청 예 :
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.5.40","port":8080,"max_conns":220,"priority":4,"weight":7}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/backends/2
PUT /farms/<farmname>/backends/<id>
L4xNAT Farm의 서비스에서 백엔드 매개 변수를 수정하십시오. id 백엔드 고유 식별자입니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| ip | 끈 | 실제 서비스가 수신하는 백엔드의 IP입니다. |
| 포트 | 번호 | 실제 서비스가 수신하는 백엔드의 포트입니다. 빈 값이 허용되며 가상 포트와 동일한 구성을 사용합니다. |
| max_conns | 번호 | 백엔드에 대한 최대 동시 연결 수입니다. 이 필드의 값이 0이면 백엔드가 연결 제한을 구성하지 않은 것입니다. |
| 우선 | 번호 | 현재 실제 서버의 우선 순위 값입니다. 1이 가장 우선 순위가 높은 곳에서 항상 가장 가능성있는 연결로 연결합니다. |
| 무게 | 번호 | 현재 실제 서버의 가중치 값입니다. 가중치가 더 큰 백엔드는 더 많은 연결을 수신합니다. |
응답 예 :
{
"description" : "Modify backend",
"message" : "Backend modified",
"params" : {
"ip" : "192.168.5.40",
"port" : 8080,
"max_conns" : 220,
"priority" : 4,
"weight" : 7
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
유지 보수의 백엔드
유지 보수의 백엔드
요청 예 :
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"maintenance","mode":"cut"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/backends/1/maintenance
PUT /farms/<farmname>/backends/<id>/maintenance
L4xNAT 팜의 백엔드에서 주어진 동작을 설정합니다. id 백엔드 고유 식별자입니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| 동작 | 끈 | 원하는 동작을 설정하십시오. 조치는 다음과 같습니다. up 백엔드는 클라이언트 요청을 수신 할 준비가되어 있으며, 유지 백엔드가 클라이언트 요청을 수신 할 준비가되지 않은 경우이 작업은 클라이언트에 영향을 미치지 않고 백엔드 서버를 중지 할 때 유용합니다. | 참된 |
| 모드 | 끈 | 유지 관리 모드를 선택하십시오. 사용 가능한 옵션은 다음과 같습니다. 배수, 백엔드는 새 연결을 허용하지 않지만 현재 연결을 계속 처리합니다. 또는 절단현재 연결이 닫힙니다. | 이 필드를 지정하지 않으면 기본 모드가됩니다. 배수. |
응답 예 :
{
"description" : "Set backend status",
"params" : {
"action" : "maintenance",
"mode" : "cut"
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
백엔드 삭제
백엔드 삭제
요청 예 :
curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/l4farm/backends/4
DELETE /farms/<farmname>/backends/<id>
L4xNAT Farm의 서비스에서 주어진 백엔드를 삭제하십시오.
id 백엔드 고유 식별자입니다.
응답 예 :
{
"description" : "Delete backend",
"message" : "Backend removed",
"success" : "true"
}
데이터 링크 팜
데이터 링크 팜 프로필을 사용하면 백엔드가 업 링크 라우터 또는 게이트웨이 인 경로 기반 팜을 만들 수 있습니다. 이러한 종류의 팜 프로필은 업 링크 채널 멀티플렉서 (1 입력 및 여러 라우터 회선 출력)로로드 밸런서를 사용하여 여러 업 링크 WAN 라우터 액세스를 공유 할 준비가되었습니다. 따라서 데이터 링크 팜은 고 가용성 통신 링크로 사용될 수 있으며 라우터 백엔드 링크 간의 대역폭 양을 합친 대역폭 증가로 사용할 수 있습니다.
이름으로 팜 검색
이름으로 팜 검색
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms/dlink
GET /farms/<farmname>
팜에 대한 모든 구성을 표시합니다.
응답 예 :
{
"backends" : [
{
"id" : 0,
"interface" : "eth0",
"ip" : "192.168.100.10",
"priority" : 2,
"status" : "undefined",
"weight" : 2
},
{
"id" : 1,
"interface" : "eth0",
"ip" : "192.168.100.11",
"priority" : 2,
"status" : "undefined",
"weight" : 1
}
],
"description" : "List farm dlink",
"params" : {
"algorithm" : "weight",
"status" : "down",
"vip" : "192.168.100.199"
}
}
응답 매개 변수
응답은 아래 형식의 JSON 객체가 될 것입니다.
농장 개체 :
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 매개 변수 | 목적 | 팜 구성의 매개 변수입니다. |
| 백엔드 | 목적[] | 이 팜에서 생성 된 실제 서버 및 해당 구성. |
데이터 링크 팜의 매개 변수 객체 :
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 연산 | 끈 | 팜에서 사용되는로드 균형 조정 알고리즘의 유형입니다. 옵션은 다음과 같습니다. 무게밸런서는 더 많은 가중치 부여로 더 많은 요금 백엔드가 제공되는 모든 사용 가능한 백엔드간에 배포합니다. 프리 오, 모든 연결을 작은 값으로 백엔드로 보냅니다. 우선. |
| 지위 | 끈 | 농장 상태. 사용 가능한 상태 값은 다음과 같습니다. 아래 (down), 팜이 실행되고 있지 않습니다. 재시작 필요, 팜이 가동되었지만 다시 시작 작업이 보류 중입니다. 임계, 팜이 가동되고 모든 백엔드에 연결할 수 없습니다. 문제, 팜이 가동 중이고 일부 백엔드에 연결할 수 없지만 거의 백엔드가 상태에 있습니다. up, 농장이 가동되고 모든 백엔드가 성공적으로 작동합니다. |
| VIP | 끈 | 가상 서비스가 수신하는 팜의 IP |
데이터 링크 팜의 백엔드 개체 :
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| id | 번호 | 팜의 백엔드에 대한 고유 식별자입니다. |
| ip | 끈 | 실제 서비스가 듣고있는 백엔드의 IP |
| 인터페이스 | 끈 | 백엔드가 연결된 로컬 네트워크 인터페이스입니다. |
| 우선 | 번호 | 현재 실제 서버의 우선 순위 값입니다. 다음과 같은 경우에 사용됩니다. 연산 필드는 prio로 구성되며 우선 순위가 낮습니다. |
| 지위 | 끈 | 백엔드 상태. 가능한 값은 다음과 같습니다. up, 팜이 실행 중이고 백엔드가 연결을받을 준비가되었습니다. 아래 (down), 팜이 실행 중이고 백 엔드가 작동하지 않는 것으로 서비스에서 감지했습니다. 정의되지 않은, 백엔드 상태가 점검되지 않았습니다. |
| 무게 | 번호 | 현재 실제 서버의 가중치 값입니다. 다음과 같은 경우에 사용됩니다. 연산 필드는 무게로 구성됩니다. |
새 팜 만들기
새 팜 만들기
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"farmname":"dlink", "vip":"192.168.100.241", "profile":"datalink" }'
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/farms
POST /farms
새 데이터 링크 팜을 만듭니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| 농장 이름 | 끈 | 농장 이름, 고유 식별자. | 참된 |
| 윤곽 | 끈 | 생성 된 팜의 프로필입니다. 데이터 링크 팜의 경우 데이터 링크 | 참된 |
| VIP | 끈 | 가상 서비스가 수신하는 팜의 IP | 참된 |
응답 예 :
{
"description" : "Creating farm 'dlink'",
"params" : {
"farmname" : "dlink",
"interface" : "eth0",
"profile" : "datalink",
"vip" : "192.168.100.241"
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
농장 수정
농장 수정
요청 예 :
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"newfarmname":"dlink2", "vip":"192.168.100.199","algorithm":"weight"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/dlink
PUT /farms/<farmname>
데이터 링크 팜의 구성을 수정하십시오.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| newfarmname | 끈 | 새로운 팜 이름입니다. 농장을 중지해야합니다. |
| 연산 | 끈 | 팜에서 사용되는로드 균형 조정 알고리즘의 유형입니다. 옵션은 다음과 같습니다. 무게밸런서는 더 많은 가중치 부여로 더 많은 요금 백엔드가 제공되는 모든 사용 가능한 백엔드간에 배포합니다. 프리 오, 모든 연결을 작은 값으로 백엔드로 보냅니다. 우선. |
| VIP | 끈 | 가상 서비스가 수신하는 팜의 IP |
응답 예 :
{
"description" : "Modify farm dlink",
"params" : {
"algorithm" : "weight",
"vip" : "192.168.100.199",
"newfarmname" : "dlink2"
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
데이터 링크 - 백엔드
데이터 링크 팜의 백엔드는 서비스 라우팅을 통한 게이트웨이입니다. 서비스는이 게이트웨이간에 다중화되며 일부 서비스는 사용할 수 없으며 서비스는 다른 게이트웨이를 사용합니다.
백엔드 나열
백엔드 나열
요청 예 :
curl -k -X GET -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/dlink/backends
GET /farms/<farmname>/backends
서비스에서 백엔드 목록을 가져옵니다.
응답 예 :
[
{
"id" : 6,
"interface" : "eth0",
"ip" : "192.168.100.10",
"priority" : 2,
"status" : "undefined",
"weight" : 2
},
{
"id" : 7,
"interface" : "eth0",
"ip" : "192.168.100.11",
"priority" : 2,
"status" : "undefined",
"weight" : 1
}
]
응답 매개 변수
이 호출은 벨로우즈 매개 변수가있는 백엔드 객체 배열을 반환합니다.
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| id | 번호 | 팜의 백엔드에 대한 고유 식별자입니다. 이 식별자는 시스템에 의해 생성됩니다. |
| 인터페이스 | 끈 | 백엔드가 연결된 로컬 네트워크 인터페이스입니다. |
| ip | 끈 | 실제 서비스가 듣고있는 백엔드의 IP |
| 우선 | 번호 | 현재 백엔드의 우선 순위 값입니다. 다음과 같은 경우에 사용됩니다. 연산 필드는 prio로 구성되며 우선 순위가 낮습니다. |
| 지위 | 끈 | 백엔드 상태. 가능한 값은 다음과 같습니다. up, 팜이 실행 중이고 백엔드가 연결을받을 준비가되었습니다. 아래 (down), 팜이 실행 중이고 백 엔드가 작동하지 않는 것으로 서비스에서 감지했습니다. 정의되지 않은, 백엔드 상태가 점검되지 않았습니다. |
| 무게 | 번호 | 현재 백엔드의 가중치 값입니다. 다음과 같은 경우에 사용됩니다. 연산 필드는 무게로 구성됩니다. |
새 백엔드 만들기
새 백엔드 만들기
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.10","interface":"eth0","priority":2,"weight":2}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/dlink/backends
POST /farms/<farmname>/backends
주어진 데이터 링크 팜에서 새 백엔드를 만듭니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| ip | 끈 | 실제 서비스가 듣고있는 백엔드의 IP | 참된 |
| 인터페이스 | 끈 | 백엔드가 연결된 로컬 네트워크 인터페이스입니다. | 참된 |
| 우선 | 번호 | 현재 실제 서버의 우선 순위 값입니다.이 값은 다음과 같은 경우에 사용됩니다. 연산 필드는 prio로 구성되며 우선 순위가 낮습니다. 기본값은 1입니다. | |
| 무게 | 번호 | 현재 백엔드의 가중치 값입니다. 다음과 같은 경우에 사용됩니다. 연산 필드는 무게로 구성됩니다. 기본값은 1입니다. |
응답 예 :
{
"description" : "New farm backend",
"message" : "Backend added",
"params" : {
"id" : 6,
"interface" : "eth0",
"ip" : "192.168.100.10",
"priority" : 2,
"weight" : 2
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
백엔드 수정
백엔드 수정
요청 예 :
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.102.50","interface":"eth0", "weight":1,"timeout":1}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/datalink/backends/2
PUT /farms/<farmname>/backends/<id>
데이터 링크 팜의 서비스에서 백엔드 매개 변수를 수정합니다. id 백엔드 고유 식별자입니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 끈 | ip | 실제 서비스가 듣고있는 백엔드의 IP |
| 인터페이스 | 끈 | 백엔드가 연결된 로컬 네트워크 인터페이스입니다. |
| 시간 제한 | 번호 | 특정 요청에 응답하는 것은 백엔드 시간 초과입니다. |
| 무게 | 번호 | 현재 백엔드의 가중치 값입니다. |
응답 예 :
{
"description" : "Modify backend",
"message" : "Backend modified",
"params" : {
"interface" : "eth0",
"ip" : "192.168.102.50",
"timeout" : 1,
"weight" : 1
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
백엔드 삭제
백엔드 삭제
요청 예 :
curl -k -X DELETE -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/farms/dlink/backends/4
DELETE /farms/<farmname>/backends/<id>
데이터 링크 팜의 서비스에서 지정된 백엔드를 삭제합니다. id 백엔드 고유 식별자입니다.
응답 예 :
{
"description" : "Delete backend",
"message" : "Backend removed",
"success" : "true"
}
네트워크
Zevenet은 다양한 유형의 네트워크 인터페이스로 작동 할 수 있습니다.
이 섹션에서는 NIC, VLAN 및 가상 인터페이스에서 작업을 나열, 생성, 구성, 삭제 및 설정할 수 있습니다.
NIC: 또는 네트워크 인터페이스 카드, 그것은 컴퓨터 하드웨어 구성 요소이며 인터페이스의 종류는 Zevenet에서 정의되고 관리 될 수있는 다음과 같은 종류의 인터페이스를위한 기반입니다.
VLAN: 또는 가상 LAN 카드는 네트워크 분할 서비스를 제공하는 종류 또는 네트워크 인터페이스입니다. nic 인터페이스를 통해 둘 이상의 VLAN을 만들 수 있습니다.
가상: 이런 종류의 인터페이스는 위에 설명 된 모든 종류의 인터페이스를 통해 생성 될 수 있습니다. 이러한 종류의 인터페이스는 팜에 사용해야하며 가상 인터페이스가 부모와 동일한 서브넷에 정의되어 있어야합니다.
모든 인터페이스 나열
모든 인터페이스 나열
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/nic
GET /interfaces
구성이있는 시스템의 인터페이스 목록을 가져옵니다.
응답 예 :
{
"description" : "List interfaces",
"interfaces" : [
{
"gateway" : "192.168.100.5",
"has_vlan" : "true",
"ip" : "192.168.100.241",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0",
"netmask" : "255.255.255.0",
"status" : "up",
"type" : "nic"
},
{
"gateway" : "192.168.120.1",
"ip" : "192.168.120.120",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0.1",
"netmask" : "255.255.255.0",
"status" : "down",
"type" : "vlan"
},
{
"gateway" : "",
"ip" : "192.168.100.155",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0:virt",
"netmask" : "255.255.255.0",
"status" : "up",
"type" : "virtual"
},
{
"gateway" : "192.168.100.5",
"has_vlan" : "false",
"ip" : "192.168.100.102",
"mac" : "62:30:43:36:29:ac",
"name" : "eth1",
"netmask" : "255.255.255.0",
"status" : "up",
"type" : "nic"
}
]
}
응답 매개 변수
응답은 인터페이스 객체 배열이있는 JSON 객체입니다.
인터페이스 개체 :
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| ip | 끈 | 인터페이스의 IP. IP는 가상 인터페이스에서 상위 인터페이스와 동일한 네트워크 세그먼트에 있어야합니다. |
| has_vlan | 끈 | 이 필드는이 인터페이스가 VLAN 인터페이스의 상위인지 여부를 나타냅니다. 이 필드는 NIC 인터페이스에만 해당됩니다. |
| 넷 마스크 | 끈 | 인터페이스의 넷 마스크. 이 값은 가상 인터페이스에서 수정할 수 없으며 부모 인터페이스에서 상속됩니다. |
| 게이트웨이 | 끈 | 인터페이스의 게이트웨이. 이 값은 가상 인터페이스에서 수정할 수 없으며 부모 인터페이스에서 상속됩니다. |
| 맥 | 끈 | 인터페이스의 MAC. 이 값은 상위 인터페이스에서 상속됩니다. |
| name | 끈 | 인터페이스의 이름. 고유 식별자로 사용됩니다. |
| 지위 | 끈 | 값은 up인터페이스는 패킷을 수신 할 수 있습니다. 아래 (down)인터페이스가 패킷을 수신 할 수 없습니다. |
| 유형 | 끈 | 다른 종류의 인터페이스는 다음과 같습니다. NIC, VLAN or 가상. |
기본 게이트웨이 검색
기본 게이트웨이 검색
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/interfaces/gateway
GET /interfaces/gateway
기본 게이트웨이는로드 밸런서의 모든 인터페이스에서 로컬로 도달 할 수없는 모든 대상 트래픽을 보내는 노드입니다.
기본 게이트웨이 인터페이스의 매개 변수를 가져옵니다.
응답 예 :
{
"description" : "Default gateway",
"params" : {
"address" : "192.168.100.5",
"interface" : "eth0"
}
}
응답 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 주소 | 끈 | 그것은 게이트웨이의 IP입니다. |
| 인터페이스 | 끈 | 게이트웨이의 인터페이스 이름. |
기본 게이트웨이 수정
기본 게이트웨이 수정
요청 예 :
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"interface":"eth0","address":"192.168.100.5"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces
PUT /interfaces/gateway
게이트웨이 인터페이스의 구성을 수정하십시오.
응답 예 :
{
"description" : "Modify default gateway",
"message" : "The default gateway has been changed successfully",
"success" : "true"
}
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 주소 | 끈 | 그것은 게이트웨이의 IP입니다. |
| 인터페이스 | 끈 | 게이트웨이의 인터페이스 이름. |
게이트웨이 구성 삭제
DELETE /interfaces/gateway
기본 게이트웨이 구성의 구성을 삭제하십시오.
경고: 게이트웨이가 구성 해제 된 경우 외부 네트워크 세그먼트에서 Zevenet에 연결할 수 없습니다.
게이트웨이 구성 삭제
요청 예 :
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/gateway
응답 메시지
게이트웨이가 동일한 네트워크 세그먼트에서 구성이 해제되면이 메시지가 나타나고 그렇지 않으면 연결이 끊어집니다.
응답 예 :
{
"description" : "Remove default gateway",
"message" : "The default gateway has been deleted successfully",
"params" : {
"address" : null,
"interface" : null
}
}
네트워크 - NIC 인터페이스
NIC 인터페이스는 Zevenet로드 밸런서에 연결된 물리적 인 인터페이스입니다.
시스템은 새로운 인터페이스가 연결되면 자동으로 인식합니다.
부모로서 NIC 인터페이스를 사용하면 다른 특성을 가진 다른 유형의 인터페이스를 만들 수 있습니다. 사용 가능한 인터페이스는 다음과 같습니다. VLAN 및 가상.
NIC 인터페이스 나열
GET /interfaces/nic
NIC 인터페이스의 모든 매개 변수를 가져옵니다.
NIC 인터페이스 나열
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/nic
응답 예 :
{
"description" : "List NIC interfaces",
"interfaces" : [
{
"gateway" : "192.168.100.5",
"has_vlan" : "true",
"ip" : "192.168.100.241",
"is_slave" : "false",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0",
"netmask" : "255.255.255.0",
"status" : "up"
},
{
"gateway" : "192.168.100.5",
"has_vlan" : "false",
"ip" : "192.168.100.102",
"mac" : "62:30:43:36:29:ac",
"name" : "eth1",
"netmask" : "255.255.255.0",
"status" : "up"
}
]
}
응답 매개 변수
응답은 NIC 인터페이스 객체 배열을 가진 JSON 객체입니다.
NIC 인터페이스 개체 :
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| ip | 끈 | 인터페이스의 IP. |
| has_vlan | 끈 | 이 필드는이 인터페이스가 VLAN 인터페이스의 상위인지 여부를 나타냅니다. 이 필드는 NIC 인터페이스에만 해당됩니다. |
| 넷 마스크 | 끈 | 인터페이스가 작동하는 네트워크 세그먼트를 정의하십시오. |
| 게이트웨이 | 끈 | 다른 네트워크 세그먼트에 패킷을 보내는 데 사용되는 IP입니다. |
| 맥 | 끈 | 링크 계층 고유 식별 자. 그것은 수정할 수 없습니다. |
| name | 끈 | 인터페이스의 이름. 인터페이스 고유 식별자로 사용됩니다. |
| 지위 | 끈 | 값은 up인터페이스는 패킷을 수신 할 수 있습니다. 아래 (down)인터페이스가 패킷을 수신 할 수 없습니다. |
NIC 인터페이스 검색
NIC 인터페이스 검색
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/nic/eth1
GET /interfaces/nic/<name>
NIC 인터페이스의 모든 매개 변수를 가져옵니다. name 인터페이스 고유 식별자입니다.
응답 예 :
{
"description" : "Show NIC interface",
"interface" : {
"gateway" : "192.168.100.5",
"ip" : "192.168.100.102",
"mac" : "62:30:43:36:29:ac",
"name" : "eth1",
"netmask" : "255.255.255.0",
"status" : "up"
}
}
응답 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| ip | 끈 | 인터페이스의 IP. |
| 넷 마스크 | 끈 | 인터페이스가 작동하는 네트워크 세그먼트를 정의하십시오. |
| 게이트웨이 | 끈 | 다른 네트워크 세그먼트에 패킷을 보내는 데 사용되는 IP입니다. |
| 맥 | 끈 | 링크 계층 고유 식별 자. 그것은 수정할 수 없습니다. |
| name | 끈 | 인터페이스의 이름. 인터페이스 고유 식별자로 사용됩니다. |
| 지위 | 끈 | 값은 up인터페이스는 패킷을 수신 할 수 있습니다. 아래 (down)인터페이스가 패킷을 수신 할 수 없습니다. |
NIC 인터페이스 수정
NIC 인터페이스 수정
요청 예 :
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.102","netmask":"255.255.255.0","gateway":"192.168.100.5"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/nic/eth1
PUT /interfaces/nic/<name>
NIC 인터페이스의 매개 변수를 수정하십시오. name 인터페이스 고유 식별자입니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| ip | 끈 | 인터페이스의 IP. |
| 넷 마스크 | 끈 | 인터페이스가 작동하는 네트워크 세그먼트를 정의하십시오. |
| 게이트웨이 | 끈 | 다른 네트워크 세그먼트의 패킷을 보내는 데 사용되는 IP입니다. |
응답 예 :
{
"description" : "Configure nic interface",
"params" : {
"gateway" : "192.168.100.5",
"ip" : "192.168.100.102",
"netmask" : "255.255.255.0"
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
NIC 구성 삭제
NIC 구성 삭제
요청 예 :
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/nic/eth3
DELETE /interfaces/nic/<name>
NIC 인터페이스의 구성을 삭제하십시오. 이 작업을 수행하면 인터페이스가 쓸모 없게되어 다시 구성 할 준비가됩니다. name 인터페이스 고유 식별자입니다.
응답 예 :
{
"description" : "Delete nic interface",
"message" : "The configuration for the network interface eth3 has been deleted.",
"success" : "true"
}
NIC 인터페이스 동작 설정
NIC 인터페이스 동작 설정
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"down"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/nic/eth1/actions
POST /interfaces/nic/<name>/actions
NIC 인터페이스에 조치를 적용하십시오. 이 호출을 통해 네트워크 인터페이스를 활성화 또는 비활성화 할 수 있습니다.
name 인터페이스 고유 식별자입니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| 동작 | 끈 | 인터페이스에 적용 할 작업입니다. 사용할 수있는 값은 다음과 같습니다. up, 인터페이스를 활성화하고 사용 준비를하십시오. 아래 (down)패킷을 수신하지 않거나 보내지 않도록 인터페이스를 비활성화하십시오. | 참된 |
응답 예 :
{
"description" : "Action on nic interface",
"params" : {
"action" : "up"
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
네트워크 - VLAN 인터페이스
VLAN 인터페이스를 사용하면 NIC 인터페이스가 다른 네트워크에서 작동하므로 IP, 게이트웨이 및 넷 마스크 필드는 상위 인터페이스와 다를 수 있습니다. VLAN 인터페이스는 상위 인터페이스의 MAC 주소를 상속합니다.
VLAN 인터페이스 필드 name VLAN 인터페이스에 대한 식별자 태그를 설정하는 데 사용되는 점 "."문자와 함께 나타납니다.
VLAN 인터페이스 나열
VLAN 인터페이스 나열
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/vlan
GET /interfaces/vlan
VLAN 인터페이스의 모든 매개 변수를 가져옵니다.
응답 예 :
{
"description" : "List VLAN interfaces",
"interfaces" : [
{
"gateway" : "192.168.120.1",
"ip" : "192.168.120.120",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0.1",
"netmask" : "255.255.255.0",
"parent" : "eth0",
"status" : "down"
}
]
}
응답 매개 변수
응답은 VLAN 인터페이스 객체 배열이있는 JSON 객체입니다.
VLAN 매개 변수는 다음과 같습니다.
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| ip | 끈 | 인터페이스의 IP. 상위 인터페이스 IP와 다를 수 있습니다. |
| 넷 마스크 | 끈 | 인터페이스가 작동하는 네트워크 세그먼트를 정의하십시오. |
| 게이트웨이 | 끈 | 다른 네트워크 세그먼트의 패킷을 보내는 데 사용되는 IP입니다. |
| 맥 | 끈 | 인터페이스의 MAC. 이 값은 상위 인터페이스에서 상속됩니다. |
| name | 끈 | 인터페이스의 이름. 고유 식별자로 사용됩니다. 이 이름은 부모 인터페이스 이름 인 점 문자 "."로 형식이 지정된 체인입니다. 및 vlan 네트워크 인터페이스 또는 vlan 태그의 번호입니다. |
| 부모의 | 끈 | 이 인터페이스를 생성하는 데 사용되는 인터페이스입니다. |
| 지위 | 끈 | 값은 up 인터페이스는 패킷을 수신 할 수 있으며, 아래 (down) 인터페이스는 패킷을 수신 할 수 없습니다. |
VLAN 인터페이스 검색
VLAN 인터페이스 검색
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/vlan/eth0.1
GET /interfaces/vlan/<name>
VLAN 인터페이스의 모든 매개 변수를 가져옵니다. name 인터페이스 고유 식별자입니다.
응답 예 :
{
"description" : "Show VLAN interface",
"interface" : {
"gateway" : "192.168.131.1",
"ip" : "192.168.131.155",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0.1",
"netmask" : "255.255.255.0",
"status" : "up"
}
}
응답 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| ip | 끈 | 인터페이스의 IP. |
| 넷 마스크 | 끈 | 인터페이스가 작동하는 네트워크 세그먼트를 정의하십시오. |
| 게이트웨이 | 끈 | 다른 네트워크 세그먼트의 패킷을 보내는 데 사용되는 IP입니다. |
| 맥 | 끈 | 인터페이스의 MAC. 이 값은 상위 인터페이스에서 상속됩니다. |
| name | 끈 | 인터페이스의 이름. 고유 식별자로 사용됩니다. 이 이름은 부모 인터페이스 이름 인 점 문자 "."로 형식이 지정된 체인입니다. 및 vlan 네트워크 인터페이스 번호입니다. |
| 지위 | 끈 | 값은 up 인터페이스는 패킷을 수신 할 수 있으며, 아래 (down) 인터페이스는 패킷을 수신 할 수 없습니다. |
VLAN 인터페이스 생성
VLAN 인터페이스 생성
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.120.120","netmask":"255.255.255.0","gateway":"192.168.120.1", "name":"eth0.1"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/vlan
POST /interfaces/vlan
NIC 인터페이스에서 VLAN 인터페이스를 생성하십시오. 다음 VLAN 매개 변수가 달라야하지만 새 VLAN 인터페이스는 MAC을 공유합니다. ip다음과 같이 바뀔 수 있습니다. 게이트웨이, 넷 마스크.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| ip | 끈 | 인터페이스의 IP. 상위 인터페이스 IP와 달라야합니다. | 참된 |
| 넷 마스크 | 끈 | 인터페이스가 작동하는 네트워크 세그먼트를 정의하십시오. | 참된 |
| 게이트웨이 | 끈 | 다른 네트워크 세그먼트의 패킷을 보내는 데 사용되는 IP입니다. | 참된 |
| name | 끈 | 인터페이스의 이름. 고유 식별자로 사용됩니다. 이 이름은 부모 인터페이스 이름 인 점 문자 "."로 형식이 지정된 체인입니다. 및 vlan 네트워크 인터페이스 번호입니다. | 참된 |
응답 예 :
{
"description" : "Add a vlan interface",
"params" : {
"gateway" : "192.168.120.1",
"ip" : "192.168.120.120",
"mac" : null,
"name" : "eth0.1",
"netmask" : "255.255.255.0"
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
VLAN 인터페이스 수정
VLAN 인터페이스 수정
요청 예 :
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.131.155","netmask":"255.255.255.0","gateway":"192.168.131.1"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/vlan/eth0.1
PUT /interfaces/vlan/<name>
VLAN 인터페이스의 매개 변수를 수정하십시오. name 인터페이스 고유 식별자입니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| ip | 끈 | 인터페이스의 IP. 상위 인터페이스 IP와 다를 수 있습니다. |
| 넷 마스크 | 끈 | 인터페이스가 작동하는 네트워크 세그먼트를 정의하십시오. |
| 게이트웨이 | 끈 | 다른 네트워크 세그먼트의 패킷을 보내는 데 사용되는 IP입니다. |
응답 예 :
{
"description" : "Modify VLAN interface",
"params" : {
"gateway" : "192.168.131.1",
"ip" : "192.168.131.155",
"netmask" : "255.255.255.0"
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
VLAN 인터페이스 삭제
VLAN 인터페이스 삭제
요청 예 :
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/vlan/eth0.1
DELETE /interfaces/vlan/<name>
VLAN 인터페이스 삭제. name 인터페이스 고유 식별자입니다.
응답 예 :
{
"description" : "Delete VLAN interface",
"message" : "The VLAN interface eth0.1 has been deleted.",
"success" : "true"
}
VLAN 인터페이스 동작 설정
VLAN 인터페이스 동작 설정
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"down"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/vlan/eth0.1/actions
POST /interfaces/vlan/<name>/actions
VLAN 인터페이스에 조치를 적용하십시오. 이 호출을 통해 네트워크 인터페이스를 활성화 또는 비활성화 할 수 있습니다.
name 이름은 고유 식별자입니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| 동작 | 끈 | 인터페이스에 적용 할 작업입니다. 사용할 수있는 값은 다음과 같습니다. up, 인터페이스를 활성화하고 사용 준비를하십시오. 아래 (down)패킷을 수신하지 않거나 보내지 않도록 인터페이스를 비활성화하십시오. | 참된 |
응답 예 :
{
"description" : "Action on vlan interface",
"params" : {
"action" : "down"
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
네트워크 - 가상 인터페이스
네트워크 인터페이스를 통해 사용자는 부모 네트워크와 동일한 네트워크 세그먼트에 다른 네트워크 인터페이스를 가질 수 있으므로 가상 인터페이스는 항상 부모 네트워크 구성을 상속합니다. 다른 매개 변수는 ip. 가상 인터페이스는 NIC 또는 VLAN에서 생성 할 수 있습니다. 새 가상 인터페이스를 만들려면 가상 인터페이스의 식별을 설정하는 데 사용되는 콜론 ":"문자가있는 필드가 나타납니다.
가상 인터페이스 나열
가상 인터페이스 나열
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/virtual
GET /interfaces/virtual
가상 인터페이스의 모든 매개 변수를 가져옵니다.
응답 예 :
{
"description" : "List virtual interfaces",
"interfaces" : [
{
"gateway" : "",
"ip" : "192.168.100.155",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0:virt",
"netmask" : "255.255.255.0",
"parent" : "eth0",
"status" : "up"
},
{
"gateway" : "192.168.100.5",
"ip" : "192.168.100.41",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0:virtiface",
"netmask" : "255.255.255.0",
"parent" : "eth0",
"status" : "down"
}
]
}
응답 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| ip | 끈 | 인터페이스의 IP. IP는 상위 인터페이스와 동일한 네트워크 세그먼트에 있어야합니다. |
| 넷 마스크 | 끈 | 인터페이스가 작동하는 네트워크 세그먼트를 정의하십시오. 상위 인터페이스에서 상속됩니다. |
| 게이트웨이 | 끈 | 다른 네트워크 세그먼트의 패킷을 보내는 데 사용되는 IP입니다. 상위 인터페이스에서 상속됩니다. |
| 맥 | 끈 | 인터페이스의 MAC. 상위 인터페이스에서 상속됩니다. |
| name | 끈 | 인터페이스의 이름. 고유 식별자로 사용됩니다. 이 이름은 부모 인터페이스, 콜론 문자 ":"및 가상 네트워크 인터페이스의 이름으로 형식이 지정된 체인이며 영숫자가 허용됩니다. |
| 부모의 | 끈 | 이 인터페이스를 생성하는 데 사용되는 인터페이스입니다. |
| 지위 | 끈 | 값은 up인터페이스는 패킷을 수신 할 수 있습니다. 아래 (down)인터페이스가 패킷을 수신 할 수 없습니다. |
가상 인터페이스 검색
가상 인터페이스 검색
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/virtual/eth0:virtiface
GET /interfaces/virtual/<name>
가상 인터페이스의 모든 매개 변수를 가져옵니다. name 인터페이스 고유 식별자입니다.
응답 예 :
{
"description" : "Show virtual interface",
"interface" : {
"gateway" : "192.168.100.5",
"ip" : "192.168.100.41",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0:virtiface",
"netmask" : "255.255.255.0",
"status" : "down"
}
}
응답 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| ip | 끈 | 인터페이스의 IP. IP는 상위 인터페이스와 동일한 네트워크 세그먼트에 있어야합니다. |
| 넷 마스크 | 끈 | 인터페이스가 작동하는 네트워크 세그먼트를 정의하십시오. 상위 인터페이스에서 상속됩니다. |
| 게이트웨이 | 끈 | 다른 네트워크 세그먼트의 패킷을 보내는 데 사용되는 IP입니다. 상위 인터페이스에서 상속됩니다. |
| 맥 | 끈 | 인터페이스의 MAC. 상위 인터페이스에서 상속됩니다. |
| name | 끈 | 인터페이스의 이름. 고유 식별자로 사용됩니다. 이 이름은 상위 인터페이스, 콜론 문자 ":"및 가상 네트워크 인터페이스의 영숫자 문자열로 형식이 지정된 체인입니다. |
| 지위 | 끈 | 값은 up인터페이스는 패킷을 수신 할 수 있습니다. 아래 (down)인터페이스가 패킷을 수신 할 수 없습니다. |
가상 인터페이스 생성
가상 인터페이스 생성
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.41", "name":"eth0:virtiface"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/virtual
POST /interfaces/virtual
가상 인터페이스를 만듭니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| ip | 끈 | 인터페이스의 IP. IP는 상위 인터페이스와 동일한 네트워크 세그먼트에 있어야합니다. | 참된 |
| name | 끈 | 인터페이스의 이름. 고유 식별자로 사용됩니다. 이 이름은 상위 인터페이스, 콜론 문자 ":"및 가상 네트워크 인터페이스의 영숫자 문자열로 형식이 지정된 체인입니다. | 참된 |
응답 예 :
{
"description" : "Add a virtual interface",
"params" : {
"gateway" : "192.168.100.5",
"ip" : "192.168.100.41",
"mac" : "c2:56:f6:54:ff:a0",
"name" : "eth0:virtiface",
"netmask" : "255.255.255.0"
}
}
응답 매개 변수
응답은 인터페이스 구성이있는 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| ip | 끈 | 인터페이스의 IP. IP는 상위 인터페이스와 동일한 네트워크 세그먼트에 있어야합니다. |
| 넷 마스크 | 끈 | 인터페이스가 작동하는 네트워크 세그먼트를 정의하십시오. 상위 인터페이스에서 상속됩니다. |
| 게이트웨이 | 끈 | 다른 네트워크 세그먼트에 패킷을 보내는 데 사용되는 IP입니다. 상위 인터페이스에서 상속됩니다. |
| 맥 | 끈 | 인터페이스의 MAC. 상위 인터페이스에서 상속됩니다. |
| name | 끈 | 인터페이스의 이름. 고유 식별자로 사용됩니다. 이 이름은 상위 인터페이스, 콜론 문자 ":"및 가상 네트워크 인터페이스에 대한 알파 숫자 문자열로 형식이 지정된 체인입니다. |
가상 인터페이스 수정
가상 인터페이스 수정
요청 예 :
curl -k -X PUT -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.131.155"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/virtual/eth0:virtiface
PUT /interfaces/virtual/<name>
가상 인터페이스의 매개 변수를 수정하십시오. name 인터페이스 고유 식별자입니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| ip | 끈 | 인터페이스의 IP. IP는 상위 인터페이스와 동일한 네트워크 세그먼트에 있어야합니다. |
응답 예 :
{
"description" : "Modify virtual interface",
"params" : {
"ip" : "192.168.100.10"
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
가상 인터페이스 삭제
가상 인터페이스 삭제
요청 예 :
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/virtual/eth0:virtiface
DELETE /interfaces/virtual/<name>
가상 인터페이스를 삭제하십시오. name 인터페이스 고유 식별자입니다.
응답 예 :
{
"description" : "Delete virtual interface",
"message" : "The virtual interface eth0:virtiface has been deleted.",
"success" : "true"
}
가상 인터페이스 동작 설정
가상 인터페이스 동작 설정
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"down"}'
https://<zenlb_server>:444/zapi/v3.1/zapi.cgi/interfaces/virtual/eth0:virtiface/actions
POST /interfaces/virtual/<name>/actions
가상 인터페이스에 작업을 적용하십시오. 이 호출을 통해 네트워크 인터페이스를 활성화 또는 비활성화 할 수 있습니다.
name 인터페이스 고유 식별자입니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| 동작 | 끈 | 인터페이스에 적용 할 작업입니다. 사용할 수있는 값은 다음과 같습니다. up, 인터페이스를 활성화하고 사용 준비를하십시오. 아래 (down)패킷을 수신하지 않거나 보내지 않도록 인터페이스를 비활성화하십시오. | 참된 |
응답 예 :
{
"description" : "Action on virtual interface",
"params" : {
"action" : "down"
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
모니터링 - 통계
시스템 및 팜에 대한 정보 표시 이 정보는 Zevenet로드 밸런서 상태를 모니터링하는 데 유용합니다.
시스템 통계 표시
시스템 통계 표시
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/stats
GET /stats
전역 시스템 통계를 얻으십시오.
응답 예 :
{
"description" : "System stats",
"params" : {
"cpu" : {
"cores" : 2,
"idle" : 94.42,
"iowait" : 0,
"irq" : 0,
"nice" : 0,
"softirq" : 0,
"sys" : 2.54,
"usage" : 5.58,
"user" : 3.05
},
"date" : "Fri Jan 27 11:40:32 2017",
"hostname" : "api3",
"load" : {
"Last_1" : 1.17,
"Last_15" : 0.36,
"Last_5" : 0.6
},
"memory" : {
"Buffers" : 21.68,
"Cached" : 147.95,
"MemFree" : 348.06,
"MemTotal" : 2005.01,
"MemUsed" : 1656.95,
"SwapCached" : 2.67,
"SwapFree" : 614.38,
"SwapTotal" : 672,
"SwapUsed" : 57.62
},
"network" : {
"eth0 in in" : 2702.29,
"eth0 out out" : 50701.95,
"eth0.1 in in" : 0,
"eth0.1 out out" : 0,
"eth1 in in" : 234.72,
"eth1 out out" : 0,
}
}
}
응답 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| CPU | 목적 | CPU 통계. |
| 데이터 | 끈 | 시스템 날짜. |
| 호스트 이름 | 끈 | 호스트의 이름. |
| 하중 | 목적 | 코어로드 통계. |
| 기억 | 목적 | 사용 된 메모리 통계. |
| 네트워크 | 목적 | 네트워크 트래픽 통계. |
CPU 개체:
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 코어 | 번호 | 프로세서의 코어 수입니다. |
| 유휴 | 번호 | CPU는 어떤 프로그램에서도 사용하지 않습니다. |
| 아이오와 | 번호 | CPU는 입력 또는 출력 프로세스에서 사용됩니다. |
| irq | 번호 | 하드웨어 인터럽트에 사용되는 CPU. |
| 좋은 | 번호 | CPU 스케줄링 우선 순위. |
| softirq | 번호 | CPU는 소프트웨어 인터럽트에 사용됩니다. |
| sys | 번호 | 시스템에서 사용하는 CPU. |
| 용법 | 번호 | 사용 된 총 CPU. |
| 사용자 | 번호 | 사용자가 사용하는 CPU. |
개체로드:
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| Last_1 | 번호 | 마지막 순간에 시스템의 백분율을로드하십시오. |
| Last_5 | 번호 | 5 분 전에 시스템 빈도를로드하십시오. |
| Last_15 | 번호 | 15 분 전에 시스템 포퓰 레이트를로드하십시오. |
메모리 개체.
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 버퍼 | 번호 | 버퍼에 사용되는 메모리입니다. 이 금액은 Mb로 표시됩니다. |
| 캐시 된 | 번호 | 시스템에 캐시 된 전체 메모리입니다. 이 금액은 Mb로 표시됩니다. |
| MemFree | 번호 | 시스템에서 캐시하지 않은 전체 여유 메모리입니다. 이 금액은 Mb로 표시됩니다. |
| MemTotal | 번호 | 시스템의 총 램 메모리입니다. 이 금액은 Mb로 표시됩니다. |
| MemUsed | 번호 | 시스템에서 사용하는 메모리입니다. 이 금액은 Mb로 표시됩니다. |
| 스왑 캐쉬 | 번호 | 예약 된 전체 캐시 메모리입니다. |
| 스왑 프리 | 번호 | 시스템에서 캐시하지 않은 전체 여유 메모리입니다. 이 금액은 Mb로 표시됩니다. |
| 스왑 총액 | 번호 | 예약 된 전체 스왑 메모리입니다. |
| 스왑 사용 | 번호 | 그것은 시스템에 의해 스왑 메모리가 사용되는 최적의 시스템에서 0이어야합니다. |
네트워크 개체:
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 안으로 | 번호 | 이 입력 트래픽 인터페이스. |
| 밖으로 | 번호 | 이 출력 트래픽 인터페이스. |
네트워크 통계 표시
네트워크 통계 표시
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/stats/system/network
GET /stats/system/network
네트워크 인터페이스를 통해 전체 입출력 트래픽에 대한 요약 정보를 얻을 수 있습니다.
응답 예 :
{
"description" : "Network interfaces usage",
"params" : {
"date" : "Fri Jan 27 11:58:05 2017",
"hostname" : "api3",
"interfaces" : [
{
"in" : "2703.88",
"interface" : "eth0",
"out" : "50917.65"
},
{
"in" : "815.69",
"interface" : "eth0.1",
"out" : "4300.38"
}
]
}
}
응답 매개 변수
응답은 키가있는 JSON이됩니다. 매개 변수 그 값은 다음과 같은 키가있는 객체입니다.
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 데이터 | 끈 | 시스템 날짜. |
| 호스트 이름 | 끈 | 호스트의 이름. |
| 인터페이스 | 목적[] | 네트워크 트래픽 통계. |
인터페이스 객체
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| in | 끈 | 총 입력 트래픽 (MB). |
| 인터페이스 | 끈 | 인터페이스 이름. |
| 아웃 | 끈 | 총 출력 트래픽은 MB입니다. |
농장 통계 표시
농장 통계 표시
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/stats/farms
GET /stats/farms
시스템의 모든 팜에 대한 연결 및 구성 요약을 가져옵니다.
응답 예 :
{
"description" : "List all farms stats",
"farms" : [
{
"established" : 0,
"farmname" : "testHttps",
"pending" : 0,
"profile" : "https",
"status" : "up",
"vip" : "192.168.101.20",
"vport" : "120"
},
{
"established" : 0,
"farmname" : "httpFarm",
"pending" : 0,
"profile" : "http",
"status" : "up",
"vip" : "192.168.10.31",
"vport" : "8080"
},
{
"established" : 0,
"farmname" : "testDL",
"pending" : 0,
"profile" : "datalink",
"status" : "up",
"vip" : "192.168.102.72",
"vport" : "eth1"
},
{
"established" : 0,
"farmname" : "testL4",
"pending" : 0,
"profile" : "l4xnat",
"status" : "up",
"vip" : "192.168.10.31",
"vport" : "30"
}
]
}
응답 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 확립 된 | 번호 | 현재 설정된 연결의 총 수 |
| 농장 이름 | 끈 | 농장 이름, 고유 식별자. |
| 대기 | 번호 | 보류중인 연결 수입니다. |
| 윤곽 | 끈 | 농장의 유형. 가능한 값은 다음과 같습니다. 데이터 링크, l4xnat, HTTP or HTTPS. 각 프로파일은 해당 섹션에서 정의됩니다. |
| 지위 | 끈 | 농장 상태. 사용 가능한 상태 값은 다음과 같습니다. 아래 (down), 팜이 실행되고 있지 않습니다. 재시작 필요, 팜이 가동되었지만 다시 시작 작업이 보류 중입니다. 임계, 팜이 가동되고 모든 백엔드에 도달 할 수 없거나 유지 관리되고 있습니다. 문제, 팜이 가동 중이고 일부 백엔드에 연결할 수 없지만 거의 백엔드가 상태에 있습니다. 유지, 팜이 가동 중이고 백엔드 상태에 있지만 거의 백엔드가 유지 관리 모드에 있습니다. up, 농장이 가동되고 모든 백엔드가 성공적으로 작동합니다. |
| VIP | 끈 | 가상 서비스가 수신하는 팜의 IP |
| vport | 끈 | 가상 서비스가 수신하는 팜의 포트 |
농장 통계보기
농장 통계보기
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/stats/farms/httpFarm
GET /stats/farms/<farmname>
현재 팜 상태, 해당 백 엔드 상태 및 연결을 표시합니다. 각 팜은 프로필에 따라 다른 개체로 응답합니다.
HTTP 팜에 대한 응답 예 :
{
"backends" : [
{
"established" : 0,
"id" : 0,
"ip" : "192.168.0.168",
"pending" : 0,
"port" : 80,
"service" : "srv1",
"status" : "up"
}
],
"description" : "List farm stats",
"sessions" : [
{
"client" : "0",
"id" : "0",
"service" : "srv1",
"session" : "192.168.0.186"
}
]
}
HTTP 팜의 응답 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 백엔드 | 목적[] | 백엔드에 대한 정보를 표시합니다. |
| 세션 | 목적[] | 세션에 대한 정보를 표시합니다. |
백엔드 객체
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 확립 된 | 번호 | 설정된 총 연결 수입니다. |
| id | 번호 | 백엔드 고유 식별자. |
| ip | 끈 | 실제 서비스가 듣고있는 IP. |
| 대기 | 번호 | 보류중인 연결 수입니다. |
| 포트 | 번호 | 실제 서비스가 수신하는 포트입니다. |
| 서비스 | 끈 | 고유 식별자로 사용되는 서비스 이름입니다. |
| 지위 | 끈 | 백엔드 상태. 가능한 값은 다음과 같습니다. up, 팜이 실행 중이고 백엔드가 연결을받을 준비가되었습니다. 아래 (down), 팜이 실행 중이고 백 엔드가 작동하지 않는 것으로 서비스에서 감지했습니다. 유지, 백엔드는 관리자가 연결을 수신 할 준비가되지 않은 것으로 표시됩니다.이 옵션은 백엔드의 유지 관리 작업에 유용합니다. 정의되지 않은, 백엔드 상태가 점검되지 않았습니다. |
세션 객체
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 클라이언트 | 끈 | 클라이언트 고유 식별자. |
| id | 끈 | 클라이언트에 할당 된 백엔드 고유 식별자입니다. |
| 서비스 | 끈 | 클라이언트에 할당 된 서비스 고유 식별자입니다. |
| 세션 | 끈 | 세션 고유 식별자입니다. 이 값은 지속성 유형에 따라 다릅니다. |
L4xNAT 팜에 대한 응답 예 :
{
"backends" : [
{
"established" : 5,
"id" : 1,
"ip" : "192.168.5.40",
"pending" : 0,
"port" : "8080",
"status" : "maintenance"
},
{
"established" : null,
"id" : 3,
"ip" : "192.5.1.1",
"pending" : 0,
"port" : "787",
"status" : "down"
},
{
"established" : null,
"id" : 5,
"ip" : "192.168.5.100",
"pending" : 0,
"port" : "8080",
"status" : "up"
}
],
"description" : "List farm stats"
}
L4xNAT 팜의 응답 매개 변수
응답은 키가있는 JSON이됩니다. 백엔드 아래 매개 변수를 사용하여 객체 배열을 평가합니다.
백엔드 객체:
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 확립 된 | 번호 | 현재 설정된 연결의 총 수 |
| id | 번호 | 백엔드 고유 식별자. |
| ip | 끈 | 실제 서비스가 듣고있는 IP. |
| 대기 | 번호 | 보류중인 연결 수입니다. |
| 포트 | 번호 | 실제 서비스가 수신하는 포트입니다. |
| 지위 | 끈 | 백엔드 상태. 가능한 값은 다음과 같습니다. up, 팜이 실행 중이고 백엔드가 연결을받을 준비가되었습니다. 아래 (down), 팜이 실행 중이고 백 엔드가 작동하지 않는 것으로 서비스에서 감지했습니다. 유지, 백엔드는 관리자가 연결을 수신 할 준비가되지 않은 것으로 표시됩니다.이 옵션은 백엔드의 유지 관리 작업에 유용합니다. 정의되지 않은, 백엔드 상태가 점검되지 않았습니다. |
데이터 링크 팜의 응답 매개 변수
데이터 링크 팜 통계는 실제로 사용할 수 없습니다.
모니터링 - 그래프
이 섹션은 내부로드 밸런서 시스템을 모니터링하여 CPU 사용량, 스왑 메모리, 램 메모리, 구성된 모든 nework 인터페이스,로드 및 하드 디스크 스토리지의 매개 변수를 통해 문제를 감지하는 데 유용합니다.
또한 주간, 가끔 및 매년 기록에 액세스 할 수 있습니다.
정보가있는 그래프는 base64 형식으로 응답됩니다.
사용 가능한 그래프 나열
사용 가능한 그래프 나열
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/graphs
GET /graphs
사용 가능한 모든 그래프가있는 객체를 시스템에 표시합니다. 가능한 요청을 보여줍니다.
응답 예 :
{
"description" : "These are the possible graphs, you`ll be able to access to the daily, weekly, monthly or yearly graph",
"farms" : [
"l4farm",
"newfarm",
"nwl4farm",
"httpweb"
],
"interfaces" : [
"eth0.1",
"eth1",
"eth0"
],
"system" : [
"cpu",
"load",
"ram",
"swap",
{
"disk" : [
"root/",
"root/boot",
"root/usr/local/zenloadbalancer/config",
"root/var/log"
]
}
]
}
응답 매개 변수
응답은 JSON의 세 가지 유형의 그래프가 될 것이며, 전원, 인터페이스 및 체계.
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 전원 | 끈[] | 사용할 수있는 팜 그래프 목록입니다. |
| 인터페이스 | 끈[] | 인터페이스 목록은 사용할 수있는 그래프입니다. |
| 체계 | 목적[] | 시스템 그래프 목록을 볼 수 있습니다. 배열에는 디스크 마운트 지점을 나타내는 배열이있는 객체가 있습니다. |
시스템 객체:
시스템 개체는 시스템과 관련된 배열 목록과 다음 형식의 디스크 개체를 포함합니다.
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 디스크 | 끈[] | 이 배열의 값은 모두 기존입니다. 마운트 포인트 시스템에서 각 그래프에는 사용 가능한 그래프가 있습니다. |
그래프 표시
그래프 표시
팜에 대한 예제 요청 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/graphs/farms/httpweb
인터페이스 요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/graphs/interfaces/eth0
디스크 요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/graphs/system/disk/root/boot
GET /graphs/<graph>
사용할 수있는 값 그래프 위치 :
| 가치관 | 설명: |
|---|---|
farms/<farmname> |
농장 이름, 팜 고유 식별자. |
interfaces/<interface> |
인터페이스, 인터페이스 고유 식별자. |
system/<system> |
체계가능한 시스템 그래프는 다음과 같습니다. CPU, 하중, 숫양 or 교환. |
system/disk/<mount point> |
마운트 포인트,의 값이다 디스크 개체, 'GET / graphs'호출에 의해 반환됩니다. |
응답 예 :
{
"description" : "Get cpu graphs",
"graphs" : [
{
"frequency" : "daily",
"graph" : "PNG IN BASE 64"
},
{
"frequency" : "weekly",
"graph" : "PNG IN BASE 64"
},
{
"frequency" : "monthly",
"graph" : "PNG IN BASE 64"
},
{
"frequency" : "yearly",
"graph" : "PNG IN BASE 64"
}
]
}
응답 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 주파수 | 끈 | 그래프를 생성하는 데 사용 된 시간. 가능한 값은 다음과 같습니다. 매일, 주간, 월 or 매년. |
| 그래프 | 끈 | 기본 64 형식의 그래프. |
빈도 그래프 표시
빈도 그래프 표시
팜에 대한 예제 요청 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/graphs/farms/httpweb/daily
인터페이스 요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/graphs/interfaces/eth0/monthly
디스크 요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/graphs/system/disk/root/boot/yearly
GET /graphs/<graph>/<frequency>
사용할 수있는 값 그래프 위치 :
| 가치관 | 설명: |
|---|---|
farms/<farmname> |
농장 이름, 팜 고유 식별자. |
interfaces/<interface> |
인터페이스, 인터페이스 고유 식별자. |
system/<system> |
체계가능한 시스템 그래프는 다음과 같습니다. CPU, 하중, 숫양 or 교환. |
system/disk/<mount point> |
마운트 포인트,의 값이다 디스크 개체, 'GET / graphs'호출에 의해 반환됩니다. |
사용할 수있는 값 주파수 위치 :
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 주파수 | 끈 | 그래프를 생성하는 데 사용 된 시간. 가능한 값은 다음과 같습니다. 매일, 주간, 월 or 매년. |
응답 예 :
{
"description" : "Get farm graphs",
"graph" : "PNG IN BASE 64"
}
응답 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 그래프 | 끈 | 기본 64 형식의 그래프. |
시스템 옵션은 밸런서에서 실행중인 서비스와 글로벌 매개 변수를 개인화 할 수있는 가능성을 제공합니다.
버전 표시
버전 표시
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/version
GET /system/version
제품 버전 정보를 보여줍니다.
응답 예 :
{
"description" : "Get version",
"params" : {
"appliance_version" : "ZVA 4100, hypervisor: xen",
"hostname" : "DEV5",
"kernel_version" : "3.16.7-ckt20",
"system_date" : "Thu Feb 2 10:34:27 2017",
"zevenet_version" : "5.0"
}
}
응답 매개 변수
응답은 아래의 매개 변수를 가진 JSON 객체가 될 것입니다.
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| appliance_version | 끈 | 응용 프로그램 버전. 가상 컴퓨터 인 경우 하이퍼 바이저도 표시하십시오. |
| 호스트 이름 | 끈 | 호스트 이름. |
| kernel_version | 끈 | 리눅스 커널 버전. |
| system_date | 끈 | 시스템 날짜. |
| zevenet_version | 끈 | Zevenet Community Edition 버전. |
DNS 표시
DNS 표시
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/dns
GET /system/dns
DNS 서비스 구성을 표시합니다.
응답 예 :
{
"description" : "Get dns",
"params" : {
"primary" : "8.8.8.8",
"secondary" : null
}
}
응답 매개 변수
응답은 아래의 매개 변수를 가진 JSON 객체가 될 것입니다.
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 일차 | 끈 | 주 DNS는 시스템에서 구성됩니다. |
| 보조 | 끈 | 보조 DNS는 시스템에서 구성됩니다. |
DNS 수정
DNS 수정
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"primary":"8.8.4.4","secondary":"8.8.8.8"}'
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/dns
POST /system/dns
DNS 서비스 구성을 수정하십시오.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 일차 | 끈 | 주 DNS는 시스템에서 구성됩니다. |
| 보조 | 끈 | 보조 DNS는 시스템에서 구성됩니다. |
응답 예 :
{
"description" : "Post dns",
"params" : {
"primary" : "8.8.4.4",
"secondary" : "8.8.8.8"
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
SNMP 표시
SNMP 표시
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/snmp
GET /system/snmp
SNMP 서비스 구성을 표시하십시오.
응답 예 :
{
"description" : "Get snmp",
"params" : {
"community" : "public",
"ip" : "*",
"port" : "161",
"scope" : "0.0.0.0/0",
"status" : "false"
}
}
응답 매개 변수
응답은 아래의 매개 변수를 가진 JSON 객체가 될 것입니다.
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 커뮤니티 | 끈 | 커뮤니티 이름. 읽기 전용 커뮤니티가 사용되었습니다. |
| ip | 끈 | SNMP 서비스가 실행중인 인터페이스 IP. 모든 인터페이스가 활성화 된 상태로 유지하는 것이 안전합니다. 캐릭터 *. |
| 포트 | 끈 | SNMP 서비스가 실행중인 포트. |
| 범위 | 끈 | 액세스 할 수있는 IP 또는 서브넷 (IP / 비트). 허용 된 클라이언트 IP가 SNMPD 서비스에 액세스하도록 허용합니다. 단 하나의 IP 만 허용하려는 경우 "/ 32"비트를 사용하십시오. |
| 지위 | 끈 | SNMP 서비스의 상태. 가능한 값은 다음과 같습니다. 참된, 서비스가 실행 중입니다. 또는 그릇된, 서비스가 중지됩니다. |
SNMP 수정
SNMP 수정
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"ip":"192.168.100.241","port":"170","scope":"0.0.0.0/0","status":"true","community":"public"}'
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/snmp
POST /system/snmp
SNMP 서비스 구성을 수정하십시오.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 커뮤니티 | 끈 | 커뮤니티 이름. 읽기 전용 커뮤니티가 사용되었습니다. |
| ip | 끈 | SNMP 서비스가 실행중인 인터페이스 IP. 모든 인터페이스가 활성화 된 상태로 유지하는 것이 안전합니다. 캐릭터 *. |
| 포트 | 끈 | SNMP 서비스가 실행중인 포트. |
| 범위 | 끈 | 액세스 할 수있는 IP 또는 서브넷 (IP / 비트). 허용 된 클라이언트 IP가 SNMPD 서비스에 액세스하도록 허용합니다. 단 하나의 IP 만 허용하려는 경우 "/ 32"비트를 사용하십시오. |
| 지위 | 끈 | SNMP 서비스의 상태. 가능한 값은 다음과 같습니다. 참된, 서비스가 실행 중입니다. 또는 그릇된, 서비스가 중지됩니다. |
응답 예 :
{
"description" : "Post snmp",
"params" : {
"community" : "public",
"ip" : "192.168.100.241",
"port" : "170",
"scope" : "0.0.0.0/0",
"status" : "true"
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
라이선스 검색
라이선스 검색
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/license/txt
GET /system/license/<format>
Zevenet 라이센스를 형식으로 표시하십시오. 사용할 수있는 체재 값은 HTML or TXT.
NTP 표시
NTP 표시
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/ntp
GET /system/ntp
NTP 서비스 구성을 표시하십시오.
응답 예 :
{
"description" : "Get ntp",
"params" : {
"server" : "pool.ntp.org"
}
}
응답 매개 변수
응답은 아래의 매개 변수를 가진 JSON 객체가 될 것입니다.
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 섬기는 사람 | 끈 | NTP 클라이언트가 요청을 처리하는 서버. |
NTP 수정
NTP 수정
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"server":"pool.ntp.org"}'
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/ntp
POST /system/ntp
NTP 서비스 구성을 수정하십시오.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 섬기는 사람 | 끈 | NTP 클라이언트가 요청을 처리하는 서버. |
응답 예 :
{
"description" : "Post ntp",
"params" : "pool.ntp.org"
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
모든 사용자 나열
모든 사용자 나열
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/users
GET /system/users
시스템에서 사용 가능한 사용자를 나열하십시오.
응답 예 :
{
"description" : "Get users",
"params" : [
{
"status" : "true",
"user" : "root"
},
{
"status" : "true",
"user" : "zapi"
}
]
}
응답 매개 변수
응답은 아래 매개 변수의 배열을 가진 JSON 객체입니다.
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 지위 | 끈 | 사용자 상태. 가능한 값은 다음과 같습니다. 참된, 사용자가 활성화됩니다. 그렇지 않은가 그릇된, 사용자는 비활성화됩니다. |
| 사용자 | 끈 | 사용자 이름. |
zapi 사용자 검색
zapi 사용자 검색
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/users/zapi
GET /system/users/zapi
zapi 사용자 구성을 표시하십시오. 이 매개 변수는 zapi를 통해 Zevenet 서비스에 액세스하는 데 필요합니다.
응답 예 :
{
"description" : "Zapi user configuration.",
"params" : {
"key" : "root",
"status" : "true"
}
}
응답 매개 변수
응답은 아래 매개 변수의 배열을 가진 JSON 객체입니다.
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 키 | 끈 | zapi에서 인증하는 키. 이것은 매개 변수입니다. ZAPI_KEY zapi에 대한 호출에 사용됩니다. |
| 지위 | 끈 | Zapi 사용자 상태. 그 값이 참된, zapi를 사용할 수 있습니다. 그렇지 않은가 그릇된, zapi는 비활성화되고 요청을 보낼 수 없습니다. |
zapi 사용자 구성 수정
zapi 사용자 구성 수정
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"key":"newzapikey","status":"enable","newpassword":"password1234"}'
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/users/zapi
POST /system/users/zapi
zapi 사용자 구성을 수정하십시오. 이 매개 변수는 zapi를 통해 Zevenet 서비스에 액세스하는 데 필요합니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 키 | 끈 | zapi에서 인증하는 키. 이것은 매개 변수입니다. ZAPI_KEY zapi에 대한 호출에 사용됩니다. |
| 새 비밀번호 | 끈 | zapi 사용자의 새 암호입니다. |
| 지위 | 끈 | Zapi 사용자 상태. 가능한 값은 다음과 같습니다. 가능 zapi 사용자 또는 비활성화 zapi 사용자를 비활성화합니다. zapi 사용자가 비활성화되어 있으면 요청을 보낼 수 없습니다. |
응답 예 :
{
"description" : "Zapi user settings.",
"message" : "Settings was changed successful.",
"params" : {
"key" : "newzapikey",
"newpassword" : "password1234",
"status" : "enable"
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
루트 암호 수정
루트 암호 수정
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
{"password":"admin","newpassword":"alwaysisbetterastrongpass"}
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/users/root
POST /system/users/root
루트 암호를 수정하십시오. 이 사용자는 GUI를 통해 zevenet 서비스에 액세스하는 데 사용됩니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: | 필수 |
|---|---|---|---|
| 암호 | 끈 | 현재 루트 사용자 암호. | 참된 |
| 새 비밀번호 | 끈 | 루트 사용자의 새 암호입니다. | 참된 |
응답 예 :
{
"description" : "User settings.",
"message" : "Settings was changed succesful.",
"params" : {
"newpassword" : "alwaysisbetterastrongpass",
"password" : "admin"
}
}
응답 매개 변수
응답은 요청 된 모든 값이 업데이트 된 json이됩니다. 자세한 정보는 응답 예제를 참조하십시오.
로그 파일 나열
로그 파일 나열
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/logs
GET /system/logs
사용 가능한 로그 파일을 나열하십시오.
응답 예 :
{
"description" : "Get logs",
"params" : [
{
"date" : "Mon Jan 30 06:25:02 2017",
"file" : "syslog.4.gz"
},
{
"date" : "Tue Jan 31 06:25:03 2017",
"file" : "syslog.3.gz"
},
{
"date" : "Wed Feb 1 06:25:04 2017",
"file" : "syslog.2.gz"
},
{
"date" : "Thu Feb 2 06:25:03 2017",
"file" : "syslog.1"
},
{
"date" : "Sun Jan 29 06:25:03 2017",
"file" : "syslog.5.gz"
},
{
"date" : "Fri Feb 3 04:28:56 2017",
"file" : "syslog"
}
]
}
응답 매개 변수
응답은 로그 파일의 배열을 가진 JSON이 될 것입니다. 각 개체의 매개 변수는 다음과 같습니다.
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 데이터 | 끈 | 마지막 파일 수정 날짜. |
| 파일 | 끈 | 로그 파일의 파일 이름입니다. 로그 고유 식별자로 사용됩니다. |
로그 파일의 행 표시
로그 파일의 행 표시
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/logs/kern.log/lines/2
GET /system/logs/<file>/lines/<lines>
로그 파일의 여러 행을 나열하십시오. URI 매개 변수 파일 읽기에서 로그 파일입니다. 선 마지막에서 보여줄 줄 수입니다.
응답 예 :
{
"description" : "Show a log file",
"log" : [
"Aug 28 09:44:00 maq2 kernel: [258451.740173] Netfilter messages via NETLINK v0.30.\n",
"Aug 28 09:44:00 maq2 kernel: [258451.775666] ctnetlink v0.93: registering with nfnetlink.\n"
]
}
응답 매개 변수
응답은 로그 파일의 배열을 가진 JSON이 될 것입니다. 키는 log이고 값은 요청 된 행 수의 배열입니다.
로그 파일 다운로드
로그 파일 다운로드
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/logs/syslog.2.gz > log.gz
GET /system/logs/<file>
GET 요청 중에 나열된 사용 가능한 로그 파일의 로그 파일을 다운로드하십시오.
파일 로그 파일 고유 식별자입니다.
시스템 - 백업
백업 옵션을 사용하면 현재 시스템 구성을 저장하고 다운로드 할 수 있습니다.
이 섹션에서는 백업 파일을 생성, 복원, 업로드 및 다운로드 할 수 있습니다.
목록 백업
목록 백업
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/backup
GET /system/backup
응답 예 :
{
"description" : "Get backups",
"params" : [
{
"date" : "Fri Feb 3 06:01:04 2017",
"name" : "newbackup"
},
{
"date" : "Fri Feb 3 05:50:48 2017",
"name" : "firstConf"
}
]
}
응답 매개 변수
응답은 백업 배열이있는 JSON이됩니다. 각 배열 요소의 매개 변수는 다음과 같습니다.
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 데이터 | 끈 | 최종 수정 날짜. |
| name | 끈 | 고유 식별자로 사용되는 파일 이름입니다. 파일 확장자는 .tar.gz. |
백업 만들기
백업 만들기
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"name":"firstConf"}'
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/backup
POST /system/backup
현재 구성의 시스템 구성 백업을 작성하십시오.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| name | 끈 | 고유 식별자로 사용되는 파일 이름입니다. 파일 확장자는 .tar.gz. |
응답 예 :
{
"description" : "Create a backups",
"message" : "Backup firstConf was created successful.",
"params" : "firstConf"
}
백업 다운로드
백업 다운로드
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/backup/firstConf > ~/zevenetConf.tar.gz
백업 파일은 TAR GZ 형식입니다.
GET /system/backup/<name>
시스템 구성 백업을 다운로드하십시오. name 백업 고유 식별자입니다.
백업 업로드
백업 업로드
요청 예 :
curl -k -X PUT -H 'Content-Type: text/plain'
--data-binary @/opt/1mar.tar.gz -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/backup/newbackup
PUT /system/backup/<name>
Zevenet에 로컬 저장된 백업을 업로드하십시오. name Zevenet에 저장 될 백업 고유 식별자입니다.
요청 매개 변수
백업을 업로드하려면 –data-binary를 사용해야합니다.
응답 예 :
{
"description" : "Upload a backup",
"message" : "Backup newbackup was created successful.",
"params" : "newbackup"
}
백업 삭제
백업 삭제
요청 예 :
curl -k -X DELETE -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/backup/firstConf
DELETE /system/backup/<name>
Zevenet 시스템에서 백업 파일을 삭제하십시오. name 백업 고유 식별자입니다.
응답 예 :
{
"description" : "Delete backup firstConf'",
"message" : "The list firstConf has been deleted successful.",
"success" : "true"
}
백업 적용
백업 적용
요청 예 :
curl -k -X POST -H 'Content-Type: application/json' -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
-d '{"action":"apply"}'
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/backup/firstConf/actions
POST /system/backup/<name>/actions
백업 파일에서 구성을 복원하십시오. name 백업 고유 식별자입니다.
요청 매개 변수
| 분야 | 거래증명방식 | 설명: |
|---|---|---|
| 동작 | 끈 | 백업 구성을 복원하려면 값이 다음과 같아야합니다. 대다. |
응답 예 :
{
"description" : "Apply a backup to the system",
"params" : {
"action" : "apply"
}
}
무료 지원을 다운로드하십시오.
무료 지원을 다운로드하십시오.
요청 예 :
curl -k -X GET -H "ZAPI_KEY: <ZAPI_KEY_STRING>"
https://<zevenet_server>:444/zapi/v3.1/zapi.cgi/system/supportsave > supportsave.tar.gz
GET /system/supportsave
시스템에서 실행중인 모든 구성 및 프로세스로 시스템 상태 이미지를 가져옵니다. 이 지원을 통해 문제를 찾고 지원을받을 필요가 있습니다.