4장. 검색
자동화 컨트롤러의 검색 툴을 사용하여 여러 기능의 검색 및 필터링 기능을 사용할 수 있습니다. 검색 필드의 이름 메뉴에서 확장 가능한 검색 조건 목록을 사용할 수 있습니다.
4.1. 검색 규칙
이러한 검색 팁에서는 호스트를 검색하지 않는 것으로 가정합니다.
- 검색의 일반적인 구문은 필드와 값이 차례로 구성됩니다.
- 콜론은 값에서 검색할 필드를 구분하는 데 사용됩니다.
-
검색에 콜론이 없는 경우(예: 3 참조)
?search=foobar
가 전송되는 간단한 문자열 검색으로 처리됩니다.
다음은 검색에 사용되는 구문의 예입니다.
-
name:localhost
이 예제에서 사용자는 name 속성에서localhost
문자열을 검색하고 있습니다. 해당 문자열이 필드 또는 관련 필드의 항목과 일치하지 않으면 전체 검색이 문자열로 처리됩니다. -
organization.name:Default
이 예는 관련 필드 검색을 보여줍니다.organization.name
의 마침표는 모델을 필드에서 구분합니다. 검색이 얼마나 깊거나 복잡한지에 따라 쿼리의 해당 부분에 마침표가 여러 개 있을 수 있습니다. foobar
이 검색은 이름 및 설명 필드에 대해icontains
검색을 사용하여 검색어의 모든 인스턴스를 찾는 간단한 문자열(키 용어) 검색입니다. 용어(예:foo bar
) 사이에 공백을 사용하는 경우 두 용어를 모두 포함하는 결과가 반환됩니다. 용어를 따옴표로 묶는 경우(예:"foo bar
") 자동화 컨트롤러는 용어가 함께 나타나는 문자열을 검색합니다.API 이름에 대해 특정 이름 검색을 검색합니다. 예를 들어 사용자 인터페이스의
관리 작업은
API의system_job
입니다.-
조직:Default
이 예제에서는 관련 필드 검색을 표시하지만 조직과 함께 사용할 필드를 지정하지 않습니다. 이는 API에서 지원하며 간단한 문자열 검색과 유사하지만 조직에 대해 수행됩니다(이름 및 설명 모두에 대해 아이콘 검색 수행).
4.1.1. 검색 필드의 값
특정 필드의 값을 찾으려면 API 끝점에서 광범위한 옵션과 유효한 해당 값을 참조하십시오. 예를 들어
> /api/v2/jobs
type
필드에 대해 검색하려면 /api/v2/jobs에 대한 OPTIONS 요청을 수행하고 API의 "type"
항목을 찾아 값을 찾을 수 있습니다. 또한 각 화면의 맨 아래로 스크롤하여 관련 검색을 볼 수 있습니다. /api/v2/jobs
의 예에서는 관련 검색이 표시됩니다.
"related_search_fields": [ "modified_by__search", "project__search", "project_update__search", "credentials__search", "unified_job_template__search", "created_by__search", "inventory__search", "labels__search", "schedule__search", "webhook_credential__search", "job_template__search", "job_events__search", "dependent_jobs__search", "launch_config__search", "unifiedjob_ptr__search", "notifications__search", "unified_job_node__search", "instance_group__search", "hosts__search", "job_host_summaries__search"
필드의 값은 GET 요청의 키에서 가져옵니다. URL
,related
, summary_fields
는 사용되지 않습니다. 관련 필드의 값도 OPTIONS 응답에서 제공되지만 다른 특성에서 제공됩니다. 관련 필드는 related_search_fields
에서 모든 값을 가져와 끝에서 __search
를 제거하여 채워집니다.
필드의 값 또는 관련 필드의 값으로 시작하지 않는 검색은 일반 문자열 검색으로 처리됩니다. 예를 들어 localhost
를 검색하면 UI에서 ?search=localhost
를 API 끝점에 쿼리 매개변수로 보냅니다. 이름 및 설명 필드에서 icontains
검색의 바로 가기입니다.
4.1.3. 기타 검색 고려 사항
자동화 컨트롤러에서 검색할 때 다음 문제를 유의하십시오.
- 현재 또는 쿼리에 지원되는 구문이 없습니다. 모든 검색어는 쿼리 매개변수에서 AND로 지정됩니다.
- 검색 매개변수의 왼쪽 부분은 공백이 있는 문자열 검색을 지원하기 위해 따옴표로 묶을 수 있습니다. 자세한 내용은 검색 규칙을 참조하십시오.
-
현재 필드의 값은 GET 요청에서 반환될 것으로 예상되는 직접적인 속성입니다. 값 중 하나에 대해 검색할 때마다 자동화 컨트롤러는
__icontains
검색을 수행합니다. 예를 들어name:localhost
가 다시?name__icontains=localhost
로 보냅니다. 자동화 컨트롤러는 현재id
에서도 모든 필드 값에 대해 이 검색을 수행합니다.