Sdílet prostřednictvím

Endpoints - Suspend

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

Pozastaví koncový bod identifikovaný daným 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

minLength: 1

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

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

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

ID monitorování stavu operace. Pokud hlavička Operation-Id odpovídá existující operaci a požadavek není stejný jako předchozí požadavek, selže s chybou 400 Chybný požadavek.

Odpovědi

Name Typ Description
202 Accepted

Endpoint

Přijal

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

Sem 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 rozhraní MICROSOFT Azure REST API, které jsou k dispozici na 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 rozhraní MICROSOFT Azure REST API, které jsou k dispozici v https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError

Vnitřní chyba se řídí pokyny rozhraní MICROSOFT Azure REST API, které jsou k dispozici v 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 (jde vnořit).
Status

Stav prostředku

Endpoint

Objekt

Objekt koncového bodu

Name Typ Description
createdDateTime

string (date-time)

Časové razítko při vytvoření objektu. Časové razítko je kódované jako formát data a času ISO 8601 ("RRRR-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

minLength: 1

Název koncového bodu
id

string (uuid)

ID koncového bodu
lastActionDateTime

string (date-time)

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

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

ID prostředku
projectId

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

ID prostředku
properties

EndpointProperties

Vlastnosti koncového bodu
status

Status

Stav prostředku

EndpointKind

Výčet

Druh koncového bodu

Hodnota Description
FastResume
HighPerformance

EndpointProperties

Objekt

Vlastnosti koncového bodu

Name Typ Description
kind

EndpointKind

Druh koncového bodu

Error

Objekt

Chyba nejvyšší úrovně se řídí pokyny rozhraní MICROSOFT Azure REST API, které jsou k dispozici na 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 chyb a/nebo očekávaných zásad
innererror

InnerError

Vnitřní chyba se řídí pokyny rozhraní MICROSOFT Azure REST API, které jsou k dispozici v 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 (jde vnořit).
message

string

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

string

Zdroj chyby. Například v případě neplatného modelu by to byl model nebo ID modelu.

ErrorCode

Výčet

Kód chyby nejvyšší úrovně

Hodnota Description
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Objekt

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

Name Typ Description
error

Error

Chyba nejvyšší úrovně se řídí pokyny rozhraní MICROSOFT Azure REST API, které jsou k dispozici na 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

Objekt

Vnitřní chyba se řídí pokyny rozhraní MICROSOFT Azure REST API, které jsou k dispozici v 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 (jde vnořit).

Name Typ Description
code

string

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

InnerError

Vnitřní chyba se řídí pokyny rozhraní MICROSOFT Azure REST API, které jsou k dispozici v 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 (jde vnořit).
message

string

Podrobná chybová zpráva
target

string

Zdroj chyby. Například v případě neplatného modelu by to byl model nebo ID modelu.

Status

Výčet

Stav prostředku

Hodnota Description
Disabled
Disabling
Failed
NotStarted
Running
Succeeded