Job Router Operations - List Workers

Başvuru

Hizmet:: Communication

API Sürümü:: 2023-11-01

Mevcut çalışanları alır.

GET {endpoint}/routing/workers?api-version=2023-11-01

İsteğe bağlı parametrelerle:

GET {endpoint}/routing/workers?api-version=2023-11-01&maxpagesize={maxpagesize}&state={state}&channelId={channelId}&queueId={queueId}&hasCapacity={hasCapacity}

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string	İletişim kaynağınızın Uri'si
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.
channelId	query		string	Belirtilirse, bu kanalla kanal yapılandırması olan çalışanları seçin.
hasCapacity	query		boolean	True olarak ayarlanırsa, yalnızca belirtilmemişse `channelId` herhangi bir kanal tarafından `channelId` veya herhangi bir kanal için kapasiteye sahip çalışanları seçin. false olarak ayarlanırsa, iş kapasitesi olmayan çalışanlar da dahil olmak üzere tüm çalışanları döndürür. Varsayılan değer false şeklindedir.
maxpagesize	query		integer int32	Sayfa başına döndürülecek nesne sayısı.
queueId	query		string	Belirtilirse, bu kuyruğa atanan çalışanları seçin.
state	query		RouterWorkerStateSelector	Belirtilirse, çalışan durumuna göre çalışanlar'ı seçin.

Yanıtlar

Name	Tür	Description
200 OK	PagedRouterWorker	İstek başarılı oldu.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Beklenmeyen bir hata yanıtı. Üst Bilgiler x-ms-error-code: string

Name

Tür

Description

200 OK

PagedRouterWorker

İstek başarılı oldu.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Beklenmeyen bir hata yanıtı.

Üst Bilgiler

x-ms-error-code: string

Örnekler

Retrieves available worker filtered by channel

Retrieves list of workers

Retrieves available worker filtered by channel

Örnek isteği

HTTP

GET https://contoso.westus.communications.azure.com/routing/workers?api-version=2023-11-01&state=active&channelId=CustomChatChannel&hasCapacity=True

Örnek yanıt

Durum kodu:: 200

{
  "value": [
    {
      "id": "DefaultWorker",
      "state": "active",
      "queues": [
        "MainQueue",
        "SecondaryQueue"
      ],
      "capacity": 100,
      "labels": {},
      "tags": {},
      "channels": [
        {
          "channelId": "CustomChatChannel",
          "capacityCostPerJob": 10,
          "maxNumberOfJobs": 4
        },
        {
          "channelId": "CustomVoiceChannel",
          "capacityCostPerJob": 100,
          "maxNumberOfJobs": 1
        }
      ],
      "offers": [],
      "assignedJobs": [],
      "loadRatio": 0,
      "availableForOffers": true,
      "etag": "etag"
    },
    {
      "id": "SecondWorker",
      "state": "active",
      "queues": [
        "MainQueue",
        "SecondaryQueue"
      ],
      "capacity": 100,
      "labels": {},
      "tags": {},
      "channels": [
        {
          "channelId": "CustomChatChannel",
          "capacityCostPerJob": 10,
          "maxNumberOfJobs": 4
        },
        {
          "channelId": "CustomVoiceChannel",
          "capacityCostPerJob": 100,
          "maxNumberOfJobs": 1
        }
      ],
      "offers": [],
      "assignedJobs": [],
      "loadRatio": 0,
      "availableForOffers": true,
      "etag": "etag"
    }
  ],
  "nextLink": null
}

Retrieves list of workers

Örnek isteği

HTTP

GET https://contoso.westus.communications.azure.com/routing/workers?api-version=2023-11-01&maxpagesize=2

Örnek yanıt

Durum kodu:: 200

{
  "value": [
    {
      "id": "DefaultWorker",
      "state": "active",
      "queues": [
        "MainQueue",
        "SecondaryQueue"
      ],
      "capacity": 100,
      "labels": {},
      "tags": {},
      "channels": [
        {
          "channelId": "CustomChatChannel",
          "capacityCostPerJob": 10,
          "maxNumberOfJobs": 4
        },
        {
          "channelId": "CustomVoiceChannel",
          "capacityCostPerJob": 100,
          "maxNumberOfJobs": 1
        }
      ],
      "offers": [],
      "assignedJobs": [],
      "loadRatio": 0,
      "availableForOffers": true,
      "etag": "etag"
    },
    {
      "id": "SecondWorker",
      "state": "active",
      "queues": [
        "MainQueue",
        "SecondaryQueue"
      ],
      "capacity": 100,
      "labels": {},
      "tags": {},
      "channels": [
        {
          "channelId": "CustomEmailChannel",
          "capacityCostPerJob": 10,
          "maxNumberOfJobs": 4
        },
        {
          "channelId": "CustomSMSChannel",
          "capacityCostPerJob": 100,
          "maxNumberOfJobs": 1
        }
      ],
      "offers": [],
      "assignedJobs": [],
      "loadRatio": 0,
      "availableForOffers": true,
      "etag": "etag"
    }
  ],
  "nextLink": null
}

Tanımlar

Name	Description
Azure.Core.Foundations.Error	Hata nesnesi.
Azure.Core.Foundations.ErrorResponse	Hata ayrıntılarını içeren bir yanıt.
Azure.Core.Foundations.InnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
PagedRouterWorker	RouterWorker öğelerinin disk belleğine alınmış koleksiyonu
RouterChannel	Bu kanaldaki bir işin çalışandan tüketeceği kapasiteyi temsil eder.
RouterJobOffer	Bir işçiye iş teklifi.
RouterWorker	yönlendirilecek işler için bir varlık.
RouterWorkerAssignment	Bir çalışanın işe ataması.
RouterWorkerState	Çalışan durumları için sabit listeleri.
RouterWorkerStateSelector	Belirtilirse, çalışan durumuna göre çalışanlar'ı seçin.

Azure.Core.Foundations.Error

Hata nesnesi.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
details	Azure.Core.Foundations.Error[]	Bu bildirilen hataya yol açan belirli hatalarla ilgili bir dizi ayrıntı.
innererror	Azure.Core.Foundations.InnerError	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hatanın insanlar tarafından okunabilir bir gösterimi.
target	string	Hatanın hedefi.

Azure.Core.Foundations.ErrorResponse

Hata ayrıntılarını içeren bir yanıt.

Name	Tür	Description
error	Azure.Core.Foundations.Error	Hata nesnesi.

Azure.Core.Foundations.InnerError

Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
innererror	Azure.Core.Foundations.InnerError	İç hata.

PagedRouterWorker

RouterWorker öğelerinin disk belleğine alınmış koleksiyonu

Name	Tür	Description
nextLink	string	Öğelerin sonraki sayfasına bağlantı
value	RouterWorker[]	Bu sayfadaki RouterWorker öğeleri

RouterChannel

Bu kanaldaki bir işin çalışandan tüketeceği kapasiteyi temsil eder.

Name	Tür	Description
capacityCostPerJob	integer	Bu kanaldaki bir iş örneğinin toplam çalışan kapasitesini tüketeceği kapasite miktarı.
channelId	string	Kanalın kimliği.
maxNumberOfJobs	integer	Bu kanal için eşzamanlı olarak desteklenebilen en fazla iş sayısı. Değer sıfırdan büyük olmalıdır.

RouterJobOffer

Bir işçiye iş teklifi.

Name	Tür	Description
capacityCost	integer	İş teklifi tarafından tüketilen kapasite maliyeti.
expiresAt	string	Teklifin süresinin UTC olarak dolacağı zaman damgası.
jobId	string	İşin kimliği.
offerId	string	Bir teklifin kimliği.
offeredAt	string	Teklifin UTC'de oluşturulduğu zaman damgası.

RouterWorker

yönlendirilecek işler için bir varlık.

Name	Tür	Description
assignedJobs	RouterWorkerAssignment[]	Bu çalışana eklenmiş atanan işlerin listesi.
availableForOffers	boolean	Bu çalışanın teklifleri almaya açık olup olmadığını gösteren bir bayrak.
capacity	integer	Bu çalışanın birden çok eşzamanlı işi yönetmesi gereken toplam kapasite puanı.
channels	RouterChannel[]	Bu çalışanın işleyebileceği kanalların toplanması ve çalışanların kapasitesi üzerindeki etkileri.
etag	string	Bu kaynağın varlık etiketi.
id	string	Çalışanın kimliği.
labels		Kural altyapıları tarafından karar almak için kullanılan öznitelikleri tanımlayan bir dizi anahtar/değer çifti. Değerler ilkel değerler olmalıdır: sayı, dize, boole.
loadRatio	number	Çalışan kapasitesini gösteren bir değer. '1' değeri tüm kapasitenin tüketilmiş olduğu anlamına gelir. '0' değeri, şu anda tüketilen kapasite olmadığı anlamına gelir.
offers	RouterJobOffer[]	Bu çalışana verilen etkin tekliflerin listesi.
queues	string[]	Bu çalışanın iş alabileceği kuyrukların koleksiyonu.
state	RouterWorkerState	Çalışanın geçerli durumu.
tags		Bu çalışana eklenmiş, tanımlayıcı olmayan öznitelik kümesi. Değerler ilkel değerler olmalıdır: sayı, dize, boole.

RouterWorkerAssignment

Bir çalışanın işe ataması.

Name	Tür	Description
assignedAt	string	İşin UTC'deki atama zamanı.
assignmentId	string	Atamanın kimliği.
capacityCost	integer	Bu atamanın çalışan üzerinde tüketilen kapasite miktarı.
jobId	string	Atanan işin kimliği.

RouterWorkerState

Çalışan durumları için sabit listeleri.

Name	Tür	Description
active	string	Çalışan etkindir ve teklif almak için kullanılabilir.
draining	string	Mevcut teklifler iptal ediliyorsa çalışan etkin değildir. Yeni teklif gönderilmez.
inactive	string	Çalışan etkin değil. Yeni teklif gönderilmez.

RouterWorkerStateSelector

Belirtilirse, çalışan durumuna göre çalışanlar'ı seçin.

Name	Tür	Description
active	string	Çalışan etkindir ve teklif almak için kullanılabilir.
all	string	Çalışan etkin veya boşaltılıyor ya da etkin değil.
draining	string	Mevcut teklifler iptal ediliyorsa çalışan etkin değildir. Yeni teklif gönderilmez.
inactive	string	Çalışan etkin değil. Yeni teklif gönderilmez.

Aracılığıyla paylaş

Job Router Operations - List Workers

URI Parametreleri

Yanıtlar

Örnekler

Retrieves available worker filtered by channel

Örnek isteği

Örnek yanıt

Retrieves list of workers

Örnek isteği

Örnek yanıt

Tanımlar

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

PagedRouterWorker

RouterChannel

RouterJobOffer

RouterWorker

RouterWorkerAssignment

RouterWorkerState

RouterWorkerStateSelector

Ek kaynaklar