8장. 액세스 리소스

/api/controller/v2/settings/named-url/: NAMED_URL_FORMATS 및 NAMED_URL_GRAPH_NODES 에서 사용할 수 있는 이름이 지정된 URL 관련 구성 설정은 두 가지가 있습니다.

NAMED_URL_FORMATS 는 이름이 지정된 모든 URL 식별자 형식의 읽기 전용 키-값 쌍 목록입니다. 다음은 NAMED_URL_FORMATS 예제를 보여줍니다.

"NAMED_URL_FORMATS": {
"organizations": "<name>",
"teams": "<name>++<organization.name>",
"credential_types": "<name>+<kind>",
"credentials": "<name>++<credential_type.name>+<credential_type.kind>++<organization.name>",
"notification_templates": "<name>++<organization.name>",
"job_templates": "<name>++<organization.name>",
"projects": "<name>++<organization.name>",
"inventories": "<name>++<organization.name>",
"hosts": "<name>++<inventory.name>++<organization.name>",
"groups": "<name>++<inventory.name>++<organization.name>",
"inventory_sources": "<name>++<inventory.name>++<organization.name>",
"inventory_scripts": "<name>++<organization.name>",
"instance_groups": "<name>",
"labels": "<name>++<organization.name>",
"workflow_job_templates": "<name>++<organization.name>",
"workflow_job_template_nodes": "<identifier>++<workflow_job_template.name>++<organization.name>",
"applications": "<name>++<organization.name>",
"users": "<username>",
"instances": "<hostname>"
}

NAMED_URL_FORMATS 의 각 항목에 대해 키는 이름이 URL인 리소스의 API 이름입니다. 값은 해당 리소스에 대해 사람이 읽을 수 있는 고유 ID를 형성하는 방법을 나타내는 문자열입니다. NAMED_URL_FORMATS 는 이름이 지정된 URL을 포함할 수 있는 리소스만 나열합니다. 여기에 나열되지 않은 리소스에는 이름이 지정된 URL이 없습니다. 리소스에 이름이 지정된 URL이 있을 수 있는 경우 해당 오브젝트에 오브젝트별 이름이 지정된 URL을 나타내는 named_url 필드가 있어야 합니다. 해당 필드는 목록 보기가 아닌 세부 정보 보기에만 표시됩니다. 정확히 생성된 이름이 지정된 URL을 사용하여 지정된 리소스 오브젝트에 액세스할 수 있습니다. 개체 및 관련 URL입니다. 예를 들어 /api/controller/v2/res_name/obj_slug/ 가 유효한 경우 /api/controller/v2/res_name/obj_slug/related_res_name/ 도 유효합니다.

NAMED_URL_FORMATS 는 사람이 읽을 수 있는 고유 식별자와 이름이 지정된 URL을 직접 구성할 수 있을 만큼 권한을 부여합니다. 사용하기 쉽도록 이름이 지정된 URL을 포함할 수 있는 리소스의 모든 오브젝트에는 해당 오브젝트의 이름이 지정된 URL을 표시하는 관련 필드인_url 이 있습니다. 사용자 정의 용도로 해당 필드를 복사하여 붙여넣을 수 있습니다. 자세한 내용은 리소스 오브젝트에 이름이 지정된 URL이 있는 경우 API 브라우저의 도움말 텍스트를 참조하십시오.

이름이 지정된 URL 레이블을 수동으로 결정할 수 있습니다(예: ID 5). NAMED_URL_FORMATS 를 사용하여 이 특정 리소스 오브젝트에 대해 이름이 지정된 URL을 작성하려면 먼저 NAMED_URL_FORMATS 의 labels 필드를 찾아 ID 형식 <name> ++<organization.name>을 가져옵니다.

이름이 지정된 URL에 대한 고유 ID를 생성하는 작업의 중요한 측면은 예약된 문자와 관련이 있습니다. ID가 URL의 일부이므로 URL 표준에 따라 예약된 문자는 백분율 기호로 인코딩됩니다. ;/?@=&[]. 예를 들어 조직 이름이 ;/?:@=&[] 인 경우 고유 식별자는 %3B%3F%3F%3F%3D%5B%5D 여야 합니다. 또 다른 특수 예약 문자는 + 이며 URL 표준에 의해 예약되지는 않지만 이름이 지정된 URL에서 식별자의 다른 부분을 연결하는 데 사용됩니다. [암호]로 인코딩됩니다. 예를 들어 조직 이름이 [ Cryostat )인 경우 고유 식별자는 %5B[#159%5D )입니다. 여기서 original [ 및 ] 은 백분율로 인코딩되고 + 는 []로 변환됩니다.

NAMED_URL_FORMATS 를 수동으로 변경할 수는 없지만 기본 리소스 수정 및 확장을 반영하여 수정 사항이 자동으로 발생하고 시간이 지남에 따라 확장됩니다. 이름이 지정된 URL 기능을 사용하려는 동일한 클러스터에서 NAMED_URL_FORMATS 를 참조하십시오.

NAMED_URL_GRAPH_NODES 는 이름이 지정된 URL을 관리하는 데 사용되는 내부 그래프 데이터 구조를 노출하는 키-값 쌍의 읽기 전용 목록입니다. 이는 사람이 읽을 수 있는 것은 아니지만 이름이 지정된 URL을 프로그래밍 방식으로 생성하는 데 사용해야 합니다. NAMED_URL_GRAPH_NODES 에서 제공하는 정보를 사용하여 이름이 지정된 URL의 기본 키를 기반으로 이름이 지정된 URL을 생성하는 스크립트의 예는 GitHub 에서 찾을 수 있습니다.