Get Health Status - Get Health Status

Layanan:

Azure AI Services

Versi API:

v3.0

Mengembalikan kesehatan keseluruhan layanan dan secara opsional dari subkomponen yang berbeda.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
Endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://westus.api.cognitive.microsoft.com).

Respons

Nama	Jenis	Deskripsi
200 OK	ServiceHealth	OK
Other Status Codes	Error	Terjadi kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Berikan kunci akun layanan kognitif Anda di sini.

Jenis: apiKey
Dalam: header

Authorization

Berikan token akses dari JWT yang dikembalikan oleh STS wilayah ini. Pastikan untuk menambahkan cakupan manajemen ke token dengan menambahkan string kueri berikut ke URL STS: ?scope=speechservicesmanagement

Jenis: apiKey
Dalam: header

Contoh

Gets the health status

Permintaan sampel

HTTP

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

Respon sampel

Kode status:

200

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

Definisi

Nama	Deskripsi
Component	Komponen
DetailedErrorCode	DetailedErrorCode
Error	Kesalahan
ErrorCode	Kode Kesalahan
HealthStatus	Status Kesehatan
InnerError	InnerError
ServiceHealth	ServiceHealth

Component

Objek

Komponen

Nama	Jenis	Deskripsi
message	string	Pesan tambahan tentang kesehatan layanan saat ini.
name	string	Nama komponen.
status	HealthStatus	Status Kesehatan Status kesehatan layanan.
type	string	Jenis komponen ini.

DetailedErrorCode

Enumeration

DetailedErrorCode

Nilai	Deskripsi
InvalidParameterValue	Nilai parameter tidak valid.
InvalidRequestBodyFormat	Format isi permintaan tidak valid.
EmptyRequest	Permintaan Kosong.
MissingInputRecords	Rekaman Input hilang.
InvalidDocument	Dokumen Tidak Valid.
ModelVersionIncorrect	Versi Model Salah.
InvalidDocumentBatch	Batch Dokumen Tidak Valid.
UnsupportedLanguageCode	Kode bahasa yang tidak didukung.
DataImportFailed	Impor data gagal.
InUseViolation	Dalam pelanggaran penggunaan.
InvalidLocale	Lokal tidak valid.
InvalidBaseModel	Model dasar tidak valid.
InvalidAdaptationMapping	Pemetaan adaptasi tidak valid.
InvalidDataset	Himpunan data tidak valid.
InvalidTest	Tes tidak valid.
FailedDataset	Himpunan data yang gagal.
InvalidModel	Model tidak valid.
InvalidTranscription	Transkripsi tidak valid.
InvalidPayload	Payload tidak valid.
InvalidParameter	Parameter tidak valid.
EndpointWithoutLogging	Titik akhir tanpa pengelogan.
InvalidPermissions	Izin tidak valid.
InvalidPrerequisite	Prasyarat tidak valid.
InvalidProductId	Id produk tidak valid.
InvalidSubscription	Langganan tidak valid.
InvalidProject	Proyek tidak valid.
InvalidProjectKind	Jenis proyek tidak valid.
InvalidRecordingsUri	uri rekaman tidak valid.
OnlyOneOfUrlsOrContainerOrDataset	Hanya salah satu url atau kontainer atau himpunan data.
ExceededNumberOfRecordingsUris	Melebihi jumlah uri rekaman.
ModelMismatch	Ketidakcocokan model.
ProjectGenderMismatch	Ketidakcocokan jenis kelamin proyek.
ModelDeprecated	Model tidak digunakan lagi.
ModelExists	Model ada.
ModelNotDeployable	Model tidak dapat disebarkan.
EndpointNotUpdatable	Titik akhir tidak dapat diperbarui.
SingleDefaultEndpoint	Titik akhir default tunggal.
EndpointCannotBeDefault	Titik akhir tidak boleh default.
InvalidModelUri	Uri model tidak valid.
SubscriptionNotFound	Langganan tidak ditemukan.
QuotaViolation	Pelanggaran kuota.
UnsupportedDelta	Delta yang tidak didukung.
UnsupportedFilter	Filter yang tidak didukung.
UnsupportedPagination	Penomoran halaman yang tidak didukung.
UnsupportedDynamicConfiguration	Konfigurasi dinamis yang tidak didukung.
UnsupportedOrderBy	Urutan yang tidak didukung oleh.
NoUtf8WithBom	Tidak ada utf8 dengan bom.
ModelDeploymentNotCompleteState	Penyebaran model tidak menyelesaikan status.
SkuLimitsExist	Batas Sku ada.
DeployingFailedModel	Menyebarkan model yang gagal.
UnsupportedTimeRange	Rentang waktu yang tidak didukung.
InvalidLogDate	Tanggal log tidak valid.
InvalidLogId	Id log tidak valid.
InvalidLogStartTime	Waktu mulai log tidak valid.
InvalidLogEndTime	Waktu akhir log tidak valid.
InvalidTopForLogs	Atas tidak valid untuk log.
InvalidSkipTokenForLogs	Melewati token untuk log tidak valid.
DeleteNotAllowed	Hapus tidak diperbolehkan.
Forbidden	Dilarang.
DeployNotAllowed	Sebarkan tidak diizinkan.
UnexpectedError	Kesalahan tak terduga.
InvalidCollection	Koleksi tidak valid.
InvalidCallbackUri	Uri panggilan balik tidak valid.
InvalidSasValidityDuration	Durasi validitas sas tidak valid.
InaccessibleCustomerStorage	Penyimpanan pelanggan yang tidak dapat diakses.
UnsupportedClassBasedAdaptation	Adaptasi berbasis kelas yang tidak didukung.
InvalidWebHookEventKind	Jenis peristiwa web hook tidak valid.
InvalidTimeToLive	Waktu hidup tidak valid.

Error

Objek

Kesalahan

Nama	Jenis	Deskripsi
code	ErrorCode	Kode Kesalahan Kode kesalahan tingkat tinggi.
details	Error[]	Detail dukungan tambahan mengenai kesalahan dan/atau kebijakan yang diharapkan.
innerError	InnerError	InnerError Format Kesalahan Dalam Baru yang sesuai dengan Panduan API Cognitive Services yang tersedia di https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Ini berisi properti yang diperlukan ErrorCode, pesan, dan target properti opsional, detail(pasangan nilai kunci), kesalahan dalam (ini dapat ditumpuk).
message	string	Pesan kesalahan tingkat tinggi.
target	string	Sumber kesalahan. Misalnya akan menjadi "dokumen" atau "id dokumen" jika dokumen tidak valid.

ErrorCode

Enumeration

Kode Kesalahan

Nilai	Deskripsi
InvalidRequest	Mewakili kode kesalahan permintaan yang tidak valid.
InvalidArgument	Mewakili kode kesalahan argumen yang tidak valid.
InternalServerError	Mewakili kode kesalahan server internal.
ServiceUnavailable	Mewakili kode kesalahan layanan yang tidak tersedia.
NotFound	Mewakili kode kesalahan yang tidak ditemukan.
PipelineError	Mewakili kode kesalahan kesalahan alur.
Conflict	Mewakili kode kesalahan konflik.
InternalCommunicationFailed	Mewakili kode kesalahan komunikasi internal gagal.
Forbidden	Mewakili kode kesalahan terlarang.
NotAllowed	Mewakili kode kesalahan yang tidak diizinkan.
Unauthorized	Mewakili kode kesalahan yang tidak sah.
UnsupportedMediaType	Mewakili kode kesalahan jenis media yang tidak didukung.
TooManyRequests	Mewakili terlalu banyak kode kesalahan permintaan.
UnprocessableEntity	Mewakili kode kesalahan entitas yang tidak dapat diolah.

HealthStatus

Enumeration

Status Kesehatan

Nilai	Deskripsi
Unhealthy	Tidak sehat.
Degraded	Diturunkan.
Healthy	Sehat.

InnerError

Objek

InnerError

Nama	Jenis	Deskripsi
code	DetailedErrorCode	DetailedErrorCode Enum kode kesalahan terperinci.
details	object	Detail dukungan tambahan mengenai kesalahan dan/atau kebijakan yang diharapkan.
innerError	InnerError	InnerError Format Kesalahan Dalam Baru yang sesuai dengan Panduan API Cognitive Services yang tersedia di https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Ini berisi properti yang diperlukan ErrorCode, pesan, dan target properti opsional, detail(pasangan nilai kunci), kesalahan dalam (ini dapat ditumpuk).
message	string	Pesan kesalahan tingkat tinggi.
target	string	Sumber kesalahan. Misalnya akan menjadi "dokumen" atau "id dokumen" jika dokumen tidak valid.

ServiceHealth

Objek

ServiceHealth

Nama	Jenis	Deskripsi
components	Component[]	Subkomponen opsional layanan ini dan statusnya.
message	string	Pesan tambahan tentang kesehatan layanan saat ini.
status	HealthStatus	Status Kesehatan Status kesehatan layanan.