你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Model Settings - Get

Service:

Time Series Insights

API Version:

2020-07-31

返回模型设置，其中包括模型显示名称、时序 ID 属性和默认类型 ID。 每个 Gen2 环境都有一个自动创建的模型。

GET https://{environmentFqdn}/timeseries/modelSettings?api-version=2020-07-31

URI 参数

名称	在	必需	类型	说明
environmentFqdn	path	True	string	按环境 FQDN，例如 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com。 可以从获取环境 API、Azure 门户或 Azure 资源管理器的响应中获取此域名。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。 当前支持的版本为“2020-07-31”。

请求头

名称	必需	类型	说明
x-ms-client-request-id		string	可选的客户端请求 ID。 服务记录此值。 允许服务跨服务跟踪操作，并允许客户就特定请求联系支持人员。
x-ms-client-session-id		string	可选的客户端会话 ID。 服务记录此值。 允许服务跨服务跟踪一组相关操作，并允许客户就特定请求组联系支持人员。

响应

名称	类型	说明
200 OK	ModelSettingsResponse	成功的操作。 Headers x-ms-request-id: string
Other Status Codes	TsiError	意外错误。 Headers x-ms-request-id: string

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

ModelSettingsGet

Sample Request

HTTP

GET https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/modelSettings?api-version=2020-07-31

Sample Response

Status code:

200

{
  "modelSettings": {
    "name": "DefaultModel",
    "timeSeriesIdProperties": [
      {
        "name": "DeviceId",
        "type": "String"
      }
    ],
    "defaultTypeId": "5AB70D71-A8CD-410E-B70D-6F04AB9C132C"
  }
}

定义

名称	说明
ModelSettingsResponse	包含完整时序模型设置的响应，其中包括模型名称、时序 ID 属性和默认类型 ID。
TimeSeriesIdProperty	单个属性的定义，可在创建环境期间定义的时序 ID 属性中使用。
TimeSeriesIdPropertyTypes	属性的类型。 目前，仅支持“字符串”。
TimeSeriesModelSettings	时序模型设置，包括模型名称、时序 ID 属性和默认类型 ID。
TsiError	有关 API 错误的信息。
TsiErrorBody	包含错误代码和消息的特定 API 错误。
TsiErrorDetails	其他错误信息。

ModelSettingsResponse

包含完整时序模型设置的响应，其中包括模型名称、时序 ID 属性和默认类型 ID。

名称	类型	说明
modelSettings	TimeSeriesModelSettings	模型设置，包括模型名称、时序 ID 属性和默认类型 ID。

TimeSeriesIdProperty

单个属性的定义，可在创建环境期间定义的时序 ID 属性中使用。

名称	类型	说明
name	string	属性的名称。
type	TimeSeriesIdPropertyTypes	属性的类型。 目前，仅支持“字符串”。

TimeSeriesIdPropertyTypes

属性的类型。 目前，仅支持“字符串”。

名称	类型	说明
String	string

TimeSeriesModelSettings

时序模型设置，包括模型名称、时序 ID 属性和默认类型 ID。

名称	类型	说明
defaultTypeId	string	新时序实例将自动所属的模型的默认类型 ID。
name	string	UX 中显示的时序模型显示名称。 示例：“温度传感器”、“MyDevices”。
timeSeriesIdProperties	TimeSeriesIdProperty[]	创建环境期间定义的时序 ID 属性。

TsiError

有关 API 错误的信息。

名称	类型	说明
error	TsiErrorBody	包含错误代码和消息的特定 API 错误。

TsiErrorBody

包含错误代码和消息的特定 API 错误。

名称	类型	说明
code	string	与语言无关、可读的字符串，用于定义特定于服务的错误代码。 此代码用作响应中指定的 HTTP 错误代码的更具体指示符。 可用于以编程方式处理特定错误情况。
details	TsiErrorDetails[]	包含其他错误信息。 可能为 null。
innerError	TsiErrorBody	包含更具体的错误，可缩小原因范围。 可能为 null。
message	string	错误的可读、语言无关的表示形式。 它旨在帮助开发人员，不适合向最终用户公开。
target	string	特定错误的目标 (例如，错误) 中的属性的名称。 可能为 null。

TsiErrorDetails

其他错误信息。

名称	类型	说明
code	string	与语言无关、可读的字符串，用于定义特定于服务的错误代码。 此代码用作响应中指定的 HTTP 错误代码的更具体指示符。 可用于以编程方式处理特定错误情况。
message	string	错误的可读、语言无关的表示形式。 它旨在帮助开发人员，不适合向最终用户公开。