APM REST API

자동화된 스크립트에서 APM REST API를 사용하여 꼭지점 특성을 생성, 업데이트 및 삭제할 수 있습니다. 사용할 수 있는 각 웹 서비스에 대해 지원되는 HTTP 동사와 요청 매개 변수가 나열됩니다.
apmdevops104kr
HID_EM_API
자동화된 스크립트에서 APM REST API를 사용하여 꼭지점 특성을 생성, 업데이트 및 삭제할 수 있습니다. 사용할 수 있는 각 웹 서비스에 대해 지원되는 HTTP 동사와 요청 매개 변수가 나열됩니다.
CA APM은 다음과 같은 공개 RESTful 웹 서비스를 지원합니다.
8
이 API에는 이전에는 사용할 수 없던 새로운 /
graph
/ 리소스가 포함되어 있습니다. 원래 루트, /vertex/ 및 /vertex/{id} 리소스도 지원됩니다. 새로운 기능을 사용하려면 새로운 인터페이스로 마이그레이션하는 것이 좋습니다.
리소스 URL은 모두 다음과 같은 형식입니다.
  • APM 온-프레미스:
    http://{{hostname}}:8081/
    apm/appmap/
  • CA의 APM Digital Experience Insights:
    https://{{hostname}}/
    apm
    /
    appmap
    /
다음 표에서는 사용 가능한 모든 APM REST API 리소스와 각 리소스가 지원하는 HTTP 동사 및 매개 변수를 보여 줍니다.
리소스
설명
ETC 인식
HTTP 동사
매개 변수
 
GET
PATCH
모두
 
타임스탬프
필터링
/apm/appmap/vertex(컬렉션)
꼭지점의 컬렉션을 나타냅니다.
아니오
아니오
  • /vertex?projection=full
    - 전체 예측을 가져옵니다.
  • /vertex?projection=compact
    - 압축 예측을 가져옵니다.
/apm/appmap/vertex/{id}
APM 에이전트를 나타냅니다.
아니오
아니오
아니오
아니오
/apm/appmap/
API의 루트 리소스
아니오
아니오
아니오
/apm/appmap/
graph/vertex
꼭지점의 컬렉션을 나타냅니다.
아니오
 
  • /vertex?timestamp=1970-01-01T00:00:01Z
    - 특정 날짜의 스냅숏을 가져옵니다. 기본값은 now입니다.
  • /vertex?projection=full
    - 전체 예측을 가져옵니다.
  • /vertex?projection=compact
    - 압축 예측을 가져옵니다.
  • /vertex
    - 페이로드는 쿼리를 지정합니다.
 예
 예
/apm/appmap/
graph/vertex/{id}
단일 꼭지점을 나타냅니다.
아니오
 
/vertex?timestamp=1970-01-01T00:00:01Z
- 특정 날짜의 스냅숏을 가져옵니다. 기본값은 now입니다.
 예
 아니오
/apm/appmap/
graph
꼭지점과 가장자리가 있는 그래프를 나타냅니다.
아니오
아니오
  • GET /apm/appmap/graph
    - 현재 시점의 꼭지점, 꼭지점 상태 및 가장자리를 반환합니다.
  • json 형식의 필터링(/graph/vertex의 경우와 동일)
  • /graph?timestamp=1970-01-01T00:00:01Z
    - 특정 날짜의 스냅숏을 가져옵니다. 기본값은 now입니다. 미래 날짜의 오류를 반환합니다.
 예
 예
/apm/appmap/
graph/incremental
마지막 호출 이후 꼭지점 및 가장자리에 대한 업데이트
아니오
아니오
  • GET /apm/appmap/graph/incremental?sinceVersion=0
    - 이 초기 호출은 현재 시점의 꼭지점 및 가장자리를 반환합니다. 응답에는 증분 업데이트를 가져오기 위한 lastVersion이 포함됩니다.
  • GET /apm/appmap/graph/incremental?sinceVersion=XXXVersion4
    - XXXVersion4 이후의 모든 증분 변경 사항을 반환합니다. 응답에는 업데이트되거나 삭제된 꼭지점 및 가장자리에 대한 정보가 포함됩니다.
 아니오
 예
/apm/appmap/
graph/
vertexstatus/incremental
스냅숏 + 꼭지점 상태에 대한 증분 업데이트
아니오
아니오
  • GET /apm/appmap/vertexstatus/incremental?sinceVersion=0
    - 이 초기 호출은 현재 시점의 모든 상태를 반환합니다. 응답에는 증분 업데이트를 가져오기 위한 lastVersion이 포함됩니다.
  • GET /apm/appmap/vertexstatus/incremental?sinceVersion=XXXVersion4
    - 버전 XXXVersion4 이후의 모든 증분 변경 사항을 반환합니다. 응답에는 업데이트된 상태에 대한 정보가 포함됩니다.
 아니오
 아니오
참고
: 매개 변수는 대/소문자를 구분하며 소문자여야 합니다.
인증
보안 토큰은 무작위로 생성되는 텍스트 문자열로, 텍스트 암호와 거의 동일합니다. 이 토큰은 API에서 APM 웹 서비스에 액세스할 수 있게 해 줍니다.
필요한 만큼 토큰을 생성할 수 있습니다. "Edit"(편집) 단추를 사용하여 토큰 설명을 변경하거나 토큰을 삭제할 수도 있습니다. 토큰을 해지하려면 토큰을 삭제해야 합니다. 모든 사용자가 모든 토큰을 삭제할 수 있습니다.
토큰이 생성된 시기와 마지막으로 사용된 시기도 확인할 수 있습니다.
다음 단계를 따르십시오.
 
  1. CA APM Team Center에서
    설정
    탭을 클릭하고
    보안
    을 클릭합니다.
  2. 새 토큰 생성
    단추를 클릭합니다.
  3. 만료 날짜를 설정하고 레이블을 추가합니다.
    참고
    : 또한 Enterprise Team Center 인스턴스에서는
    유형
    공용 API
    로 선택하십시오.
  4. 새 토큰 생성
    을 클릭합니다.
    중요!
    보안상의 이유로 토큰은 두 번 이상 표시될 수 없습니다. 토큰은
    새 토큰 생성
    을 클릭한 후에만 표시됩니다.
 
구성 
  • 새 끝점은 ETC, MOM 및 독립 실행형 구성(수집기 또는 공급자 제외)에서 기본적으로 활성화됩니다. 
  • 이전의 /vertex 끝점은 기본적으로 비활성화됩니다. MOM 구성에서는 IntroscopeEnterpriseManager.properties를 설정하여 이러한 끝점을 활성화할 수 있습니다.
    introscope.public.restapi.enabled=true
    사용자는 IntroscopeEnterpriseManager.properties에서 공개 REST API에 대한 클램프를 설정할 수 있습니다.
    # Maximum number of concurrent requests to handle. REST endpoints will return error # if this number is exceeded. If you increase the number please allocate more RAM, # CPU and I/O resources to EM process. introscope.public.restapi.maxConcurrentRequestsClamp=20
로깅 구성 
다음 코드를 사용하여 로깅을 구성하십시오.
log4j.logger.Manager.AppMap.PublicApi=INFO,console,logfile
로그 파일에서 자세한 정보를 보려면 로그 수준을 DEBUG로 설정하십시오.