DevOps Config API

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

    • DevOps Config API는 애플리케이션을 관리하기 위한 엔드포인트를 제공합니다.

    이 API에는 응용 프로그램이 DevOps 구성 필요하며 sn_devops_config 네임스페이스 내에서 제공됩니다.

    DELETE, PATCH 및 POST 작업의 경우 호출하는 사용자에게 sn_devops_config.admin 역할이 있어야 합니다. GET 작업의 경우 호출하는 사용자에게 sn_devops_config.viewer 또는 sn_devops_config.admin 역할이 있어야 합니다.

    애플리케이션 수명주기 관리를 위해 DevOps Config API를 사용합니다. 를 사용하여 DevOps 구성애플리케이션을 관리하는 방법에 대한 자세한 내용은 DevOps Config 구성을 참조하십시오.

    DevOps Config - DELETE /devops_config/application/{appid}

    애플리케이션을 삭제합니다.

    URL 형식

    버전이 지정된 URL: / api/sn_devops_config/v1/devops_config/application/{appid}

    기본 URL: / api/sn_devops_config/devops_config/application/{appid}

    지원되는 요청 매개변수

    표 1. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    appid 삭제할 애플리케이션의 Sys_id입니다. CDM 애플리케이션 [sn_cdm_application] 테이블에 있습니다.

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

    헤더

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

    표 4. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. application/json만 지원합니다.
    표 5. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 6. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청. 애플리케이션 ID가 잘못되었습니다.
    403 금지되었습니다. 사용자에게 API에 액세스할 수 있는 권한이 없습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    오류 오류 정보입니다. 이 매개 변수는 요청이 실패한 경우에만 반환됩니다.

    데이터 유형: 객체

    "error": { 
   "message": "String", 
   "detail": "String" 
}
    오류.상세 정보 요청이 실패한 이유에 대한 추가 정보입니다.

    데이터 유형: 문자열
    error.message 요청이 실패한 이유를 포함하는 오류 메시지입니다.

    데이터 유형: 문자열
    결과 요청에 대한 정보를 포함하는 결과 객체입니다.

    데이터 유형: 객체

    "result": { 
   "errors": [Array], 
   "success": [Array] 
}
    결과.오류 요청의 오류 배열입니다. 성공적인 요청의 경우 배열이 비어 있습니다.

    데이터 유형: 배열
    결과.성공 요청에 대한 성공 메시지입니다. 실패한 요청에 대한 배열은 비어 있습니다.

    데이터 유형: 배열
    상태 요청의 상태입니다. 이 매개 변수는 요청이 실패한 경우에만 반환됩니다.

    가능한 값: 실패

    데이터 유형: 문자열

    cURL 요청

    이 예제에서는 응용 프로그램을 삭제합니다.

    curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/38e17dc3473d111072566862736d43c7" \ 
--request DELETE \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    응답 본문입니다.

    { 
  "result": { 
    "errors": [], 
    "success": [ 
      "CDM Application Demo Application 1234 has been deleted successfully." 
    ] 
  } 
}

    cURL 요청

    이 예제에서는 사용자에게 API에 액세스할 수 있는 권한이 없는 경우의 오류 응답을 보여 줍니다.

    curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/38e17dc3473d111072566862736d43c7" \ 
--request DELETE \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    오류 응답.

    { 
  "error": { 
    "message": "User Not Authorized", 
    "detail": "Failed API level ACL Validation" 
  }, 
  "status": "failure" 
}

    DevOps Config - GET /devops_config/application/{appid}

    애플리케이션을 검색합니다.

    URL 형식

    버전이 지정된 URL: / api/sn_devops_config/v1/devops_config/application/{appid}

    기본 URL: / api/sn_devops_config/devops_config/application/{appid}

    지원되는 요청 매개변수

    표 7. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    appid 검색할 애플리케이션의 Sys_id입니다. CDM 애플리케이션 [sn_cdm_application] 테이블에 있습니다.

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

    헤더

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

    표 10. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. application/json만 지원합니다.
    표 11. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 12. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청. 애플리케이션 ID가 잘못되었습니다.
    403 금지되었습니다. 사용자에게 API에 액세스할 수 있는 권한이 없습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    오류 오류 정보입니다. 이 매개 변수는 요청이 실패한 경우에만 반환됩니다.

    데이터 유형: 객체

    "error": { 
   "message": "String", 
   "detail": "String" 
}
    오류.상세 정보 요청이 실패한 이유에 대한 추가 정보입니다.

    데이터 유형: 문자열
    error.message 요청이 실패한 이유를 포함하는 오류 메시지입니다.

    데이터 유형: 문자열
    결과 요청에 대한 정보를 포함하는 결과 객체입니다.

    데이터 유형: 객체

    "result": { 
  "data": {Object},
  "message": "String",
  "status": Number
}
    결과.데이터 애플리케이션에 대한 데이터입니다.

    데이터 유형: 객체

    "data": { 
  "appDescription": "String", 
  "appId": "String",
  "appManagedByGroups": [Array],
  "appManufacturerId": "String", 
  "appManufacturerName": "String", 
  "appModelId": "String", 
  "appModelName": "String", 
  "appModelOwnerId": "String", 
  "appModelOwnerName": "String", 
  "appName": "String", 
  "sdlcType": "String"
}
    result.data.app설명 애플리케이션에 대한 설명입니다.

    데이터 유형: 문자열
    결과.데이터.appId 애플리케이션의 Sys_id입니다. CDM 애플리케이션 [sn_cdm_application] 테이블에 있습니다.

    데이터 유형: 문자열
    result.data.appManagedByGroups 애플리케이션을 관리하는 sys_ids 그룹의 쉼표로 구분된 목록입니다. 그룹 [sys_user_group] 테이블에 있습니다.

    데이터 유형: 문자열
    result.data.appManufacturerId 제조업체의 Sys_id입니다. 회사 [core_company] 테이블에 있습니다.

    데이터 유형: 문자열
    result.data.appManufacturerName 제조업체의 이름입니다.

    데이터 유형: 문자열
    result.data.appModelId 애플리케이션 모델의 Sys_id입니다. 애플리케이션 모델 [cmdb_application_product_model] 테이블에 있습니다.

    데이터 유형: 문자열
    result.data.appModelName 애플리케이션 모델의 이름입니다. 애플리케이션 모델 [cmdb_application_product_model] 테이블에 있습니다.

    데이터 유형: 문자열
    result.data.appModelOwnerId 애플리케이션 모델 소유자의 Sys_id입니다. 사용자 [sys_user] 테이블에 있습니다.

    데이터 유형: 문자열
    result.data.appModelOwnerName 애플리케이션 모델 소유자의 이름입니다.

    데이터 유형: 문자열
    결과.데이터.appName 애플리케이션의 이름입니다.

    데이터 유형: 문자열
    결과.데이터.오류 오류 정보입니다. 이 매개 변수는 요청이 실패한 경우에만 반환됩니다.

    데이터 유형: 문자열
    result.data.sdlcType 애플리케이션의 유형입니다.
    가능한 값:
    • 애플리케이션
    • 인프라

    데이터 유형: 문자열
    result.message 요청의 성공 또는 실패 결과에 대한 정보입니다.

    데이터 유형: 문자열
    result.status 요청의 상태 코드입니다.
    가능한 값:
    • 200
    • 400
    • 403

    데이터 유형: 숫자
    상태 요청의 상태입니다. 이 매개 변수는 요청이 실패한 경우에만 반환됩니다.

    가능한 값: 실패

    데이터 유형: 문자열

    cURL 요청

    이 예제에서는 응용 프로그램을 검색합니다.

    curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/38e17dc3473d111072566862736d43c7" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    응답 본문입니다.

    { 
  "result": { 
    "status": 200, 
    "message": "Success", 
    "data": { 
      "appName": "Demo Application 1234", 
      "appId": "38e17dc3473d111072566862736d43c7", 
      "appDescription": "Updated description of Demo Application created from REST API", 
      "sdlcType": "application", 
      "appModelId": "a4e13dc3473d111072566862736d4307", 
      "appModelName": "Demo Application 1234", 
      "appManufacturerId": "262702654725d950a34a3085d36d435e", 
      "appManufacturerName": "", 
      "appModelOwnerId": "6816f79cc0a8016401c5a33be04be441", 
      "appModelOwnerName": "System Administrator", 
      "appManagedByGroups": [] 
    } 
  } 
}

    cURL 요청

    이 예제에서는 사용자가 잘못된 애플리케이션 ID를 제공할 때 오류 응답을 표시합니다.

    curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/18a17de3283d15107256686277777777" \ 
--request GET \ 
--header "Accept:application/json" \ 
--user 'username':'password'

    오류 응답.

    { 
  "result": { 
    "status": 400, 
    "message": "No valid Application", 
    "data": { 
      "error": "No valid Application" 
    } 
  } 
}

    DevOps 구성 - PATCH /devops_config/application/{appid}

    애플리케이션을 업데이트합니다.

    URL 형식

    버전이 지정된 URL: / api/sn_devops_config/v1/devops_config/application/{appid}

    기본 URL: / api/sn_devops_config/devops_config/application/{appid}

    지원되는 요청 매개변수

    표 13. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    appid 업데이트할 애플리케이션의 Sys_id입니다. CDM 애플리케이션 [sn_cdm_application] 테이블에 있습니다.

    데이터 유형: 문자열
    표 14. 쿼리 매개변수
    이름 설명
    없음
    표 15. 요청 본문 매개변수(JSON)
    이름 설명
    app설명 애플리케이션에 대한 설명입니다.

    데이터 유형: 문자열
    appManagedByGroups 애플리케이션을 관리하는 sys_ids 그룹의 쉼표로 구분된 목록입니다. 호출하는 사용자는 이러한 그룹에 속해야 합니다. 그룹 [sys_user_group] 테이블에 있습니다.

    데이터 유형: 문자열

    "appManagedByGroups": "sys_id, sys_id"
    appManufacturerId 제조업체의 Sys_id입니다. 회사 [core_company] 테이블에 있습니다.

    데이터 유형: 문자열
    appModelOwnerId 애플리케이션 모델 소유자의 Sys_id입니다. 사용자 [sys_user] 테이블에 있습니다.

    데이터 유형: 문자열

    헤더

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

    표 16. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. application/json만 지원합니다.
    컨텐츠-형식 요청 본문의 데이터 형식입니다. application/json만 지원합니다.
    표 17. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 18. 상태 코드
    상태 코드 설명
    200 애플리케이션이 성공적으로 업데이트되었습니다.
    403 금지되었습니다. 사용자에게 API에 액세스할 수 있는 권한이 없습니다.
    404 애플리케이션이 업데이트되지 않았습니다. 개체의 속성 result 에는 message 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    오류 오류 정보입니다. 이 매개 변수는 요청이 실패한 경우에만 반환됩니다.

    데이터 유형: 객체

    "error": { 
   "message": "String", 
   "detail": "String" 
}
    error.message 요청이 실패한 이유를 포함하는 오류 메시지입니다.

    데이터 유형: 문자열
    오류.상세 정보 요청이 실패한 이유에 대한 추가 정보입니다.

    데이터 유형: 문자열
    결과 애플리케이션에 대한 정보를 포함하는 결과 객체입니다.

    데이터 유형: 객체

    "result": { 
   "message": "String", 
   "data": "String" 
}
    result.message 요청의 성공 또는 실패 결과에 대한 정보입니다.

    데이터 유형: 문자열
    결과.데이터 애플리케이션의 Sys_id입니다. CDM 애플리케이션 [sn_cdm_application] 테이블에 있습니다.

    데이터 유형: 문자열
    상태 요청의 상태입니다. 이 매개 변수는 요청이 실패한 경우에만 반환됩니다.

    가능한 값: 실패

    데이터 유형: 문자열

    cURL 요청

    이 예제에서는 기존 응용 프로그램을 업데이트합니다.

    curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/38e17dc3473d111072566862736d43c7" \ 
--request PATCH \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{ 
  \"appDescription\": \"Updated description of Demo Application created from REST API\", 
  \"appManufacturerId\": \"262702654725d950a34a3085d36d435e\", 
  \"appModelOwnerId\": \"6816f79cc0a8016401c5a33be04be441\" 
}" \ 
--user 'username':'password'

    응답 본문입니다.

    { 
  "result": { 
    "message": "Application with name Demo Application 1234 updated successfully.", 
    "data": "38e17dc3473d111072566862736d43c7" 
  } 
}

    DevOps 구성 - POST /devops_config/application

    애플리케이션을 작성합니다.

    URL 형식

    버전이 지정된 URL: / api/sn_devops_config/v1/devops_config/application

    기본 URL: / api/sn_devops_config/devops_config/application

    지원되는 요청 매개변수

    표 19. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 20. 쿼리 매개변수
    이름 설명
    없음
    표 21. 요청 본문 매개변수(JSON)
    이름 설명
    app설명 애플리케이션에 대한 설명입니다.

    데이터 유형: 문자열
    appManagedByGroups 애플리케이션을 관리하는 sys_ids 그룹의 쉼표로 구분된 목록입니다. 호출하는 사용자는 이러한 그룹에 속해야 합니다. 그룹 [sys_user_group] 테이블에 있습니다.

    데이터 유형: 문자열

    "appManagedByGroups": "sys_id, sys_id"
    appManufacturerId 제조업체의 Sys_id입니다. 회사 [core_company] 테이블에 있습니다.

    데이터 유형: 문자열
    appModelId 애플리케이션을 생성하는 데 사용할 기존 애플리케이션 모델의 Sys_id입니다. 애플리케이션 모델 [cmdb_application_product_model] 테이블에 있습니다.

    이 매개 변수를 제공하면 , , appServiceIdappModelNameappServiceName, 또는 technicalServiceId 매개 변수를 제공하지 appName마세요.

    데이터 유형: 문자열
    appModel이름 애플리케이션을 생성하는 데 사용할 기존 애플리케이션 모델의 이름입니다. 애플리케이션 모델 [cmdb_application_product_model] 테이블에 있습니다.

    이 매개 변수를 제공하면 , , appServiceIdappModelIdappServiceName, 또는 technicalServiceId 매개 변수를 제공하지 appName마세요.

    데이터 유형: 문자열
    appModelOwnerId 애플리케이션 모델 소유자의 Sys_id입니다. 사용자 [sys_user] 테이블에 있습니다.

    데이터 유형: 문자열
    appName 애플리케이션의 이름입니다.

    기존 애플리케이션과 동일한 이름을 사용하지 마세요.

    이 매개 변수를 제공하면 , , appServiceIdappModelIdappServiceName, 또는 technicalServiceId 매개 변수를 제공하지 appModelName마세요.

    데이터 유형: 문자열
    appServiceId 애플리케이션을 생성하는 데 사용할 기존 애플리케이션 서비스의 Sys_id입니다. 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 있습니다.

    is 애플리케이션인 경우에만 type 이 매개변수를 사용하십시오.

    이 매개 변수를 제공하면 , , appServiceNameappModelNameappModelId, 또는 technicalServiceId 매개 변수를 제공하지 appName마세요.

    데이터 유형: 문자열
    appService이름 애플리케이션을 생성하는 데 사용할 기존 애플리케이션 서비스의 이름입니다. 애플리케이션 서비스 [cmdb_ci_service_auto] 테이블에 있습니다.

    is 애플리케이션인 경우에만 type 이 매개변수를 사용하십시오.

    이 매개 변수를 제공하면 , , appServiceIdappModelNameappModelId, 또는 technicalServiceId 매개 변수를 제공하지 appName마세요.

    데이터 유형: 문자열
    technicalServiceId 애플리케이션을 생성하는 데 사용할 기존 동적 CI 그룹의 Sys_id입니다. 동적 CI 그룹[cmdb_ci_query_based_service] 테이블에 있습니다.

    인프라인 경우에만 type 이 매개변수를 사용합니다.

    이 매개 변수를 제공하면 , , appServiceNameappModelNameappModelId, 또는 appServiceId 매개 변수를 제공하지 appName마세요.

    데이터 유형: 문자열
    유형 필수 작성할 애플리케이션의 유형입니다.
    유효한 값은 다음과 같습니다.
    • 애플리케이션
    • 인프라

    데이터 유형: 문자열

    헤더

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

    표 22. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. application/json만 지원합니다.
    컨텐츠-형식 요청 본문의 데이터 형식입니다. application/json만 지원합니다.
    표 23. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 24. 상태 코드
    상태 코드 설명
    201 애플리케이션이 성공적으로 생성되었습니다.
    403 금지되었습니다. 사용자에게 API에 액세스할 수 있는 권한이 없습니다.
    404 애플리케이션이 생성되지 않았습니다. 개체의 속성 result 에는 message 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON)

    이름 설명
    오류 오류 정보입니다. 이 매개 변수는 요청이 실패한 경우에만 반환됩니다.

    데이터 유형: 객체

    "error": { 
   "message": "String", 
   "detail": "String" 
}
    error.message 요청이 실패한 이유를 포함하는 오류 메시지입니다.

    데이터 유형: 문자열
    오류.상세 정보 요청이 실패한 이유에 대한 추가 정보입니다.

    데이터 유형: 문자열
    결과 애플리케이션에 대한 정보를 포함하는 결과 객체입니다.

    데이터 유형: 객체

    "result": { 
   "message": "String", 
   "data": "String" 
}
    result.message 요청의 성공 또는 실패 결과에 대한 정보입니다.

    데이터 유형: 문자열
    결과.데이터 애플리케이션의 Sys_id입니다. CDM 애플리케이션 [sn_cdm_application] 테이블에 있습니다.

    데이터 유형: 문자열
    상태 요청의 상태입니다. 이 매개 변수는 요청이 실패한 경우에만 반환됩니다.

    가능한 값: 실패

    데이터 유형: 문자열

    cURL 요청

    이 예제에서는 새 응용 프로그램을 만듭니다.

    curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{ 
  \"type\": \"application\", 
  \"appName\": \"Demo Application 1234\", 
  \"appDescription\": \"Description of Demo Application created from REST API\", 
  \"appManufacturerId\": \"262702654725d950a34a3085d36d435e\", 
  \"appModelOwnerId\": \"6816f79cc0a8016401c5a33be04be441\" 
}" \ 
--user 'username':'password'

    응답 본문입니다.

    { 
  "result": { 
    "message": "Application with name Demo Application 1234 created successfully.", 
    "data": "38e17dc3473d111072566862736d43c7" 
  } 
}