API 확장 클래스

  • 릴리스 버전: Zurich
  • 업데이트 날짜 2025년 08월 07일
  • 소요 시간: 13분

    • 앱은 CMDB CI 클래스 모델 ServiceNow Store API(애플리케이션 프로그래밍 인터페이스)에 대한 클래스를 추가하거나 업데이트합니다.

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

    모든 CMDB CI 클래스 모델 릴리스에 대한 전체 릴리스 정보는 다음에서 찾을 수 있습니다. https://www.servicenow.com/docs/bundle/store-release-notes/page/release-notes/store/it-operations-management/store-rn-itom-cmdb-class-models.html?emcs_t=S2h8ZW1haWx8Ym9hcmRfc3Vic2NyaXB0aW9ufE1FMlVTSFREVDc3S0hTfDMzNDcxMjV8U1VCU0NSSVBUSU9OU3xoSw

    스토어에서 앱 요청

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

    API

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

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

    클래스

    이 섹션에는 스토어 앱이 추가하거나 업데이트하는 클래스가 CMDB CI 클래스 모델 나열됩니다. 자세한 내용은 "API용 CMDB의 새 데이터 모델"이라는 제목의 커뮤니티 문서를 참조하십시오.

    CMDB CI 클래스 모델: API에 대해 사용할 수 있는 클래스는 다음과 같습니다. 이 앱이 확장할 수 있는 클래스를 포함하여 의 클래스 기본 시스템목록은 를 참조하십시오 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 정의와 관련된 재사용 가능한 객체입니다. 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 인프라입니다. 예: Kong Gateway.
    관리형 API

    [cmdb_ci_managed_api]

    		 구성 항목

    [cmdb_ci_api]

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

    클래스 속성

    CMDB CI 클래스 모델: 릴리스 1.49.0은 해당 클래스에 다음 속성을 추가합니다.

    표 1. API [cmdb_ci_api]
    속성 데이터 유형 설명
    기본 URL 문자열 (1024) 모든 API 구성요소가 확장되는 기본 주소입니다.
    ID 문자열 (1024) 소스 시스템의 고유 식별자입니다.
    유형 선택 목록 API의 유형입니다. 다음을 지정할 수 있습니다.
    • REST
    • SOAP
    • HTTP
    • gRPC
    • GraphQL
    • 웹소켓
    버전 숫자 API의 버전입니다.
    사양 위치 URL API 사양의 위치에 대한 URL입니다. 예: OpenAPI 사양 정의.
    기술 사양 위치 문자열 API에 대한 기술 사양 리포지토리의 위치입니다. 예: 배포된 API 코드가 포함된 GitHub 리포지토리.
    설계 사양 위치 문자열 API 설계 또는 문서의 위치에 대한 URL입니다. 예: SwaggerHub API 설계 사양 URL입니다.
    API [cmdb_ci_api] 클래스는 API 메타데이터에 대한 키-값 스토리지를 사용하도록 태그 및 레이블을 키 값 [cmdb_key_value] 테이블에 매핑하는 것을 지원합니다.
    표 2. API 구성요소 [cmdb_ci_api_component]
    속성 데이터 유형 설명
    방법 문자열 REST API 메서드입니다. 예제:
    • 임포트
    • 게시
    • DELETE
    프로토콜 문자열 통신 프로토콜입니다. 예: HTTP, HTTPS.
    호스트 문자열 (100) API를 호스팅하는 시스템입니다.
    경로 문자열 (1024) API가 따르는 특정 경로입니다.
    포트 문자열 통신 포트입니다. 예: 80, 443 등.
    URL 문자열 (1024) 호출 중인 자원의 URL입니다.
    ID 문자열 (1024) 소스 시스템의 고유 식별자입니다.
    인터넷 연결 부울 공용 인터넷에서 구성 요소에 연결할 수 있는지 여부를 나타내는 부울입니다. 구성요소에 연결할 수 있는 경우 1 또는 "예"를 지정합니다.
    권한 부여 문자열 인증 또는 인증 방법의 유형입니다. 예제:
    • 기본
    • 키
    • OAuth
    • 안 함
    요청 데이터 유형 문자열 (255) 요청의 데이터 유형 목록입니다. 예제:
    • 참조
    • 이메일
    • 주소
    응답 데이터 유형 문자열 (255) 응답의 데이터 유형 목록입니다. 예제:
    • 참조
    • 이메일
    • 주소
    API 구성요소 [cmdb_ci_api_component] 클래스는 API 구성요소 메타데이터에 대한 키-값 스토리지를 사용하도록 태그 및 레이블을 키 값 [cmdb_key_value] 테이블에 매핑하는 것을 지원합니다.
    표 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 Gateway [cmdb_ci_api_gateway] 클래스는 태그 및 레이블을 키 값 [cmdb_key_value] 테이블에 매핑하는 것을 지원합니다. 매핑을 사용하면 API 게이트웨이 메타데이터에 대한 키-값 스토리지를 사용할 수 있습니다.
    API 게이트웨이에 사용할 수 있는 마커 클래스는 다음과 같습니다. 이러한 클래스는 API Gateway [cmdb_ci_api_gateway] 상위 클래스의 모든 속성을 상속합니다.
    • Anypoint API 게이트웨이 [cmdb_ci_api_gateway_anypoint] (MuleSoft에서 제공)
    • Tyk API 게이트웨이 [cmdb_ci_api_gateway_tyk] (Tyk 제공)
    • Boomi API 게이트웨이 [cmdb_ci_api_gateway_boomi] (Boomi 제공)
    마커 클래스는 기존 클래스 구조를 따르며 규칙을 변경할 IRE(식별 및 조정 엔진) 필요가 없습니다.
    주:
    관리형 API [cmdb_ci_managed_api] 클래스는 게이트웨이 및 기타 관리형 서비스에서 검색되는 API에만 해당되며 새 속성을 도입하지 않습니다.
    API 게이트웨이 및 개발자 포털에서 API 제품 번들은 개발자와 애플리케이션에서 사용할 하나 이상의 API 컬렉션입니다. 일부 플랫폼에서는 API 제품에만 이 용어를 사용합니다.
    표 6. API 제품 번들 [cmdb_ci_api_product_bundle]
    속성 데이터 유형 설명
    ID 문자열 (255) API 제품 번들의 고유 식별자입니다.
    검색된 승인 유형 문자열 소스 시스템에서 검색된 승인 요청의 유형입니다.
    검색된 접근 유형 문자열 소스 시스템에서 검색된 액세스 구성입니다. 예를 들어 public 또는 internal입니다.
    작성 날짜 날짜/시간 API 제품 번들이 처음 검색되거나 기록된 날짜 및 시간입니다.
    마지막으로 수정한 날짜 날짜/시간 API 제품 번들에 대한 최신 업데이트의 날짜 및 시간입니다.
    검색된 상태 문자열 소스에서 보고한 제품 번들의 현재 상태입니다. 예를 들어 게시됨 또는 사용되지 않음입니다.
    하나 이상의 API 제품 번들에 액세스하기 위해 개발자는 개발자 포털에서 API 소비자 구독을 등록할 수 있습니다. 구독은 하나 이상의 번들로 등록되고 번들의 API에 액세스하기 위한 키를 제공합니다.
    표 7. API 소비자 구독 [cmdb_ci_api_consumer_subscription]
    속성 데이터 유형 설명
    검색된 범위 문자열 소스 시스템에서 검색된 액세스 범위입니다. 예를 들어 모든 API 또는 특정 API입니다.
    API 소비자 참조 API 소비자 기록에 대한 참조입니다. 예: cmdb_ci_api_consumer.
    ID 문자열 (255) API 소비자 구독의 고유 식별자입니다.
    검색된 상태 문자열 소스 시스템에서 검색된 구독 상태입니다. 예를 들어 활성 또는 비활성입니다.
    작성 날짜 날짜/시간 소스 시스템에서 API 소비자 구독이 생성된 날짜 및 시간입니다.
    마지막으로 수정한 날짜 날짜/시간 API 소비자 구독에 대한 최근 업데이트의 날짜 및 시간입니다.

    WebACL 클래스 [cmdb_ci_web_acl]는 CloudFront, API 게이트웨이 REST API, 애플리케이션 로드 밸런서, AppSync GraphQL API, Cognito 사용자 풀, App Runner 서비스, AWS Verified Access 및 Azure Front Door 애플리케이션 게이트웨이에 대한 ACL을 나타냅니다.

    주요 관계 구조

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

    표 8. 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]

    		 추천됨
    API 게이트웨이

    [cmdb_ci_api_gateway]

    		 Provides::Provided By API 제품 번들

    [cmdb_ci_api_product_bundle]

    		 종속
    API 게이트웨이

    [cmdb_ci_api_gateway]

    		 Provides::Provided By API 소비자 구독

    [cmdb_ci_api_consumer_subscription]

    		 종속
    API 제품 번들 Contains::Contained by API

    [cmdb_ci_api]

    		 추천됨
    API 제품 번들 Used by::Uses API 소비자 구독

    [cmdb_ci_api_consumer_subscription]

    		 추천됨

    관련 비 CMDB 테이블

    CMDB CI 클래스 모델 v 1.49.0에서는 다음 API 확장 클래스에 대한 관련 목록으로 다음과 같은 비 CMDB 테이블을 도입했습니다.

    API 관련 목록
    표 9. 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 구성요소 관련 목록
    표 10. API 헤더 [api_header]
    속성 데이터 유형 설명
    이름 문자열 (100) API 헤더의 이름입니다.
    API 구성요소 참조 API 헤더가 정의된 구성요소에 대한 참조입니다(cmdb_ci_api_component).
    일치하지 않는 API 엔드포인트 참조 엔드포인트가 기존 API 또는 구성요소(cmdb_ci_unmatched_endpoint)와 일치하지 않는 경우 일치하지 않는 API에 대한 참조입니다.
    API 게이트웨이 관련 목록
    표 11. API 소비자 [api_consumer]
    속성 데이터 유형 설명
    사용자 이름 문자열 (100)

    API 소비자의 이름입니다.

    주:
    api_policy 테이블의 소비자 필드는 참조 필드입니다. API 정책 목록의 사용자 이름 필드에 사용자 이름을 표시하려면 사용자 이름 속성을 true로 설정해야 display 합니다. 속성이 true로 설정되지 않은 경우 목록에 Sys ID가 대신 표시됩니다.
    ID 문자열 (255) 소스 시스템의 고유 식별자입니다.
    사용자 지정 ID 문자열 (100) 사용자의 대체 표시 이름입니다.
    API 게이트웨이 참조 소비자가 정의된 게이트웨이에 대한 참조입니다(cmdb_ci_api_gateway).
    API 소비자 유형 선택 목록 API 사용자 유형(user_type)입니다. 다음을 지정할 수 있습니다.
    • 내부
    • 외부
    • 알 수 없음
    검색된 상태 문자열 API 소비자 계정의 현재 상태를 나타냅니다.
    제공자 문자열 API 소비자 인증을 담당하는 ID 관리 제공자의 이름입니다.
    이메일 문자열 API 소비자의 이메일 주소입니다.
    등록 날짜 날짜/시간 소비자가 제공 플랫폼에 등록한 날짜입니다.
    표 12. API 소비자 액세스[api_consumer_access]
    속성 데이터 유형 설명
    API 소비자 참조 API 소비자 기록에 대한 참조입니다. 예: cmdb_ci_api_consumer.
    API 참조 소비자가 액세스를 요청하는 API [cmdb_ci_api]에 대한 참조입니다.
    인증 방법 문자열 API 소비자가 API에 액세스하는 데 사용하는 인증 방법입니다. 예를 들어 API 키 또는 OAuth입니다.
    상태 선택 액세스가 현재 활성 상태인지 비활성 상태인지 나타냅니다.
    마지막으로 사용됨 날짜/시간 API 소비자가 API에 액세스한 마지막 날짜 및 시간입니다.
    유효 기간(종료) 날짜/시간 API에 대한 소비자 액세스 권한의 만료 날짜입니다.
    표 13. API 정책 [api_policy]
    속성 데이터 유형 설명
    이름 문자열 (100) API 정책의 이름입니다.
    ID 문자열 (255) 소스 시스템의 고유 식별자입니다.
    프런트엔드 참조 API 프런트엔드(cmdb_ci_api_frontend)에 대한 참조입니다.
    관리형 API 참조 cmdb_ci_managed_api(관리형 API)에 대한 참조입니다.
    소비자 참조 API 소비자(api_consumer) 비 CMDB 테이블에 대한 참조입니다.
    주:
    소비자 는 참조 필드입니다. API 정책 목록에 api_consumer(사용자 이름)을 표시하려면 api_consumer 테이블의 사용자 이름 필드에 대해 속성을 true로 설정해야 display 합니다. 속성이 true로 설정되지 않은 경우 목록에 Sys ID가 대신 표시됩니다.
    프로토콜 문자열 이 API 정책을 적용할 수 있는 프로토콜의 배열입니다.
    활성 부울 이 비 CMDB 테이블이 활성 또는 비활성으로 간주되는지 여부를 결정합니다.
    API 게이트웨이 참조 소비자가 정의된 게이트웨이에 대한 참조입니다(cmdb_ci_api_gateway).