若要擷取物件表示方式,用戶端會向物件參考發出 HTTP 要求。

安全性

API 用戶端與伺服器之間的 HTTP 連結是使用 SSL 建立的。API 用戶端會設定以 Token 為基礎的驗證,以與伺服器進行通訊。

圖 1. 案例:為使用者提供認證,以取得有關識別碼 123 警示的詳細資料
使用有效認證存取的受保護端點
您可以在產生 Cloud Services 驗證 Token 之後呼叫 vRealize Operations Cloud API。使用以下端點:
https://www.mgmt.cloud.vmware.com/vrops-cloud/suite-api
備註: 如果您的組織位於美國境外,請使用 API 端點的國家/地區縮寫。使用錯誤的端點會導致 404 錯誤。例如,如果您的組織位於澳大利亞,您的國家/地區縮寫為 AU,而您的 API 端點為:
https://au.www.mgmt.cloud.vmware.com/vrops-cloud/suite-api 
您必須以下列格式將 Cloud Services 驗證 Token 與每個要求一起做為 HTTP 標頭傳遞:
Authorization: CSPToken {CSP Auth Token}
例如:
curl -k https://www.mgmt.cloud.vmware.com/vrops-cloud/suite-api/api/resources -H "Content-Type: application/json" -H "Accept: application/json" -H "Authorization: CSPToken abc12345...

要求標頭

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 Cloud 會使用驗證 XML 剖析器,該剖析器需要在要求內文中的元素符合配置的順序和編號。除非符合下列準則,否則要求內文會因被視為無效而遭到拒絕:

  • 必須為要求中的元素所表示的所有命名空間提供 XML 命名空間屬性。
  • 如果要求中表示了多個命名空間,則 XML 命名空間屬性必須包含識別前置詞,且該前置詞必須與該命名空間中的所有元素搭配使用。
  • 所有所需元素必須出現在要求內文中。出現在要求內文中的所有元素都必須依照配置建立的順序出現,並顯示符合配置所指定類型限制的內容。