APM 하이퍼미디어 API
CA APM은 사용자가 이용할 수 있는 몇 가지 공용 하이퍼미디어 API를 제공합니다. 이 섹션에서는 CA APM 하이퍼미디어 API의 기본 개념과 이러한 API가 공유하는 공통적인 메커니즘을 다룹니다.
apmdevops104kr
CA APM은 사용자가 이용할 수 있는 몇 가지 공용 하이퍼미디어 API를 제공합니다. 이 섹션에서는 CA APM 하이퍼미디어 API의 기본 개념과 이러한 API가 공유하는 공통적인 메커니즘을 다룹니다.
HATEOAS(Hypermedia as the Engine of Application State) REST 응용 프로그램 아키텍처는 클라이언트가 하이퍼미디어를 통해 CA APM과 상호 작용할 수 있도록 합니다. 하이퍼미디어 API를 사용하려면 기준 URL만 알면 됩니다. 사용 가능한 모든 리소스 및 작업은 응용 프로그램 서버에서 동적으로 제공됩니다.
APM RESTful API는 HTTP를 기본 프로토콜로 사용하고 표현 형식으로 HAL(Hypertext Application Language)과 JSON을 사용합니다.
이 사양에서 설명하는 모든 기능이 모든 API에 구현된 것은 아닙니다. 각 API에 대한 자세한 내용은 CA APM API를 참조하십시오.
여러 도구를 사용하여 APM 하이퍼미디어 API와 상호 작용할 수 있습니다. 예:
- Postman Chrome 확장
- cURL(명령줄 도구)
- 스크립팅 언어(Python)
응답 상태 코드
API는 응답과 함께 HTTP 상태 코드를 반환합니다.
일반적으로 HTTP 상태 코드는 몇 가지 범주로 그룹화됩니다.
- 1xx코드는 정보 제공용입니다.
- 2xx는 성공을 나타냅니다.
- 3xx는 리디렉션을 알려 줍니다.
- 4xx는 클라이언트 오류, 즉 클라이언트에 어떤 문제가 있음을 나타냅니다.
- 5xx는 서버 쪽 오류, 즉 서버에 어떤 문제가 있음을 나타냅니다.
다음 표에서는 사용된 메서드별로 성공 상태 코드를 보여 줍니다.
메서드 | 성공 시 반환 | 제공 헤더 | 응답 본문 |
GET | 200 OK | 다양함 | 다양함 |
POST | 201 Created | Location: 생성된 리소스를 가리킴 | 비어 있음 |
POST - 비동기 | 202 Accepted | Location: 곧 생성될 리소스를 가리킴 | 비어 있음 |
POST | 200 OK | - | 생성된 리소스 |
PUT(새 리소스) | 201 Created | Location: 생성된 리소스를 가리킴 | 비어 있음 |
PUT(새 리소스) | 200 OK | - | 생성된 리소스 |
PUT(새 리소스) - 비동기 | 202 Accepted | Location: 곧 생성될 리소스를 가리킴 | 비어 있음 |
PUT(기존 리소스) | 204 No Content | - | 비어 있음 |
PUT(기존 리소스) - 비동기 | 202 Accepted | Location: 곧 업데이트될 리소스를 가리킴 | 비어 있음 |
PATCH | 204 No Content | - | 비어 있음 |
PATCH - 비동기 | 202 Accepted | - | 비어 있음 |
DELETE | 200 OK | - | - |
DELETE - 비동기 | 202 Accepted | - | - |