Endpoints - Suspend

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-02-01-preview

Zawiesza punkt końcowy zidentyfikowany przez dany identyfikator.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://eastus.api.cognitive.microsoft.com).
id	path	True	string uuid	Identyfikator zasobu, który powinien być identyfikatorem UUID.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string	Tutaj podaj klucz zasobu usługi Mowa.
Operation-Id		string	Identyfikator monitora stanu dla operacji. Jeśli nagłówek Operation-Id pasuje do istniejącej operacji, a żądanie nie jest identyczne z poprzednim żądaniem, zakończy się niepowodzeniem z błędem 400 Nieprawidłowe żądanie. Wzorzec wyrażenia regularnego: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted	Endpoint	Zaakceptowano Nagłówki Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Wystąpił błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Tutaj podaj klucz zasobu usługi Mowa.

Typ: apiKey
W: header

Przykłady

Suspend an endpoint

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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"
}

Definicje

Nazwa	Opis
Endpoint	Obiekt punktu końcowego
EndpointKind	Rodzaj punktu końcowego
EndpointProperties	Właściwości punktu końcowego
Error	Błąd najwyższego poziomu jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera to błąd najwyższego poziomu z kodem błędu, komunikatem, szczegółami, elementem docelowym i wewnętrznym błędem z bardziej opisowymi szczegółami.
ErrorCode	Kod błędu najwyższego poziomu
ErrorResponse	Odpowiedź na błąd jest zgodna z wytycznymi interfejsu API REST platformy Microsoft Azure, które są dostępne pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Błąd wewnętrzny jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on wymagany kod błędu właściwości, komunikat i obiekt docelowy właściwości opcjonalnych, błąd wewnętrzny (można go zagnieżdżać).
Status	Stan zasobu.

Endpoint

Obiekt punktu końcowego

Nazwa	Typ	Opis
createdDateTime	string	Sygnatura czasowa utworzenia obiektu. Znacznik czasu jest zakodowany jako format daty i godziny ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Opis punktu końcowego
displayName	string	Nazwa punktu końcowego
id	string	Identyfikator punktu końcowego
lastActionDateTime	string	Sygnatura czasowa po wprowadzeniu bieżącego stanu. Znacznik czasu jest zakodowany jako format daty i godziny ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
modelId	string	Identyfikator zasobu
projectId	string	Identyfikator zasobu
properties	EndpointProperties	Właściwości punktu końcowego
status	Status	Stan zasobu.

EndpointKind

Rodzaj punktu końcowego

Nazwa	Typ	Opis
FastResume	string
HighPerformance	string

EndpointProperties

Właściwości punktu końcowego

Nazwa	Typ	Opis
kind	EndpointKind	Rodzaj punktu końcowego

Error

Błąd najwyższego poziomu jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera to błąd najwyższego poziomu z kodem błędu, komunikatem, szczegółami, elementem docelowym i wewnętrznym błędem z bardziej opisowymi szczegółami.

Nazwa	Typ	Opis
code	ErrorCode	Kod błędu najwyższego poziomu
details	Error[]	Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad.
innererror	InnerError	Błąd wewnętrzny jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on wymagany kod błędu właściwości, komunikat i obiekt docelowy właściwości opcjonalnych, błąd wewnętrzny (można go zagnieżdżać).
message	string	Komunikat o błędzie najwyższego poziomu.
target	string	Źródło błędu. Na przykład będzie to "model" lub "identyfikator modelu" w przypadku nieprawidłowego modelu.

ErrorCode

Kod błędu najwyższego poziomu

Nazwa	Typ	Opis
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

Odpowiedź na błąd jest zgodna z wytycznymi interfejsu API REST platformy Microsoft Azure, które są dostępne pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nazwa	Typ	Opis
error	Error	Błąd najwyższego poziomu jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera to błąd najwyższego poziomu z kodem błędu, komunikatem, szczegółami, elementem docelowym i wewnętrznym błędem z bardziej opisowymi szczegółami.

InnerError

Błąd wewnętrzny jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on wymagany kod błędu właściwości, komunikat i obiekt docelowy właściwości opcjonalnych, błąd wewnętrzny (można go zagnieżdżać).

Nazwa	Typ	Opis
code	string	Szczegółowy kod błędu pomocny w diagnostyce.
innererror	InnerError	Błąd wewnętrzny jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on wymagany kod błędu właściwości, komunikat i obiekt docelowy właściwości opcjonalnych, błąd wewnętrzny (można go zagnieżdżać).
message	string	Szczegółowy komunikat o błędzie.
target	string	Źródło błędu. Na przykład będzie to "model" lub "identyfikator modelu" w przypadku nieprawidłowego modelu.

Status

Stan zasobu.

Nazwa	Typ	Opis
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string