Dataset - Get

參考

Service:: Maps Creator

API Version:: 2023-03-01-preview

使用取得數據集的詳細數據。

提交取得詳細數據要求

若要取得先前建立數據集的詳細數據，請發出 GET 路徑中的要求 datasetId 。

取得詳細數據回應

以下是傳回timestamp數據集資源的、datasetIddescription、、 datasetSources和 ontology 的範例回應：

{
   "timestamp": "2020-01-01T22:50:48.123Z",
   "datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
   "description": "Some description or comment for the dataset.",
   "datasetSources": {
     "conversionIds": [
       "0c1288fa-2058-4a1b-b68d-13a5f5af7d7c"
     ],
     "udids": [
       "15d21452-c9bb-27b6-5e79-743ca5c3205d"
     ]
     "appendDatasetId": "46d1edb6-d29e-4786-9589-dbd4efd7a977"
   },
   "ontology": "facility-2.0",
   "featureCounts": {
     "directoryInfo": 2,
     "category": 10,
     "facility": 1,
     "level": 3,
     "unit": 183,
     "zone": 3,
     "verticalPenetration": 6,
     "opening": 48,
     "areaElement": 108
   }
 }

GET https://{geography}.atlas.microsoft.com/datasets/{datasetId}?api-version=2023-03-01-preview

URI 參數

名稱	位於	必要	類型	Description
datasetId	path	True	string	要從中查詢之數據集的標識碼。
geography	path	True	string	此參數會指定 Azure 地圖服務 Creator 資源所在的位置。有效值為us和 eu。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。

要求標頭

名稱	必要	類型	Description
x-ms-client-id		string	指定哪個帳戶與 Microsoft Entra ID 安全性模型搭配使用。它代表 Azure 地圖服務帳戶的唯一標識符，而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。若要在 Azure 地圖服務中使用 Microsoft Entra ID 安全性，請參閱下列文章以取得指引。

回應

名稱	類型	Description
200 OK	Dataset	已成功完成取得數據集要求。
Other Status Codes	ErrorResponse	發生意外錯誤。

安全性

AADToken

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

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

備註

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

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

目前，Azure Active Directory v1.0 或 v2.0 支援公司、學校和來賓，但不支持個人帳戶。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名稱	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，以便安全地儲存您的密鑰。

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

範例

Get details for a previously created dataset

Sample Request

HTTP

GET https://us.atlas.microsoft.com/datasets/{datasetId}?api-version=2023-03-01-preview

Sample Response

Status code:: 200

Location: https://us.atlas.microsoft.com/dataset/{datasetId}?api-version=1.0
Access-Control-Expose-Headers: Resource-Location

Response Body

{
  "created": "2021-05-21T03:04:05.678Z",
  "datasetId": "{datasetId}",
  "description": "Some other description or comment for the dataset.",
  "datasetSources": {
    "conversionIds": [
      "{conversionId}"
    ],
    "udids": [
      "{udid}"
    ],
    "appendDatasetId": "{appendDatasetId}"
  },
  "featureCounts": {
    "directoryInfo": 2,
    "category": 10,
    "facility": 1,
    "level": 3,
    "unit": 183,
    "zone": 3,
    "verticalPenetration": 6,
    "opening": 48,
    "areaElement": 108
  },
  "ontology": "facility-2.0"
}

定義

名稱	Description
Dataset	數據集的詳細資訊。
DatasetSources	數據集之建立要求詳細數據的相關信息。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應

Dataset

數據集的詳細資訊。

名稱	類型	Description
created	string	為數據集建立的時間戳。
datasetId	string	數據集的識別碼。
datasetSources	DatasetSources	數據集之建立要求詳細數據的相關信息。
description	string	數據集的描述。
featureCounts	object	數據集的功能計數。
ontology	string	此數據集的本體版本。

DatasetSources

數據集之建立要求詳細數據的相關信息。

名稱	類型	Description
appendDatasetId	string	附加以建立目前數據集的數據集。
conversionIds	string[]	`conversionIds`用來建立資料集的。
udids	string[]	`udids`用來建立資料集的。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

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

ErrorDetail

錯誤詳細數據。

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

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

Share via