Red Hat Summit6장. API에서 필터링
시스템은 컬렉션을 "쿼리 세트"로 인식합니다. 다양한 연산자를 사용하여 필터링할 수 있습니다.
프로세스
"foo"라는 이름이 포함된 그룹을 찾으려면 다음을 사용합니다.
http://<controller server name>/api/v2/groups/?name__contains=foo
Copy to clipboardCopiedhttp://<controller server name>/api/v2/groups/?name__contains=foo정확한 일치 항목을 찾으려면 다음을 사용합니다.
http://<controller server name>/api/v2/groups/?name=foo
Copy to clipboardCopiedhttp://<controller server name>/api/v2/groups/?name=foo리소스가 정수 유형인 경우 문자열 입력 값을 정수로 캐스팅하려면
\_\_int를 끝에 추가해야 합니다.http://<controller server name>/api/v2/arbitrary_resource/?x__int=5
Copy to clipboardCopiedhttp://<controller server name>/api/v2/arbitrary_resource/?x__int=5다음을 사용하여 관련 리소스를 쿼리할 수 있습니다.
http://<controller server name>/api/v2/users/?first_name__icontains=kim
Copy to clipboardCopiedhttp://<controller server name>/api/v2/users/?first_name__icontains=kim이렇게 하면 "Kim" 문자열이 포함된 이름이 있는 모든 사용자가 반환됩니다.
한 번에 여러 필드에 대해 필터링할 수도 있습니다.
http://<controller server name>/api/v2/groups/?name__icontains=test&has_active_failures=false
Copy to clipboardCopiedhttp://<controller server name>/api/v2/groups/?name__icontains=test&has_active_failures=false그러면 활성 오류가 없는 "test"가 포함된 모든 그룹이 검색됩니다.
추가 리소스
사용 가능한 연산자 유형에 대한 자세한 내용은 QuerySet API 참조를 참조하십시오.
또한 UI가 사용되는 동안 API에서 다양한 기준으로 필터링하는 방법을 확인할 수 있습니다.
6.1. API의 고급 쿼리
지정된 값과 일치하는 항목으로 반환된 결과 목록을 필터링하는 데 사용되는 추가 쿼리 문자열 매개변수를 사용할 수 있습니다. 필터링을 위해 데이터베이스에 존재하는 필드 및 관계만 사용할 수 있습니다. 지정된 값의 특수 문자가 URL로 인코딩되었는지 확인합니다. 예를 들면 다음과 같습니다.
?field=value%20xyz
?field=value%20xyz필드는 데이터베이스에 정의된 필드 및 관계에 대해서만 관계를 확장할 수도 있습니다.
?other__field=value
?other__field=value
특정 기준과 일치하는 결과를 제외하려면 field 매개변수 앞에 not__: 접두사를 지정합니다.
?not__field=value
?not__field=value
기본적으로 모든 쿼리 문자열 필터는 AND로 연결되므로 모든 필터와 일치하는 결과만 반환됩니다. 여러 조건 중 하나와 일치하는 결과를 결합하려면 각 쿼리 문자열 매개변수 앞에 or__ 를 붙입니다.
?or__field=value&or__field=othervalue ?or__not__field=value&or__field=othervalue
?or__field=value&or__field=othervalue
?or__not__field=value&or__field=othervalue
기본 AND 필터링에서는 여러 데이터베이스 관계에 걸쳐 필터링되는 각 관련 오브젝트에 모든 필터를 동시에 적용합니다. 반면 체인 필터는 각 관련 오브젝트에 필터를 개별적으로 적용합니다. 이를 사용하려면 query 문자열 매개변수 앞에 chain__: 접두사를 붙입니다.
?chain__related__field=value&chain__related__field2=othervalue ?chain__not__related__field=value&chain__related__field2=othervalue
?chain__related__field=value&chain__related__field2=othervalue
?chain__not__related__field=value&chain__related__field2=othervalue
첫 번째 쿼리를 ? 관련field=value&relatedfield2=othervalue 로 작성하는 경우 관련 개체가 두 조건을 모두 충족하는 기본 오브젝트만 반환합니다. 체인 필터를 사용하여 작성된 대로 각 조건과 일치하는 기본 오브젝트의 교집합을 반환합니다.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}