Endpoints - Suspend

  • Reference
Služba:
Azure AI Services
Verze rozhraní API:
2024-02-01-preview

Pozastaví koncový bod identifikovaný podle daného ID.

POST {endpoint}/customvoice/endpoints/{id}:suspend?api-version=2024-02-01-preview

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
endpoint
 path True

string

Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://eastus.api.cognitive.microsoft.com).
id
 path True

string

uuid

ID prostředku, které by mělo být UUID.
api-version
 query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name Vyžadováno Typ Description
Ocp-Apim-Subscription-Key True

string

Tady zadejte svůj klíč prostředku služby Speech.
Operation-Id

string

ID monitorování stavu operace Pokud hlavička Operation-Id odpovídá existující operaci a požadavek není shodný s předchozím požadavkem, selže s chybnou žádostí 400.

Vzor regulárního výrazu: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Odpovědi

Name Typ Description
202 Accepted

Endpoint

Přijato

Hlavičky

  • Operation-Id: string
  • Operation-Location: string
Other Status Codes

ErrorResponse

Došlo k chybě.

Hlavičky

x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Tady zadejte svůj klíč prostředku služby Speech.

Typ: apiKey
V: header

Příklady

Suspend an endpoint

Ukázkový požadavek

POST {endpoint}/customvoice/endpoints/9f50c644-2121-40e9-9ea7-544e48bfe3cb:suspend?api-version=2024-02-01-preview

Ukázková odpověď

Stavový kód:
202 
Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/23f53763-5f21-442a-a944-18f72cdcaa4f?api-version=2024-02-01-preview
Operation-Id: 23f53763-5f21-442a-a944-18f72cdcaa4f
{
  "id": "9f50c644-2121-40e9-9ea7-544e48bfe3cb",
  "description": "Endpoint for Jessica voice",
  "projectId": "Jessica",
  "modelId": "Jessica",
  "properties": {
    "kind": "HighPerformance"
  },
  "status": "Disabling",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Definice

Name Description
Endpoint

Objekt koncového bodu
EndpointKind

Druh koncového bodu
EndpointProperties

Vlastnosti koncového bodu
Error

Chyba nejvyšší úrovně se řídí pokyny k rozhraní Microsoft Azure REST API, které jsou k dispozici na adrese https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Obsahuje chybu nejvyšší úrovně s kódem chyby, zprávou, podrobnostmi, cílem a vnitřní chybou s popisnějšími podrobnostmi.
ErrorCode

Kód chyby nejvyšší úrovně
ErrorResponse

Odpověď na chybu se řídí pokyny k rozhraní Microsoft Azure REST API, které jsou k dispozici na adrese https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError

Vnitřní chyba se řídí pokyny k rozhraní Microsoft Azure REST API, které jsou k dispozici na adrese https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Obsahuje kód chyby požadovaných vlastností, zprávu a cíl volitelných vlastností, vnitřní chybu (může být vnořená).
Status

Stav prostředku.

Endpoint

Objekt koncového bodu

Name Typ Description
createdDateTime

string

Časové razítko, kdy byl objekt vytvořen. Časové razítko je kódováno jako formát data a času ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", viz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description

string

Popis koncového bodu
displayName

string

Název koncového bodu
id

string

ID koncového bodu
lastActionDateTime

string

Časové razítko, kdy byl zadán aktuální stav. Časové razítko je kódováno jako formát data a času ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", viz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
modelId

string

ID prostředku
projectId

string

ID prostředku
properties

EndpointProperties

Vlastnosti koncového bodu
status

Status

Stav prostředku.

EndpointKind

Druh koncového bodu

Name Typ Description
FastResume

string

HighPerformance

string

EndpointProperties

Vlastnosti koncového bodu

Name Typ Description
kind

EndpointKind

Druh koncového bodu

Error

Chyba nejvyšší úrovně se řídí pokyny k rozhraní Microsoft Azure REST API, které jsou k dispozici na adrese https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Obsahuje chybu nejvyšší úrovně s kódem chyby, zprávou, podrobnostmi, cílem a vnitřní chybou s popisnějšími podrobnostmi.

Name Typ Description
code

ErrorCode

Kód chyby nejvyšší úrovně
details

Error[]

Další podrobnosti podpory týkající se chyby nebo očekávaných zásad
innererror

InnerError

Vnitřní chyba se řídí pokyny k rozhraní Microsoft Azure REST API, které jsou k dispozici na adrese https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Obsahuje kód chyby požadovaných vlastností, zprávu a cíl volitelných vlastností, vnitřní chybu (může být vnořená).
message

string

Chybová zpráva nejvyšší úrovně.
target

string

Zdroj chyby. Například v případě neplatného modelu by to bylo "model" nebo "id modelu".

ErrorCode

Kód chyby nejvyšší úrovně

Name Typ Description
BadArgument

string

BadRequest

string

Forbidden

string

InternalServerError

string

NotFound

string

ServiceUnavailable

string

TooManyRequests

string

Unauthorized

string

UnsupportedMediaType

string

ErrorResponse

Odpověď na chybu se řídí pokyny k rozhraní Microsoft Azure REST API, které jsou k dispozici na adrese https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name Typ Description
error

Error

Chyba nejvyšší úrovně se řídí pokyny k rozhraní Microsoft Azure REST API, které jsou k dispozici na adrese https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Obsahuje chybu nejvyšší úrovně s kódem chyby, zprávou, podrobnostmi, cílem a vnitřní chybou s popisnějšími podrobnostmi.

InnerError

Vnitřní chyba se řídí pokyny k rozhraní Microsoft Azure REST API, které jsou k dispozici na adrese https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Obsahuje kód chyby požadovaných vlastností, zprávu a cíl volitelných vlastností, vnitřní chybu (může být vnořená).

Name Typ Description
code

string

Podrobný kód chyby, který vám pomůže s diagnostikou
innererror

InnerError

Vnitřní chyba se řídí pokyny k rozhraní Microsoft Azure REST API, které jsou k dispozici na adrese https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Obsahuje kód chyby požadovaných vlastností, zprávu a cíl volitelných vlastností, vnitřní chybu (může být vnořená).
message

string

Podrobná chybová zpráva
target

string

Zdroj chyby. Například v případě neplatného modelu by to bylo "model" nebo "id modelu".

Status

Stav prostředku.

Name Typ Description
Disabled

string

Disabling

string

Failed

string

NotStarted

string

Running

string

Succeeded

string