다음을 통해 공유

Time Series Instances - Search

  • 참조
서비스:
Time Series Insights
API 버전:
2020-07-31

인스턴스 특성을 기반으로 시계열 인스턴스를 검색할 때 적중 항목의 일부 목록입니다.

POST https://{environmentFqdn}/timeseries/instances/search?api-version=2020-07-31

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
environmentFqdn
 path True

string

환경별 FQDN(예: 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com). 환경 가져오기 API, Azure Portal 또는 Azure Resource Manager의 응답에서 이 도메인 이름을 가져올 수 있습니다.
api-version
 query True

string

클라이언트 요청과 함께 사용할 API의 버전입니다. 현재 지원되는 버전은 "2020-07-31"입니다.

요청 헤더

Name 필수 형식 Description
x-ms-continuation

string

페이지 매김을 지원하는 호출에서 결과의 다음 페이지를 검색하기 위한 결과 이전 페이지의 연속 토큰입니다. 첫 번째 페이지 결과를 가져오려면 null 연속 토큰을 매개 변수 값으로 지정합니다. 모든 결과가 반환되고 결과의 다음 페이지가 없는 경우 반환된 연속 토큰은 null입니다.
x-ms-client-request-id

string

선택적 클라이언트 요청 ID입니다. 서비스는 이 값을 기록합니다. 서비스에서 서비스 간 작업을 추적할 수 있도록 하고 고객이 특정 요청과 관련하여 지원에 문의할 수 있도록 허용합니다.
x-ms-client-session-id

string

선택적 클라이언트 세션 ID입니다. 서비스는 이 값을 기록합니다. 서비스에서 서비스 전반의 관련 작업 그룹을 추적할 수 있도록 하고 고객이 특정 요청 그룹에 대한 지원에 문의할 수 있도록 허용합니다.

요청 본문

Name 필수 형식 Description
searchString True

string

시계열 인스턴스의 특성과 일치하는 쿼리 검색 문자열입니다. 예: "floor 100". 대/소문자를 구분하지 않고 존재해야 하지만 빈 문자열일 수 있습니다.
hierarchies

SearchInstancesHierarchiesParameters

시계열 인스턴스 계층을 반환하는 방법의 매개 변수입니다. null이면 계층이 반환되지 않습니다. 인스턴스 매개 변수가 null이고 계층 매개 변수가 null이 아니면 인스턴스가 없는 계층만 반환됩니다.
instances

SearchInstancesParameters

시계열 인스턴스를 반환하는 방법의 매개 변수입니다. null일 수 있습니다. 인스턴스 및 계층 매개 변수가 모두 null이면 인스턴스는 매개 변수의 기본값에 따라 결과에 반환되고 계층 구조는 반환되지 않습니다.
path

string[]

시계열 인스턴스의 계층 경로를 필터링합니다. 경로는 문자열 경로 세그먼트의 배열로 표시됩니다. 첫 번째 요소는 계층 이름이어야 합니다. 예: ["Location", "California"]. 선택 사항, 대/소문자 구분, 비어있지 않으며 null일 수 있습니다.

응답

Name 형식 Description
200 OK

SearchInstancesResponsePage

검색 응답에 성공했습니다.

헤더

x-ms-request-id: string
Other Status Codes

TsiError

예기치 않은 오류입니다.

헤더

x-ms-request-id: string

보안

azure_auth

Azure Active Directory OAuth2 Flow

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

범위

Name Description
user_impersonation 사용자 계정 가장

예제

SearchInstancesDefault
SearchInstancesExpandHierarchiesOnly
SearchInstancesHierarchiesDefaultInputPage1
SearchInstancesHierarchiesDefaultInputPage2
SearchInstancesHierarchiesDefaultInputPage3
SearchInstancesOneLevel
SearchInstancesRecursive
SearchInstancesUntilChildren

SearchInstancesDefault

샘플 요청

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100"
}

샘플 응답

상태 코드:
200 
{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1One",
          "Id2One",
          "1.0"
        ],
        "name": "instance1",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      },
      {
        "timeSeriesId": [
          "Id1Two",
          "Id2Two",
          "2.0"
        ],
        "name": "instance2",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      }
    ],
    "hitCount": 2,
    "continuationToken": null
  },
  "hierarchyNodes": null
}

SearchInstancesExpandHierarchiesOnly

샘플 요청

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": [
    "Location"
  ],
  "instances": null,
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "Name"
    },
    "pageSize": 2
  }
}

샘플 응답

상태 코드:
200 
{
  "instances": {
    "hits": [],
    "hitCount": 0,
    "continuationToken": null
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "California",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "San Diego",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            },
            {
              "name": "San Francisco",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            }
          ],
          "hitCount": 2,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesHierarchiesDefaultInputPage1

샘플 요청

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "Rank"
    },
    "highlights": true,
    "pageSize": 1
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "CumulativeInstanceCount"
    },
    "pageSize": 1
  }
}

샘플 응답

상태 코드:
200 
{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1Two",
          "Id2Two",
          "2.0"
        ],
        "name": "instance2",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": {
          "timeSeriesId": [
            "Id1Two",
            "Id2Two",
            "2.0"
          ],
          "typeName": "DefaultType",
          "name": "instance2",
          "description": "<hit>floor</hit> <hit>100</hit>",
          "hierarchyIds": [
            "1643004c-0a84-48a5-80e5-7688c5ae9295"
          ],
          "hierarchyNames": [
            "Location"
          ],
          "instanceFieldNames": [
            "state",
            "city"
          ],
          "instanceFieldValues": [
            "California",
            "San Francisco"
          ]
        }
      }
    ],
    "hitCount": 2,
    "continuationToken": "c3sic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNTE3MDUxOTg0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0="
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "Location",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "California",
              "cumulativeInstanceCount": 2,
              "hierarchyNodes": {
                "hits": [
                  {
                    "name": "San Francisco",
                    "cumulativeInstanceCount": 1,
                    "hierarchyNodes": null
                  }
                ],
                "hitCount": 2,
                "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0="
              }
            }
          ],
          "hitCount": 1,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesHierarchiesDefaultInputPage2

샘플 요청

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "Rank"
    },
    "highlights": true,
    "pageSize": 1
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "CumulativeInstanceCount"
    },
    "pageSize": 1
  }
}

샘플 응답

상태 코드:
200 
{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1One",
          "Id2One",
          "1.0"
        ],
        "name": "instance1",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": {
          "timeSeriesId": [
            "Id1One",
            "Id2One",
            "1.0"
          ],
          "typeName": "DefaultType",
          "name": "instance1",
          "description": "<hit>floor</hit> <hit>100</hit>",
          "hierarchyIds": [
            "1643004c-0a84-48a5-80e5-7688c5ae9295"
          ],
          "hierarchyNames": [
            "Location"
          ],
          "instanceFieldNames": [
            "state",
            "city"
          ],
          "instanceFieldValues": [
            "California",
            "Los Angeles"
          ]
        }
      }
    ],
    "hitCount": 2,
    "continuationToken": null
  },
  "hierarchyNodes": null
}

SearchInstancesHierarchiesDefaultInputPage3

샘플 요청

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "Rank"
    },
    "highlights": true,
    "pageSize": 1
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "CumulativeInstanceCount"
    },
    "pageSize": 1
  }
}

샘플 응답

상태 코드:
200 
{
  "instances": null,
  "hierarchyNodes": {
    "hits": [
      {
        "name": "Location",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "California",
              "cumulativeInstanceCount": 2,
              "hierarchyNodes": {
                "hits": [
                  {
                    "name": "San Diego",
                    "cumulativeInstanceCount": 1,
                    "hierarchyNodes": null
                  }
                ],
                "hitCount": 2,
                "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0="
              }
            }
          ],
          "hitCount": 1,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesOneLevel

샘플 요청

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": false,
    "sort": {
      "by": "DisplayName"
    },
    "highlights": false,
    "pageSize": 2
  },
  "hierarchies": {
    "expand": {
      "kind": "OneLevel"
    },
    "sort": {
      "by": "Name"
    },
    "pageSize": 2
  }
}

샘플 응답

상태 코드:
200 
{
  "instances": {
    "hits": [],
    "hitCount": 0,
    "continuationToken": null
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "Location",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": null
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesRecursive

샘플 요청

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "DisplayName"
    },
    "highlights": false,
    "pageSize": 2
  },
  "hierarchies": null
}

샘플 응답

상태 코드:
200 
{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1One",
          "Id2One",
          "1.0"
        ],
        "name": "instance1",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      },
      {
        "timeSeriesId": [
          "Id1Two",
          "Id2Two",
          "2.0"
        ],
        "name": "instance2",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      }
    ],
    "hitCount": 2,
    "continuationToken": null
  },
  "hierarchyNodes": null
}

SearchInstancesUntilChildren

샘플 요청

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": [
    "Location"
  ],
  "instances": {
    "recursive": false,
    "sort": {
      "by": "DisplayName"
    },
    "highlights": false,
    "pageSize": 2
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "Name"
    },
    "pageSize": 2
  }
}

샘플 응답

상태 코드:
200 
{
  "instances": {
    "hits": [],
    "hitCount": 0,
    "continuationToken": null
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "California",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "San Diego",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            },
            {
              "name": "San Francisco",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            }
          ],
          "hitCount": 2,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

정의

Name Description
HierarchiesExpandKind

계층 노드의 확장 종류입니다. 'UntilChildren'로 설정되면 계층 구조 노드는 둘 이상의 자식이 있을 때까지 재귀적으로 확장됩니다. 'OneLevel'로 설정하면 계층은 단일 수준 일치 경로 검색 인스턴스 매개 변수에서만 확장됩니다. 선택 사항으로, 기본값은 'UntilChildren'입니다.
HierarchiesExpandParameter

동일한 검색 인스턴스 호출에서 계층 노드를 확장할지 여부를 정의합니다.
HierarchiesSortBy

계층 노드 정렬에 사용할 값입니다. 'CumulativeInstanceCount'로 설정되면 반환된 계층은 계층 노드 및 해당 자식 계층 노드에 속하는 총 인스턴스를 기준으로 정렬됩니다. 'Name'으로 설정되면 반환된 계층은 계층 이름에 따라 정렬됩니다. 선택 사항, 기본값은 'CumulativeInstanceCount'입니다.
HierarchiesSortParameter

계층 노드의 정렬 정의입니다.
HierarchyHit

입력에 따라 쿼리와 일치하는 인스턴스를 포함하는 계층 노드입니다. 비어 있거나 null일 수 있습니다.
Highlights

사용자에게 표시할 시계열 인스턴스의 강조 표시된 텍스트입니다. 검색 문자열과 일치하는 텍스트 부분의 삽입 및 태그를 강조 표시합니다. 강조 표시된 속성을 사용하여 추가 API 호출을 수행하지 마세요.
InstanceHit

인스턴스 검색 호출에서 반환되는 시계열 인스턴스입니다. 반환된 인스턴스는 검색 요청과 일치하며 사용자에게 'true'로 설정된 경우 표시할 강조 표시된 텍스트를 포함합니다.
InstancesSortBy

검색 인스턴스 호출에서 반환되기 전에 시계열 인스턴스를 정렬하는 데 사용할 값입니다. 'Rank'로 설정되면 반환된 인스턴스는 관련성에 따라 정렬됩니다. 'DisplayName'으로 설정하면 반환된 결과가 표시 이름에 따라 정렬됩니다. 표시 이름은 인스턴스가 있는 경우 인스턴스의 이름이고, 그렇지 않으면 표시 이름은 시계열 ID입니다. 기본값은 'Rank'입니다.
InstancesSortParameter

검색 인스턴스 호출에서 반환되기 전에 시계열 인스턴스를 정렬하는 방법에 대한 정의입니다.
SearchHierarchyNodesResponse

입력을 기반으로 쿼리와 일치하는 인스턴스를 포함하는 계층 노드입니다. 비어 있거나 null일 수 있습니다.
SearchInstancesHierarchiesParameters

검색 인스턴스 호출을 통해 시계열 인스턴스 계층 구조를 반환하는 방법의 매개 변수입니다.
SearchInstancesParameters

검색 인스턴스 호출을 통해 시계열 인스턴스를 반환하는 방법의 매개 변수입니다.
SearchInstancesRequest

시계열 인스턴스에 대해 검색 쿼리를 실행하고 일치하는 시계열 인스턴스를 반환하도록 요청합니다.
SearchInstancesResponse

입력에 따라 쿼리와 일치하는 인스턴스입니다. 비어 있거나 null일 수 있습니다.
SearchInstancesResponsePage

검색 결과의 단일 페이지입니다.
TsiError

API 오류에 대한 정보입니다.
TsiErrorBody

오류 코드 및 메시지가 있는 특정 API 오류입니다.
TsiErrorDetails

추가 오류 정보입니다.

HierarchiesExpandKind

열거형

계층 노드의 확장 종류입니다. 'UntilChildren'로 설정되면 계층 구조 노드는 둘 이상의 자식이 있을 때까지 재귀적으로 확장됩니다. 'OneLevel'로 설정하면 계층은 단일 수준 일치 경로 검색 인스턴스 매개 변수에서만 확장됩니다. 선택 사항으로, 기본값은 'UntilChildren'입니다.

값 Description
OneLevel
UntilChildren

HierarchiesExpandParameter

Object

동일한 검색 인스턴스 호출에서 계층 노드를 확장할지 여부를 정의합니다.

Name 형식 Description
kind

HierarchiesExpandKind

계층 노드의 확장 종류입니다. 'UntilChildren'로 설정되면 계층 구조 노드는 둘 이상의 자식이 있을 때까지 재귀적으로 확장됩니다. 'OneLevel'로 설정하면 계층은 단일 수준 일치 경로 검색 인스턴스 매개 변수에서만 확장됩니다. 선택 사항으로, 기본값은 'UntilChildren'입니다.

HierarchiesSortBy

열거형

계층 노드 정렬에 사용할 값입니다. 'CumulativeInstanceCount'로 설정되면 반환된 계층은 계층 노드 및 해당 자식 계층 노드에 속하는 총 인스턴스를 기준으로 정렬됩니다. 'Name'으로 설정되면 반환된 계층은 계층 이름에 따라 정렬됩니다. 선택 사항, 기본값은 'CumulativeInstanceCount'입니다.

값 Description
CumulativeInstanceCount
Name

HierarchiesSortParameter

Object

계층 노드의 정렬 정의입니다.

Name 형식 Description
by

HierarchiesSortBy

계층 노드 정렬에 사용할 값입니다. 'CumulativeInstanceCount'로 설정되면 반환된 계층은 계층 노드 및 해당 자식 계층 노드에 속하는 총 인스턴스를 기준으로 정렬됩니다. 'Name'으로 설정되면 반환된 계층은 계층 이름에 따라 정렬됩니다. 선택 사항, 기본값은 'CumulativeInstanceCount'입니다.

HierarchyHit

Object

입력에 따라 쿼리와 일치하는 인스턴스를 포함하는 계층 노드입니다. 비어 있거나 null일 수 있습니다.

Name 형식 Description
cumulativeInstanceCount

integer (int32)

이 노드에 속하는 총 인스턴스 수이며 쿼리와 일치하는 하위 트리입니다.
hierarchyNodes

SearchHierarchyNodesResponse

이 노드의 자식 계층 구조 노드입니다. 비어 있거나 null일 수 있습니다.
name

string

계층 노드의 이름입니다. 비어 있을 수 있으며 null일 수 없습니다.

Highlights

Object

사용자에게 표시할 시계열 인스턴스의 강조 표시된 텍스트입니다. 검색 문자열과 일치하는 텍스트 부분의 삽입 및 태그를 강조 표시합니다. 강조 표시된 속성을 사용하여 추가 API 호출을 수행하지 마세요.

Name 형식 Description
description

string

시계열 인스턴스에 대한 설명이 강조 표시됩니다. null일 수 있습니다.
hierarchyIds

string[]

시계열 인스턴스가 속한 강조 표시된 시계열 계층 ID 목록입니다. 계층을 조회하는 데 사용할 수 없습니다. null일 수 있습니다.
hierarchyNames

string[]

시계열 인스턴스가 속한 강조 표시된 시계열 계층 이름 목록입니다. 계층을 조회하는 데 사용할 수 없습니다. null일 수 있습니다.
instanceFieldNames

string[]

강조 표시된 시계열 인스턴스 필드 이름 목록입니다. null일 수 있습니다.
instanceFieldValues

string[]

강조 표시된 시계열 인스턴스 필드 값 목록입니다. null일 수 있습니다.
name

string

시계열 인스턴스의 강조 표시된 이름입니다. null일 수 있습니다.
timeSeriesId

string[]

표시할 시계열 ID의 강조 표시된 문자열 값 목록입니다. 조회 인스턴스에 사용할 수 없습니다.
typeName

string

이 인스턴스가 속한 강조 표시된 시계열 형식 이름입니다.

InstanceHit

Object

인스턴스 검색 호출에서 반환되는 시계열 인스턴스입니다. 반환된 인스턴스는 검색 요청과 일치하며 사용자에게 'true'로 설정된 경우 표시할 강조 표시된 텍스트를 포함합니다.

Name 형식 Description
hierarchyIds

string[]

검색 요청과 일치하는 시계열 인스턴스가 속한 시계열 계층 ID 목록입니다. 계층을 조회하는 데 사용할 수 없습니다. null일 수 있습니다.
highlights

Highlights

사용자에게 표시할 시계열 인스턴스의 강조 표시된 텍스트입니다. 검색 문자열과 일치하는 텍스트 부분의 삽입 및 태그를 강조 표시합니다. 강조 표시된 속성을 사용하여 추가 API 호출을 수행하지 마세요.
name

string

검색 요청과 일치하는 시계열 인스턴스의 이름입니다. null일 수 있습니다.
timeSeriesId

TimeSeriesId[]

검색 요청과 일치하는 시계열 인스턴스의 시계열 ID입니다.
typeId

string

검색 요청과 일치하는 시계열 인스턴스가 속한 형식을 나타냅니다. Null이면 안 하세요.

InstancesSortBy

열거형

검색 인스턴스 호출에서 반환되기 전에 시계열 인스턴스를 정렬하는 데 사용할 값입니다. 'Rank'로 설정되면 반환된 인스턴스는 관련성에 따라 정렬됩니다. 'DisplayName'으로 설정하면 반환된 결과가 표시 이름에 따라 정렬됩니다. 표시 이름은 인스턴스가 있는 경우 인스턴스의 이름이고, 그렇지 않으면 표시 이름은 시계열 ID입니다. 기본값은 'Rank'입니다.

값 Description
DisplayName
Rank

InstancesSortParameter

Object

검색 인스턴스 호출에서 반환되기 전에 시계열 인스턴스를 정렬하는 방법에 대한 정의입니다.

Name 형식 Description
by

InstancesSortBy

검색 인스턴스 호출에서 반환되기 전에 시계열 인스턴스를 정렬하는 데 사용할 값입니다. 'Rank'로 설정되면 반환된 인스턴스는 관련성에 따라 정렬됩니다. 'DisplayName'으로 설정하면 반환된 결과가 표시 이름에 따라 정렬됩니다. 표시 이름은 인스턴스가 있는 경우 인스턴스의 이름이고, 그렇지 않으면 표시 이름은 시계열 ID입니다. 기본값은 'Rank'입니다.

SearchHierarchyNodesResponse

Object

입력을 기반으로 쿼리와 일치하는 인스턴스를 포함하는 계층 노드입니다. 비어 있거나 null일 수 있습니다.

Name 형식 Description
continuationToken

string

반환되는 경우 이는 현재 결과가 부분 결과를 나타낸다는 것을 의미합니다. 연속 토큰을 사용하면 결과의 다음 페이지를 가져올 수 있습니다. 쿼리 결과의 다음 페이지를 가져오려면 "x-ms-continuation" HTTP 헤더에서 연속 토큰 매개 변수를 사용하여 동일한 요청을 보냅니다.
hitCount

integer (int32)

입력에 따라 쿼리와 일치하는 인스턴스를 포함하는 총 계층 구조 노드 수입니다.
hits

HierarchyHit[]

입력에 따라 쿼리와 일치하는 인스턴스를 포함하는 계층 노드 목록입니다. 비어 있을 수 있습니다.

SearchInstancesHierarchiesParameters

Object

검색 인스턴스 호출을 통해 시계열 인스턴스 계층 구조를 반환하는 방법의 매개 변수입니다.

Name 형식 Description
expand

HierarchiesExpandParameter

동일한 검색 인스턴스 호출에서 계층 노드를 확장할지 여부를 정의합니다. 선택 사항으로, 기본값은 'UntilChildren'입니다.
pageSize

integer (int32)

동일한 페이지에서 반환할 동일한 수준의 최대 계층 수입니다. 선택 사항이며, 설정되지 않은 경우 기본값은 10입니다. 범위는 1에서 100까지입니다. 페이지 크기를 초과하는 결과가 있는 경우 연속 토큰을 사용하여 다음 페이지를 가져올 수 있습니다.
sort

HierarchiesSortParameter

계층 노드의 정렬 정의입니다. 선택 사항, 기본값은 'CumulativeInstanceCount'입니다.

SearchInstancesParameters

Object

검색 인스턴스 호출을 통해 시계열 인스턴스를 반환하는 방법의 매개 변수입니다.

Name 형식 Description
highlights

boolean

강조 표시된 검색 결과의 정의입니다. 'true'로 설정하면 강조 표시된 검색 결과가 반환됩니다. 'false'로 설정하면 강조 표시된 검색 결과가 반환되지 않습니다. 기본값은 'true'입니다.
pageSize

integer (int32)

결과의 각 페이지에 예상되는 최대 인스턴스 수입니다. 설정되지 않은 경우 기본값은 10입니다. 범위는 1에서 100까지입니다. 페이지 크기를 초과하는 결과가 있는 경우 사용자는 연속 토큰을 사용하여 다음 페이지를 가져올 수 있습니다.
recursive

boolean

반환되는 인스턴스의 정의입니다. 재귀가 'true'로 설정되면 경로로 시작하는 경로가 있는 모든 인스턴스가 경로 매개 변수가 반환됩니다. 재귀가 'false'로 설정되면 경로 매개 변수와 정확히 일치하는 경로가 있는 인스턴스만 반환됩니다. 재귀 검색을 사용하면 검색 사용자 환경을 구현할 수 있지만 재귀적이지 않은 검색을 사용하면 탐색 환경을 구현할 수 있습니다. 선택 사항, 기본값은 'true'입니다.
sort

InstancesSortParameter

검색 인스턴스 호출에서 반환되기 전에 시계열 인스턴스가 정렬되는 방식(관련성 또는 사전순)에 대한 정의입니다. 선택 사항으로, 기본값은 "Rank"입니다.

SearchInstancesRequest

Object

시계열 인스턴스에 대해 검색 쿼리를 실행하고 일치하는 시계열 인스턴스를 반환하도록 요청합니다.

Name 형식 Description
hierarchies

SearchInstancesHierarchiesParameters

시계열 인스턴스 계층을 반환하는 방법의 매개 변수입니다. null이면 계층이 반환되지 않습니다. 인스턴스 매개 변수가 null이고 계층 매개 변수가 null이 아니면 인스턴스가 없는 계층만 반환됩니다.
instances

SearchInstancesParameters

시계열 인스턴스를 반환하는 방법의 매개 변수입니다. null일 수 있습니다. 인스턴스 및 계층 매개 변수가 모두 null이면 인스턴스는 매개 변수의 기본값에 따라 결과에 반환되고 계층 구조는 반환되지 않습니다.
path

string[]

시계열 인스턴스의 계층 경로를 필터링합니다. 경로는 문자열 경로 세그먼트의 배열로 표시됩니다. 첫 번째 요소는 계층 이름이어야 합니다. 예: ["Location", "California"]. 선택 사항, 대/소문자 구분, 비어있지 않으며 null일 수 있습니다.
searchString

string

시계열 인스턴스의 특성과 일치하는 쿼리 검색 문자열입니다. 예: "floor 100". 대/소문자를 구분하지 않고 존재해야 하지만 빈 문자열일 수 있습니다.

SearchInstancesResponse

Object

입력에 따라 쿼리와 일치하는 인스턴스입니다. 비어 있거나 null일 수 있습니다.

Name 형식 Description
continuationToken

string

반환되는 경우 이는 현재 결과가 부분 결과를 나타낸다는 것을 의미합니다. 연속 토큰을 사용하면 결과의 다음 페이지를 가져올 수 있습니다. 쿼리 결과의 다음 페이지를 가져오려면 "x-ms-continuation" HTTP 헤더에서 연속 토큰 매개 변수를 사용하여 동일한 요청을 보냅니다.
hitCount

integer (int32)

입력에 따라 쿼리와 일치하는 총 인스턴스 수입니다.
hits

InstanceHit[]

입력에 따라 쿼리와 일치하는 인스턴스 목록입니다. 비어 있을 수 있습니다.

SearchInstancesResponsePage

Object

검색 결과의 단일 페이지입니다.

Name 형식 Description
hierarchyNodes

SearchHierarchyNodesResponse

입력을 기반으로 쿼리와 일치하는 인스턴스를 포함하는 계층 노드입니다. 비어 있거나 null일 수 있습니다.
instances

SearchInstancesResponse

입력에 따라 쿼리와 일치하는 인스턴스입니다. 비어 있거나 null일 수 있습니다.

TsiError

Object

API 오류에 대한 정보입니다.

Name 형식 Description
error

TsiErrorBody

오류 코드 및 메시지가 있는 특정 API 오류입니다.

TsiErrorBody

Object

오류 코드 및 메시지가 있는 특정 API 오류입니다.

Name 형식 Description
code

string

서비스별 오류 코드를 정의하는 언어 독립적, 사람이 읽을 수 있는 문자열입니다. 이 코드는 응답에 지정된 HTTP 오류 코드에 대한 보다 구체적인 표시기 역할을 합니다. 프로그래밍 방식으로 특정 오류 사례를 처리하는 데 사용할 수 있습니다.
details

TsiErrorDetails[]

추가 오류 정보를 포함합니다. null일 수 있습니다.
innerError

TsiErrorBody

원인을 좁히는 보다 구체적인 오류를 포함합니다. null일 수 있습니다.
message

string

사람이 읽을 수 있는 언어 독립적 오류 표현입니다. 개발자를 돕기 위한 것이며 최종 사용자에게 노출하는 데 적합하지 않습니다.
target

string

특정 오류의 대상입니다(예: 오류의 속성 이름). null일 수 있습니다.

TsiErrorDetails

Object

추가 오류 정보입니다.

Name 형식 Description
code

string

서비스별 오류 코드를 정의하는 언어 독립적, 사람이 읽을 수 있는 문자열입니다. 이 코드는 응답에 지정된 HTTP 오류 코드에 대한 보다 구체적인 표시기 역할을 합니다. 프로그래밍 방식으로 특정 오류 사례를 처리하는 데 사용할 수 있습니다.
message

string

사람이 읽을 수 있는 언어 독립적 오류 표현입니다. 개발자를 돕기 위한 것이며 최종 사용자에게 노출하는 데 적합하지 않습니다.