Job - List Preparation And Release Task Status

İşin çalıştığı İşlem Düğümleri genelinde belirtilen İş için İş Hazırlama ve İş Serbest Bırakma Görevinin yürütme durumunu listeler.
Bu API, İş Hazırlama veya İş Yayın Görevi çalıştıran tüm İşlem Düğümlerinde İş Hazırlama ve İş Bırakma Görevi durumunu döndürür. Bu, havuzdan kaldırılan İşlem Düğümlerini içerir. Bu API, İş Hazırlama veya İş Bırakma Görevi olmayan bir İş üzerinde çağrılırsa, Batch hizmeti JobPreparationTaskNotSpecified hata koduyla HTTP durum kodu 409 (Çakışma) döndürür.

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?api-version=2023-11-01.18.0
GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

URI Parametreleri

Name İçinde Gerekli Tür Description
batchUrl
path True

string

Tüm Azure Batch hizmet isteklerinin temel URL'si.

jobId
path True

string

İşin Kimliği.

api-version
query True

string

İstemci API Sürümü.

$filter
query

string

OData $filter yan tümcesi. Bu filtreyi oluşturma hakkında daha fazla bilgi için bkz https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status. .

$select
query

string

OData $select yan tümcesi.

maxresults
query

integer

int32

Yanıtta döndürülecek en fazla öğe sayısı. En fazla 1000 Görev döndürülebilir.

timeout
query

integer

int32

Sunucunun isteği işlemek için harcayabileceği en uzun süre (saniye olarak). Varsayılan değer 30 saniyedir.

İstek Başlığı

Media Types: "application/json; odata=minimalmetadata"

Name Gerekli Tür Description
client-request-id

string

uuid

Çağıran tarafından oluşturulan istek kimliği, küme ayraçları gibi dekorasyonu olmayan bir GUID biçimindedir; örneğin 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Sunucunun yanıtta client-request-id döndürip döndürmeyeceği.

ocp-date

string

date-time-rfc1123

İsteğin verildiği saat. İstemci kitaplıkları bunu genellikle geçerli sistem saat saatine ayarlar; REST API'yi doğrudan çağırıyorsanız açıkça ayarlayın.

Yanıtlar

Name Tür Description
200 OK

CloudJobListPreparationAndReleaseTaskStatusResult

İş Hazırlama ve İş Bırakma Görevi durumlarının listesini içeren yanıt.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
Other Status Codes

BatchError

Batch hizmetinden gelen hata. Bu API, İş Hazırlama veya İş Bırakma Görevi olmayan bir İş üzerinde çağrılırsa, Batch hizmeti HTTP durum kodu 409'u döndürür.

Güvenlik

azure_auth

OAuth 2.0 kimlik doğrulama kodu akışını Microsoft Entra

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Kullanıcı hesabınızın kimliğine bürünme

Authorization

Type: apiKey
In: header

Örnekler

Job list preparation and release task status

Sample Request

GET account.region.batch.azure.com/jobs/jobId/jobpreparationandreleasetaskstatus?api-version=2023-11-01.18.0


Sample Response

{
  "value": [
    {
      "poolId": "poolId",
      "nodeId": "tvm-2167304207_1-20140905t174658z",
      "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z",
      "jobPreparationTaskExecutionInfo": {
        "state": "completed",
        "startTime": "2015-05-01T10:20:31Z",
        "endTime": "2015-05-02T20:12:42Z",
        "taskRootDirectory": "tasks/myjob/job-1/myjobpreptask",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobpreptask",
        "exitCode": 0,
        "retryCount": 0
      },
      "jobReleaseTaskExecutionInfo": {
        "state": "completed",
        "startTime": "2015-05-01T10:20:31Z",
        "endTime": "2015-05-02T20:12:42Z",
        "taskRootDirectory": "tasks/myjob/job-1/myjobreleasetask",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobreleasetask",
        "exitCode": 0
      }
    }
  ],
  "odata.nextLink": "https://account.region.batch.azure.com/jobs/myjob/jobpreparationandreleasestatus?$skipToken=tvm-2167304207_1-20140905t174658z&api-version=2023-11-01.18.0"
}

Tanımlar

Name Description
BatchError

Azure Batch hizmetinden alınan bir hata yanıtı.

BatchErrorDetail

Azure Batch hata yanıtına eklenen ek bilgilerden oluşan bir öğe.

CloudJobListPreparationAndReleaseTaskStatusResult

Bir İş için İş Hazırlama ve İş Bırakma Görevlerinin durumunu listelemenin sonucu.

ErrorCategory

Hatanın kategorisi.

ErrorMessage

Azure Batch hata yanıtında bir hata iletisi alındı.

JobPreparationAndReleaseTaskExecutionInformation

İşlem Düğümünde İş Hazırlama ve İş Bırakma Görevlerinin durumu.

JobPreparationTaskExecutionInformation

İşlem Düğümünde İş Hazırlama Görevinin yürütülmesi hakkında bilgi içerir.

JobPreparationTaskState

İşlem Düğümündeki İş Hazırlama Görevinin geçerli durumu.

JobReleaseTaskExecutionInformation

İşlem Düğümünde İş Serbest Bırakma Görevinin yürütülmesi hakkında bilgi içerir.

JobReleaseTaskState

İşlem Düğümündeki İş Serbest Bırakma Görevinin geçerli durumu.

NameValuePair

Ad-değer çiftini temsil eder.

TaskContainerExecutionInformation

Bir Görevin yürüttüğü kapsayıcı hakkında bilgi içerir.

TaskExecutionResult

Görev yürütmenin sonucu.

TaskFailureInformation

Görev hatası hakkında bilgi.

BatchError

Azure Batch hizmetinden alınan bir hata yanıtı.

Name Tür Description
code

string

Hatanın tanımlayıcısı. Kodlar sabittir ve program aracılığıyla kullanılması amaçlanmıştır.

message

ErrorMessage

Hatayı açıklayan ve kullanıcı arabiriminde görüntülenmeye uygun olması amaçlanan bir ileti.

values

BatchErrorDetail[]

Hatayla ilgili ek ayrıntıları içeren anahtar-değer çiftleri koleksiyonu.

BatchErrorDetail

Azure Batch hata yanıtına eklenen ek bilgilerden oluşan bir öğe.

Name Tür Description
key

string

Value özelliğinin anlamını belirten tanımlayıcı.

value

string

Hata yanıtına eklenen ek bilgiler.

CloudJobListPreparationAndReleaseTaskStatusResult

Bir İş için İş Hazırlama ve İş Bırakma Görevlerinin durumunu listelemenin sonucu.

Name Tür Description
odata.nextLink

string

Sonraki sonuç kümesini almak için URL.

value

JobPreparationAndReleaseTaskExecutionInformation[]

İş Hazırlama ve İş Bırakma Görevi yürütme bilgilerinin listesi.

ErrorCategory

Hatanın kategorisi.

Name Tür Description
servererror

string

Hata, bir iç sunucu sorunundan kaynaklanır.

usererror

string

Hata, yanlış yapılandırma gibi bir kullanıcı sorunundan kaynaklanır.

ErrorMessage

Azure Batch hata yanıtında bir hata iletisi alındı.

Name Tür Description
lang

string

Hata iletisinin dil kodu

value

string

İletinin metni.

JobPreparationAndReleaseTaskExecutionInformation

İşlem Düğümünde İş Hazırlama ve İş Bırakma Görevlerinin durumu.

Name Tür Description
jobPreparationTaskExecutionInfo

JobPreparationTaskExecutionInformation

Bu İşlem Düğümündeki İş Hazırlama Görevinin yürütme durumu hakkında bilgi.

jobReleaseTaskExecutionInfo

JobReleaseTaskExecutionInformation

Bu İşlem Düğümündeki İş Serbest Bırakma Görevinin yürütme durumu hakkında bilgi.
Bu özellik yalnızca İş Serbest Bırakma Görevi İşlem Düğümünde çalıştırıldığında ayarlanır.

nodeId

string

Bu girdinin başvurduğu İşlem Düğümünün kimliği.

nodeUrl

string

Bu girdinin başvurduğu İşlem Düğümünün URL'si.

poolId

string

Bu girdinin başvurduğu İşlem Düğümünü içeren Havuzun Kimliği.

JobPreparationTaskExecutionInformation

İşlem Düğümünde İş Hazırlama Görevinin yürütülmesi hakkında bilgi içerir.

Name Tür Description
containerInfo

TaskContainerExecutionInformation

Görevin yürütülmekte olduğu kapsayıcı hakkında bilgi.
Bu özellik yalnızca Görev bir kapsayıcı bağlamında çalışıyorsa ayarlanır.

endTime

string

İş Hazırlama Görevinin tamamlanma zamanı.
Bu özellik yalnızca Görev Tamamlandı durumundaysa ayarlanır.

exitCode

integer

Görev komut satırında belirtilen programın çıkış kodu.
Bu parametre yalnızca Görev tamamlanmış durumdaysa döndürülür. Bir işlemin çıkış kodu, uygulama geliştiricisi tarafından bu işlem için uygulanan özel kuralı yansıtır. Kodunuzda karar vermek için çıkış kodu değerini kullanırsanız, uygulama işlemi tarafından kullanılan çıkış kodu kuralını bildiğinizden emin olun. Çıkış kodunun işlem zorla sonlandırıldığında olduğu gibi İşlem Düğümü işletim sistemi tarafından da oluşturulabileceğini unutmayın.

failureInfo

TaskFailureInformation

Varsa Görev hatasını açıklayan bilgiler.
Bu özellik yalnızca Görev tamamlanmış durumdaysa ve bir hatayla karşılaştıysa ayarlanır.

lastRetryTime

string

İş Hazırlama Görevi'nin yeniden denendiği en son zaman.
Bu özellik yalnızca Görev yeniden denendiyse ayarlanır (örneğin, retryCount sıfır olmayan). Varsa, bu genellikle startTime ile aynıdır, ancak Görev yeniden deneme dışında nedenlerle yeniden başlatıldıysa farklı olabilir; Örneğin, İşlem Düğümü yeniden deneme sırasında yeniden başlatıldıysa startTime güncelleştirilir ancak lastRetryTime güncelleştirilmez.

result

TaskExecutionResult

Görev yürütmenin sonucu.
Değer 'başarısız' ise, hatanın ayrıntıları failureInfo özelliğinde bulunabilir.

retryCount

integer

Görevin Batch hizmeti tarafından yeniden denenme sayısı. Görev uygulaması hataları (sıfır olmayan çıkış kodu) yeniden deneniyor, ön işleme hataları (Görev çalıştırılamadı) ve dosya yükleme hataları yeniden denenmiyor. Batch hizmeti, Görevi kısıtlamalar tarafından belirtilen sınıra kadar yeniden dener.
Görev uygulaması hataları (sıfır olmayan çıkış kodu) yeniden deneniyor, ön işleme hataları (Görev çalıştırılamadı) ve dosya yükleme hataları yeniden denenmiyor. Batch hizmeti, Görevi kısıtlamalar tarafından belirtilen sınıra kadar yeniden dener.

startTime

string

Görevin çalışmaya başladığı saat.
Görev yeniden başlatıldıysa veya yeniden denendiyse, görevin çalışmaya başladığı en son zamandır.

state

JobPreparationTaskState

İşlem Düğümündeki İş Hazırlama Görevinin geçerli durumu.

taskRootDirectory

string

İşlem Düğümündeki İş Hazırlama Görevinin kök dizini. Görev tarafından oluşturulan günlük dosyaları gibi dosyaları almak için bu yolu kullanabilirsiniz.

taskRootDirectoryUrl

string

İşlem Düğümündeki İş Hazırlama Görevinin kök dizininin URL'si.

JobPreparationTaskState

İşlem Düğümündeki İş Hazırlama Görevinin geçerli durumu.

Name Tür Description
completed

string

Görevden çıkış kodu 0 ile çıkıldı veya Görev yeniden deneme sınırını aştı veya Görev hazırlama hataları (kaynak dosyası indirme hataları gibi) nedeniyle Batch hizmeti Görevi başlatamadı.

running

string

Görev şu anda çalışıyor (yeniden deneme dahil).

JobReleaseTaskExecutionInformation

İşlem Düğümünde İş Serbest Bırakma Görevinin yürütülmesi hakkında bilgi içerir.

Name Tür Description
containerInfo

TaskContainerExecutionInformation

Görevin yürütülmekte olduğu kapsayıcı hakkında bilgi.
Bu özellik yalnızca Görev bir kapsayıcı bağlamında çalışıyorsa ayarlanır.

endTime

string

İş Serbest Bırakma Görevinin tamamlanma zamanı.
Bu özellik yalnızca Görev Tamamlandı durumundaysa ayarlanır.

exitCode

integer

Görev komut satırında belirtilen programın çıkış kodu.
Bu parametre yalnızca Görev tamamlanmış durumdaysa döndürülür. Bir işlemin çıkış kodu, uygulama geliştiricisi tarafından bu işlem için uygulanan özel kuralı yansıtır. Kodunuzda karar vermek için çıkış kodu değerini kullanırsanız, uygulama işlemi tarafından kullanılan çıkış kodu kuralını bildiğinizden emin olun. Çıkış kodunun işlem zorla sonlandırıldığında olduğu gibi İşlem Düğümü işletim sistemi tarafından da oluşturulabileceğini unutmayın.

failureInfo

TaskFailureInformation

Varsa Görev hatasını açıklayan bilgiler.
Bu özellik yalnızca Görev tamamlanmış durumdaysa ve bir hatayla karşılaştıysa ayarlanır.

result

TaskExecutionResult

Görev yürütmenin sonucu.
Değer 'başarısız' ise, hatanın ayrıntıları failureInfo özelliğinde bulunabilir.

startTime

string

Görevin çalışmaya başladığı saat.
Görev yeniden başlatıldıysa veya yeniden denendiyse, görevin çalışmaya başladığı en son zamandır.

state

JobReleaseTaskState

İşlem Düğümündeki İş Serbest Bırakma Görevinin geçerli durumu.

taskRootDirectory

string

İşlem Düğümündeki İş Serbest Bırakma Görevinin kök dizini. Görev tarafından oluşturulan günlük dosyaları gibi dosyaları almak için bu yolu kullanabilirsiniz.

taskRootDirectoryUrl

string

İşlem Düğümündeki İş Serbest Bırakma Görevinin kök dizininin URL'si.

JobReleaseTaskState

İşlem Düğümündeki İş Serbest Bırakma Görevinin geçerli durumu.

Name Tür Description
completed

string

Görevden çıkış kodu 0 ile çıkıldı veya Görev yeniden deneme sınırını aştı veya Görev hazırlama hataları (kaynak dosyası indirme hataları gibi) nedeniyle Batch hizmeti Görevi başlatamadı.

running

string

Görev şu anda çalışıyor (yeniden deneme dahil).

NameValuePair

Ad-değer çiftini temsil eder.

Name Tür Description
name

string

Ad-değer çiftindeki ad.

value

string

Ad-değer çiftindeki değer.

TaskContainerExecutionInformation

Bir Görevin yürüttüğü kapsayıcı hakkında bilgi içerir.

Name Tür Description
containerId

string

Kapsayıcının kimliği.

error

string

Kapsayıcı hakkında ayrıntılı hata bilgileri.
Bu, varsa Docker hizmetinden alınan ayrıntılı hata dizesidir. "docker inspect" tarafından döndürülen hata alanına eşdeğerdir.

state

string

Kapsayıcının durumu.
Bu, Docker hizmetine göre kapsayıcının durumudur. "docker inspect" tarafından döndürülen durum alanına eşdeğerdir.

TaskExecutionResult

Görev yürütmenin sonucu.

Name Tür Description
failure

string

Görev işlenirken bir hata oluştu. Hata Görev işlemi başlatılmadan önce, Görev işlemi yürütülürken veya Görev işleminden çıkıldıktan sonra oluşmuş olabilir.

success

string

Görev başarıyla çalıştı.

TaskFailureInformation

Görev hatası hakkında bilgi.

Name Tür Description
category

ErrorCategory

Görev hatasının kategorisi.

code

string

Görev hatasının tanımlayıcısı. Kodlar sabittir ve program aracılığıyla kullanılması amaçlanmıştır.

details

NameValuePair[]

Hatayla ilgili ek ayrıntıların listesi.

message

string

Kullanıcı arabiriminde görüntülenmeye uygun olması amaçlanan Görev hatasını açıklayan bir ileti.