Job Executions - List By Agent

Reference

Služba:: SQL Database

Verze rozhraní API:: 2021-11-01

Seznamy všechna spuštění v agentu úloh.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/executions?api-version=2021-11-01

S volitelnými parametry:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/executions?createTimeMin={createTimeMin}&createTimeMax={createTimeMax}&endTimeMin={endTimeMin}&endTimeMax={endTimeMax}&isActive={isActive}&$skip={$skip}&$top={$top}&api-version=2021-11-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
jobAgentName	path	True	string	Název agenta úloh.
resourceGroupName	path	True	string	Název skupiny prostředků, která prostředek obsahuje. Tuto hodnotu můžete získat z rozhraní API Resource Manager Azure nebo z portálu.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.
$skip	query		integer (int64)	Počet prvků v kolekci, které se mají přeskočit.
$top	query		integer (int64)	Počet prvků, které se mají vrátit z kolekce.
createTimeMax	query		string (date-time)	Pokud je zadaný, budou zahrnuta pouze spuštění úloh vytvořená před zadaným časem.
createTimeMin	query		string (date-time)	Pokud je zadaný, budou zahrnuta pouze spuštění úloh vytvořená v zadaném čase nebo po něm.
endTimeMax	query		string (date-time)	Pokud je zadaný, budou zahrnuta pouze spuštění úloh dokončená před určeným časem.
endTimeMin	query		string (date-time)	Pokud je zadán, budou zahrnuta pouze spuštění úloh dokončená v zadaném čase nebo po uplynutí zadaného času.
isActive	query		boolean	Pokud je zadáno, budou zahrnuta pouze aktivní nebo pouze dokončená spuštění úlohy.

Odpovědi

Name	Typ	Description
200 OK	JobExecutionListResult	Spuštění úloh se úspěšně načetla.
Other Status Codes		Chybové odpovědi: *** 404 JobAgentNotFound – Zadaný agent úloh na zadaném logickém serveru neexistuje. 404 SubscriptionDoesNotHaveServer – Požadovaný server se nenašel. 404 ServerNotInSubscriptionResourceGroup – zadaný server v zadané skupině prostředků a předplatném neexistuje.

Name

Typ

Description

200 OK

JobExecutionListResult

Spuštění úloh se úspěšně načetla.

Other Status Codes

Chybové odpovědi: ***

404 JobAgentNotFound – Zadaný agent úloh na zadaném logickém serveru neexistuje.
404 SubscriptionDoesNotHaveServer – Požadovaný server se nenašel.
404 ServerNotInSubscriptionResourceGroup – zadaný server v zadané skupině prostředků a předplatném neexistuje.

Příklady

List all job executions in a job agent with filtering.

List all job executions in a job agent.

List all job executions in a job agent with filtering.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/executions?createTimeMin=2017-03-21T19:00:00Z&createTimeMax=2017-03-21T19:05:00Z&endTimeMin=2017-03-21T19:20:00Z&endTimeMax=2017-03-21T19:25:00Z&isActive=False&api-version=2021-11-01


import java.time.OffsetDateTime;

/**
 * Samples for JobExecutions ListByAgent.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobExecutionsByAgentWithFilter.
     * json
     */
    /**
     * Sample code: List all job executions in a job agent with filtering.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        listAllJobExecutionsInAJobAgentWithFiltering(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobExecutions().listByAgent("group1", "server1", "agent1",
            OffsetDateTime.parse("2017-03-21T19:00:00Z"), OffsetDateTime.parse("2017-03-21T19:05:00Z"),
            OffsetDateTime.parse("2017-03-21T19:20:00Z"), OffsetDateTime.parse("2017-03-21T19:25:00Z"), false, null,
            null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Ukázková odpověď

Stavový kód:: 200

{
  "value": [
    {
      "properties": {
        "jobVersion": 1,
        "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
        "lifecycle": "Created",
        "provisioningState": "Created",
        "createTime": "2017-03-21T19:02:00.8707045Z",
        "startTime": "2017-03-21T19:12:00.8707045Z",
        "endTime": "2017-03-21T19:22:00.8707045Z",
        "currentAttempts": 0,
        "currentAttemptStartTime": "2017-03-21T19:12:00.8707045Z",
        "lastMessage": "Job execution created."
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999",
      "name": "5555-6666-7777-8888-999999999999",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions"
    },
    {
      "properties": {
        "jobVersion": 1,
        "jobExecutionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
        "lifecycle": "Succeeded",
        "provisioningState": "Succeeded",
        "createTime": "2017-12-15T19:02:00.8707045Z",
        "startTime": "2017-12-15T19:12:00.8707045Z",
        "endTime": "2017-12-15T19:22:00.8707045Z",
        "currentAttempts": 1,
        "lastMessage": "Job execution succeeded."
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job2/executions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions"
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1//executions?api-version=2017-03-01-preview&%24skip=2"
}

List all job executions in a job agent.

Ukázkový požadavek

HTTP
Java

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/executions?api-version=2021-11-01


/**
 * Samples for JobExecutions ListByAgent.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobExecutionsByAgent.json
     */
    /**
     * Sample code: List all job executions in a job agent.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAllJobExecutionsInAJobAgent(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobExecutions().listByAgent("group1", "server1", "agent1", null,
            null, null, null, null, null, null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Ukázková odpověď

Stavový kód:: 200

{
  "value": [
    {
      "properties": {
        "jobVersion": 1,
        "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
        "lifecycle": "Created",
        "provisioningState": "Created",
        "createTime": "2017-03-21T19:02:00.8707045Z",
        "startTime": "2017-03-21T19:12:00.8707045Z",
        "endTime": "2017-03-21T19:22:00.8707045Z",
        "currentAttempts": 0,
        "currentAttemptStartTime": "2017-03-21T19:12:00.8707045Z",
        "lastMessage": "Job execution created."
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999",
      "name": "5555-6666-7777-8888-999999999999",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions"
    },
    {
      "properties": {
        "jobVersion": 1,
        "jobExecutionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
        "lifecycle": "Succeeded",
        "provisioningState": "Succeeded",
        "createTime": "2017-12-15T19:02:00.8707045Z",
        "startTime": "2017-12-15T19:12:00.8707045Z",
        "endTime": "2017-12-15T19:22:00.8707045Z",
        "currentAttempts": 1,
        "lastMessage": "Job execution succeeded."
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job2/executions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions"
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1//executions?api-version=2017-03-01-preview&%24skip=2"
}

Definice

Name	Description
JobExecution	Spuštění úlohy
JobExecutionLifecycle	Podrobný stav provádění úlohy.
JobExecutionListResult	Seznam spuštění úloh.
JobExecutionTarget	Cíl, na který se provádí spuštění úlohy.
JobTargetType	Typ cíle.
ProvisioningState	Stav zřizování ARM při provádění úlohy.

JobExecution

Objekt

Spuštění úlohy

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku.
properties.createTime	string (date-time)	Čas vytvoření spuštění úlohy.
properties.currentAttemptStartTime	string (date-time)	Počáteční čas aktuálního pokusu.
properties.currentAttempts	integer (int32)	Kolikrát došlo k pokusu o spuštění úlohy.
properties.endTime	string (date-time)	Čas dokončení provádění úlohy.
properties.jobExecutionId	string (uuid)	Jedinečný identifikátor spuštění úlohy.
properties.jobVersion	integer (int32)	Číslo verze úlohy.
properties.lastMessage	string	Poslední stav nebo chybová zpráva.
properties.lifecycle	JobExecutionLifecycle	Podrobný stav provádění úlohy.
properties.provisioningState	ProvisioningState	Stav zřizování ARM při provádění úlohy.
properties.startTime	string (date-time)	Čas, kdy spuštění úlohy začalo.
properties.stepId	integer (int32)	ID kroku úlohy.
properties.stepName	string	Název kroku úlohy.
properties.target	JobExecutionTarget	Cíl, na který se toto spuštění provádí.
type	string	Typ prostředku.

JobExecutionLifecycle

Výčet

Podrobný stav provádění úlohy.

Hodnota	Description
Canceled
Created
Failed
InProgress
Skipped
Succeeded
SucceededWithSkipped
TimedOut
WaitingForChildJobExecutions
WaitingForRetry

JobExecutionListResult

Objekt

Seznam spuštění úloh.

Name	Typ	Description
nextLink	string	Odkaz na načtení další stránky výsledků
value	JobExecution[]	Pole výsledků

JobExecutionTarget

Objekt

Cíl, na který se provádí spuštění úlohy.

Name	Typ	Description
databaseName	string	název databáze,
serverName	string	Název serveru.
type	JobTargetType	Typ cíle.

JobTargetType

Výčet

Typ cíle.

Hodnota	Description
SqlDatabase
SqlElasticPool
SqlServer
SqlShardMap
TargetGroup

ProvisioningState

Výčet

Stav zřizování ARM při provádění úlohy.

Hodnota	Description
Canceled
Created
Failed
InProgress
Succeeded

Sdílet prostřednictvím

Job Executions - List By Agent

Parametry identifikátoru URI

Odpovědi

Příklady

List all job executions in a job agent with filtering.

Ukázkový požadavek

Ukázková odpověď

List all job executions in a job agent.

Ukázkový požadavek

Ukázková odpověď

Definice

JobExecution

JobExecutionLifecycle

JobExecutionListResult

JobExecutionTarget

JobTargetType

ProvisioningState

Další materiály