3.7. 검색

max 매개변수를 사용하여 반환된 오브젝트 수를 제한합니다. 예를 들어 다음 요청에서는 시스템에서 사용할 수 있는 수에 관계없이 하나의 가상 머신만 반환합니다.

GET /ovirt-engine/api/vms?max=1

max 매개변수가 없는 검색 요청은 모든 오브젝트를 반환합니다. 시스템의 전반적인 성능에 대한 요청의 영향을 줄이기 위해 max 매개변수를 지정하는 것이 좋습니다.

기본적으로 쿼리는 대소문자를 구분하지 않습니다. 예를 들어 다음 요청에서는 myvm,MyVM 및 MYVM 이라는 가상 머신을 반환합니다.

GET /ovirt-engine/api/vms?search=name%3Dmyvm

선택적 case_sensitive 부울 매개변수를 사용하여 이 동작을 변경할 수 있습니다. 예를 들어 MyHost 또는 MYHOST 가 아닌 myhost 라는 가상 머신을 정확히 얻으려면 다음과 같은 요청을 보냅니다.

GET /ovirt-engine/api/vms?search=name%3D=myvm&case_sensitive=true

검색 매개변수는 Red Hat Virtualization 쿼리 언어와 동일한 구문을 사용합니다.

(criteria) [sortby (element) asc|desc]

sortby 절은 선택 사항이며 결과를 정렬할 때만 필요합니다.

검색 쿼리 예:

search 매개변수 값은 연산자 및 공백과 같은 예약된 문자를 변환하기 위해 URL로 인코딩 되어야 합니다. 예를 들어 등호는 %3D 로 인코딩되어야 합니다.

GET /ovirt-engine/api/vms?search=name%3Dmyvm

별표는 값의 일부로 사용하여 emtpy 문자열을 포함하여 일치하는 문자열이 있음을 나타낼 수 있습니다. 예를 들어 다음 요청에서는 myvm ,myvm2, myvm a 또는 myvm -webserver 와 같이 이름이 myvm으로 시작하는 모든 가상 머신을 반환합니다.

GET /ovirt-engine/api/vms?search=name%3Dmyvm*

일부 Red Hat Virtualization 환경에는 대규모 오브젝트 컬렉션이 포함되어 있습니다. 하나의 요청으로 모두를 검색하는 것은 실용적이지 않으며 성능이 저하됩니다. 페이지별로 페이지를 검색할 수 있도록 search 매개 변수는 선택적 페이지 절을 지원합니다. max 매개변수와 함께 이 값은 페이징 기준으로 사용됩니다. 예를 들어 페이지 크기가 10개인 가상 머신의 첫 번째 페이지를 가져오려면 다음과 같이 요청을 보냅니다.

GET /ovirt-engine/api/vms?search=page%201&max=10

페이지 값을 늘려 다음 페이지를 검색합니다.

GET /ovirt-engine/api/vms?search=page%202&max=10

page 절은 search 매개변수 내부의 다른 절과 함께 사용할 수 있습니다. 예를 들어 다음 요청에서는 가상 머신의 두 번째 페이지를 반환하지만 이름으로 정렬됩니다.

GET /ovirt-engine/api/vms?search=sortby%20name%20page%202&max=10