개체 표현을 검색하려면 클라이언트는 개체 참조에 대해 HTTP 요청을 수행합니다.

보안

API 클라이언트와 서버 간의 HTTP 링크는 SSL을 사용하여 구축됩니다. API 클라이언트는 서버와 통신하도록 토큰 기반 인증을 구성합니다.

그림 1. 시나리오: ID 123의 경고에 대한 세부 정보를 가져오기 위해 사용자 자격 증명 제공
유효한 자격 증명으로 보호된 끝점에 액세스됨
토큰 기반 인증을 사용하면 vRealize Operations API 서버에 로그인 요청을 POST하고 유효한 사용자 자격 증명을 제공하여 인증 토큰을 얻을 수 있습니다. 다음 예에서는 토큰 기반 인증 시나리오를 제공합니다.
  1. vRealize Operations 인스턴스에 대한 유효한 사용자 자격 증명을 얻습니다.
  2. 인증을 위해 REST 끝점에 요청을 POST합니다. 
    https://RESTendpoint.example.com/suite-api/api/auth/token/acquire

    요청 본문에는 사용자 이름, 비밀번호 및 인증 소스가 포함됩니다.

  3. 응답 본문에서 끝점은 토큰, 만료 날짜 및 시간을 반환합니다.
  4. 추가 통신을 위해 토큰 개체를 인증 헤더에 다음 형식으로 포함합니다. 
    Authorization: vRealizeOpsToken <vROps_token>
    또는 SSO 소스에서 토큰을 얻은 경우 인증 헤더의 형식은 다음과 같습니다. 
    Authorization: SSO2Token <SSO_SAML_TOKEN>
  5. 로그아웃 끝점에 POST 요청을 전송하여 만료 날짜 및 시간 전에 토큰을 무효화할 수 있습니다. 
    POST https://RESTendpoint.example.com/suite-api/api/auth/token/release

요청 헤더

다음 HTTP 헤더는 일반적으로 API 요청에 포함되어 있습니다.
수락-언어 응답에 원하는 언어를 지정하려면 Accept-Language 요청 헤더를 사용합니다. ErrorType 응답의 메시지 문자열은 현지화됩니다. 프랑스어로 현지화된 메시지 문자열로 응답을 요청하려면 다음 헤더를 사용합니다. 
Accept-Language: fr-FR
권한 부여 API 세션을 생성하기 위한 모든 요청에는 조직에서 사용하는 ID 제공자에 의해 규정된 양식의 Authorization 헤더가 포함되어야 합니다.
컨텐츠-유형 본문을 포함하는 요청에는 적절한 HTTP Content-Type 헤더가 포함되어야 합니다.
  • XML의 요청 본문의 경우 헤더에 컨텐츠 유형: 애플리케이션/XML이 포함되어야 합니다.
  • JSON의 요청 본문의 경우 헤더에 컨텐츠 유형: 애플리케이션/JSON이 포함되어야 합니다.
허용 원하는 응답 형식을 지정하려면 Accept 요청 헤더를 포함합니다.
  • XML의 응답의 경우 헤더에 허용: 애플리케이션/XML이 포함되어야 합니다.
  • JSON의 응답의 경우 헤더에 허용: 애플리케이션/JSON이 포함되어야 합니다.

XML 형식의 본문 요청

XML로 작성된 요청 본문의 경우, vRealize Operations는 요청 본문의 요소가 순서와 숫자에서 스키마와 호응하도록 요구하는 유효성 검사 XML 구문 분석을 사용합니다. 요청 본문은 다음 조건을 충족하지 않는 한 잘못된 것으로 거부됩니다.

  • 요청에서 요소로 표시되는 모든 네임스페이스에 대해 XML 네임스페이스 특성을 제공해야 합니다.
  • 요청에 네임스페이스가 여러 개 표시되는 경우, XML 네임스페이스 특성에 식별 접두사를 포함해야 하고 해당 접두사를 해당 네임스페이스의 모든 요소와 함께 사용해야 합니다.
  • 모든 필수 요소가 요청 본문에 나타나야 합니다. 요청 본문에 표시되는 모든 요소는 스키마가 구축하는 순서와 스키마가 지정하는 유형 제약 조건을 준수하는 컨텐츠로 나타나야 합니다.