이 문서는 Partnership API 사용에 대한 기술적인 세부 사항을 설명합니다. 소개 및 요구 사항은 먼저 Intro to Partnership API 를 읽으십시오.
요구 사항
The Partnership API is not available to your organization unless you're specifically instructed by your New Relic representative that you should use it.
요구 사항은 파트너십 API 소개를 참조하세요.
파트너십 API 키 찾기
Partnership API를 사용하려면 파트너 관계 소유자 계정 과 관련된 REST API 키로 인증해야 합니다(다른 REST API 키 를 사용할 수 없음).
사용이 필요한 API REST API (v2) 엔드포인트 호출과 함께 파트너십 키를 사용하는 Admin user's API key 경우 사용자 관리의 API 키 및 파트너십을 참조하세요.
파트너 ID 찾기
또한 Partnership API를 사용하려면 파트너 관계와 관련된 파트너 ID를 제공하여 인증해야 합니다. 이것은 파트너 관계 소유자 계정의 계정 ID 와 고유합니다.
파트너 ID를 얻으려면 파트너 관리 콘솔 로 이동하여 URL에 나열된 파트너 ID 번호를 검색하십시오.
https://partner-admin-console.newrelic.com/accounts/$ACCOUNT_ID/admin_console/partnerships/$PARTNER_ID
파트너 API에 대한 기본 URL의 일부로 파트너 ID를 포함해야 합니다.
URL 구성요소 | URL 패턴 |
---|---|
파트너 API 엔드포인트 |
|
리소스 URL 패턴 |
|
예시 |
|
API 호출 인증
API를 호출할 때 파트너 API에 인증하려면 다음 단계를 따르세요.
x-api-key
이라는 요청 헤더를 추가하고 해당 값을
Partner API key
로 설정합니다.
요청 URI의 지정된 지점에
Partner ID
포함합니다.
New Relic 계정을 관리하는 파트너를 위한 참고 사항
고객을 위해 New Relic 계정을 관리하는 파트너의 경우 모든 계정 수준 상호 작용에 대한 초기 API 호출은 "계정 생성"입니다. 이 호출은 새로 생성된 계정의 xml 레코드를 반환합니다. 이 레코드의 일부는 account_id
입니다. Partnership API의 다른 모든 호출에는 account_id
이 매개변수로 필요합니다. 반환된 xml 추출을 구문 분석하고 account_id
를 저장하고 이를 사용자의 파트너 계정 레코드와 연결하려면 파트너가 프로비저닝해야 합니다.
오류
New Relic은 기존 HTTP 응답 코드를 사용하여 API 요청의 성공 또는 실패를 나타냅니다. 일반적으로 2xx
범위의 코드는 성공을 나타내고 4xx
범위의 코드는 제공된 정보로 인해 발생한 오류를 나타냅니다(예: 필수 매개변수가 누락됨).
Error | Probable cause |
---|---|
400 잘못된 요청 | 가장 일반적으로 호출에 필수 매개변수가 누락되었습니다. |
401 권한 없음 | 유효한 API 키가 제공되지 않았습니다. |
402 요청 실패 | 매개변수는 유효하지만 어떤 이유로 요청이 실패했습니다. |
404 찾을 수 없음 | 요청하신 항목이 존재하지 않습니다. |
422 처리할 수 없는 개체 | 귀하의 계정에는 특별 약관이 있으며 변경할 수 없습니다. |