Endpoints - Suspend

服務:: Azure AI Services

API 版本:: 2024-02-01-preview

暫停指定標識碼所識別的端點。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點（通訊協定和主機名，例如：https://eastus.api.cognitive.microsoft.com）。
id	path	True	string (uuid)	資源標識碼，應該是 UUID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string	在這裡提供您的語音資源金鑰。
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	作業的狀態監視器標識碼。如果 Operation-Id 標頭符合現有的作業，且要求與先前的要求不相同，則會失敗併產生 400 錯誤的要求。

回應

名稱	類型	Description
202 Accepted	Endpoint	接受標題 Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	發生錯誤。標題 x-ms-error-code: string

名稱

類型

Description

202 Accepted

Endpoint

接受

標題

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

發生錯誤。

標題

x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

在這裡提供您的語音資源金鑰。

類型: apiKey
位於: header

範例

Suspend an endpoint

範例要求

HTTP

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

範例回覆

狀態碼:: 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"
}

定義

名稱	Description
Endpoint	Endpoint 物件
EndpointKind	端點種類
EndpointProperties	端點屬性
Error	最上層錯誤遵循 Microsoft Azure REST API 指導方針，可在 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors取得。這包含具有錯誤碼、訊息、詳細數據、目標和具有更描述性詳細數據的內部錯誤的最上層錯誤。
ErrorCode	最上層錯誤碼
ErrorResponse	錯誤回應遵循 Microsoft Azure REST API 指導方針，可在 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors取得。
InnerError	內部錯誤遵循 Microsoft Azure REST API 指導方針，https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors提供。這包括必要的屬性錯誤碼、訊息和選擇性屬性目標、內部錯誤（這可以是巢狀的）。
Status	資源的狀態。

Endpoint

Object

Endpoint 物件

名稱	類型	Description
createdDateTime	string (date-time)	物件建立時的時間戳。時間戳會編碼為 ISO 8601 日期和時間格式（“YYYY-MM-DDThh：mm：ssZ”，請參閱 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations）。
description	string	端點描述
displayName	string minLength: 1	端點名稱
id	string (uuid)	端點標識碼
lastActionDateTime	string (date-time)	輸入目前狀態時的時間戳。時間戳會編碼為 ISO 8601 日期和時間格式（“YYYY-MM-DDThh：mm：ssZ”，請參閱 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]$	資源標識碼
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	資源標識碼
properties	EndpointProperties	端點屬性
status	Status	資源的狀態。

EndpointKind

列舉型別

端點種類

值	Description
HighPerformance
FastResume

EndpointProperties

Object

端點屬性

名稱	類型	Description
kind	EndpointKind	端點種類

Error

Object

最上層錯誤遵循 Microsoft Azure REST API 指導方針，可在 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors取得。這包含具有錯誤碼、訊息、詳細數據、目標和具有更描述性詳細數據的內部錯誤的最上層錯誤。

名稱	類型	Description
code	ErrorCode	最上層錯誤碼
details	Error[]	有關錯誤和/或預期原則的其他支持詳細數據。
innererror	InnerError	內部錯誤遵循 Microsoft Azure REST API 指導方針，https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors提供。這包括必要的屬性錯誤碼、訊息和選擇性屬性目標、內部錯誤（這可以是巢狀的）。
message	string	最上層錯誤訊息。
target	string	錯誤的來源。例如，如果是無效的模型，則為 “model” 或 “model id”。

ErrorCode

列舉型別

最上層錯誤碼

值	Description
BadRequest
BadArgument
Unauthorized
Forbidden
NotFound
UnsupportedMediaType
TooManyRequests
InternalServerError
ServiceUnavailable

ErrorResponse

Object

錯誤回應遵循 Microsoft Azure REST API 指導方針，可在 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors取得。

名稱	類型	Description
error	Error	最上層錯誤遵循 Microsoft Azure REST API 指導方針，可在 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors取得。這包含具有錯誤碼、訊息、詳細數據、目標和具有更描述性詳細數據的內部錯誤的最上層錯誤。

InnerError

Object

內部錯誤遵循 Microsoft Azure REST API 指導方針，https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors提供。這包括必要的屬性錯誤碼、訊息和選擇性屬性目標、內部錯誤（這可以是巢狀的）。

名稱	類型	Description
code	string	詳細的錯誤碼可協助診斷。
innererror	InnerError	內部錯誤遵循 Microsoft Azure REST API 指導方針，https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors提供。這包括必要的屬性錯誤碼、訊息和選擇性屬性目標、內部錯誤（這可以是巢狀的）。
message	string	詳細的錯誤訊息。
target	string	錯誤的來源。例如，如果是無效的模型，則為 “model” 或 “model id”。

Status

列舉型別

資源的狀態。

值	Description
NotStarted
Running
Succeeded
Failed
Disabling
Disabled

共用方式為

Endpoints - Suspend

URI 參數

要求標頭

回應

安全性

Ocp-Apim-Subscription-Key

範例

Suspend an endpoint

範例要求

範例回覆

定義

Endpoint

EndpointKind

EndpointProperties

Error

ErrorCode

ErrorResponse

InnerError

Status