Condividi tramite

Get Health Status - Get Health Status

Servizio:
Azure AI Services
Versione API:
v3.0

Restituisce l'integrità complessiva del servizio e, facoltativamente, dei diversi sottocomponenti.

GET {Endpoint}/speechtotext/v3.0/healthstatus

Parametri dell'URI

Nome In Necessario Tipo Descrizione
Endpoint
 path True

string

Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://westus.api.cognitive.microsoft.com).

Risposte

Nome Tipo Descrizione
200 OK

ServiceHealth

Va bene
Other Status Codes

Error

Si è verificato un errore.

Sicurezza

Ocp-Apim-Subscription-Key

Specificare la chiave dell'account di Servizi cognitivi qui.

Tipo: apiKey
In: header

Authorization

Fornire un token di accesso dal token JWT restituito dal servizio token di sicurezza di questa area. Assicurarsi di aggiungere l'ambito di gestione al token aggiungendo la stringa di query seguente all'URL sts: ?scope=speechservicesmanagement

Tipo: apiKey
In: header

Esempio

Gets the health status

Esempio di richiesta

GET https://westus.api.cognitive.microsoft.com//speechtotext/v3.0/healthstatus

Risposta di esempio

Codice di stato:
200 
{
  "status": "Healthy",
  "components": [
    {
      "name": "Database",
      "type": "SpeechServicesDbContext",
      "status": "Healthy"
    }
  ]
}

Definizioni

Nome Descrizione
Component

Componente
DetailedErrorCode

DetailedErrorCode
Error

Errore
ErrorCode

Codice Errore
HealthStatus

Stato di Salute
InnerError

InnerError
ServiceHealth

Salute del Servizio

Component

Object

Componente

Nome Tipo Descrizione
message

string

Messaggi aggiuntivi sull'integrità del servizio corrente.
name

string

Nome del componente.
status

HealthStatus

Stato di Salute
Stato di integrità del servizio.
type

string

Tipo di questo componente.

DetailedErrorCode

Enumerazione

DetailedErrorCode

Valore Descrizione
InvalidParameterValue

Valore del parametro non valido.
InvalidRequestBodyFormat

Formato del corpo della richiesta non valido.
EmptyRequest

Richiesta vuota.
MissingInputRecords

Record di input mancanti.
InvalidDocument

Documento non valido.
ModelVersionIncorrect

Versione del modello non corretta.
InvalidDocumentBatch

Batch di documenti non valido.
UnsupportedLanguageCode

Codice del linguaggio non supportato.
DataImportFailed

Importazione dei dati non riuscita.
InUseViolation

In violazione dell'uso.
InvalidLocale

Impostazioni locali non valide.
InvalidBaseModel

Modello di base non valido.
InvalidAdaptationMapping

Mapping di adattamento non valido.
InvalidDataset

Set di dati non valido.
InvalidTest

Test non valido.
FailedDataset

Set di dati non riuscito.
InvalidModel

Modello non valido.
InvalidTranscription

Trascrizione non valida.
InvalidPayload

Payload non valido.
InvalidParameter

Parametro non valido.
EndpointWithoutLogging

Endpoint senza registrazione.
InvalidPermissions

Autorizzazioni non valide.
InvalidPrerequisite

Prerequisito non valido.
InvalidProductId

ID prodotto non valido.
InvalidSubscription

Sottoscrizione non valida.
InvalidProject

Progetto non valido.
InvalidProjectKind

Tipo di progetto non valido.
InvalidRecordingsUri

URI delle registrazioni non valido.
OnlyOneOfUrlsOrContainerOrDataset

Solo uno degli URL o del contenitore o del set di dati.
ExceededNumberOfRecordingsUris

È stato superato il numero di URI delle registrazioni.
ModelMismatch

Mancata corrispondenza del modello.
ProjectGenderMismatch

Mancata corrispondenza di genere del progetto.
ModelDeprecated

Modello deprecato.
ModelExists

Il modello esiste.
ModelNotDeployable

Modello non distribuibile.
EndpointNotUpdatable

Endpoint non aggiornabile.
SingleDefaultEndpoint

Singolo endpoint predefinito.
EndpointCannotBeDefault

L'endpoint non può essere predefinito.
InvalidModelUri

URI del modello non valido.
SubscriptionNotFound

Sottoscrizione non trovata.
QuotaViolation

Violazione della quota.
UnsupportedDelta

Delta non supportato.
UnsupportedFilter

Filtro non supportato.
UnsupportedPagination

Impaginazione non supportata.
UnsupportedDynamicConfiguration

Configurazione dinamica non supportata.
UnsupportedOrderBy

Ordine non supportato per.
NoUtf8WithBom

Nessun utf8 con bom.
ModelDeploymentNotCompleteState

Lo stato della distribuzione del modello non è completo.
SkuLimitsExist

Esistono limiti di SKU.
DeployingFailedModel

Distribuzione del modello non riuscito.
UnsupportedTimeRange

Intervallo di tempo non supportato.
InvalidLogDate

Data del log non valida.
InvalidLogId

ID log non valido.
InvalidLogStartTime

Ora di inizio del log non valida.
InvalidLogEndTime

Ora di fine del log non valida.
InvalidTopForLogs

Top non valido per i log.
InvalidSkipTokenForLogs

Token skip non valido per i log.
DeleteNotAllowed

Eliminazione non consentita.
Forbidden

Vietato.
DeployNotAllowed

Distribuzione non consentita.
UnexpectedError

Errore imprevisto.
InvalidCollection

Raccolta non valida.
InvalidCallbackUri

URI di callback non valido.
InvalidSasValidityDuration

Durata della validità della firma di accesso condiviso non valida.
InaccessibleCustomerStorage

Archiviazione dei clienti inaccessibile.
UnsupportedClassBasedAdaptation

Adattamento basato su classe non supportato.
InvalidWebHookEventKind

Tipo di evento web hook non valido.
InvalidTimeToLive

Tempo di vita non valido.

Error

Object

Errore

Nome Tipo Descrizione
code

ErrorCode

Codice Errore
Codici di errore di alto livello.
details

Error[]

Ulteriori dettagli di supporto relativi all'errore e/o ai criteri previsti.
innerError

InnerError

InnerError
Nuovo formato di errore interno conforme alle linee guida dell'API Servizi cognitivi, disponibile in https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene le proprietà obbligatorie ErrorCode, message e proprietà facoltative di destinazione, dettagli(coppia chiave-valore), errore interno (che può essere annidato).
message

string

Messaggio di errore di alto livello.
target

string

Indica l'origine dell'errore. Ad esempio, si tratta di "documenti" o "ID documento" in caso di documento non valido.

ErrorCode

Enumerazione

Codice Errore

Valore Descrizione
InvalidRequest

Rappresentazione del codice di errore della richiesta non valido.
InvalidArgument

Rappresentazione del codice di errore dell'argomento non valido.
InternalServerError

Rappresentazione del codice di errore interno del server.
ServiceUnavailable

Rappresentazione del codice di errore del servizio non disponibile.
NotFound

Rappresentazione del codice di errore non trovato.
PipelineError

Rappresentazione del codice di errore della pipeline.
Conflict

Rappresentazione del codice di errore del conflitto.
InternalCommunicationFailed

Rappresentazione del codice di errore della comunicazione interna non riuscita.
Forbidden

Rappresentazione del codice di errore non consentito.
NotAllowed

Rappresentazione del codice di errore non consentito.
Unauthorized

Rappresentazione del codice di errore non autorizzato.
UnsupportedMediaType

Rappresentazione del codice di errore del tipo di supporto non supportato.
TooManyRequests

Rappresentazione del codice di errore troppe richieste.
UnprocessableEntity

Rappresentazione del codice di errore dell'entità non elaborabile.

HealthStatus

Enumerazione

Stato di Salute

Valore Descrizione
Unhealthy

Malsano.
Degraded

Danneggiato.
Healthy

Integro.

InnerError

Object

InnerError

Nome Tipo Descrizione
code

DetailedErrorCode

DetailedErrorCode
Enumerazione dettagliata del codice di errore.
details

object

Ulteriori dettagli di supporto relativi all'errore e/o ai criteri previsti.
innerError

InnerError

InnerError
Nuovo formato di errore interno conforme alle linee guida dell'API Servizi cognitivi, disponibile in https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene le proprietà obbligatorie ErrorCode, message e proprietà facoltative di destinazione, dettagli(coppia chiave-valore), errore interno (che può essere annidato).
message

string

Messaggio di errore di alto livello.
target

string

Indica l'origine dell'errore. Ad esempio, si tratta di "documenti" o "ID documento" in caso di documento non valido.

ServiceHealth

Object

Salute del Servizio

Nome Tipo Descrizione
components

Component[]

Sottocomponenti facoltativi di questo servizio e il relativo stato.
message

string

Messaggi aggiuntivi sull'integrità del servizio corrente.
status

HealthStatus

Stato di Salute
Stato di integrità del servizio.