다음을 통해 공유

Time Series Instances - Execute Batch

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

여러 시계열 인스턴스에서 일괄 처리, 가져오기, 업데이트, 삭제 작업을 실행합니다.

POST https://{environmentFqdn}/timeseries/instances/$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

InstancesRequestBatchGetOrDelete

시계열 인스턴스를 삭제합니다. 시계열 ID 또는 이름을 지정할 수 있습니다.
get

InstancesRequestBatchGetOrDelete

반환할 시계열 ID 또는 시계열 인스턴스의 이름입니다.
put

TimeSeriesInstance[]

생성하거나 업데이트할 시계열 인스턴스입니다.
update

TimeSeriesInstance[]

업데이트할 시계열 인스턴스입니다. instance가 없으면 오류가 반환됩니다.

응답

Name 형식 Description
200 OK

InstancesBatchResponse

작업이 성공했습니다.

헤더

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

TsiError

예기치 않은 오류입니다.

헤더

x-ms-request-id: string

보안

azure_auth

Azure Active Directory OAuth2 흐름

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

범위

Name Description
user_impersonation 사용자 계정 가장

예제

InstancesBatchDeleteByIds
InstancesBatchDeleteByNames
InstancesBatchGetByIds
InstancesBatchGetByNames
InstancesBatchPut
InstancesBatchUpdate

InstancesBatchDeleteByIds

샘플 요청

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

{
  "delete": {
    "timeSeriesIds": [
      [
        "2da181d7-8346-4cf2-bd94-a17742237429",
        "T1"
      ],
      [
        "18672e3d-2beb-4007-9846-042b09ef3c72",
        "T2"
      ]
    ]
  }
}

샘플 응답

상태 코드:
200 
{
  "delete": [
    null,
    {
      "code": "InvalidInput",
      "message": "Time series instance with ID '[\"18672e3d-2beb-4007-9846-042b09ef3c72\", \"T2\"]' cannot be deleted. There are already ingested events associated with this time series ID.",
      "innerError": {
        "code": "CannotDeleteInstance"
      }
    }
  ]
}

InstancesBatchDeleteByNames

샘플 요청

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

{
  "delete": {
    "names": [
      "F2W6.GF",
      "F1W7.GS1"
    ]
  }
}

샘플 응답

상태 코드:
200 
{
  "delete": [
    null,
    {
      "code": "InvalidInput",
      "message": "Time series instance with ID '[\"18672e3d-2beb-4007-9846-042b09ef3c72\", \"T2\"]' cannot be deleted. There are already ingested events associated with this time series ID.",
      "innerError": {
        "code": "CannotDeleteInstance"
      }
    }
  ]
}

InstancesBatchGetByIds

샘플 요청

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

{
  "get": {
    "timeSeriesIds": [
      [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ]
    ]
  }
}

샘플 응답

상태 코드:
200 
{
  "get": [
    {
      "instance": {
        "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
        "name": "F1W7.GS1",
        "timeSeriesId": [
          "006dfc2d-0324-4937-998c-d16f3b4f1952",
          "T1"
        ],
        "description": "ContosoFarm1W7_GenSpeed1",
        "hierarchyIds": [
          "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
        ],
        "instanceFields": {
          "Name": "GeneratorSpeed",
          "Plant": "Contoso Plant 1",
          "Unit": "W7",
          "System": "Generator System",
          "Status": false,
          "Version": 1.3,
          "Code": 28
        }
      }
    }
  ]
}

InstancesBatchGetByNames

샘플 요청

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

{
  "get": {
    "names": [
      "F1W7.GS1"
    ]
  }
}

샘플 응답

상태 코드:
200 
{
  "get": [
    {
      "instance": {
        "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
        "name": "F1W7.GS1",
        "timeSeriesId": [
          "006dfc2d-0324-4937-998c-d16f3b4f1952",
          "T1"
        ],
        "description": "ContosoFarm1W7_GenSpeed1",
        "hierarchyIds": [
          "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
        ],
        "instanceFields": {
          "Name": "GeneratorSpeed",
          "Plant": "Contoso Plant 1",
          "Unit": "W7",
          "System": "Generator System",
          "Status": false,
          "Version": 1.3,
          "Code": 28
        }
      }
    }
  ]
}

InstancesBatchPut

샘플 요청

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

{
  "put": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "F1W7.GS1",
      "timeSeriesId": [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ],
      "description": "ContosoFarm1W7_GenSpeed1",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GeneratorSpeed",
        "Plant": "Contoso Plant 1",
        "Unit": "W7",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ]
}

샘플 응답

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

InstancesBatchUpdate

샘플 요청

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

{
  "update": [
    {
      "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff",
      "name": "F1W7.GS1",
      "timeSeriesId": [
        "006dfc2d-0324-4937-998c-d16f3b4f1952",
        "T1"
      ],
      "description": "ContosoFarm1W7_GenSpeed1",
      "hierarchyIds": [
        "33d72529-dd73-4c31-93d8-ae4e6cb5605d"
      ],
      "instanceFields": {
        "Name": "GeneratorSpeed",
        "Plant": "Contoso Plant 1",
        "Unit": "W7",
        "System": "Generator System",
        "Status": false,
        "Version": 1.3,
        "Code": 28
      }
    }
  ]
}

샘플 응답

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

정의

Name Description
InstanceOrError

특정 시계열 인스턴스에 대한 일괄 처리 작업의 결과입니다. 인스턴스 객체는 조작이 성공할 때(넣기 조작 제외) 설정되고, 조작이 실패하면 오류 객체가 설정된다.
InstancesBatchRequest

인스턴스 배치에 대해 단일 작업을 수행하도록 요청합니다. "get", "put", "update" 또는 "delete" 중 정확히 하나를 설정해야 합니다.
InstancesBatchResponse

인스턴스 배치에 대한 단일 작업의 응답입니다. 요청에 따라 "get", "put", "update" 또는 "delete" 중 하나만 설정됩니다.
InstancesRequestBatchGetOrDelete

시계열 ID 또는 시계열 이름으로 인스턴스를 가져오거나 삭제하도록 요청합니다. "timeSeriesIds" 또는 "names" 중 정확히 하나를 설정해야 합니다.
TimeSeriesInstance

시계열 인스턴스는 시계열 자체입니다. 대부분의 경우 deviceId 또는 assetId는 환경에 있는 자산의 고유 식별자입니다. 인스턴스에는 인스턴스 필드라고 하는 설명 정보가 있습니다. 최소한 인스턴스 필드에는 계층 정보가 포함됩니다. 또한 제조업체, 운영자 또는 마지막 서비스 날짜와 같은 유용하고 설명적인 데이터를 포함할 수도 있습니다.
TsiError

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

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

추가 오류 정보입니다.

InstanceOrError

Object

특정 시계열 인스턴스에 대한 일괄 처리 작업의 결과입니다. 인스턴스 객체는 조작이 성공할 때(넣기 조작 제외) 설정되고, 조작이 실패하면 오류 객체가 설정된다.

Name 형식 Description
error

TsiErrorBody

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

TimeSeriesInstance

시계열 인스턴스 개체 - 작업이 성공할 때 설정됩니다(put 작업 제외).

InstancesBatchRequest

Object

인스턴스 배치에 대해 단일 작업을 수행하도록 요청합니다. "get", "put", "update" 또는 "delete" 중 정확히 하나를 설정해야 합니다.

Name 형식 Description
delete

InstancesRequestBatchGetOrDelete

시계열 인스턴스를 삭제합니다. 시계열 ID 또는 이름을 지정할 수 있습니다.
get

InstancesRequestBatchGetOrDelete

반환할 시계열 ID 또는 시계열 인스턴스의 이름입니다.
put

TimeSeriesInstance[]

생성하거나 업데이트할 시계열 인스턴스입니다.
update

TimeSeriesInstance[]

업데이트할 시계열 인스턴스입니다. instance가 없으면 오류가 반환됩니다.

InstancesBatchResponse

Object

인스턴스 배치에 대한 단일 작업의 응답입니다. 요청에 따라 "get", "put", "update" 또는 "delete" 중 하나만 설정됩니다.

Name 형식 Description
delete

TsiErrorBody[]

요청의 "delete" 배열에 대한 위치별로 해당하는 오류 개체 목록입니다. Null은 인스턴스가 삭제되었거나 존재하지 않음을 의미합니다. Error 객체는 작업이 실패할 때(예: 이 시계열 인스턴스와 관련된 이벤트가 있는 경우) 설정됩니다.
get

InstanceOrError[]

요청의 "get" 배열에 대한 위치별로 해당하는 인스턴스 또는 오류 개체 목록입니다. Instance 객체는 조작 성공 시 설정되고 error 객체는 조작 실패 시 설정됩니다.
put

InstanceOrError[]

요청의 "put" 배열에 대한 위치별로 해당하는 오류 객체 목록입니다. Error 객체는 조작에 실패할 때 설정됩니다.
update

InstanceOrError[]

요청의 "update" 배열에 대한 위치별로 해당하는 오류 개체 목록입니다. Instance 객체는 조작 성공 시 설정되고 error 객체는 조작 실패 시 설정됩니다.

InstancesRequestBatchGetOrDelete

Object

시계열 ID 또는 시계열 이름으로 인스턴스를 가져오거나 삭제하도록 요청합니다. "timeSeriesIds" 또는 "names" 중 정확히 하나를 설정해야 합니다.

Name 형식 Description
names

string[]

반환하거나 삭제할 시계열 인스턴스의 이름 목록입니다.
timeSeriesIds

TimeSeriesId[]

반환하거나 삭제할 시계열 인스턴스의 시계열 ID 목록입니다.

TimeSeriesInstance

Object

시계열 인스턴스는 시계열 자체입니다. 대부분의 경우 deviceId 또는 assetId는 환경에 있는 자산의 고유 식별자입니다. 인스턴스에는 인스턴스 필드라고 하는 설명 정보가 있습니다. 최소한 인스턴스 필드에는 계층 정보가 포함됩니다. 또한 제조업체, 운영자 또는 마지막 서비스 날짜와 같은 유용하고 설명적인 데이터를 포함할 수도 있습니다.

Name 형식 Description
description

string

이 선택적 필드에는 인스턴스에 대한 설명이 포함되어 있습니다.
hierarchyIds

string[]

인스턴스가 속한 시계열 계층 ID 집합입니다. null일 수 있습니다.
instanceFields

사용자 정의 인스턴스 속성을 포함하는 키-값 쌍 집합입니다. null일 수 있습니다. 지원되는 속성 값 유형은 bool, string, long, double이며 중첩되거나 null일 수 없습니다.
name

string

환경에서 고유한 인스턴스의 선택적 이름입니다. 이름은 시계열 인스턴스의 변경 가능한 별칭 또는 표시 이름 역할을 합니다. 변경 가능, null일 수 있습니다.
timeSeriesId

TimeSeriesId[]

인스턴스를 고유하게 식별하는 시계열 ID입니다. 환경의 시계열 ID 속성과 일치합니다. 변경할 수 없으며 null이 아닙니다.
typeId

string

이는 이 인스턴스가 속한 유형을 나타냅니다. 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

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