Data - List

참조

Service:: Maps

API Version:: 2.0

데이터 업로드를 사용하여 이전에 업로드한 모든 콘텐츠 목록을 가져오는 데 사용합니다.

참고

Azure Maps 데이터 서비스 사용 중지

Azure Maps Data Service(v1 및 v2 모두)는 이제 더 이상 사용되지 않으며 24/9/16에 사용 중지됩니다. 서비스 중단을 방지하려면 2024년 9월 16일까지 Azure Maps Data Registry 서비스를 사용할 수 있도록 데이터 서비스에 대한 모든 호출을 업데이트해야 합니다. 자세한 내용은 데이터 레지스트리를 만드는 방법을 참조하세요.

Data List API는 호출자가 데이터 업로드 API를 사용하여 이전에 업로드한 모든 콘텐츠 목록을 가져올 수 있도록 하는 HTTP GET 요청입니다.

목록 요청 제출

모든 지도 데이터 콘텐츠를 나열하려면 추가 매개 변수 없이 요청을 실행 GET 합니다.

데이터 응답 나열

데이터 목록 API는 모든 데이터의 전체 목록을 형식으로 json 반환합니다. 응답에는 각 데이터 리소스에 대한 다음 세부 정보가 포함됩니다.

udid - 데이터 리소스의 고유 데이터 ID입니다.

location - 데이터 리소스의 위치입니다. 이 위치에서 HTTP GET 요청을 실행하여 데이터를 다운로드합니다.

다음은 3개의 데이터 리소스 및 udidlocation 를 반환하는 샘플 응답입니다.

{
    "mapDataList": 
    [
        {
            "udid": "9a1288fa-1858-4a3b-b68d-13a8j5af7d7c",
            "location": "https://us.atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0",
            "sizeInBytes": 29920,
            "uploadStatus": "Completed"
        },
        {
            "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
            "location": "https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0",
            "sizeInBytes": 1339,
            "uploadStatus": "Completed"
        },
        {
            "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
            "location": "https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
            "sizeInBytes": 1650,
            "uploadStatus": "Pending"
        }]
}

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
geography	path	True	string	이 매개 변수는 Azure Maps Creator 리소스가 있는 위치를 지정합니다. 유효한 값은 우리와 eu입니다.
api-version	query	True	string	Azure Maps API의 버전 번호.

요청 헤더

Name	필수	형식	Description
x-ms-client-id		string	Microsoft Entra ID 보안 모델과 함께 사용할 계정을 지정합니다. Azure Maps 계정의 고유 ID를 나타내며 Azure Maps 관리 평면 계정 API에서 검색할 수 있습니다. Azure Maps Microsoft Entra ID 보안을 사용하려면 다음 문서를 참조하세요.

응답

Name	형식	Description
200 OK	MapDataListResult	데이터 요청 나열이 성공적으로 완료되었습니다. 응답 본문에는 이전에 업로드한 모든 데이터의 목록이 포함됩니다.
Other Status Codes	ErrorResponse	예기치 않은 오류가 발생했습니다.

보안

AADToken

다음은 Microsoft Entra OAuth 2.0 흐름입니다. Azure 역할 기반 액세스 제어와 쌍을 이루는 경우 Azure Maps REST API에 대한 액세스를 제어하는 데 사용할 수 있습니다. Azure 역할 기반 액세스 제어는 하나 이상의 Azure Maps 리소스 계정 또는 하위 리소스에 대한 액세스를 지정하는 데 사용됩니다. 모든 사용자, 그룹 또는 서비스 주체는 기본 제공 역할 또는 REST API를 Azure Maps 하나 이상의 권한으로 구성된 사용자 지정 역할을 통해 액세스 권한을 부여할 수 있습니다.

시나리오를 구현하려면 인증 개념을 보는 것이 좋습니다. 요약하자면, 이 보안 정의는 특정 API 및 범위에 대한 액세스 제어가 가능한 개체를 통해 애플리케이션을 모델링하는 솔루션을 제공합니다.

참고

이 보안 정의는 애플리케이션이 x-ms-client-id 액세스를 요청하는 Azure Maps 리소스를 나타내기 위해 헤더를 사용해야 합니다. 이는 지도 관리 API에서 가져올 수 있습니다.

Authorization URL 은 Azure 퍼블릭 클라우드 instance 관련됩니다. 소버린 클라우드에는 고유한 권한 부여 URL 및 Microsoft Entra ID 구성이 있습니다. * Azure 역할 기반 액세스 제어는 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면에서 구성됩니다. * Azure Maps Web SDK를 사용하면 여러 사용 사례에 대한 애플리케이션의 구성 기반 설정을 사용할 수 있습니다.

Microsoft ID 플랫폼 대한 자세한 내용은 Microsoft ID 플랫폼 개요를 참조하세요.

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

Scopes

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

이 키는 Azure Portal Azure Maps 계정을 Create PowerShell, CLI, Azure SDK 또는 REST API를 사용할 때 프로비전되는 공유 키입니다.

이 키를 사용하면 모든 애플리케이션이 모든 REST API에 액세스할 수 있습니다. 즉, 이 키는 발급된 계정에서 master 키로 사용할 수 있습니다.

공개적으로 노출된 애플리케이션의 경우 기밀 클라이언트 애플리케이션 접근 방식을 사용하여 키를 안전하게 저장할 수 있도록 Azure Maps REST API에 액세스하는 것이 좋습니다.

Type: apiKey
In: query

SAS Token

공유 액세스 서명 토큰은 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면을 통해 Azure Maps 리소스의 SAS 나열 작업에서 만들어집니다.

이 토큰을 사용하면 모든 애플리케이션이 특정 토큰에 사용할 만료, 속도 및 지역에 대한 Azure 역할 기반 액세스 제어 및 세분화된 제어를 사용하여 액세스할 수 있는 권한이 부여됩니다. 즉, SAS 토큰을 사용하여 애플리케이션이 공유 키보다 더 보안이 유지되는 방식으로 액세스를 제어할 수 있습니다.

공개적으로 노출된 애플리케이션의 경우 렌더링 남용을 제한하고 정기적으로 SAS 토큰을 갱신하도록 맵 계정 리소스 에서 허용되는 특정 원본 목록을 구성하는 것이 좋습니다.

Type: apiKey
In: header

예제

List all the previously uploaded data

Sample Request

HTTP

GET https://us.atlas.microsoft.com/mapData?api-version=2.0

Sample Response

Status code:: 200

{
  "mapDataList": [
    {
      "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
      "location": "https://us.atlas.microsoft.com/mapData/f6495f62-94f8-0ec2-c252-45626f82fcb2?api-version=1.0",
      "sizeInBytes": 29920,
      "uploadStatus": "Completed"
    },
    {
      "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
      "location": "https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0",
      "sizeInBytes": 1339,
      "uploadStatus": "Completed"
    },
    {
      "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c",
      "location": "https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0",
      "sizeInBytes": 1650,
      "uploadStatus": "Pending"
    }
  ]
}

정의

Name	Description
DataFormat	업로드된 콘텐츠의 데이터 형식입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
MapData	데이터에 대한 세부 정보입니다.
MapDataListResult	데이터 목록 API에 대한 응답 모델입니다. 이전에 업로드한 모든 데이터의 목록을 반환합니다.
UploadStatus	콘텐츠의 현재 업로드 상태.

DataFormat

업로드된 콘텐츠의 데이터 형식입니다.

Name	형식	Description
dwgzippackage	string	DWG 파일이 포함된 ZIP 패키지입니다.
geojson	string	GeoJSON 은 JSON 기반 지리 공간적 데이터 교환 형식입니다.
zip	string	압축된 데이터 형식입니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

오류 응답

Name	형식	Description
error	ErrorDetail	Error 개체.

MapData

데이터에 대한 세부 정보입니다.

Name	형식	Description
dataFormat	DataFormat	업로드된 콘텐츠의 데이터 형식입니다.
description	string	현재 설명입니다.
location	string	데이터의 위치입니다. 이 위치에서 HTTP `GET` 요청을 실행하여 데이터를 다운로드합니다.
sizeInBytes	integer	콘텐츠 크기(바이트)입니다.
udid	string	데이터의 고유 데이터 ID입니다.
uploadStatus	UploadStatus	콘텐츠의 현재 업로드 상태.

MapDataListResult

데이터 목록 API에 대한 응답 모델입니다. 이전에 업로드한 모든 데이터의 목록을 반환합니다.

Name	형식	Description
mapDataList	MapData[]	이전에 업로드한 모든 데이터의 목록입니다.

UploadStatus

콘텐츠의 현재 업로드 상태.

Name	형식	Description
Completed	string	업로드 유효성 검사 및 처리 완료됨
Failed	string	업로드 유효성 검사 및/또는 처리 실패
Pending	string	업로드가 처리 중입니다.

Share via