Service Health - Get

Service:

Azure AI Services

API-versie:

v3.1

Retourneert de algehele status van de service en optioneel van de verschillende subonderdelen.

GET {endpoint}/speechtotext/v3.1/healthstatus

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus.api.cognitive.microsoft.com).

Antwoorden

Name	Type	Description
200 OK	ServiceHealth	OK
Other Status Codes	Error	Er is een fout opgetreden.

Beveiliging

Ocp-Apim-Subscription-Key

Geef hier de sleutel van uw Cognitive Services-account op.

Type: apiKey
In: header

Authorization

Geef een toegangstoken op van de JWT die wordt geretourneerd door de STS van deze regio. Zorg ervoor dat u het beheerbereik aan het token toevoegt door de volgende querytekenreeks toe te voegen aan de STS-URL: ?scope=speechservicesmanagement

Type: apiKey
In: header

Voorbeelden

Gets the health status

Voorbeeldaanvraag

HTTP

GET {endpoint}/speechtotext/v3.1/healthstatus

Voorbeeldrespons

Statuscode:

200

{
  "status": "Healthy",
  "components": [
    {
      "name": "Database",
      "type": "SpeechServicesDbContext",
      "status": "Healthy"
    }
  ]
}

Definities

Name	Description
Component	Onderdeel
DetailedErrorCode	DetailedErrorCode
Error	Fout
ErrorCode	ErrorCode
HealthStatus	Gezondheidsstatus
InnerError	InnerError
ServiceHealth	DienstenGezondheid

Component

Object

Onderdeel

Name	Type	Description
message	string	Aanvullende berichten over de huidige servicestatus.
name	string	De naam van het onderdeel.
status	HealthStatus	Gezondheidsstatus Status van de service.
type	string	Het type van dit onderdeel.

DetailedErrorCode

Inventarisatie

DetailedErrorCode

Waarde	Description
DataImportFailed	Het importeren van gegevens is mislukt.
DeleteNotAllowed	Verwijderen is niet toegestaan.
DeployNotAllowed	Implementeren is niet toegestaan.
DeployingFailedModel	Het implementeren van een mislukt model.
EmptyRequest	Lege aanvraag.
EndpointCannotBeDefault	Eindpunt kan niet standaard zijn.
EndpointNotUpdatable	Eindpunt kan niet worden bijgewerkt.
EndpointWithoutLogging	Eindpunt zonder logboekregistratie.
ExceededNumberOfRecordingsUris	Het aantal opnamen is overschreden.
FailedDataset	Mislukte gegevensset.
Forbidden	Verboden.
InUseViolation	Schending van gebruik.
InaccessibleCustomerStorage	Niet-toegankelijke opslag van klanten.
InvalidAdaptationMapping	Ongeldige aanpassingstoewijzing.
InvalidBaseModel	Ongeldig basismodel.
InvalidCallbackUri	Ongeldige callback-URI.
InvalidCollection	Ongeldige verzameling.
InvalidDataset	Ongeldige gegevensset.
InvalidDocument	Ongeldig document.
InvalidDocumentBatch	Ongeldige documentbatch.
InvalidLocale	Ongeldige landinstelling.
InvalidLogDate	Ongeldige logboekdatum.
InvalidLogEndTime	Ongeldige eindtijd van logboek.
InvalidLogId	Ongeldige logboek-id.
InvalidLogStartTime	Ongeldige begintijd voor logboeken.
InvalidModel	Ongeldig model.
InvalidModelUri	Ongeldige model-URI.
InvalidParameter	Ongeldige parameter.
InvalidParameterValue	Ongeldige parameterwaarde.
InvalidPayload	Ongeldige nettolading.
InvalidPermissions	Ongeldige machtigingen.
InvalidPrerequisite	Ongeldige vereiste.
InvalidProductId	Ongeldige product-id.
InvalidProject	Ongeldig project.
InvalidProjectKind	Ongeldig projecttype.
InvalidRecordingsUri	Ongeldige opnamen-URI.
InvalidRequestBodyFormat	Ongeldige indeling voor de hoofdtekst van de aanvraag.
InvalidSasValidityDuration	Ongeldige geldigheidsduur van SAS.
InvalidSkipTokenForLogs	Ongeldig skip-token voor logboeken.
InvalidSubscription	Ongeldig abonnement.
InvalidTest	Ongeldige test.
InvalidTimeToLive	Ongeldige time to live.
InvalidTopForLogs	Ongeldig bovenaan voor logboeken.
InvalidTranscription	Ongeldige transcriptie.
InvalidWebHookEventKind	Ongeldig gebeurtenistype webhook.
MissingInputRecords	Ontbrekende invoerrecords.
ModelDeploymentNotCompleteState	Modelimplementatie is niet voltooid.
ModelDeprecated	Model afgeschaft.
ModelExists	Het model bestaat.
ModelMismatch	Model komt niet overeen.
ModelNotDeployable	Model kan niet worden geïmplementeerd.
ModelVersionIncorrect	Modelversie onjuist.
NoUtf8WithBom	Geen utf8 met bom.
OnlyOneOfUrlsOrContainerOrDataset	Slechts één van url's of containers of gegevenssets.
ProjectGenderMismatch	Project geslacht komt niet overeen.
QuotaViolation	Quotumschending.
SingleDefaultEndpoint	Eén standaardeindpunt.
SkuLimitsExist	Er bestaan SKU-limieten.
SubscriptionNotFound	Abonnement is niet gevonden.
UnexpectedError	Onverwachte fout.
UnsupportedClassBasedAdaptation	Niet-ondersteunde aanpassing op basis van klassen.
UnsupportedDelta	Niet-ondersteunde delta.
UnsupportedDynamicConfiguration	Niet-ondersteunde dynamische configuratie.
UnsupportedFilter	Niet-ondersteund filter.
UnsupportedLanguageCode	Niet-ondersteunde taalcode.
UnsupportedOrderBy	Niet-ondersteunde volgorde door.
UnsupportedPagination	Niet-ondersteunde paginering.
UnsupportedTimeRange	Niet-ondersteund tijdsbereik.

Error

Object

Fout

Name	Type	Description
code	ErrorCode	ErrorCode Foutcodes op hoog niveau.
details	Error[]	Aanvullende ondersteunende informatie over de fout en/of het verwachte beleid.
innerError	InnerError	InnerError Nieuwe indeling voor interne fouten die voldoet aan de Richtlijnen voor de Cognitive Services-API die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat vereiste eigenschappen ErrorCode, bericht en optionele eigenschappendoel, details (sleutelwaardepaar), interne fout (dit kan worden genest).
message	string	Foutbericht op hoog niveau.
target	string	De bron van de fout. Dit is bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

ErrorCode

Inventarisatie

ErrorCode

Waarde	Description
Conflict	Vertegenwoordiging van de conflictfoutcode.
Forbidden	Vertegenwoordiging van de verboden foutcode.
InternalCommunicationFailed	De foutcode voor de interne communicatie is mislukt.
InternalServerError	De foutcode van de interne server vertegenwoordigt.
InvalidArgument	De foutcode van het ongeldige argument vertegenwoordigt.
InvalidRequest	De foutcode van de ongeldige aanvraag vertegenwoordigt.
NotAllowed	Vertegenwoordiging van de niet-toegestane foutcode.
NotFound	De foutcode wordt niet gevonden.
PipelineError	De foutcode van de pijplijnfout weergeven.
ServiceUnavailable	Vertegenwoordiging van de service niet-beschikbare foutcode.
TooManyRequests	De foutcode voor te veel aanvragen vertegenwoordigt.
Unauthorized	Vertegenwoordiging van de niet-geautoriseerde foutcode.
UnprocessableEntity	De foutcode van de niet-verwerkte entiteit vertegenwoordigt.
UnsupportedMediaType	De foutcode van het niet-ondersteunde mediatype vertegenwoordigt.

HealthStatus

Inventarisatie

Gezondheidsstatus

Waarde	Description
Degraded	Gedegradeerd.
Healthy	In orde.
Unhealthy	Ongezond.

InnerError

Object

InnerError

Name	Type	Description
code	DetailedErrorCode	DetailedErrorCode Gedetailleerde opsomming van foutcodes.
details	object	Aanvullende ondersteunende informatie over de fout en/of het verwachte beleid.
innerError	InnerError	InnerError Nieuwe indeling voor interne fouten die voldoet aan de Richtlijnen voor de Cognitive Services-API die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat vereiste eigenschappen ErrorCode, bericht en optionele eigenschappendoel, details (sleutelwaardepaar), interne fout (dit kan worden genest).
message	string	Foutbericht op hoog niveau.
target	string	De bron van de fout. Dit is bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

ServiceHealth

Object

DienstenGezondheid

Name	Type	Description
components	Component[]	Optionele subonderdelen van deze service en hun status.
message	string	Aanvullende berichten over de huidige servicestatus.
status	HealthStatus	Gezondheidsstatus Status van de service.