Snapshot - Get
Hämta information om en ögonblicksbild. Ögonblicksbild är endast tillgänglig för källprenumerationen som tog den och målprenumerationer som ingår i applyScope i Snapshot – Take.
GET {Endpoint}/face/v1.0-preview/snapshots/{snapshotId}
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus.api.cognitive.microsoft.com). |
snapshot
|
path | True |
string uuid |
ID som refererar till en viss ögonblicksbild. |
Begärandehuvud
Name | Obligatorisk | Typ | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Ett lyckat anrop returnerar ögonblicksbildens information. |
|
Other Status Codes |
Felsvar. |
Säkerhet
Ocp-Apim-Subscription-Key
Typ:
apiKey
I:
header
Exempel
Get snapshot example
Exempelbegäran
GET {Endpoint}/face/v1.0-preview/snapshots/e58b3f08-1e8b-4165-81df-aa9858f233dc
Exempelsvar
{
"id": "e58b3f08-1e8b-4165-81df-aa9858f233dc",
"account": "/subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/TestRG/providers/Microsoft.CognitiveServices/accounts/FaceTest01",
"type": "FaceList",
"applyScope": [
"35230F59-AA9C-45E0-AB5E-C859BF1A5429",
"64084E07-9B7F-4A98-BEA4-9986D3A1EDEB"
],
"userData": "User-provided data attached to the snapshot.",
"createdTime": "2018-12-25T11:41:02.2331413Z",
"lastUpdateTime": "2018-12-25T11:51:27.8705696Z"
}
Definitioner
Name | Description |
---|---|
APIError |
Felinformation som returneras av API:et |
Error |
Feltext. |
Snapshot |
Ögonblicksbildsobjekt. Api:et för ögonblicksbilder flyttar dina data utanför den geo du väljer för din resurs till USA, västra, Europa, västra och Sydostasien. |
Snapshot |
Typ av källobjekt i ögonblicksbilden, som anges av prenumeranten som skapade ögonblicksbilden när ögonblicksbilden anropades – Ta. För närvarande stöds FaceList, PersonGroup, LargeFaceList och LargePersonGroup. |
APIError
Felinformation som returneras av API:et
Name | Typ | Description |
---|---|---|
error |
Feltext. |
Error
Feltext.
Name | Typ | Description |
---|---|---|
code |
string |
|
message |
string |
Snapshot
Ögonblicksbildsobjekt. Api:et för ögonblicksbilder flyttar dina data utanför den geo du väljer för din resurs till USA, västra, Europa, västra och Sydostasien.
Name | Typ | Description |
---|---|---|
account |
string |
Ansiktskonto-ID för Azure Cognitive Service för prenumeranten som skapade ögonblicksbilden av Snapshot – Take. |
applyScope |
string[] |
Matris med målprenumerations-ID:t för ögonblicksbilden, som anges av den användare som skapade ögonblicksbilden när han eller hon anropade Snapshot – Take. För varje ögonblicksbild kan endast prenumerationer som ingår i applyScope of Snapshot – Take tillämpa den. |
createdTime |
string |
En kombinerad DATUM- och tidssträng för UTC som beskriver den skapade tiden för ögonblicksbilden. T.ex. 2018-12-25T11:41:02.2331413Z. |
id |
string |
Ögonblicksbilds-ID. |
lastUpdateTime |
string |
En kombinerad DATUM- och tidssträng för UTC som beskriver den senaste gången ögonblicksbilden skapades eller uppdaterades av Snapshot – Update. T.ex. 2018-12-25T11:51:27.8705696Z. |
type |
Typ av källobjekt i ögonblicksbilden, som anges av prenumeranten som skapade ögonblicksbilden när ögonblicksbilden anropades – Ta. För närvarande stöds FaceList, PersonGroup, LargeFaceList och LargePersonGroup. |
|
userData |
string |
Användardefinierade data om ögonblicksbilden för valfritt ändamål. Längden får inte överstiga 16 kB. |
SnapshotObjectType
Typ av källobjekt i ögonblicksbilden, som anges av prenumeranten som skapade ögonblicksbilden när ögonblicksbilden anropades – Ta. För närvarande stöds FaceList, PersonGroup, LargeFaceList och LargePersonGroup.
Name | Typ | Description |
---|---|---|
FaceList |
string |
|
LargeFaceList |
string |
|
LargePersonGroup |
string |
|
PersonGroup |
string |