API 확장 클래스

  • 릴리스 버전: Washingtondc
  • 업데이트 날짜 2024년 02월 01일
  • 읽기7분

    • CMDB CI Class Models 스토어 앱은 API(Application Programming Interface)에 대한 클래스를 추가하거나 업데이트합니다.

    앱은 클래스 설명, 식별 규칙, 식별자 항목 및 종속 관계(해당되는 경우)를 포함하여 CMDB 클래스 계층 구조를 확장하는 클래스 모델을 추가합니다. 추가된 클래스를 다른 CMDB 클래스처럼 사용할 수 있습니다. 와 같은 검색 및 서비스 매핑 패턴 애플리케이션은 이러한 클래스 확장을 사용하여 CI를 채우고 다양한 기술 및 소프트웨어를 검색할 수 있습니다.

    스토어에서 앱 요청

    ServiceNow Store 웹 사이트를 방문하면 사용 가능한 모든 앱을 확인하고 스토어에 요청을 제출하는 방법에 대한 정보를 참조할 수 있습니다. 출시된 모든 앱의 누적 릴리스 정보는 ServiceNow Store 버전 기록 릴리스 정보를 참조하십시오.

    API

    API는 컴퓨터 프로그램이 서로 통신할 수 있도록 하는 정의 및 프로토콜 집합으로, 이를 통해 애플리케이션 소프트웨어를 빌드하거나 통합할 수 있습니다. API는 일반적으로 웹 기반 기술을 사용하여 다른 API와 통신합니다. API는 일반적으로 프로그래밍 방식으로 작업 또는 태스크를 수행하거나 데이터를 보거나, 가져오거나, 내보내거나, 삭제하거나, 수정하는 데 사용됩니다.

    이 릴리스에 추가된 클래스는 데이터 모델을 확장하고 API CI 클래스 표현을 위한 기초를 제공합니다. 이 기초를 사용하여 다음을 수행할 수 있습니다.
    • API에 대한 가시성을 높일 수 있습니다.
    • API 엔드포인트와 관련된 보안 문제 및 취약성을 식별합니다.

    클래스

    이 섹션에는 CMDB CI Class Models 스토어 앱이 추가하거나 업데이트하는 클래스가 나열됩니다.

    CMDB CI Class Models: 릴리스 1.49.0은 API에 대해 다음 클래스를 추가합니다. 이 스토어 앱이 확장할 수 있는 클래스를 포함하여 기본 시스템의 CMDB 클래스 목록은 을 참조하십시오 CMDB 테이블 설명.

    클래스 확장 설명
    API

    [cmdb_ci_api]

    		 구성 항목

    [cmdb_ci]

    		 일반적으로 웹 기반 기술을 사용하여 두 컴퓨터 프로그램이 서로 통신할 수 있도록 하는 API입니다. 예: ChatAPI(https://[apiID].execute-api.use-east-2.amazonaws.com).
    API 구성요소

    [cmdb_ci_api_component]

    		 구성 항목

    [cmdb_ci]

    		 데이터의 기능 또는 교환을 용이하게 하는 API 정의와 관련된 재사용 가능한 객체입니다. 예: GET https://[instance].service-now.com/api/now/table/{tablename}.
    API 프런트엔드

    [cmdb_ci_api_frontend]

    		 API 구성요소

    [cmdb_ci_api_component]

    		 클라이언트 또는 사용자가 상호작용하거나 요청을 수행하는 API의 일부입니다. 예: GET https://[apiID].execute-api.us-east-2.amazonaws.com/{proxy+}.
    API 백엔드

    [cmdb_ci_api_backend]

    		 API 구성요소

    [cmdb_ci_api_component]

    		 서버와 같은 백엔드 서비스와 상호작용하여 요청을 이행하는 API의 일부입니다. 예: lambda:Chat-API-proxy.
    API 게이트웨이

    [cmdb_ci_api_gateway]

    		 애플리케이션

    [cmdb_ci_appl]

    		 클라이언트 API 요청을 중앙 집중화하고 백엔드 프로세스 및 서비스를 관리하는 API 인프라입니다. 예: 콩 게이트웨이.
    관리되는 API

    [cmdb_ci_managed_api]

    		 구성 항목

    [cmdb_ci_api]

    		 게이트웨이 또는 관리 서비스에서 검색된 API입니다. 이 클래스의 API에 대한 게이트웨이에 종속성을 적용할 수 있습니다.

    클래스 속성

    CMDB CI Class Models: 릴리스 1.49.0은 각 클래스에 다음 속성을 추가합니다.

    표 1. API [cmdb_ci_api]
    속성 데이터 유형 설명
    기본 URL 문자열 (1024) 모든 API 구성요소가 확장되는 기본 주소입니다.
    ID 문자열 (1024) 소스 시스템의 고유 식별자입니다.
    유형 선택 목록 API 유형입니다. 다음을 지정할 수 있습니다.
    • REST
    • SOAP
    • HTTP
    • gRPC (영문)
    • GraphQL
    • Websocket
    버전 숫자 API의 버전입니다.
    사양 위치 URL API 사양의 위치에 대한 URL입니다. 예: OpenAPI 사양 정의.
    표 2. API 구성요소 [cmdb_ci_api_component]
    속성 데이터 유형 설명
    방법 문자열 REST API 메서드. 예시:
    • GET
    • POST
    • 삭제
    프로토콜 문자열 통신 프로토콜입니다. 예: HTTP, HTTPS.
    호스트 문자열 (100) API를 호스팅하는 시스템입니다.
    경로 문자열 (1024) API가 따르는 특정 경로입니다.
    포트 문자열 통신 포트입니다. 예: 80, 443 등.
    URL 문자열 (1024) 호출되는 자원의 URL입니다.
    ID 문자열 (1024) 소스 시스템의 고유 식별자입니다.
    인터넷 연결 부울 공용 인터넷에서 구성요소에 연결할 수 있는지 여부를 나타내는 부울입니다. 구성요소에 연결할 수 있는 경우 1 또는 "true"를 지정합니다.
    권한 부여 문자열 권한 부여 또는 인증 방법의 유형입니다. 예시:
    • 기본
    • 키
    • OAuth
    • 없음
    요청 데이터 유형 문자열 (255) 요청의 데이터 형식 목록입니다. 예시:
    • 참조
    • 이메일
    • 주소
    응답 데이터 유형 문자열 (255) 응답의 데이터 유형 목록입니다. 예시:
    • 참조
    • 이메일
    • 주소
    표 3. API 프론트엔드 [cmdb_ci_api_frontend]
    속성 데이터 유형 설명
    상위 ID [cmdb_ci_api_frontend] 참조 상위 API 구성요소에 대한 참조입니다.
    표 4. API 백엔드 [cmdb_ci_api_backend]
    속성 데이터 유형 설명
    유형 문자열 API의 백엔드 프로토콜 유형입니다. 예시:
    • Lambda
    • HTTP
    • 논리 앱
    표 5. API 게이트웨이 [cmdb_ci_api_gateway]
    속성 데이터 유형 설명
    ID 문자열 (255) 소스 시스템의 고유 식별자입니다.
    주:
    관리되는 API[cmdb_ci_managed_api]는 게이트웨이 및 기타 관리되는 서비스에서 검색된 API에만 해당되며 현재 새 특성을 도입하지 않습니다.

    주요 관계 구조

    API 및 Kong 클래스에 대해 정의해야 하는 여러 가지 주요 관계가 있습니다.

    표 6. API 관계
    상위 클래스 관계 하위 클래스 관계 유형
    API

    [cmdb_ci_api]

    		 Uses::Used by API 구성요소

    [cmdb_ci_api_component]

    		 추천됨
    API 게이트웨이

    [cmdb_ci_api_gateway]

    		 Provides::Provided By 관리되는 API

    [cmdb_ci_managed_api]

    		 종속
    API 프런트엔드

    [cmdb_ci_api_frontend]

    		 Use End Point To::Use End Point From API 백엔드

    [cmdb_ci_api_backend]

    		 추천됨
    API 백엔드

    [cmdb_ci_api_backend]

    		 Uses::Used By Kong 부하 분산 장치

    [cmdb_ci_kong_lb]

    		 추천됨

    관련 비 CMDB 테이블

    CMDB CI Class Models v 1.49.0에서는 다음 API 확장 클래스에 대한 관련 목록으로 이러한 비-CMDB 테이블을 소개합니다.

    API 관련 목록
    표 7. API 배포 [api_deployment]
    속성 데이터 유형 설명
    이름 문자열 (100) API 배포의 이름입니다.
    API 참조 배포된 API(cmdb_ci_api)에 대한 참조입니다.
    일치하지 않는 API 엔드포인트 참조 API가 기존 API(cmdb_ci_unmatched_api_endpoint)와 일치하지 않는 경우 일치하지 않는 API 엔드포인트에 대한 참조입니다.
    구성 항목 참조 구성 항목에 대한 참조입니다. API가 배포되는 CI를 알고 있는 경우 일반적으로 참조로 수동으로 지정됩니다.
    주:
    API 배포 비-CMDB 테이블은 API [cmdb_ci_api] 클래스와 일치하지 않는 API 엔드포인트 [cmdb_ci_unmatched_api_endpoint] 클래스 모두와 관련됩니다.
    API 구성요소 관련 목록
    표 8. API 헤더 [api_header]
    속성 데이터 유형 설명
    이름 문자열 (100) API 헤더의 이름입니다.
    API 구성요소 참조 API 헤더가 정의된 구성요소에 대한 참조입니다(cmdb_ci_api_component).
    일치하지 않는 API 엔드포인트 참조 엔드포인트를 기존 API 또는 구성요소(cmdb_ci_unmatched_endpoint)와 일치시킬 수 없는 경우 일치하지 않는 API에 대한 참조입니다.
    API Gateway 관련 목록
    표 9. API 소비자[api_consumer]
    속성 데이터 유형 설명
    사용자 이름 문자열 (100) API 소비자의 이름입니다.
    ID 문자열 (255) 소스 시스템의 고유 식별자입니다.
    사용자 지정 ID 문자열 (100) 사용자의 대체 표시 이름입니다.
    API 게이트웨이 참조 소비자가 정의된(cmdb_ci_api_gateway) 게이트웨이에 대한 참조입니다.
    표 10. API 정책 [api_policy]
    속성 데이터 유형 설명
    이름 문자열 (100) API 정책의 이름입니다.
    ID 문자열 (255) 소스 시스템의 고유 식별자입니다.
    프런트엔드 참조 API 프런트엔드(cmdb_ci_api_frontend)에 대한 참조입니다.
    관리되는 API 참조 관리되는 API(cmdb_ci_managed_api)에 대한 참조입니다.
    소비자 참조 api_consumer(API 소비자)의 비 CMDB 테이블에 대한 참조입니다.
    프로토콜 문자열 이 API 정책을 적용할 수 있는 프로토콜의 배열입니다.
    활성 부울 이 비-CMDB 테이블이 활성으로 간주되는지 비활성으로 간주되는지 결정합니다.
    API 게이트웨이 참조 소비자가 정의된(cmdb_ci_api_gateway) 게이트웨이에 대한 참조입니다.