API 확장 클래스
앱은 CMDB CI 클래스 모델 ServiceNow Store API(애플리케이션 프로그래밍 인터페이스)에 대한 클래스를 추가하거나 업데이트합니다.
CMDB CI 클래스 모델 는 클래스 계층 구조를 확장하는 클래스 모델을 추가하는 앱입니다 ServiceNow StoreCMDB . 새 클래스나 업데이트된 클래스에는 클래스 설명, 식별 규칙, 식별자 항목 및 종속 관계(해당하는 경우)가 포함됩니다. 추가된 클래스는 다른 CMDB 클래스와 마찬가지로 사용할 수 있습니다. 같은 디스커버리 및 서비스 매핑 패턴 애플리케이션은 클래스 확장을 사용하여 CI를 채우고 기술 및 소프트웨어를 검색할 수 있습니다.
모든 에 대한 전체 릴리스 정보를 CMDB CI 클래스 모델참조하십시오.
스토어에서 앱 요청
사용 가능한 모든 앱을 보고 스토어에 요청을 제출하는 방법에 대한 자세한 내용을 보려면 다음을 ServiceNow Store 방문하십시오. 출시된 모든 앱의 누적 릴리스 정보는 ServiceNow Store 버전 기록 릴리스 정보를 참조하십시오.
API
API는 컴퓨터 프로그램이 서로 통신할 수 있도록 하는 정의 및 프로토콜 세트이며, 이를 통해 애플리케이션 소프트웨어를 빌드하거나 통합할 수 있습니다. API는 일반적으로 웹 기반 기술을 사용하여 다른 API와 통신합니다. API는 일반적으로 프로그래밍 방식으로 작업 또는 작업을 수행하거나 데이터를 보거나, 가져오거나, 내보내거나, 삭제하거나, 수정하는 데 사용됩니다.
- API에 대한 가시성을 높입니다.
- API 엔드포인트와 관련된 보안 문제 및 취약성을 식별합니다.
클래스
이 섹션에는 앱이 추가하거나 업데이트하는 CMDB CI 클래스 모델 클래스가 나열됩니다. 자세한 내용은 다음을 참조하십시오. "의 새 데이터 모델"이라는 제목의 커뮤니티 문서 CMDB for APIs".
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://[인스턴스].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 게이트웨이. |
| 관리형 API [cmdb_ci_managed_api] |
구성 항목 [cmdb_ci_api] |
게이트웨이 또는 관리 서비스에서 검색된 API입니다. 이 클래스의 API에 대해 게이트웨이에 대한 의존성을 적용할 수 있습니다. |
클래스 속성
CMDB CI 클래스 모델: 릴리스 1.49.0은 각 클래스에 다음 속성을 추가합니다.
| 속성 | 데이터 유형 | 설명 |
|---|---|---|
| 기본 URL | 문자열 (1024) | 모든 API 구성요소가 확장되는 기본 주소입니다. |
| ID | 문자열 (1024) | 소스 시스템의 고유 식별자입니다. |
| 유형 | 목록 | API의 유형입니다. 다음을 지정할 수 있습니다.
|
| 버전 | 숫자 | API의 버전입니다. |
| 사양 위치 | URL | API 사양의 위치에 대한 URL입니다. 예: OpenAPI 사양 정의. |
| 기술 사양 위치 | 문자열 | API에 대한 기술 사양 리포지토리의 위치입니다. 예: GitHub 배포된 API 코드가 포함된 리포지토리. |
| 설계 사양 위치 | 문자열 | API 설계 또는 문서의 위치에 대한 URL입니다. 예: SwaggerHub API 설계 사양 URL입니다. |
| 속성 | 데이터 유형 | 설명 |
|---|---|---|
| 방법 | 문자열 | REST API 메서드입니다. 예제:
|
| 프로토콜 | 문자열 | 통신 프로토콜입니다. 예: HTTP, HTTPS |
| 호스트 | 문자열 (100) | API를 호스팅하는 시스템입니다. |
| 경로 | 문자열 (1024) | API가 따르는 특정 경로입니다. |
| 포트 | 문자열 | 통신 포트입니다. 예: 80, 443 등. |
| URL | 문자열 (1024) | 호출 중인 자원의 URL입니다. |
| ID | 문자열 (1024) | 소스 시스템의 고유 식별자입니다. |
| 인터넷 커넥트 | 부울 | 공용 인터넷에서 구성요소에 연결할 수 있는지 여부를 나타내는 부울입니다. 구성요소에 연결할 수 있는 경우 1 또는 "예"를 지정합니다. |
| 권한 부여 | 문자열 | 권한 부여 또는 인증 방법의 유형입니다. 예제:
|
| 요청 데이터 유형 | 문자열 (255) | 요청의 데이터 유형 목록입니다. 예제:
|
| 응답 데이터 유형 | 문자열 (255) | 응답의 데이터 유형 목록입니다. 예제:
|
| 속성 | 데이터 유형 | 설명 |
|---|---|---|
| 상위 ID | [cmdb_ci_api_frontend]에 대한 참조 | 상위 API 구성요소에 대한 참조입니다. |
| 속성 | 데이터 유형 | 설명 |
|---|---|---|
| 유형 | 문자열 | API의 백엔드 프로토콜 유형입니다. 예제:
|
| 속성 | 데이터 유형 | 설명 |
|---|---|---|
| ID | 문자열 (255) | 소스 시스템의 고유 식별자입니다. |
- Anypoint API 게이트웨이 [cmdb_ci_api_gateway_anypoint] (제공자 MuleSoft)
- Tyk API 게이트웨이 [cmdb_ci_api_gateway_tyk] (Tyk 제공)
- Boomi API 게이트웨이 [cmdb_ci_api_gateway_boomi] (Boomi 제공)
| 속성 | 데이터 유형 | 설명 |
|---|---|---|
| ID | 문자열 (255) | API 제품 번들의 고유 식별자입니다. |
| 검색된 승인 유형 | 문자열 | 소스 시스템에서 검색된 승인 요청의 유형입니다. |
| 검색된 접근 유형 | 문자열 | 소스 시스템에서 검색된 액세스 구성입니다. 예를 들어 public 또는 internal입니다. |
| 작성 날짜 | 날짜/시간 | API 제품 번들이 처음 검색되거나 기록된 날짜 및 시간입니다. |
| 마지막으로 수정한 날짜 | 날짜/시간 | API 제품 번들에 대한 최신 업데이트의 날짜 및 시간입니다. |
| 검색된 상태 | 문자열 | 소스에서 보고한 제품 번들의 현재 상태입니다. 예를 들어 게시됨 또는 사용되지 않음입니다. |
| 속성 | 데이터 유형 | 설명 |
|---|---|---|
| 검색된 범위 | 문자열 | 소스 시스템에서 검색된 액세스 범위입니다. 예를 들어 모든 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 및 Front Door 애플리케이션 게이트웨이에 대한 ACL을 Azure 나타냅니다.
주요 관계 구조
API 및 Kong 클래스에 대해 정의해야 하는 여러 키 관계가 있습니다.
| 상위 클래스 | 관계 | 하위 클래스 | 관계 유형 |
|---|---|---|---|
| API [cmdb_ci_api] |
Uses::Used by | API 구성요소 [cmdb_ci_api_component] |
추천됨 |
| API 게이트웨이 [cmdb_ci_api_gateway] |
제공::P제공자 | 관리형 API [cmdb_ci_managed_api] |
종속 |
| API 프런트엔드 [cmdb_ci_api_frontend] |
엔드포인트 사용 종료::엔드포인트 사용 시작 | API 백엔드 [cmdb_ci_api_backend] |
추천됨 |
| API 백엔드 [cmdb_ci_api_backend] |
Uses::Used By | Kong 부하 분산 장치 [cmdb_ci_kong_lb] |
추천됨 |
| API 게이트웨이 [cmdb_ci_api_gateway] |
제공::P제공자 | API 제품 번들 [cmdb_ci_api_product_bundle] |
종속 |
| API 게이트웨이 [cmdb_ci_api_gateway] |
제공::P제공자 | 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 정책 목록의 사용자 이름 필드에 사용자 이름을 표시하려면 사용자 이름의 속성을예로 설정 display 해야 합니다. 속성이true로 설정되지 않은 경우 목록에 대신 시스템 ID가 표시됩니다.ID 문자열 (255) 소스 시스템의 고유 식별자입니다. 사용자 지정 ID 문자열 (100) 사용자의 대체 표시 이름입니다. API 게이트웨이 참조 소비자가 정의된 게이트웨이에 대한 참조입니다(cmdb_ci_api_gateway). API 소비자 유형 목록 API 사용자 유형(user_type)입니다. 다음을 지정할 수 있습니다. - 내부
- 외부
- 알 수 없음
검색된 상태 문자열 API 소비자 계정의 현재 상태를 나타냅니다. 제공자 문자열 API 소비자 인증을 담당하는 ID 관리 제공자의 이름입니다. 이메일 문자열 API 소비자의 이메일 주소입니다. 등록 날짜 날짜/시간 소비자가 제공 플랫폼에 등록한 날짜입니다.