Endpoints - Suspend

Ссылка

Service:: Azure AI Services

API Version:: 2023-12-01-preview

Приостанавливает конечную точку, определяемую указанным идентификатором.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например). https://eastus.api.cognitive.microsoft.com
id	path	True	string uuid	Идентификатор ресурса, который должен быть UUID.
api-version	query	True	string	Версия API, используемая для данной операции.

Заголовок запроса

Имя Обязательно Тип Описание

Ocp-Apim-Subscription-Key

True

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string	Укажите здесь ключ ресурса службы "Речь".
Operation-Id		string	Идентификатор монитора состояния для операции. Если заголовок Operation-Id соответствует существующей операции и запрос не идентичен предыдущему запросу, он завершится ошибкой с ошибкой 400 Bad Request. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`

string

Укажите здесь ключ ресурса службы "Речь".

Operation-Id

string

Идентификатор монитора состояния для операции. Если заголовок Operation-Id соответствует существующей операции и запрос не идентичен предыдущему запросу, он завершится ошибкой с ошибкой 400 Bad Request.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Ответы

Имя	Тип	Описание
202 Accepted	Endpoint	Принято Headers Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Произошла ошибка.

Имя

Тип

Описание

202 Accepted

Endpoint

Принято

Headers

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

Произошла ошибка.

Безопасность

Ocp-Apim-Subscription-Key

Укажите здесь ключ ресурса службы "Речь".

Type: apiKey
In: header

Примеры

Suspend an endpoint

Sample Request

HTTP

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

Sample Response

Status code:: 202

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/23f53763-5f21-442a-a944-18f72cdcaa4f?api-version=2023-12-01-preview
Operation-Id: 23f53763-5f21-442a-a944-18f72cdcaa4f

Response Body

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

Определения

Имя	Описание
Endpoint	Объект Endpoint
EndpointKind	Тип конечной точки
EndpointProperties	Свойства конечной точки
Error	Ошибка верхнего уровня соответствует рекомендациям по REST API Microsoft Azure, которые доступны по адресу https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Он содержит ошибку верхнего уровня с кодом ошибки, сообщением, сведениями, целевым объектом и внутренней ошибкой с более подробными сведениями.
ErrorCode	Код ошибки верхнего уровня
ErrorResponse	Ответ об ошибке соответствует рекомендациям по REST API Microsoft Azure, которые доступны по адресу https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Внутренняя ошибка соответствует рекомендациям по REST API Microsoft Azure, которые доступны по адресу https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Содержит код ошибки обязательных свойств, сообщение и необязательные свойства целевой объект, внутреннюю ошибку (это может быть вложено).
Status	Состояние ресурса.

Endpoint

Объект Endpoint

Имя	Тип	Описание
createdDateTime	string	Метка времени создания объекта. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).
description	string	Описание конечной точки
displayName	string	имя конечной точки;
id	string	Идентификатор конечной точки
lastActionDateTime	string	Метка времени ввода текущего состояния. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).
modelId	string	Идентификатор ресурса
projectId	string	Идентификатор ресурса
properties	EndpointProperties	Свойства конечной точки
status	Status	Состояние ресурса.

EndpointKind

Тип конечной точки

Имя	Тип	Описание
FastResume	string
HighPerformance	string

EndpointProperties

Свойства конечной точки

Имя	Тип	Описание
kind	EndpointKind	Тип конечной точки

Error

Ошибка верхнего уровня соответствует рекомендациям по REST API Microsoft Azure, которые доступны по адресу https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Он содержит ошибку верхнего уровня с кодом ошибки, сообщением, сведениями, целевым объектом и внутренней ошибкой с более подробными сведениями.

Имя	Тип	Описание
code	ErrorCode	Код ошибки верхнего уровня
details	Error[]	Дополнительные сведения об ошибке и (или) ожидаемых политиках.
innererror	InnerError	Внутренняя ошибка соответствует рекомендациям по REST API Microsoft Azure, которые доступны по адресу https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Содержит код ошибки обязательных свойств, сообщение и необязательные свойства целевой объект, внутреннюю ошибку (это может быть вложено).
message	string	Сообщение об ошибке верхнего уровня.
target	string	Источник ошибки. Например, в случае недопустимой модели это будет "model" или "model id".

ErrorCode

Код ошибки верхнего уровня

Имя	Тип	Описание
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

Ответ об ошибке соответствует рекомендациям по REST API Microsoft Azure, которые доступны по адресу https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Имя	Тип	Описание
error	Error	Ошибка верхнего уровня соответствует рекомендациям по REST API Microsoft Azure, которые доступны по адресу https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Он содержит ошибку верхнего уровня с кодом ошибки, сообщением, сведениями, целевым объектом и внутренней ошибкой с более подробными сведениями.

InnerError

Внутренняя ошибка соответствует рекомендациям по REST API Microsoft Azure, которые доступны по адресу https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Содержит код ошибки обязательных свойств, сообщение и необязательные свойства целевой объект, внутреннюю ошибку (это может быть вложено).

Имя	Тип	Описание
code	string	Подробный код ошибки для диагностики.
innererror	InnerError	Внутренняя ошибка соответствует рекомендациям по REST API Microsoft Azure, которые доступны по адресу https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Содержит код ошибки обязательных свойств, сообщение и необязательные свойства целевой объект, внутреннюю ошибку (это может быть вложено).
message	string	Подробное сообщение об ошибке.
target	string	Источник ошибки. Например, в случае недопустимой модели это будет "model" или "model id".

Status

Состояние ресурса.

Имя	Тип	Описание
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string

Поделиться через

Endpoints - Suspend

Параметры URI

Заголовок запроса

Ответы

Безопасность

Ocp-Apim-Subscription-Key

Примеры

Suspend an endpoint

Sample Request

Sample Response

Определения

Endpoint

EndpointKind

EndpointProperties

Error

ErrorCode

ErrorResponse

InnerError

Status

Дополнительные ресурсы