要检索对象表示形式,客户端会向对象引用发出 HTTP 请求。

安全

API 客户端和服务器之间的 HTTP 链接是使用 SSL 建立的。API 客户端配置基于令牌的身份验证以与服务器进行通信。

图 1. 方案:提供用户凭据以获取有关 ID 为 123 的警示的详细信息
使用有效凭据访问的受保护端点
对于基于令牌的身份验证,您可以向 vRealize Operations Manager API 服务器发布登录请求,并提供有效的用户凭据以获取身份验证令牌。以下示例说明了基于令牌的身份验证方案。
  1. 您可以获取 vRealize Operations Manager 实例的有效用户凭据。
  2. 向 REST 端点发布请求以进行身份验证。
    POST https://RESTendpoint.example.com/api/token/acquire

    请求正文包括用户名、密码和身份验证源。

  3. 在响应正文中,端点会返回令牌、到期日期和时间。
  4. 要进行进一步通信,请将令牌对象包含在授权标头中,格式为:
    Authorization: vRealizeOpsToken <vROps_token>
    或者,如果从 SSO 源获取令牌,则授权标头的格式为:
    Authorization: SSO2Token <SSO_SAML_TOKEN>
  5. 您可以通过向注销端点发送 POST 请求,使令牌在过期日期和时间之前失效。
    POST https://RESTendpoint.example.com/api/token/release

请求标头

API 请求中通常包含以下 HTTP 标头:
Accept-Language 要指定响应中所需的语言,请使用 Accept-Language 请求标头。ErrorType 响应中的消息字符串已本地化。要使用本地化为法语的消息字符串请求响应,请使用以下标头:
Accept-Language: fr-FR
授权 用于创建 API 会话的所有请求都必须包含由您的组织使用的身份提供程序所规定格式的 Authorization 标头
Content-Type 包含正文的请求必须包括相应的 HTTP Content-Type 标头。
  • 对于 XML 形式的请求正文,标头必须包含 Content-Type: application/xml
  • 对于 JSON 形式的请求正文,标头必须包含 Content-Type: application/json
接受 要指定所需的响应格式,请包含 Accept 请求标头。
  • 对于 XML 格式的响应,标头必须包含 Accept: application/xml
  • 对于 JSON 格式的响应,标头必须包含 Accept: application/json

XML 格式的请求正文

对于以 XML 格式编写的请求正文,vRealize Operations Manager 使用验证 XML 分析程序,该分析程序要求请求正文中的元素在顺序和编号上与架构一致。除非满足以下条件,否则请求正文将被拒绝为无效:

  • 必须为请求中的元素所表示的所有命名空间提供 XML 命名空间属性。
  • 如果请求中表示多个命名空间,则 XML 命名空间属性必须包含标识前缀,并且该前缀必须与该命名空间中的所有元素一起使用。
  • 所有必需元素都必须显示在请求正文中。请求正文中出现的所有元素都必须按照架构建立的顺序显示,并且内容必须符合架构指定的类型限制。