Twins - DigitalTwins GetById

Service:

Azure Digital Twins

API Version:

2023-10-31

检索数字孪生体。 状态代码：

• 200 正常
• 400 错误的请求
  • InvalidArgument - 数字孪生 ID 无效。
• 404 未找到
  • DigitalTwinNotFound - 找不到数字孪生体。

GET https://digitaltwins-hostname/digitaltwins/{id}?api-version=2023-10-31

URI 参数

名称	在	必需	类型	说明
id	path	True	string	数字孪生体的 ID。 ID 在服务中是唯一的，区分大小写。
api-version	query	True	string	请求的 API 版本。

请求头

名称	必需	类型	说明
traceparent		string	标识分布式跟踪系统中的请求。
tracestate		string	提供特定于供应商的跟踪标识信息，并且是 traceparent 的配套信息。

响应

名称	类型	说明
200 OK	DigitalTwin	成功 Headers ETag: string
Other Status Codes	ErrorResponse	默认响应。 Headers x-ms-error-code: string

安全性

oauth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0

示例

Get a digital twin by id

Sample Request

HTTP

GET https://digitaltwins-hostname/digitaltwins/myTwinId?api-version=2023-10-31

Sample Response

Status code:

200

{
  "$dtId": "myTwinId",
  "$etag": "W/\"9c2876c2-aff0-40b3-9fba-0c6be9d020a6\"",
  "property1": 1,
  "property2": {
    "subProperty1": "some value",
    "subProperty2": "some other value"
  },
  "component1": {
    "componentProperty": "some value",
    "$metadata": {
      "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
      "componentProperty": {
        "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
      }
    }
  },
  "$metadata": {
    "$model": "dtmi:com:example:interfaces:interfaceName;1",
    "$lastUpdateTime": "2022-02-28T00:30:00.1234567Z",
    "property1": {
      "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
    },
    "property2": {
      "lastUpdateTime": "2022-02-28T00:30:00.1234567Z"
    }
  }
}

定义

名称	说明
Error	错误定义。
ErrorResponse	错误响应。
InnerError	比包含的错误提供的更具体的错误说明。

Error

错误定义。

名称	类型	说明
code	string	服务特定的错误代码，用作 HTTP 错误代码的子状态。
details	Error[]	内部错误详细信息。
innererror	InnerError	一个 对象，该对象包含比当前对象更具体的错误信息。
message	string	错误的可读表示形式。

ErrorResponse

错误响应。

名称	类型	说明
error	Error	错误详细信息。

InnerError

比包含的错误提供的更具体的错误说明。

名称	类型	说明
code	string	比包含的错误提供的更具体的错误代码。
innererror	InnerError	一个 对象，该对象包含比当前对象更具体的错误信息。