Service Health - Get

Serviço:

Azure AI Services

Versão da API:

v3.2-preview.2

Retorna a integridade geral do serviço e, opcionalmente, dos diferentes subcomponentes.

GET {endpoint}/speechtotext/v3.2-preview.2/healthstatus

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus.api.cognitive.microsoft.com).

Respostas

Nome	Tipo	Description
200 OK	ServiceHealth	OKEY
Other Status Codes	Error	Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

Forneça a chave da conta de serviços cognitivos aqui.

Tipo: apiKey
Em: header

Authorization

Forneça um token de acesso do JWT retornado pelo STS desta região. Adicione o escopo de gerenciamento ao token adicionando a seguinte cadeia de caracteres de consulta à URL do STS: ?scope=speechservicesmanagement

Tipo: apiKey
Em: header

Exemplos

Gets the health status

Solicitação de exemplo

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/healthstatus

Resposta de exemplo

Código de status:

200

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

Definições

Nome	Description
Component	Componente
DetailedErrorCode	DetailedErrorCode
Error	Erro
ErrorCode	Código de Erro
HealthStatus	Estado de Saúde
InnerError	InnerError
ServiceHealth	ServiceHealth

Component

Objeto

Componente

Nome	Tipo	Description
message	string	Mensagens adicionais sobre a integridade do serviço atual.
name	string	O nome do componente.
status	HealthStatus	Estado de Saúde Status de integridade do serviço.
type	string	O tipo desse componente.

DetailedErrorCode

Enumeração

DetailedErrorCode

Valor	Description
DataImportFailed	Falha na importação de dados.
DeleteNotAllowed	Exclusão não permitida.
DeployNotAllowed	Implantação não permitida.
DeployingFailedModel	Implantação de modelo com falha.
EmptyRequest	Solicitação vazia.
EndpointCannotBeDefault	O ponto de extremidade não pode ser padrão.
EndpointNotUpdatable	Ponto de extremidade não atualizável.
EndpointWithoutLogging	Ponto de extremidade sem registro em log.
ExceededNumberOfRecordingsUris	Número excedido de uris de gravações.
FailedDataset	Conjunto de dados com falha.
Forbidden	Proibido.
InUseViolation	Em violação de uso.
InaccessibleCustomerStorage	Armazenamento de clientes inacessível.
InvalidAdaptationMapping	Mapeamento de adaptação inválido.
InvalidBaseModel	Modelo base inválido.
InvalidCallbackUri	URI de retorno de chamada inválido.
InvalidCollection	Coleção inválida.
InvalidDataset	Conjunto de dados inválido.
InvalidDocument	Documento inválido.
InvalidDocumentBatch	Lote de Documentos Inválido.
InvalidLocale	Localidade inválida.
InvalidLogDate	Data de log inválida.
InvalidLogEndTime	Hora de término do log inválida.
InvalidLogId	ID de log inválida.
InvalidLogStartTime	Hora de início do log inválida.
InvalidModel	Modelo inválido.
InvalidModelUri	URI de modelo inválido.
InvalidParameter	Parâmetro inválido.
InvalidParameterValue	Valor de parâmetro inválido.
InvalidPayload	Conteúdo inválido.
InvalidPermissions	Permissões inválidas.
InvalidPrerequisite	Pré-requisito inválido.
InvalidProductId	ID do produto inválido.
InvalidProject	Projeto inválido.
InvalidProjectKind	Tipo de projeto inválido.
InvalidRecordingsUri	URI de gravações inválido.
InvalidRequestBodyFormat	Formato do corpo da solicitação inválido.
InvalidSasValidityDuration	Duração de validade sas inválida.
InvalidSkipTokenForLogs	Token de ignorar inválido para logs.
InvalidSourceAzureResourceId	ID de recurso do Azure de origem inválida.
InvalidSubscription	Assinatura inválida.
InvalidTest	Teste inválido.
InvalidTimeToLive	Tempo de vida inválido.
InvalidTopForLogs	Parte superior inválida para logs.
InvalidTranscription	Transcrição inválida.
InvalidWebHookEventKind	Tipo de evento de gancho da Web inválido.
MissingInputRecords	Registros de entrada ausentes.
ModelCopyOperationExists	A operação de cópia de modelo existe.
ModelDeploymentNotCompleteState	Implantação de modelo não completa o estado.
ModelDeprecated	Modelo preterido.
ModelExists	O modelo existe.
ModelMismatch	Incompatibilidade de modelo.
ModelNotDeployable	Modelo não implantável.
ModelVersionIncorrect	Versão do modelo incorreta.
NoUtf8WithBom	Não utf8 com bom.
OnlyOneOfUrlsOrContainerOrDataset	Apenas uma das URLs, contêiner ou conjunto de dados.
ProjectGenderMismatch	Incompatibilidade de gênero do projeto.
QuotaViolation	Violação de cota.
SingleDefaultEndpoint	Ponto de extremidade padrão único.
SkuLimitsExist	Existem limites de SKU.
SubscriptionNotFound	Assinatura não encontrada.
UnexpectedError	Erro inesperado.
UnsupportedClassBasedAdaptation	Adaptação baseada em classe sem suporte.
UnsupportedDelta	Delta sem suporte.
UnsupportedDynamicConfiguration	Configuração dinâmica sem suporte.
UnsupportedFilter	Filtro sem suporte.
UnsupportedLanguageCode	Código de idioma sem suporte.
UnsupportedOrderBy	Ordem sem suporte por.
UnsupportedPagination	Paginação sem suporte.
UnsupportedTimeRange	Intervalo de tempo sem suporte.

Error

Objeto

Erro

Nome	Tipo	Description
code	ErrorCode	Código de Erro Códigos de erro de alto nível.
details	Error[]	Detalhes adicionais de suporte sobre o erro e/ou as políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes de API dos Serviços Cognitivos que está disponível em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Isso contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valor de chave), erro interno(isso pode ser aninhado).
message	string	Mensagem de erro de alto nível.
target	string	A origem do erro. Por exemplo, seriam "documentos" ou "id de documento" em caso de documento inválido.

ErrorCode

Enumeração

Código de Erro

Valor	Description
Conflict	Representando o código de erro de conflito.
Forbidden	Representando o código de erro proibido.
InternalCommunicationFailed	Representando o código de erro de falha de comunicação interna.
InternalServerError	Representando o código de erro interno do servidor.
InvalidArgument	Representando o código de erro de argumento inválido.
InvalidRequest	Representando o código de erro de solicitação inválido.
NotAllowed	Representando o código de erro não permitido.
NotFound	Representando o código de erro não encontrado.
PipelineError	Representando o código de erro do pipeline.
ServiceUnavailable	Representando o código de erro indisponível do serviço.
TooManyRequests	Representando o código de erro de muitas solicitações.
Unauthorized	Representando o código de erro não autorizado.
UnprocessableEntity	Representando o código de erro de entidade não processável.
UnsupportedMediaType	Representando o código de erro de tipo de mídia sem suporte.

HealthStatus

Enumeração

Estado de Saúde

Valor	Description
Degraded	Degradado.
Healthy	Íntegro.
Unhealthy	Insalubre.

InnerError

Objeto

InnerError

Nome	Tipo	Description
code	DetailedErrorCode	DetailedErrorCode Enumeração detalhada do código de erro.
details	object	Detalhes adicionais de suporte sobre o erro e/ou as políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes de API dos Serviços Cognitivos que está disponível em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Isso contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valor de chave), erro interno(isso pode ser aninhado).
message	string	Mensagem de erro de alto nível.
target	string	A origem do erro. Por exemplo, seriam "documentos" ou "id de documento" em caso de documento inválido.

ServiceHealth

Objeto

ServiceHealth

Nome	Tipo	Description
components	Component[]	Subcomponentes opcionais desse serviço e seu status.
message	string	Mensagens adicionais sobre a integridade do serviço atual.
status	HealthStatus	Estado de Saúde Status de integridade do serviço.