Devices - Get

서비스:

IoT Central

API 버전:

2022-07-31

ID별 디바이스 가져오기
디바이스 ID로 기존 디바이스에 대한 세부 정보를 가져옵니다.

GET https://{subdomain}.{baseDomain}/api/devices/{deviceId}?api-version=2022-07-31

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
baseDomain	path	True	string	모든 Azure IoT Central 서비스 요청에 대한 기본 도메인입니다.
deviceId	path	True	string	디바이스의 고유 ID입니다.
subdomain	path	True	string	애플리케이션 하위 도메인입니다.
api-version	query	True	string	호출되는 API의 버전입니다.

응답

Name	형식	Description
200 OK	Device	Success
Other Status Codes	Error	IoT Central 서비스에서 받은 오류 응답입니다. 헤더 x-ms-error-code: string

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Get device by ID

샘플 요청

HTTP

GET https://appsubdomain.azureiotcentral.com/api/devices/CheckoutThermostat?api-version=2022-07-31

샘플 응답

상태 코드:

200

{
  "id": "CheckoutThermostat",
  "etag": "eyJoZWFkZXIiOiJcIjAyMDA4YzMyLTAwMDAtMGQwMC0wMDAwLTVkOTY4YjdhMDAwMFwiIn0",
  "displayName": "CheckoutThermostat",
  "template": "dtmi:contoso:testDeviceTemplate;1",
  "simulated": true,
  "provisioned": true,
  "enabled": true,
  "organizations": [
    "seattle"
  ]
}

정의

Name	Description
Device	디바이스 정의입니다.
Error	응답 오류 정의입니다.
ErrorDetails	오류의 세부 정보입니다.

Device

디바이스 정의입니다.

Name	형식	Description
displayName	string	디바이스의 표시 이름입니다.
enabled	boolean	IoT Central에 대한 디바이스 연결을 사용하도록 설정했는지 여부입니다.
etag	string	ETag는 디바이스 업데이트에서 충돌을 방지하는 데 사용됩니다.
id	string	디바이스의 고유 ID입니다.
organizations	string[]	디바이스가 속한 organization ID 목록이며, 현재 organization 하나만 지원되며, 곧 여러 조직이 지원될 예정입니다.
provisioned	boolean	디바이스에 대한 리소스가 할당되었는지 여부입니다.
simulated	boolean	디바이스가 시뮬레이션되는지 여부입니다.
template	string	디바이스에 대한 디바이스 템플릿 정의입니다.

Error

응답 오류 정의입니다.

Name	형식	Description
error	ErrorDetails	현재 요청에 대한 오류 세부 정보입니다.

ErrorDetails

오류의 세부 정보입니다.

Name	형식	Description
code	string	오류 코드
message	string	오류 메시지 세부 정보입니다.
requestId	string	현재 요청에 대한 상관 관계 ID입니다.
time	string	오류 요청이 실패한 시간입니다.