클라우드 서비스 카탈로그 API

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

    • 클라우드 서비스 카탈로그 API는 클라우드 서비스 스택을 만들고 자원 작업 요청을 호출하는 등 클라우드 서비스 카탈로그에서 사용할 수 있는 1일차(프로비저닝) 및 2일차(수정) 작업과 관련된 메서드를 제공합니다. 또한 카탈로그 요청, 스택의 상태 및 기타 정보에 대한 정보를 검색할 수도 있습니다.

    이 API는 now 네임스페이스에 포함되며 sn_cmp.cloud_service_user 역할이 필요합니다. CSC(클라우드 서비스 카탈로그) 애플리케이션은 별도의 구독으로 사용할 수 있으며 ITOM Enterprise 번들 또는 ITOM 클라우드 가속화 제품 권리가 필요합니다.

    클라우드 서비스 카탈로그 API는 2일차 작업 중에 수행하는 작업을 제공합니다. 이 API의 컨텍스트에서 자원 카탈로그 항목은 2일차 작업과 관련된 카탈로그 항목을 참조합니다.

    이 API를 사용하려면 클라우드 서비스 카탈로그 안내 설정 프로세스를 완료했거나 UI에서 프로비저닝 및 카탈로그 작업이 작동하는 작업 구성이 있는지 확인하십시오. 이러한 단계에 대한 자세한 내용은 다음 문서를 참조하십시오 Cloud Services Catalog.

    클라우드 서비스 카탈로그 - GET /now/cmp_catalog_api/itemsbyciclass

    지정된 CI(구성 항목) 클래스에 따라 자원 카탈로그 항목의 목록을 반환합니다.

    URL 형식

    기본 URL: /api/now/cmp_catalog_api/itemsbyciclass

    지원되는 요청 매개변수

    표 1. 경로 매개변수
    이름 설명
    없음
    표 2. 쿼리 매개변수
    이름 설명
    ci_class 필수 자원 카탈로그 항목을 가져올 CI 클래스의 이름입니다(예: "cmdb_ci_vm_instance"). 구성 항목 [cmdb_ci] 테이블의 참조 CI 유형 필드에 있습니다.

    데이터 유형: 문자열
    display_variables 각 카탈로그 항목과 연결된 카탈로그 항목 변수를 나열할지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 목록 카탈로그 항목 변수를 표시합니다.
    • false: 목록 카탈로그 항목 변수를 표시하지 않습니다.

    데이터 유형: 부울

    기본값: False
    operation_name 옵션입니다. 운영의 이름 OperationSignature [sn_cmp_rb_op_signature] 테이블에 있는 자원 인터페이스의 이름 열에 있습니다.
    주:
    이 매개변수는 작업의 일부 또는 전체를 쿼리할 수 있습니다. 예를 들어 "Servicenow"로 시작하는 모든 인터페이스를 나열하려면 변수를 operation_name = Servicenow로 설정할 수 있습니다.

    기본값: 모든 운영 유형의 모든 카탈로그 항목이 반환됩니다.

    데이터 유형: 문자열
    resource_interface 옵션입니다. 자원 카탈로그 항목이 호스팅되는 자원 인터페이스입니다. ResourceInterfaces [sn_cmp_rb_resourceinterface] 테이블의 이름 열에 있습니다.

    데이터 유형: 문자열
    표 3. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 4. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 5. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 6. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    403 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
    405 잘못된 메서드입니다. 기능이 비활성화되었습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    활성 자원 운영 카탈로그 항목의 활성 상태입니다.

    가능한 값:

    • true: 자원 운영 카탈로그 항목이 활성 상태입니다.
    • False: 자원 운영 카탈로그 항목이 비활성 상태입니다.

    데이터 유형: 문자열
    created_on 자원 운영 카탈로그 항목이 작성된 시점의 타임 스탬프입니다.

    형식: yyyy-MM-dd HH:mm:ss.

    데이터 유형: 문자열
    display_name 자원 인터페이스의 이름입니다. ResourceInterfaces [sn_cmp_rb_resourceinterface] 테이블에 있습니다.

    데이터 유형: 문자열
    ID 자원 운영 카탈로그 항목의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 자원 운영 카탈로그 항목 [sn_cmp_rsrc_opr_cat_item]
    이름 자원 운영 카탈로그 항목의 이름입니다. 자원 운영 카탈로그 항목 [sn_cmp_rsrc_opr_cat_item] 테이블에 있습니다.

    데이터 유형: 문자열
    short_description 자원 운영 카탈로그 항목에 대한 간략한 설명입니다.

    데이터 유형: 문자열

    테이블: 자원 운영 카탈로그 항목 [sn_cmp_rsrc_opr_cat_item]
    updated_on 자원 운영 카탈로그 항목이 마지막으로 업데이트된 시점의 타임 스탬프입니다. 필수 형식: yyyy-MM-dd HH:mm:ss.

    데이터 유형: 문자열

    cURL 요청

    다음 예시에서는 요청 항목의 상태를 요청하고 반환합니다.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/itemsbyciclass?ci_class=cmdb_ci_vm_instance&resource_interface=Virtual%20Machine%20Store%20Extension%20Interface&operation_name=Execute%20Job%20Template" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    응답:

    [
  {
    "display_name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "id": "01b2341a56789012345d6ddeeff7b89fc",
    "created_on": "2019-04-28 12:58:26",
    "updated_on": "2019-04-28 12:58:26",
    "name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "short_description": "Catalog item to invoke operation",
    "active": true
  }
]

    클라우드 서비스 카탈로그 - GET /now/cmp_catalog_api/itemsbyrb

    지정된 자원 블록에 따라 자원 카탈로그 항목의 목록을 반환합니다.

    URL 형식

    기본 URL: /api/now/cmp_catalog_api/itemsbyrb

    지원되는 요청 매개변수

    표 7. 경로 매개변수
    이름 설명
    없음
    표 8. 쿼리 매개변수
    이름 설명
    display_variables 각 카탈로그 항목과 연결된 카탈로그 항목 변수를 나열할지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 목록 카탈로그 항목 변수를 표시합니다.
    • false: 목록 카탈로그 항목 변수를 표시하지 않습니다.

    데이터 유형: 부울

    기본값: False
    operation_name 옵션입니다. 운영의 이름 OperationSignature [sn_cmp_rb_op_signature] 테이블에 있는 자원 인터페이스의 이름 열에 있습니다.
    주:
    이 매개변수는 작업의 일부 또는 전체를 쿼리할 수 있습니다. 예를 들어 "Servicenow"로 시작하는 모든 인터페이스를 나열하려면 변수를 operation_name = Servicenow로 설정할 수 있습니다.

    기본값: 모든 운영 유형의 모든 카탈로그 항목이 반환됩니다.

    데이터 유형: 문자열
    resource_block 필수. 관련 자원 운영 카탈로그 항목을 가져올 자원 블록의 이름입니다(예: 가상 서버).

    기본값: 모든 운영 유형의 모든 카탈로그 항목이 반환됩니다.

    데이터 유형: 문자열

    테이블: 자원 블록 [sn_cmp_rb_resourceblock]
    resource_interface 옵션입니다. 자원 카탈로그 항목이 호스팅되는 자원 인터페이스입니다. ResourceInterfaces [sn_cmp_rb_resourceinterface] 테이블의 이름 열에 있습니다.

    데이터 유형: 문자열
    표 9. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 10. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 11. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 12. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    403 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
    405 잘못된 메서드입니다. 기능이 비활성화되었습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    활성 자원 운영 카탈로그 항목의 활성 상태입니다.

    가능한 값:

    • true: 자원 운영 카탈로그 항목이 활성 상태입니다.
    • False: 자원 운영 카탈로그 항목이 비활성 상태입니다.

    데이터 유형: 문자열
    display_name 자원 인터페이스의 이름입니다. ResourceInterfaces [sn_cmp_rb_resourceinterface] 테이블에 있습니다.

    데이터 유형: 문자열
    ID 자원 운영 카탈로그 항목의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 자원 운영 카탈로그 항목 [sn_cmp_rsrc_opr_cat_item]
    이름 자원 운영 카탈로그 항목의 이름입니다. 자원 운영 카탈로그 항목 [sn_cmp_rsrc_opr_cat_item] 테이블에 있습니다.

    데이터 유형: 문자열
    short_description 자원 운영 카탈로그 항목에 대한 간략한 설명입니다.

    데이터 유형: 문자열

    테이블: 자원 운영 카탈로그 항목 [sn_cmp_rsrc_opr_cat_item]
    변수 자원 카탈로그 항목에 대한 추가 상세 정보 목록입니다. 이 API에서 반환되는 변수는 전달된 쿼리 매개변수에 따라 달라집니다.

    데이터 유형: 객체 배열

    "variables": [
  {
    "parameter1": "String",
    "parameter2": "String"
  }
]

    가상 서버 자원 블록을 기반으로 하는 자원 카탈로그 항목의 목록입니다.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/itemsbyrb?resource_interface=Virtual%20Machine%20Store%20Extension%20Interface&operation_name=Execute%20Job%20Template&resource_block=Virtual%20Server" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    응답:

    [
  {
    "display_name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "id": "01b2341a56789012345d6ddeeff7b89fc",
    "created_on": "2019-04-28 12:58:26",
    "updated_on": "2019-04-28 12:58:26",
    "name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "short_description": "Catalog item to invoke operation",
    "active": true
  }
]

    클라우드 서비스 카탈로그 - GET /now/cmp_catalog_api/services

    프로비저닝 또는 수명주기 카탈로그 유형의 지정된 Blueprint를 기반으로 카탈로그 항목 목록을 반환합니다.

    URL 형식

    기본 URL: /api/now/cmp_catalog_api/services

    지원되는 요청 매개변수

    표 13. 경로 매개변수
    이름 설명
    없음
    표 14. 쿼리 매개변수
    이름 설명
    catalog_type 옵션입니다. 카탈로그 항목의 유형입니다. 허용되는 값(대/소문자 구분):
    • 프로비저닝 - 모든 Blueprint 유형 카탈로그 항목을 반환합니다.
    • 수명주기 - 모든 2일차 운영 유형 카탈로그 항목을 반환합니다.

    입력이 비어 있으면(기본값) 두 카탈로그 유형의 모든 서비스가 반환됩니다.

    데이터 유형: 문자열
    display_variables 각 카탈로그 항목과 연결된 카탈로그 항목 변수를 나열할지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 목록 카탈로그 항목 변수를 표시합니다.
    • false: 목록 카탈로그 항목 변수를 표시하지 않습니다.

    데이터 유형: 부울

    기본값: False
    blueprint_name 옵션입니다. 관련 카탈로그 항목을 가져올 Blueprint의 이름입니다. 범주 항목 [sn_cmp_bp_cat_item] 테이블에 있습니다.
    주:
    이 매개변수는 Blueprint 이름의 일부 또는 전체를 쿼리할 수 있습니다. 예를 들어, "Servicenow"로 시작하는 모든 Blueprint를 나열하려면 변수를 blueprint_name = Servicenow로 설정할 수 있습니다.

    기본값: 모든 Blueprint의 모든 서비스가 반환됩니다.

    데이터 유형: 문자열
    표 15. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 16. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 17. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 18. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    403 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
    405 잘못된 메서드입니다. 기능이 비활성화되었습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    활성 카탈로그가 활성 상태인지 여부를 나타내는 플래그입니다.
    가능한 값:
    • true: 카탈로그가 활성 상태입니다.
    • false: 카탈로그가 활성 상태가 아닙니다.

    데이터 유형: 문자열
    Blueprint 블루프린트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: Blueprint [sn_cmp_bp_blueprint]
    blueprint_category Blueprint 범주의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 클라우드 서비스 범주 [sn_capi_service_category]
    blueprint_category_name Blueprint 범주의 이름입니다.
    가능한 값:
    • 접근
    • 분석
    • 애플리케이션 서비스
    • Blockchain
    • 비즈니스 생산성
    • 계산
    • 구성 관리
    • 컨테이너
    • 데이터베이스
    • 개발자 도구
    • 이벤트
    • 하이브리드 클라우드
    • IOT
    • IPAM
    • 시끄러운 밸런서
    • 머신 러닝
    • 관리 도구
    • 마켓플레이스
    • 모바일
    • 네트워크
    • 생산성
    • 보안
    • 셸 접근
    • 스토리지
    • 도구
    • 알 수 없음
    • 가상 현실

    데이터 유형: 문자열

    테이블:클라우드 서비스 범주 [sn_capi_service_category]
    blueprint_name Blueprint의 이름입니다. Blueprint [sn_cmp_bp_blueprint] 테이블에 있습니다.

    데이터 유형: 문자열
    blueprint_type Blueprint의 유형입니다.

    가능한 값: 사용자 지정 Blueprint

    데이터 유형: 문자열
    catalog_name 카탈로그의 이름입니다.

    데이터 유형: 문자열

    테이블: 클라우드 카탈로그 항목 [sn_cmp_bp_cat_item]
    catalog_type 카탈로그의 유형입니다.
    가능한 값:
    • 1: 카탈로그는 프로비저닝 유형입니다.
    • 2: 카탈로그가 수명주기 유형입니다.

    데이터 유형: 문자열
    catalog_type 카탈로그의 유형입니다.
    가능한 값:
    • 1: 카탈로그는 프로비저닝 유형입니다.
    • 2: 카탈로그가 수명주기 유형입니다.

    데이터 유형: 문자열
    createdOn 카탈로그 항목이 작성된 시점의 타임 스탬프입니다.

    데이터 유형: 문자열
    createdBy 카탈로그 항목을 생성한 사용자입니다.

    데이터 유형: 문자열
    ID 블루프린트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 클라우드 카탈로그 항목 [sn_cmp_bp_cat_item]
    last_updated_on 카탈로그 항목이 마지막으로 업데이트된 시점의 타임 스탬프입니다.

    데이터 유형: 문자열
    last_updated_by 카탈로그 항목을 마지막으로 업데이트한 사용자(예: 관리자 또는 시스템)입니다.

    데이터 유형: 문자열
    운영 작업의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: OperationSignature [sn_cmp_rb_op_signature]
    operation_name 운영의 이름
    가능한 값:
    • 프로비전 해제: 종료된 상태의 자원을 삭제하고 그에 따라 자원 CMDB 테이블을 업데이트합니다.
    • ModifyLease: 프로비저닝된 자원에 예약된 임대 작업을 수정합니다.
    • ModifySchedule: 프로비저닝된 자원의 일정을 수정합니다.
    • 시작: 꺼짐 상태인 자원을 시작합니다.
    • 중지: 켜짐 상태인 자원을 중지합니다.

    데이터 유형: 문자열
    변수 목록 카탈로그 항목에 대한 상세 정보입니다. 이 API에서 반환되는 변수는 요청에 전달되는 쿼리 매개변수에 따라 달라집니다.

    데이터 유형: 객체 배열

    "variables": [
  {
    "parameter1": "String",
    "parameter2": "String"
  }
]

    이 예에서는 "classiclb"라는 수명주기 유형 Blueprint의 모든 카탈로그 항목을 반환합니다.

    curl "https://instance.servicenow.comapi/now/cmp_catalog_api/services?display_variables=true&catalog_type=LifeCycle&blueprint_name=classiclb" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    응답:

    [
  {
    "catalog_name": "Deprovision",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "01b2341a56789012345d6ddeeff7b89fc",
    "variables": [
      {
        "id": "a12d34c5678c91234bf45678912d34e4",
        "name": "StackID",
        "question_text": "StackID",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:46:03",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:46:02",
    "created_by": "user@password.com",
    "operation": "a70d51c0476c46104bf15222516d4375",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Deprovision"
  },
  {
    "catalog_name": "ModifySchedule",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": null,
    "id": "361d55c0476c46104bf15222516d4351",
    "variables": [
      {
        "id": "031d55c0476c46104bf15222516d43af",
        "name": "ScheduleProfile",
        "question_text": "ScheduleProfile",
        "default_value": "Not specified"
      },
      {
        "id": "0b1d55c0476c46104bf15222516d43c9",
        "name": "ScheduleTimeZone",
        "question_text": "ScheduleTimeZone",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:45:53",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:52",
    "created_by": "user@password.com",
    "operation": "130d51c0476c46104bf15222516d436c",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "ModifySchedule"
  },
  {
    "catalog_name": "Stop",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "542dd5c0476c46104bf15222516d43b0",
    "variables": [
      {
        "id": "a02d19c0476c46104bf15222516d4301",
        "name": "StackID",
        "question_text": "StackID",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:46:00",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:58",
    "created_by": "user@password.com",
    "operation": "930d51c0476c46104bf15222516d436f",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Stop"
  },
  {
    "catalog_name": "Cleanup",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "712d59c0476c46104bf15222516d435c",
    "variables": [
      {
        "id": "da2d59c0476c46104bf15222516d43dc",
        "name": "resourceId",
        "question_text": "ResourceId",
        "default_value": "Not specified"
      },
      {
        "id": "da2d59c0476c46104bf15222516d43e2",
        "name": "operationName",
        "question_text": "OperationName",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:46:06",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:46:04",
    "created_by": "user@password.com",
    "operation": "ab0d51c0476c46104bf15222516d437b",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Cleanup"
  },
  {
    "catalog_name": "ModifyLease",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": null,
    "id": "bb1dd5c0476c46104bf15222516d4301",
    "variables": [
      {
        "id": "142dd5c0476c46104bf15222516d4382",
        "name": "resourceId",
        "question_text": "ResourceId",
        "default_value": "Not specified"
      },
      {
        "id": "d82dd5c0476c46104bf15222516d4394",
        "name": "operationName",
        "question_text": "OperationName",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:45:58",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:56",
    "created_by": "user@password.com",
    "operation": "2b0d51c0476c46104bf15222516d4378",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "ModifyLease"
  },
  {
    "catalog_name": "Start",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "d71d95c0476c46104bf15222516d4312",
    "variables": [
      {
        "id": "731d95c0476c46104bf15222516d43ae",
        "name": "resourceId",
        "question_text": "ResourceId",
        "default_value": "Not specified"
      },
      {
        "id": "731d95c0476c46104bf15222516d43b4",
        "name": "operationName",
        "question_text": "OperationName",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:45:55",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:54",
    "created_by": "user@password.com",
    "operation": "270d51c0476c46104bf15222516d4372",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Start"
  }
]

    클라우드 서비스 카탈로그 - GET /now/cmp_catalog_api/stacks

    프로비저닝 유형 Blueprint(스택이라고도 함)를 기반으로 카탈로그 항목의 목록을 반환합니다.

    URL 형식

    기본 URL: /api/now/cmp_catalog_api/stacks

    지원되는 요청 매개변수

    표 19. 경로 매개변수
    이름 설명
    없음
    표 20. 쿼리 매개변수
    이름 설명
    blueprint_name 옵션입니다. 관련 카탈로그 항목을 가져올 Blueprint의 이름입니다. 범주 항목 [sn_cmp_bp_cat_item] 테이블에 있습니다.
    주:
    이 매개변수는 Blueprint 이름의 일부 또는 전체를 쿼리할 수 있습니다. 예를 들어, "Servicenow"로 시작하는 모든 Blueprint를 나열하려면 변수를 blueprint_name = Servicenow로 설정할 수 있습니다.

    기본값: 모든 Blueprint의 모든 서비스가 반환됩니다.

    데이터 유형: 문자열
    display_variables 각 카탈로그 항목과 연결된 카탈로그 항목 변수를 나열할지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 목록 카탈로그 항목 변수를 표시합니다.
    • false: 목록 카탈로그 항목 변수를 표시하지 않습니다.

    데이터 유형: 부울

    기본값: False
    표 21. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 22. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 23. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 24. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    403 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
    405 잘못된 메서드입니다. 기능이 비활성화되었습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    활성 카탈로그가 활성 상태인지 여부를 나타내는 플래그입니다.
    가능한 값:
    • true: 카탈로그가 활성 상태입니다.
    • false: 카탈로그가 활성 상태가 아닙니다.

    데이터 유형: 문자열
    Blueprint 블루프린트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: Blueprint [sn_cmp_bp_blueprint]
    blueprint_category Blueprint 범주의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 클라우드 서비스 범주 [sn_capi_service_category]
    blueprint_category_name Blueprint 범주의 이름입니다.
    가능한 값:
    • 접근
    • 분석
    • 애플리케이션 서비스
    • Blockchain
    • 비즈니스 생산성
    • 계산
    • 구성 관리
    • 컨테이너
    • 데이터베이스
    • 개발자 도구
    • 이벤트
    • 하이브리드 클라우드
    • IOT
    • IPAM
    • 시끄러운 밸런서
    • 머신 러닝
    • 관리 도구
    • 마켓플레이스
    • 모바일
    • 네트워크
    • 생산성
    • 보안
    • 셸 접근
    • 스토리지
    • 도구
    • 알 수 없음
    • 가상 현실

    데이터 유형: 문자열

    테이블:클라우드 서비스 범주 [sn_capi_service_category]
    blueprint_name Blueprint의 이름입니다. Blueprint [sn_cmp_bp_blueprint] 테이블에 있습니다.

    데이터 유형: 문자열
    blueprint_type Blueprint의 유형입니다.

    가능한 값: 사용자 지정 Blueprint

    데이터 유형: 문자열
    catalog_name 카탈로그의 이름입니다.

    데이터 유형: 문자열

    테이블: 클라우드 카탈로그 항목 [sn_cmp_bp_cat_item]
    catalog_type 카탈로그의 유형입니다.
    가능한 값:
    • 1: 카탈로그는 프로비저닝 유형입니다.
    • 2: 카탈로그가 수명주기 유형입니다.

    데이터 유형: 문자열
    catalog_type_name 카탈로그 유형의 이름입니다.
    가능한 값:
    • 프로비저닝 작업(1일 차): 카탈로그 유형의 이름은 provision입니다.
    • 수명주기 운영(2일 차): 카탈로그 유형의 이름은 수명주기입니다.

    데이터 유형: 문자열
    ID 블루프린트의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 클라우드 카탈로그 항목 [sn_cmp_bp_cat_item]
    수명주기운영 수명주기 작업의 이름과 sys_id 포함하는 객체입니다.

    날짜 유형: 객체 배열

    "lifecycleOperations": [
      {
        "id": "String",
        "name": "String"
      }
    lifecycleOperations.id 수명주기 작업의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: OperationSignature [sn_cmp_rb_op_signature]
    lifeCycleOperations.name 수명주기 작업의 유형입니다.
    가능한 값:
    • 정리: 종료된 상태의 자원을 정리합니다.
    • 프로비전 해제: 종료된 상태의 자원을 삭제하고 그에 따라 자원 CMDB 테이블을 업데이트합니다.
    • ModifyLease: 프로비저닝된 자원에 예약된 임대 작업을 수정합니다.
    • ModifySchedule: 프로비저닝 시간의 스택 또는 기존 스택에서 업무 시간 예약을 수행합니다.
    • 시작: 꺼짐 상태인 자원을 시작합니다.
    • 중지: 켜짐 상태인 자원을 중지합니다.

    날짜 유형: 개체
    운영 작업의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: OperationSignature [sn_cmp_rb_op_signature]
    operation_name 운영의 이름
    가능한 값:
    • 프로비전 해제: 종료된 상태의 자원을 삭제하고 그에 따라 자원 CMDB 테이블을 업데이트합니다.
    • ModifyLease: 프로비저닝된 자원에 예약된 임대 작업을 수정합니다.
    • ModifySchedule: 프로비저닝된 자원의 일정을 수정합니다.
    • 시작: 꺼짐 상태인 자원을 시작합니다.
    • 중지: 켜짐 상태인 자원을 중지합니다.

    데이터 유형: 문자열
    shortDescription 카탈로그에 대한 간략한 설명입니다.

    데이터 유형: 문자열
    template_name 템플릿의 이름입니다.

    데이터 유형: 문자열

    테이블: 클라우드 카탈로그 항목 [sn_cmp_bp_cat_item]
    template_type 템플릿 유형의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 클라우드 카탈로그 항목 [sn_cmp_bp_cat_item]
    template_cloud_product_name 제품의 이름입니다.

    데이터 유형: 문자열

    테이블: 클라우드 카탈로그 항목 [sn_cmp_bp_cat_item]
    변수 목록 카탈로그 항목에 대한 상세 정보입니다. 이 API에서 반환되는 변수는 요청에 전달되는 쿼리 매개변수에 따라 달라집니다.

    데이터 유형: 객체 배열

    "variables": [
  {
    "parameter1": "String",
    "parameter2": "String"
  }
]

    다음 예에서는 프로비저닝 카탈로그 유형인 인스턴스에서 모든 카탈로그 항목을 반환합니다.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/stacks" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    돌아오다:

    [
  {
    "catalog_type": "1",
    "catalog_type_name": "Provision Operation (Day 1)",
    "catalog_name": "classiclb",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "blueprint_category_name": "Compute",
    "active": true,
    "category": "8641fe260b212200eff7ef9bb4673a3d",
    "shortDescription": null,
    "id": "07cc9580476c46104bf15222516d43c3",
    "last_updated_on": "2024-02-19 07:46:13",
    "last_updated_by": "user@servicenow.com",
    "blueprint_type": "Cloud Template",
    "template_type": "932f81e49f00320048111f80a57fcf6e",
    "template_name": "CloudFormation Template",
    "template_cloud_product": "52cfc4749f00320048111f80a57fcf9a",
    "template_cloud_product_name": "AWS CloudFormation",
    "lifecycleOperations": [
      {
        "id": "1d2d19c0476c46104bf15222516d4392",
        "name": "Deprovision"
      },
      {
        "id": "361d55c0476c46104bf15222516d4351",
        "name": "ModifySchedule"
      },
      {
        "id": "542dd5c0476c46104bf15222516d43b0",
        "name": "Stop"
      },
      {
        "id": "712d59c0476c46104bf15222516d435c",
        "name": "Cleanup"
      },
      {
        "id": "bb1dd5c0476c46104bf15222516d4301",
        "name": "ModifyLease"
      },
      {
        "id": "d71d95c0476c46104bf15222516d4312",
        "name": "Start"
      }
    ],
    "created_on": "2024-02-19 07:44:44",
    "created_by": "user@servicenow.com",
    "operation": "130d51c0476c46104bf15222516d4368",
    "operation_name": "Provision"
  }
]

    클라우드 서비스 카탈로그 - GET /now/cmp_catalog_api/status

    지정된 카탈로그 RITM(요청 항목)의 상태와 상세 정보를 반환합니다.

    이 메서드를 사용하여 요청의 원본을 식별 및 추적하고 플로우를 모니터링합니다. 응답에는 다음이 포함됩니다.
    1. 제출된 요청의 RITM 번호
    2. 요청이 있는 스테이지
    3. 요청을 열어 할당된 사용자
    4. 요청에 할당된 그룹
    5. 요청이 오픈된 시기
    6. 요청의 현재 상태
    7. 제출 데이터

    URL 형식

    기본 URL: /api/now/cmp_catalog_api/status

    지원되는 요청 매개변수

    표 25. 경로 매개변수
    이름 설명
    없음
    표 26. 쿼리 매개변수
    이름 설명
    req_item 요청 항목 [sc_req_item] 테이블의 고유 요청 항목 번호입니다. 예: RITM0000001.

    데이터 유형: 문자열
    표 27. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 28. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 29. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 30. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    403 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
    405 잘못된 메서드입니다. 기능이 비활성화되었습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    assignmentGroup 요청에 할당된 그룹입니다.

    데이터 유형: 문자열
    assignedTo 요청에 할당된 사용자 이메일입니다.

    데이터 유형: 문자열
    카탈로그 항목 카탈로그 항목 요청의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 클라우드 카탈로그 항목 [sn_cmp_bp_cat_item]
    오류 반환된 오류에 대한 상세 정보가 포함된 메시지입니다.
    가능한 오류 메시지:
    • 기록 없음 : 요청 항목이 없습니다.
    • 사용자가 인증되지 않음: 사용자의 자격 증명에 이 요청을 할 수 있는 권한이 없습니다.

    데이터 유형: 문자열
    번호 새 요청 항목에 부여된 고유 요청 항목 번호(RITM)입니다.

    데이터 유형: 문자열

    테이블: 요청 항목 [sc_req_item]
    openedAt 요청 항목이 열렸을 때의 타임 스탬프입니다.

    형식: yyyy-MM-dd HH:mm:ss.

    날짜 유형: 문자열
    openedBy 요청을 연 사용자의 Sys_id입니다.

    데이터 유형: 문자열
    스테이지 요청 항목의 현재 처리 단계입니다.
    가능한 값:
    • 스택 배치
    • 배치 취소됨
    • 배치 실패
    • 배치 성공
    • 자원 한계 초과됨
    • 재시도 중인 스택 배치
    • 사용자를 위해 작성된 작업
    • 프로비저닝 승인 대기 중

    데이터 유형: 문자열
    상태 요청 항목의 현재 완료 상태입니다.
    가능한 값:
    • 완료 종결
    • 미완료 종결
    • 건너뛴 채 종결
    • 오픈
    • 보류 중
    • 작업 진행 중

    데이터 유형: 문자열
    submissionData 클라우드 계정, 위치, 애플리케이션 및 비용 센터 데이터와 같은 요청 제출에 대한 정보입니다. 제출 데이터는 요청에 전달된 요청 항목 번호에 따라 달라집니다.

    데이터 유형: 객체

    "submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}"
}
    sys_id 요청 항목 기록의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 요청 항목 [sc_req_item]

    cURL 요청

    다음 예에서는 요청 항목 번호 RITM0010076에 대한 상태 정보를 반환합니다.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/statusreq_item=RITM0010076" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    응답:

    { 
  "catItem": "39737024c390719005091d75e0013115", 
  "stage": "Task Created for User", 
  "sys_id": "ee1197db476cc2904bf15222516d439f", 
  "assignedTo": null, 
  "assignmentGroup": null, 
  "number": "RITM0010072", 
  "openedAt": "2024-02-29 18:32:55", 
  "openedBy": "6816f79cc0a8016401c5a33be04be441", 
  "state": "Open", 
  "submissionData": "{\"CloudAccount\":\"AzureCA\",\"CSC_Azure_Functions_newResourceGroup\":\"test-rg-dnd\",\"CSC_Azure_Functions_runTimeVersion\":\"~18\",\"CSC_Azure_Functions_runTimeEngine\":\"node\",\"CSC_Azure_Functions_os\":\"Windows\",\"CSC_Azure_Functions_functionAppName\":\"sa02291029-fa\",\"LeaseEndDate\":\"2024-05-29 17:29:57\",\"ScheduleProfile\":\"-- No Schedule --\",\"UserGroup\":\"cfcbad03d711110050f5edcb9e61038f\",\"CSC_Azure_Functions_applicationName\":\"function-app\",\"ScheduleTimeZone\":\"America/Los_Angeles\",\"BusinessService\":\"\",\"environment\":\"Production\",\"CostCenter\":\"\",\"UseExistingWorkspace\":false,\"CSC_Azure_Functions_existingResourceGroup\":\"cpg-dnd\",\"CSC_Azure_Functions_isNewResourceGroup\":\"false\",\"CSC_Azure_Functions_storageAccountName\":\"sa02291029fasa\",\"Application\":\"\",\"StackName\":\"sa02291029\",\"Location\":\"Azure Datacenter - eastus\",\"Workspace\":\"\"}" 
}

    클라우드 서비스 카탈로그 - POST /now/cmp_catalog_api/submitoprequest

    프로비저닝된 자원에 대한 2일차 운영을 수행하기 위해 자원 운영 요청을 제출합니다.

    URL 형식

    기본 URL: /api/now/cmp_catalog_api/submitoprequest

    지원되는 요청 매개변수

    표 31. 경로 매개변수
    이름 설명
    없음
    표 32. 쿼리 매개변수
    이름 설명
    cat_id 필수. 호출할 클라우드 카탈로그 항목의 sys_id입니다. 클라우드 카탈로그 항목 [sn_cmp_bp_cat_item] 테이블에서 사용할 수 있습니다.

    데이터 유형: 문자열
    표 33. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    CloudAccount 필수 요청을 제출할 클라우드 계정의 이름입니다. 계정 이름은 클라우드 계정 [cmdb_ci_cmp_cloud_account] 테이블에서 사용할 수 있습니다.

    데이터 유형: 문자열
    위치 필수 자원을 프로비저닝할 데이터센터 위치입니다. 예: us-west-1 또는 asia-south-2 이 값은 클라우드 계정의 플랫폼 제공자의 데이터센터 위치와 일치해야 합니다. 연결된 데이터센터 [sn_cmp_ca_assc_datacenter] 테이블에서 사용할 수 있습니다.

    데이터 유형: 문자열
    StackName 필수 스택의 이름입니다. 스택 이름은 동적이며 자원 관리에 반영됩니다.

    데이터 유형: 문자열
    resourceId 필수 2일 차 작업이 수행될 자원의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 스택 항목 [sn_cmp_stack_item]
    resource_block 필수. 관련 자원 운영 카탈로그 항목을 가져올 자원 블록의 이름입니다(예: 가상 서버).

    기본값: 모든 운영 유형의 모든 카탈로그 항목이 반환됩니다.

    데이터 유형: 문자열

    테이블: 자원 블록 [sn_cmp_rb_resourceblock]
    operation_name 옵션입니다. 운영의 이름 OperationSignature [sn_cmp_rb_op_signature] 테이블에 있는 자원 인터페이스의 이름 열에 있습니다. 입력하는 작업 이름은 매개변수에 resourceBlock 전달된 값에 따라 달라집니다.
    주:
    이 매개변수는 작업의 일부 또는 전체를 쿼리할 수 있습니다. 예를 들어 "Servicenow"로 시작하는 모든 인터페이스를 나열하려면 변수를 operation_name = Servicenow로 설정할 수 있습니다.
    기본값: 모든 운영 유형의 모든 카탈로그 항목이 반환됩니다.데이터 유형: 문자열
    자원 인터페이스 필수. 관련 자원 운영 카탈로그 항목을 가져올 자원 블록의 이름입니다(예: 가상 서버).입력하는 자원 인터페이스는 and operation_name 매개변수에 resourceBlock 전달된 값에 따라 달라집니다.

    기본값: 모든 운영 유형의 모든 카탈로그 항목이 반환됩니다.

    데이터 유형: 문자열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 34. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 35. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 36. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    403 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
    405 잘못된 메서드입니다. 기능이 비활성화되었습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    assignmentGroup 요청에 할당된 그룹입니다.

    데이터 유형: 문자열
    assignedTo 요청에 할당된 사용자 이메일입니다.

    데이터 유형: 문자열
    카탈로그 항목 카탈로그 항목 요청의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 클라우드 카탈로그 항목 [sn_cmp_bp_cat_item]
    번호 새 요청 항목에 부여된 고유 요청 항목 번호(RITM)입니다.

    데이터 유형: 문자열

    테이블: 요청 항목 [sc_req_item]
    openedAt 요청 항목이 열렸을 때의 타임 스탬프입니다.

    형식: yyyy-MM-dd HH:mm:ss.

    날짜 유형: 문자열
    openedBy 요청을 연 사용자의 Sys_id입니다.

    데이터 유형: 문자열
    스테이지 요청 항목의 현재 처리 단계입니다.
    가능한 값:
    • 스택 배치
    • 배치 취소됨
    • 배치 실패
    • 배치 성공
    • 자원 한계 초과됨
    • 재시도 중인 스택 배치
    • 사용자를 위해 작성된 작업
    • 프로비저닝 승인 대기 중

    데이터 유형: 문자열
    상태 요청 항목의 현재 완료 상태입니다.
    가능한 값:
    • 완료 종결
    • 미완료 종결
    • 건너뛴 채 종결
    • 오픈
    • 보류 중
    • 작업 진행 중

    데이터 유형: 문자열
    submissionData 클라우드 계정, 위치, 애플리케이션 및 비용 센터 데이터와 같은 요청 제출에 대한 정보입니다. 제출 데이터는 요청에 전달된 요청 항목 번호에 따라 달라집니다.

    데이터 유형: 객체

    "submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}"
}
    sys_id 요청 항목 기록의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 요청 항목 [sc_req_item]

    다음 예에서는 2일차 작업 요청 항목을 생성합니다.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/submitoprequest?cat_id=e44dcd238731e5101126cbb4dabb3506" /
--request POST\ 
--header 'Accept: application/json' \ 
--user 'username':'password'

//Request body:
{"StackName":"sa02292143","CloudAccount":"AWS","Location":"AWS Datacenter - us-east-1","resourceId":"df8c61e3eb2cc210d298fbbdbad0cd74","operationName":"Deprovision","resourceInterface":"S3 Interface","resourceBlock":"S3"}

    응답 본문:

    { 
  "number": "RITM0010078", 
  "catItem": "e44dcd238731e5101126cbb4dabb3506", 
  "stage": "request_approved", 
  "sys_id": "9bf5cab3c3594610bc89b33605013190", 
  "assignedTo": null, 
  "assignmentGroup": null, 
  "openedAt": "2024-04-08 09:08:47", 
  "openedBy": "6816f79cc0a8016401c5a33be04be441", 
  "state": "Open", 
  "submissionData": "{\"StackName\":\"sa02292143\",\"CloudAccount\":\"AWS\",\"Location\":\"AWS Datacenter - us-east-1\",\"resourceId\":\"df8c61e3eb2cc210d298fbbdbad0cd74\",\"operationName\":\"Deprovision\",\"resourceInterface\":\"S3 Interface\",\"resourceBlock\":\"S3\"}" 
} 
 
Sample Request Body for CSC S3 Bucket Catalog Order: 
 
{"StackName":"sa02292143","CloudAccount":"AWS","Location":"AWS Datacenter - us-east-1","resourceId":"df8c61e3eb2cc210d298fbbdbad0cd74","operationName":"Deprovision","resourceInterface":"S3 Interface","resourceBlock":"S3"}

    클라우드 서비스 카탈로그 - POST /now/cmp_catalog_api/submitrequest

    클라우드 서비스 요청을 제출합니다. 이 방법은 2일 차 작업과 스택 또는 자원 작업 카탈로그 항목 모두에 대해 프로비저닝된 요청을 수락합니다.

    URL 형식

    기본 URL: /api/now/cmp_catalog_api/submitrequest

    지원되는 요청 매개변수

    표 37. 경로 매개변수
    이름 설명
    없음
    표 38. 쿼리 매개변수
    이름 설명
    cat_id 필수. 호출할 클라우드 카탈로그 항목의 sys_id입니다. 클라우드 카탈로그 항목 [sn_cmp_bp_cat_item] 테이블에서 사용할 수 있습니다.

    데이터 유형: 문자열
    표 39. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    CloudAccount 필수 요청을 제출할 클라우드 계정의 이름입니다. 계정 이름은 클라우드 계정 [cmdb_ci_cmp_cloud_account] 테이블에서 사용할 수 있습니다.

    데이터 유형: 문자열
    위치 필수 자원을 프로비저닝할 데이터센터 위치입니다. 예: us-west-1 또는 asia-south-2 이 값은 클라우드 계정의 플랫폼 제공자의 데이터센터 위치와 일치해야 합니다. 연결된 데이터센터 [sn_cmp_ca_assc_datacenter] 테이블에서 사용할 수 있습니다.

    데이터 유형: 문자열
    StackName 필수 스택의 이름입니다. 스택 이름은 동적이며 자원 관리에 반영됩니다.

    데이터 유형: 문자열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 40. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 41. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용되는 가능한 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 42. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    403 금지되었습니다. 사용자에게 지정된 기록에 대한 액세스 권한이 없습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
    405 잘못된 메서드입니다. 기능이 비활성화되었습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    assignmentGroup 요청에 할당된 그룹입니다.

    데이터 유형: 문자열
    assignedTo 요청에 할당된 사용자 이메일입니다.

    데이터 유형: 문자열
    카탈로그 항목 카탈로그 항목 요청의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 클라우드 카탈로그 항목 [sn_cmp_bp_cat_item]
    번호 새 요청 항목에 부여된 고유 요청 항목 번호(RITM)입니다.

    데이터 유형: 문자열

    테이블: 요청 항목 [sc_req_item]
    openedAt 요청 항목이 열렸을 때의 타임 스탬프입니다.

    형식: yyyy-MM-dd HH:mm:ss.

    날짜 유형: 문자열
    openedBy 요청을 연 사용자의 Sys_id입니다.

    데이터 유형: 문자열
    스테이지 요청 항목의 현재 처리 단계입니다.
    가능한 값:
    • 스택 배치
    • 배치 취소됨
    • 배치 실패
    • 배치 성공
    • 자원 한계 초과됨
    • 재시도 중인 스택 배치
    • 사용자를 위해 작성된 작업
    • 프로비저닝 승인 대기 중

    데이터 유형: 문자열
    상태 요청 항목의 현재 완료 상태입니다.
    가능한 값:
    • 완료 종결
    • 미완료 종결
    • 건너뛴 채 종결
    • 오픈
    • 보류 중
    • 작업 진행 중

    데이터 유형: 문자열
    submissionData 클라우드 계정, 위치, 애플리케이션 및 비용 센터 데이터와 같은 요청 제출에 대한 정보입니다. 제출 데이터는 요청에 전달된 요청 항목 번호에 따라 달라집니다.

    데이터 유형: 객체

    "submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}"
}
    sys_id 요청 항목 기록의 Sys_id입니다.

    데이터 유형: 문자열

    테이블: 요청 항목 [sc_req_item]

    다음 예에서는 인스턴스의 AWS 클라우드 계정에서 클라우드 자원 요청을 제출합니다.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/submitrequest?cat_id=022e3deec3122910a769f44ed40131b9" /
--request POST \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

//Request body:
{"CloudAccount":"AWS","Location":"us-east-1","StackName":"ss"}

    응답:

    { 
  "number": "RITM0010001", 
  "catItem": "022e3deec3122910a769f44ed40131b9", 
  "stage": "check_permissions", 
  "sys_id": "86d34233c3594610bc89b336050131dd", 
  "assignedTo": null, 
  "assignmentGroup": null, 
  "openedAt": "2024-04-08 08:59:25", 
  "openedBy": "6816f79cc0a8016401c5a33be04be441", 
  "state": "Open", 
  "submissionData": "{\"CloudAccount\":\"AWS\",\"Location\":\"us-east-1\",\"StackName\":\"ss\"}" 
}