Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
AWS IoT TwinMaker connettori dati
I connettori devono accedere all'archivio dati sottostante per risolvere le query inviate e restituire risultati o un errore.
Per informazioni sui connettori disponibili, sulle relative interfacce di richiesta e sulle interfacce di risposta, consulta i seguenti argomenti.
Per ulteriori informazioni sulle proprietà utilizzate nelle interfacce dei connettori, vedere l'GetPropertyValueHistoryazione API.
Nota
Alcuni connettori hanno due campi di data e ora nelle interfacce di richiesta e risposta per le proprietà dell'ora di inizio e dell'ora di fine. Entrambi startDateTime endDateTime utilizzano un numero lungo per rappresentare epoch second, che non è più supportato. Per mantenere la compatibilità con le versioni precedenti, inviamo comunque un valore di timestamp a quel campo, ma consigliamo di utilizzare endTime i campi startTime and coerenti con il nostro formato di timestamp API.
Argomenti
Connettore di inizializzazione dello schema
È possibile utilizzare l'inizializzatore dello schema nel tipo di componente o nel ciclo di vita dell'entità per recuperare il tipo di componente o le proprietà del componente dall'origine dati sottostante. L'inizializzatore dello schema importa automaticamente il tipo o le proprietà del componente senza chiamare esplicitamente un'azione API da configurare. properties
SchemaInitializer interfaccia di richiesta
{ "workspaceId": "string", "entityId": "string", "componentName": "string", "properties": { // property name as key, // value is of type PropertyRequest "string": "PropertyRequest" } }
Nota
La mappa delle proprietà in questa interfaccia di richiesta è unPropertyRequest. Per ulteriori informazioni, consulta PropertyRequest.
SchemaInitializer interfaccia di risposta
{ "properties": { // property name as key, // value is of type PropertyResponse "string": "PropertyResponse" } }
Nota
La mappa delle proprietà in questa interfaccia di richiesta è unPropertyResponse. Per ulteriori informazioni, consulta PropertyResponse.
DataReaderByEntity
DataReaderByEntity è un connettore del piano dati utilizzato per ottenere i valori delle serie temporali delle proprietà in un singolo componente.
Per informazioni sui tipi di proprietà, sulla sintassi e sul formato di questo connettore, vedi l'azione GetPropertyValueHistory API.
DataReaderByEntity interfaccia di richiesta
{ "startDateTime": long, // In epoch sec, deprecated "startTime": "string", // ISO-8601 timestamp format "endDateTime": long, // In epoch sec, deprecated "endTime": "string", // ISO-8601 timestamp format "properties": { // A map of properties as in the get-entity API response // property name as key, // value is of type PropertyResponse "string": "PropertyResponse" }, "workspaceId": "string", "selectedProperties": List:"string", "propertyFilters": List:PropertyFilter, "entityId": "string", "componentName": "string", "componentTypeId": "string", "interpolation": InterpolationParameters, "nextToken": "string", "maxResults": int, "orderByTime": "string" }
DataReaderByEntity interfaccia di risposta
{ "propertyValues": [ { "entityPropertyReference": EntityPropertyReference, // The same as EntityPropertyReference "values": [ { "timestamp": long, // Epoch sec, deprecated "time": "string", // ISO-8601 timestamp format "value": DataValue // The same as DataValue } ] } ], "nextToken": "string" }
DataReaderByComponentType
Per ottenere i valori delle serie temporali delle proprietà comuni che provengono dallo stesso tipo di componente, usa il connettore DataReaderByEntity del piano dati. Ad esempio, se definisci le proprietà delle serie temporali nel tipo di componente e hai più componenti che utilizzano quel tipo di componente, puoi interrogare tali proprietà su tutti i componenti in un determinato intervallo di tempo. Un caso d'uso comune è quando si desidera interrogare lo stato di allarme di più componenti per una visione globale delle entità.
Per informazioni sui tipi di proprietà, sulla sintassi e sul formato di questo connettore, vedi l'azione GetPropertyValueHistory API.
DataReaderByComponentType interfaccia di richiesta
{ "startDateTime": long, // In epoch sec, deprecated "startTime": "string", // ISO-8601 timestamp format "endDateTime": long, // In epoch sec, deprecated "endTime": "string", // ISO-8601 timestamp format "properties": { // A map of properties as in the get-entity API response // property name as key, // value is of type PropertyResponse "string": "PropertyResponse" }, "workspaceId": "string", "selectedProperties": List:"string", "propertyFilters": List:PropertyFilter, "componentTypeId": "string", "interpolation": InterpolationParameters, "nextToken": "string", "maxResults": int, "orderByTime": "string" }
DataReaderByComponentType interfaccia di risposta
{ "propertyValues": [ { "entityPropertyReference": EntityPropertyReference, // The same as EntityPropertyReference "entityId": "string", "componentName": "string", "values": [ { "timestamp": long, // Epoch sec, deprecated "time": "string", // ISO-8601 timestamp format "value": DataValue // The same as DataValue } ] } ], "nextToken": "string" }
DataReader
DataReader è un connettore per piano dati in grado di gestire sia i casi DataReaderByEntity di che DataReaderByComponentType.
Per informazioni sui tipi di proprietà, sulla sintassi e sul formato di questo connettore, vedi l'azione GetPropertyValueHistory API.
DataReader interfaccia di richiesta
EntityId e componentName sono facoltativi.
{ "startDateTime": long, // In epoch sec, deprecated "startTime": "string", // ISO-8601 timestamp format "endDateTime": long, // In epoch sec, deprecated "endTime": "string", // ISO-8601 timestamp format "properties": { // A map of properties as in the get-entity API response // property name as key, // value is of type PropertyRequest "string": "PropertyRequest" }, "workspaceId": "string", "selectedProperties": List:"string", "propertyFilters": List:PropertyFilter, "entityId": "string", "componentName": "string", "componentTypeId": "string", "interpolation": InterpolationParameters, "nextToken": "string", "maxResults": int, "orderByTime": "string" }
DataReader interfaccia di risposta
{ "propertyValues": [ { "entityPropertyReference": EntityPropertyReference, // The same as EntityPropertyReference "values": [ { "timestamp": long, // Epoch sec, deprecated "time": "string", // ISO-8601 timestamp format "value": DataValue // The same as DataValue } ] } ], "nextToken": "string" }
AttributePropertyValueReaderByEntity
AttributePropertyValueReaderByEntity è un connettore del piano dati che è possibile utilizzare per recuperare il valore delle proprietà statiche in una singola entità.
Per informazioni sui tipi di proprietà, sulla sintassi e sul formato di questo connettore, vedi l'azione GetPropertyValue API.
AttributePropertyValueReaderByEntity interfaccia di richiesta
{ "properties": { // property name as key, // value is of type PropertyResponse "string": "PropertyResponse" } "workspaceId": "string", "entityId": "string", "componentName": "string", "selectedProperties": List:"string", }
AttributePropertyValueReaderByEntity interfaccia di risposta
{ "propertyValues": { "string": { // property name as key "propertyReference": EntityPropertyReference, // The same as EntityPropertyReference "propertyValue": DataValue // The same as DataValue } }
DataWriter
DataWriter è un connettore del piano dati che è possibile utilizzare per riscrivere punti di dati di serie temporali nell'archivio dati sottostante per le proprietà di un singolo componente.
Per informazioni sui tipi di proprietà, sulla sintassi e sul formato di questo connettore, vedi l'azione BatchPutPropertyValues API.
DataWriter interfaccia di richiesta
{ "workspaceId": "string", "properties": { // entity id as key "String": { // property name as key, // value is of type PropertyResponse "string": PropertyResponse } }, "entries": [ { "entryId": "string", "entityPropertyReference": EntityPropertyReference, // The same as EntityPropertyReference "propertyValues": [ { "timestamp": long, // Epoch sec, deprecated "time": "string", // ISO-8601 timestamp format "value": DataValue // The same as DataValue } ] } ] }
DataWriter interfaccia di risposta
{ "errorEntries": [ { "errors": List:BatchPutPropertyError // The value is a list of type BatchPutPropertyError } ] }
Esempi
I seguenti esempi JSON sono esempi di sintassi di risposta e richiesta per più connettori.
-
SchemaInitializer:
Gli esempi seguenti mostrano l'inizializzatore dello schema nel ciclo di vita di un tipo di componente.
Richiesta:
{ "workspaceId": "myWorkspace", "properties": { "modelId": { "definition": { "dataType": { "type": "STRING" }, "isExternalId": true, "isFinal": true, "isImported": false, "isInherited": false, "isRequiredInEntity": true, "isStoredExternally": false, "isTimeSeries": false, "defaultValue": { "stringValue": "myModelId" } }, "value": { "stringValue": "myModelId" } }, "tableName": { "definition": { "dataType": { "type": "STRING" }, "isExternalId": false, "isFinal": false, "isImported": false, "isInherited": false, "isRequiredInEntity": false, "isStoredExternally": false, "isTimeSeries": false, "defaultValue": { "stringValue": "myTableName" } }, "value": { "stringValue": "myTableName" } } } }Risposta:
{ "properties": { "myProperty1": { "definition": { "dataType": { "type": "DOUBLE", "unitOfMeasure": "%" }, "configuration": { "myProperty1Id": "idValue" }, "isTimeSeries": true } }, "myProperty2": { "definition": { "dataType": { "type": "STRING" }, "isTimeSeries": false, "defaultValue": { "stringValue": "property2Value" } } } } } -
Inizializzatore dello schema nel ciclo di vita dell'entità:
Richiesta:
{ "workspaceId": "myWorkspace", "entityId": "myEntity", "componentName": "myComponent", "properties": { "assetId": { "definition": { "dataType": { "type": "STRING" }, "isExternalId": true, "isFinal": true, "isImported": false, "isInherited": false, "isRequiredInEntity": true, "isStoredExternally": false, "isTimeSeries": false }, "value": { "stringValue": "myAssetId" } }, "tableName": { "definition": { "dataType": { "type": "STRING" }, "isExternalId": false, "isFinal": false, "isImported": false, "isInherited": false, "isRequiredInEntity": false, "isStoredExternally": false, "isTimeSeries": false }, "value": { "stringValue": "myTableName" } } } }Risposta:
{ "properties": { "myProperty1": { "definition": { "dataType": { "type": "DOUBLE", "unitOfMeasure": "%" }, "configuration": { "myProperty1Id": "idValue" }, "isTimeSeries": true } }, "myProperty2": { "definition": { "dataType": { "type": "STRING" }, "isTimeSeries": false }, "value": { "stringValue": "property2Value" } } } } -
DataReaderByEntity e DataReader:
Richiesta:
{ "workspaceId": "myWorkspace", "entityId": "myEntity", "componentName": "myComponent", "selectedProperties": [ "Temperature", "Pressure" ], "startTime": "2022-04-07T04:04:42Z", "endTime": "2022-04-07T04:04:45Z", "maxResults": 4, "orderByTime": "ASCENDING", "properties": { "assetId": { "definition": { "dataType": { "type": "STRING" }, "isExternalId": true, "isFinal": true, "isImported": false, "isInherited": false, "isRequiredInEntity": true, "isStoredExternally": false, "isTimeSeries": false }, "value": { "stringValue": "myAssetId" } }, "Temperature": { "definition": { "configuration": { "temperatureId": "xyz123" }, "dataType": { "type": "DOUBLE", "unitOfMeasure": "DEGC" }, "isExternalId": false, "isFinal": false, "isImported": true, "isInherited": false, "isRequiredInEntity": false, "isStoredExternally": false, "isTimeSeries": true } }, "Pressure": { "definition": { "configuration": { "pressureId": "xyz456" }, "dataType": { "type": "DOUBLE", "unitOfMeasure": "MPA" }, "isExternalId": false, "isFinal": false, "isImported": true, "isInherited": false, "isRequiredInEntity": false, "isStoredExternally": false, "isTimeSeries": true } } } }Risposta:
{ "propertyValues": [ { "entityPropertyReference": { "entityId": "myEntity", "componentName": "myComponent", "propertyName": "Temperature" }, "values": [ { "time": "2022-04-07T04:04:42Z", "value": { "doubleValue": 588.168 } }, { "time": "2022-04-07T04:04:43Z", "value": { "doubleValue": 592.4224 } } ] } ], "nextToken": "qwertyuiop" } -
AttributePropertyValueReaderByEntity:
Richiesta:
{ "workspaceId": "myWorkspace", "entityId": "myEntity", "componentName": "myComponent", "selectedProperties": [ "manufacturer", ], "properties": { "assetId": { "definition": { "dataType": { "type": "STRING" }, "isExternalId": true, "isFinal": true, "isImported": false, "isInherited": false, "isRequiredInEntity": true, "isStoredExternally": false, "isTimeSeries": false }, "value": { "stringValue": "myAssetId" } }, "manufacturer": { "definition": { "dataType": { "type": "STRING" }, "configuration": { "manufacturerPropId": "M001" }, "isExternalId": false, "isFinal": false, "isImported": false, "isInherited": false, "isRequiredInEntity": false, "isStoredExternally": true, "isTimeSeries": false } } } }Risposta:
{ "propertyValues": { "manufacturer": { "propertyReference": { "propertyName": "manufacturer", "entityId": "myEntity", "componentName": "myComponent" }, "propertyValue": { "stringValue": "Amazon" } } } } -
DataWriter:
Richiesta:
{ "workspaceId": "myWorkspaceId", "properties": { "myEntity": { "Temperature": { "definition": { "configuration": { "temperatureId": "xyz123" }, "dataType": { "type": "DOUBLE", "unitOfMeasure": "DEGC" }, "isExternalId": false, "isFinal": false, "isImported": true, "isInherited": false, "isRequiredInEntity": false, "isStoredExternally": false, "isTimeSeries": true } } } }, "entries": [ { "entryId": "myEntity", "entityPropertyReference": { "entityId": "myEntity", "componentName": "myComponent", "propertyName": "Temperature" }, "propertyValues": [ { "timestamp": 1626201120, "value": { "doubleValue": 95.6958 } }, { "timestamp": 1626201132, "value": { "doubleValue": 80.6959 } } ] } ] }Risposta:
{ "errorEntries": [ { "errors": [ { "errorCode": "409", "errorMessage": "Conflict value at same timestamp", "entry": { "entryId": "myEntity", "entityPropertyReference": { "entityId": "myEntity", "componentName": "myComponent", "propertyName": "Temperature" }, "propertyValues": [ "time": "2022-04-07T04:04:42Z", "value": { "doubleValue": 95.6958 } ] } } ] } ] }
