Conversion - Get Operation

參考

服務:: Maps Creator

API 版本:: 2.0

用來檢查轉換程序的狀態。

Get Operation API 是 HTTP GET 要求，可讓呼叫端檢查轉換程式的狀態並擷取conversionId值。

此路徑會從 POST /conversions 的呼叫取得。進行中時，不會傳回 HTTP 200 回應碼，而且沒有額外的標頭，後面接著 HTTP 200 回應碼， Resource-Location 且標頭一旦成功完成。

GET https://{geography}.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2.0

URI 參數

名稱	位於	必要	類型	Description
geography	path	True	string	此參數會指定 Azure 地圖服務 Creator 資源所在的位置。有效值為us和 eu。
operationId	path	True	string	要查詢轉換建立/匯入要求狀態的標識碼。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。

回應

名稱	類型	Description
200 OK	LongRunningOperationResult	作業正在執行或完成。如果作業成功，請使用 Resource-Location 標頭來取得結果的路徑。標題 Resource-Location: string
Other Status Codes	ErrorResponse	發生意外錯誤。

名稱

類型

Description

200 OK

LongRunningOperationResult

作業正在執行或完成。如果作業成功，請使用 Resource-Location 標頭來取得結果的路徑。

標題

Resource-Location: string

Other Status Codes

ErrorResponse

發生意外錯誤。

安全性

AADToken

以下是 Microsoft Entra OAuth 2.0 流程。與 Azure 角色型存取控制配對時，可用來控制對 REST API 的存取 Azure 地圖服務。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務資源帳戶或子資源的存取權。任何使用者、群組或服務主體都可以透過內建角色或由一或多個許可權組成的自定義角色來授與存取權，以 Azure 地圖服務 REST API。

若要實作案例，建議您檢視驗證概念。總而言之，此安全性定義提供一個解決方案，可透過能夠針對特定 API 和範圍進行存取控制的物件，將應用程式模型化 () 。

備註

此安全性定義需要使用x-ms-client-id 標頭來指出應用程式要求存取權 Azure 地圖服務資源。這可以從地圖服務管理 API 取得。

Authorization URL專屬於 Azure 公用雲端實例。主權雲端具有唯一的授權 URL 和 Microsoft Entra ID 組態。 * 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 管理平面設定 Azure 角色型存取控制。 * Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式的組態型設定。

如需 Microsoft 身分識別平台的詳細資訊，請參閱 Microsoft 身分識別平台概觀。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

這是當您在 Azure 入口網站或使用 PowerShell、CLI、Azure SDK 或 REST API 建立 Azure 地圖服務帳戶時所佈建的共享密鑰。

使用此金鑰時，任何應用程式都可以存取所有 REST API。換句話說，此金鑰可作為發行帳戶中的主要金鑰。

對於公開的應用程式，我們建議使用機密用戶端應用程式方法來存取 Azure 地圖服務 REST API，以便安全地儲存您的密鑰。

類型: apiKey
位於: query

SAS Token

這是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 地圖服務資源上的清單 SAS 作業建立共用存取簽章令牌。

使用此令牌時，任何應用程式都有權使用 Azure 角色型訪問控制進行存取，並精細控制到期、速率和區域 (特定令牌的使用) 。換句話說，SAS 令牌可用來允許應用程式以比共用密鑰更安全的方式控制存取。

對於公開的應用程式，我們建議在地圖帳戶資源上設定允許的來源特定清單，以限制轉譯濫用，並定期更新 SAS 令牌。

類型: apiKey
位於: header

範例

Get the status of an operation which has finished successfully, with non-fatal warnings

Get the status of an operation which is still running

Get the status of an operation which has finished successfully, with non-fatal warnings

範例要求

HTTP

GET https://us.atlas.microsoft.com/conversions/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0

範例回覆

狀態碼:: 200

Resource-Location: https://us.atlas.microsoft.com/conversions/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-20T22:43:14.9401559+00:00",
  "status": "Succeeded",
  "warning": {
    "code": "dwgConversionProblem",
    "details": [
      {
        "code": "warning",
        "details": [
          {
            "code": "manifestWarning",
            "message": "Ignoring unexpected JSON property: unitProperties[0].nonWheelchairAccessible with value False"
          }
        ]
      }
    ]
  }
}

Get the status of an operation which is still running

範例要求

HTTP

GET https://us.atlas.microsoft.com/conversions/operations/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=2.0

範例回覆

狀態碼:: 200

{
  "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
  "created": "2021-04-23T19:14:03.2452596+00:00",
  "status": "Running"
}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
LongRunningOperationResult	Long-Running Operations API 的回應模型。
LroStatus	要求的狀態狀態。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

LongRunningOperationResult

Long-Running Operations API 的回應模型。

名稱	類型	Description
created	string	建立的時間戳。
error	ErrorDetail	錯誤詳細數據。
operationId	string	這個長時間執行作業的標識碼。
status	LroStatus	要求的狀態狀態。
warning	ErrorDetail	錯誤詳細數據。

LroStatus

要求的狀態狀態。

名稱	類型	Description
Failed	string	要求有一或多個失敗。
NotStarted	string	要求尚未開始處理。
Running	string	要求已開始處理。
Succeeded	string	要求已成功完成。

共用方式為

Conversion - Get Operation

URI 參數

回應

安全性

AADToken

備註

範圍

subscription-key

SAS Token

範例

Get the status of an operation which has finished successfully, with non-fatal warnings

範例要求

範例回覆

Get the status of an operation which is still running

範例要求

範例回覆

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

LongRunningOperationResult

LroStatus

其他資源