다음을 통해 공유

Time Series Types - Execute Batch

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

여러 시계열 형식에 대한 일괄 처리 가져오기, 만들기, 업데이트, 삭제 작업을 실행합니다.

POST https://{environmentFqdn}/timeseries/types/$batch?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-client-request-id

string

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

string

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

요청 본문

Name 형식 Description
delete

TypesRequestBatchGetOrDelete

삭제할 시계열 형식의 정의입니다.
get

TypesRequestBatchGetOrDelete

반환할 시계열 형식의 정의입니다.
put

TimeSeriesType[]

업데이트하거나 만들 시계열 형식의 정의입니다.

응답

Name 형식 Description
200 OK

TypesBatchResponse

작업이 성공했습니다.

헤더

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 사용자 계정 가장

예제

TypesBatchDeleteByIds
TypesBatchDeleteByNames
TypesBatchGetByIds
TypesBatchGetByNames
TypesBatchPut

TypesBatchDeleteByIds

샘플 요청

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

{
  "delete": {
    "typeIds": [
      "9250f816-faed-44c4-88e6-630e5eefa38b"
    ]
  }
}

샘플 응답

상태 코드:
200 
{
  "delete": [
    null
  ]
}

TypesBatchDeleteByNames

샘플 요청

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

{
  "delete": {
    "names": [
      "TemperatureSensor"
    ]
  }
}

샘플 응답

상태 코드:
200 
{
  "delete": [
    null
  ]
}

TypesBatchGetByIds

샘플 요청

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

{
  "get": {
    "typeIds": [
      "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8"
    ],
    "names": null
  }
}

샘플 응답

상태 코드:
200 
{
  "get": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "TemperatureSensor",
        "description": "This is a temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": null,
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

TypesBatchGetByNames

샘플 요청

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

{
  "get": {
    "names": [
      "DefaultType",
      "TemperatureSensor"
    ]
  }
}

샘플 응답

상태 코드:
200 
{
  "get": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "TemperatureSensor",
        "description": "This is a temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": null,
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

TypesBatchPut

샘플 요청

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

{
  "put": [
    {
      "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
      "name": "DefaultType",
      "description": "My Default type",
      "variables": {
        "EventCount": {
          "kind": "aggregate",
          "filter": null,
          "aggregation": {
            "tsx": "count()"
          }
        }
      }
    },
    {
      "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
      "name": "OutdoorTemperatureSensor",
      "description": "This is an outdoor temperature sensor.",
      "variables": {
        "AverageTemperature": {
          "kind": "numeric",
          "value": {
            "tsx": "$event.Temperature.Double"
          },
          "filter": {
            "tsx": "$event.Mode.String = 'outdoor'"
          },
          "aggregation": {
            "tsx": "avg($value)"
          }
        }
      }
    }
  ]
}

샘플 응답

상태 코드:
200 
{
  "put": [
    {
      "timeSeriesType": {
        "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "name": "DefaultType",
        "description": "My Default type",
        "variables": {
          "EventCount": {
            "kind": "aggregate",
            "filter": null,
            "aggregation": {
              "tsx": "count()"
            }
          }
        }
      },
      "error": null
    },
    {
      "timeSeriesType": {
        "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8",
        "name": "OutdoorTemperatureSensor",
        "description": "This is an outdoor temperature sensor.",
        "variables": {
          "AverageTemperature": {
            "kind": "numeric",
            "value": {
              "tsx": "$event.Temperature.Double"
            },
            "filter": {
              "tsx": "$event.Mode.String = 'outdoor'"
            },
            "aggregation": {
              "tsx": "avg($value)"
            }
          }
        }
      },
      "error": null
    }
  ]
}

정의

Name Description
AggregateVariable

집계 변수는 집계 계산을 나타냅니다. 집계 변수는 보간을 지원하지 않습니다.
Boundary

보간에 사용할 검색 범위의 왼쪽과 오른쪽에 있는 시간 범위입니다. 이는 입력 검색 범위의 시작 또는 끝에 가까운 데이터 요소가 누락된 시나리오에서 유용합니다. null일 수 있습니다.
CategoricalVariable

범주 변수는 제한된 정의된 값 집합의 발생 횟수 또는 기간에 따라 분석해야 하는 신호를 나타냅니다.
Interpolation

원시 데이터 포인트에서 수행할 보간 작업입니다. 현재 보간된 시계열의 샘플링만 허용됩니다. 허용되는 집계 함수 - 예: left($value). 보간을 적용할 필요가 없는 경우 null일 수 있습니다.
InterpolationKind

보간 기술의 유형: "선형" 또는 "단계".
NumericVariable

숫자 변수는 보간을 사용하여 재구성할 수 있는 단일 연속 숫자 신호를 나타냅니다.
TimeSeriesAggregateCategory

범주 변수에 사용되는 범주입니다. 범주는 이 레이블이 할당된 'label' 및 'values'로 정의됩니다.
TimeSeriesDefaultCategory

기본 범주를 나타냅니다.
TimeSeriesType

시계열 형식은 시계열 인스턴스와 연결된 이벤트에서 계산을 수행하기 위한 변수 또는 수식을 정의합니다. instance 각 시계열은 정확히 하나의 형식과 연결됩니다. 형식에는 하나 이상의 변수가 포함될 수 있습니다. 예를 들어 instance 시계열은 평균 온도, 최소 온도 및 최대 온도 변수로 구성된 온도 센서 형식일 수 있습니다.
TimeSeriesTypeOrError

특정 시계열 형식에 대한 일괄 처리 작업의 결과입니다. 작업 성공 시 형식 개체가 설정되고 작업이 실패할 때 오류 개체가 설정됩니다.
TsiError

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

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

추가 오류 정보입니다.
Tsx

단일 문자열로 작성된 TSX(시계열 식)입니다. 예: "$event. Status.String='Good'", "avg($event. 온도)". 시계열 식을 작성하는 방법에 대한 설명서를 참조하세요.
TypesBatchRequest

시계열 형식의 일괄 처리에 대해 단일 작업을 수행하도록 요청합니다. 정확히 "get", "put" 또는 "delete" 중 하나를 설정해야 합니다.
TypesBatchResponse

시계열 형식의 일괄 처리에 대한 단일 작업의 응답입니다. 정확히 "get", "put" 또는 "delete" 중 하나가 설정됩니다.
TypesRequestBatchGetOrDelete

ID 또는 형식 이름으로 시계열 형식을 얻거나 삭제하도록 요청합니다. 정확히 "typeIds" 또는 "name" 중 하나를 설정해야 합니다.

AggregateVariable

집계 변수는 집계 계산을 나타냅니다. 집계 변수는 보간을 지원하지 않습니다.

Name 형식 Description
aggregation

Tsx

kind가 "집계"인 경우 집계 시계열 식은 "$event 같은 이벤트 속성을 사용하여 직접 수행해야 하는 집계를 나타내는 데 사용됩니다. 온도". 예를 들어 온도 변화 범위를 계산하기 위한 집계는 "max($event. 온도)-min($event. 온도)".
filter

Tsx

계산에 고려되는 이벤트 수를 제한하는 이벤트를 필터링합니다. 예: "$event. Status.String='Good'". 선택 사항입니다.
kind string:

aggregate

허용되는 "kind" 값은 "numeric" 또는 "aggregate"입니다. "numeric"을 사용하면 재구성된 신호의 값과 이를 집계할 식을 지정할 수 있지만 ,"집계" 종류를 사용하면 값을 지정하지 않고도 이벤트 속성을 직접 집계할 수 있습니다.

Boundary

보간에 사용할 검색 범위의 왼쪽과 오른쪽에 있는 시간 범위입니다. 이는 입력 검색 범위의 시작 또는 끝에 가까운 데이터 요소가 누락된 시나리오에서 유용합니다. null일 수 있습니다.

Name 형식 Description
span

string

CategoricalVariable

범주 변수는 제한된 정의된 값 집합의 발생 횟수 또는 기간에 따라 분석해야 하는 신호를 나타냅니다.

Name 형식 Description
categories

TimeSeriesAggregateCategory[]

범주 변수에 사용되는 범주입니다. 범주는 'label' 및 이 레이블이 할당된 '값'으로 정의됩니다.
defaultCategory

TimeSeriesDefaultCategory

기본 범주를 나타냅니다.
filter

Tsx

계산에 고려되는 이벤트 수를 제한하는 이벤트를 필터링합니다. 예: "$event. Status.String='Good'". 선택 사항입니다.
interpolation

Interpolation

범주 변수는 '단계' 보간만 지원합니다.
kind string:

categorical

허용되는 "kind" 값은 "numeric" 또는 "aggregate"입니다. "numeric"을 사용하면 재구성된 신호의 값과 이를 집계할 식을 지정할 수 있지만 ,"집계" 종류를 사용하면 값을 지정하지 않고도 이벤트 속성을 직접 집계할 수 있습니다.
value

Tsx

값 시계열 식은 분류될 신호의 값을 나타내는 데 사용됩니다. 범주 변수의 경우 'String' 또는 'Long' 형식으로만 계산할 수 있습니다.

Interpolation

원시 데이터 포인트에서 수행할 보간 작업입니다. 현재 보간된 시계열의 샘플링만 허용됩니다. 허용되는 집계 함수 - 예: left($value). 보간을 적용할 필요가 없는 경우 null일 수 있습니다.

Name 형식 Description
boundary

Boundary

보간에 사용할 검색 범위의 왼쪽과 오른쪽에 있는 시간 범위입니다. 이는 입력 검색 범위의 시작 또는 끝에 가까운 데이터 요소가 누락된 시나리오에서 유용합니다. null일 수 있습니다.
kind

InterpolationKind

보간 기술의 유형: "선형" 또는 "단계".

InterpolationKind

보간 기술의 유형: "선형" 또는 "단계".

Name 형식 Description
Linear

string

Step

string

NumericVariable

숫자 변수는 보간을 사용하여 재구성할 수 있는 단일 연속 숫자 신호를 나타냅니다.

Name 형식 Description
aggregation

Tsx

kind가 "numeric"인 경우 집계 시계열 식은 $value 식에서 수행해야 하는 집계를 나타내는 데 사용됩니다. 이렇게 하려면 $value 지정해야 하며 집계 함수 내에서만 $value 사용할 수 있습니다. 예를 들어 최소 $value 계산하기 위한 집계는 "min($value)"으로 작성됩니다.
filter

Tsx

계산에 고려되는 이벤트 수를 제한하는 이벤트를 필터링합니다. 예: "$event. Status.String='Good'". 선택 사항입니다.
interpolation

Interpolation

원시 데이터 포인트에서 수행할 보간 작업입니다. 현재 보간된 시계열의 샘플링만 허용됩니다. 허용되는 집계 함수 - 예: left($value). 보간을 적용할 필요가 없는 경우 null일 수 있습니다.
kind string:

numeric

허용되는 "kind" 값은 "numeric" 또는 "aggregate"입니다. "numeric"을 사용하면 재구성된 신호의 값과 이를 집계할 식을 지정할 수 있지만 ,"집계" 종류를 사용하면 값을 지정하지 않고도 이벤트 속성을 직접 집계할 수 있습니다.
value

Tsx

값 시계열 식은 집계 또는 보간될 신호의 값을 나타내는 데 사용됩니다. 예를 들어 이벤트의 온도 값은 다음과 같이 표시됩니다. "$event. Temperature.Double".

TimeSeriesAggregateCategory

범주 변수에 사용되는 범주입니다. 범주는 이 레이블이 할당된 'label' 및 'values'로 정의됩니다.

Name 형식 Description
label

string

출력 변수 이름을 생성하는 데 사용할 범주의 이름입니다.
values

object[]

범주가 매핑하는 값 목록입니다. 문자열의 고유한 목록 또는 long 목록일 수 있습니다.

TimeSeriesDefaultCategory

기본 범주를 나타냅니다.

Name 형식 Description
label

string

'범주'에 정의된 값과 일치하지 않는 값에 할당되는 기본 범주의 이름입니다.

TimeSeriesType

시계열 형식은 시계열 인스턴스와 연결된 이벤트에서 계산을 수행하기 위한 변수 또는 수식을 정의합니다. instance 각 시계열은 정확히 하나의 형식과 연결됩니다. 형식에는 하나 이상의 변수가 포함될 수 있습니다. 예를 들어 instance 시계열은 평균 온도, 최소 온도 및 최대 온도 변수로 구성된 온도 센서 형식일 수 있습니다.

Name 형식 Description
description

string

유형에 대한 설명입니다. null일 수 있습니다.
id

string

변경할 수 없는 대/소문자를 구분하는 고유 형식 식별자입니다. 만들기 또는 업데이트 요청에서 null일 수 있으며 서버는 ID를 생성합니다. 가져오기 및 삭제 작업에서 null이 아닙니다.
name

string

사용자가 지정한 형식의 고유 이름입니다. 변경할 수 있으며 null이 아닙니다.
variables

object

형식과 연결된 다양한 변수입니다. 비어 있지 않고 null이 아닙니다.

TimeSeriesTypeOrError

특정 시계열 형식에 대한 일괄 처리 작업의 결과입니다. 작업 성공 시 형식 개체가 설정되고 작업이 실패할 때 오류 개체가 설정됩니다.

Name 형식 Description
error

TsiErrorBody

오류 개체 - 작업이 실패할 때 설정합니다.
timeSeriesType

TimeSeriesType

시계열 형식 개체 - 작업이 성공하면 설정합니다.

TsiError

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

Name 형식 Description
error

TsiErrorBody

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

TsiErrorBody

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

Name 형식 Description
code

string

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

TsiErrorDetails[]

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

TsiErrorBody

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

string

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

string

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

TsiErrorDetails

추가 오류 정보입니다.

Name 형식 Description
code

string

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

string

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

Tsx

단일 문자열로 작성된 TSX(시계열 식)입니다. 예: "$event. Status.String='Good'", "avg($event. 온도)". 시계열 식을 작성하는 방법에 대한 설명서를 참조하세요.

Name 형식 Description
tsx

string

단일 문자열로 작성된 TSX(시계열 식)입니다. 예: "$event. Status.String='Good'", "avg($event. 온도)". 시계열 식을 작성하는 방법에 대한 설명서를 참조하세요.

TypesBatchRequest

시계열 형식의 일괄 처리에 대해 단일 작업을 수행하도록 요청합니다. 정확히 "get", "put" 또는 "delete" 중 하나를 설정해야 합니다.

Name 형식 Description
delete

TypesRequestBatchGetOrDelete

삭제할 시계열 형식의 정의입니다.
get

TypesRequestBatchGetOrDelete

반환할 시계열 형식의 정의입니다.
put

TimeSeriesType[]

업데이트하거나 만들 시계열 형식의 정의입니다.

TypesBatchResponse

시계열 형식의 일괄 처리에 대한 단일 작업의 응답입니다. 정확히 "get", "put" 또는 "delete" 중 하나가 설정됩니다.

Name 형식 Description
delete

TsiErrorBody[]

작업 성공 시 null - 요청의 "delete" 배열 위치별로 해당하는 오류 개체 목록입니다.
get

TimeSeriesTypeOrError[]

요청의 "get" 배열에 대한 위치에 해당하는 형식 또는 오류 개체 목록입니다. 작업 성공 시 형식 개체가 설정되고 작업이 실패할 때 오류 개체가 설정됩니다.
put

TimeSeriesTypeOrError[]

요청의 "put" 배열에 대한 위치에 따라 해당하는 형식 또는 오류 개체의 목록입니다. 작업 성공 시 형식 개체가 설정되고 작업이 실패할 때 오류 개체가 설정됩니다.

TypesRequestBatchGetOrDelete

ID 또는 형식 이름으로 시계열 형식을 얻거나 삭제하도록 요청합니다. 정확히 "typeIds" 또는 "name" 중 하나를 설정해야 합니다.

Name 형식 Description
names

string[]

반환하거나 삭제할 시계열 형식의 이름 목록입니다.
typeIds

string[]

반환하거나 삭제할 시계열 형식의 ID 목록입니다.