通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Job Step Executions - List By Job Execution

  • 参考
服务:
SQL Database
API 版本:
2021-11-01

Lists作业执行的步骤执行。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps?api-version=2021-11-01
具有可选参数: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps?createTimeMin={createTimeMin}&createTimeMax={createTimeMax}&endTimeMin={endTimeMin}&endTimeMax={endTimeMax}&isActive={isActive}&$skip={$skip}&$top={$top}&api-version=2021-11-01

URI 参数

名称 在 必需 类型 说明
jobAgentName
 path True

string

作业代理的名称。
jobExecutionId
 path True

string

uuid

作业执行的 ID
jobName
 path True

string

要获取的作业的名称。
resourceGroupName
 path True

string

包含该资源的资源组名称。 可以从 Azure 资源管理器 API 或门户获取此值。
serverName
 path True

string

服务器的名称。
subscriptionId
 path True

string

用于标识 Azure 订阅的订阅 ID。
api-version
 query True

string

要用于请求的 API 版本。
$skip
 query

integer

int64

集合中要跳过的元素数。
$top
 query

integer

int64

要从集合返回的元素数。
createTimeMax
 query

string

date-time

如果已指定，则仅包含在指定时间之前创建的作业执行。
createTimeMin
 query

string

date-time

如果指定，则仅包括指定时间或之后创建的作业执行。
endTimeMax
 query

string

date-time

如果指定，则只包括指定时间之前完成的作业执行。
endTimeMin
 query

string

date-time

如果指定，则仅包含指定时间或之后完成的作业执行。
isActive
 query

boolean

如果指定，则仅包含活动或已完成的作业执行。

响应

名称 类型 说明
200 OK

JobExecutionListResult

已成功检索步骤执行。
Other Status Codes

错误响应： ***

  • 404 JobAgentNotFound - 指定的作业代理不存在于指定的逻辑服务器中。

  • 404 ResourceNotFound - 找不到请求的资源。

  • 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器

  • 404 ServerNotInSubscriptionResourceGroup - 指定的服务器不存在于指定的资源组和订阅中。

示例

List job step executions

示例请求

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5A86BF65-43AC-F258-2524-9E92992F97CA/steps?api-version=2021-11-01

示例响应

状态代码:
200 
{
  "value": [
    {
      "properties": {
        "jobVersion": 1,
        "stepName": "step1",
        "stepId": 1,
        "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
        "lifecycle": "Succeeded",
        "provisioningState": "Succeeded",
        "createTime": "2017-12-03T04:33:15.7189151Z",
        "startTime": "2017-12-03T04:33:16.176937Z",
        "endTime": "2017-12-03T04:33:19.0600862Z",
        "currentAttempts": 1,
        "currentAttemptStartTime": "2017-12-03T04:33:17.4840068Z",
        "lastMessage": "Step 1 succeeded."
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999/steps/step1",
      "name": "step1",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions/steps"
    }
  ]
}

定义

名称 说明
JobExecution

作业的执行
JobExecutionLifecycle

作业执行的详细状态。
JobExecutionListResult

作业执行的列表。
JobExecutionTarget

执行作业的目标。
JobTargetType

目标的类型。
ProvisioningState

作业执行的 ARM 预配状态。

JobExecution

Object

作业的执行

名称 类型 说明
id

string

资源 ID。
name

string

资源名称。
properties.createTime

string

创建作业执行的时间。
properties.currentAttemptStartTime

string

当前尝试的开始时间。
properties.currentAttempts

integer

已尝试执行作业的次数。
properties.endTime

string

作业执行完成的时间。
properties.jobExecutionId

string

作业执行的唯一标识符。
properties.jobVersion

integer

作业版本号。
properties.lastMessage

string

最后一个状态或错误消息。
properties.lifecycle

JobExecutionLifecycle

作业执行的详细状态。
properties.provisioningState

ProvisioningState

作业执行的 ARM 预配状态。
properties.startTime

string

作业执行开始的时间。
properties.stepId

integer

作业步骤 ID。
properties.stepName

string

作业步骤名称。
properties.target

JobExecutionTarget

执行此执行的目标。
type

string

资源类型。

JobExecutionLifecycle

Enumeration

作业执行的详细状态。

值 说明
Canceled
Created
Failed
InProgress
Skipped
Succeeded
SucceededWithSkipped
TimedOut
WaitingForChildJobExecutions
WaitingForRetry

JobExecutionListResult

Object

作业执行的列表。

名称 类型 说明
nextLink

string

用于检索下一页结果的链接。
value

JobExecution[]

结果数组。

JobExecutionTarget

Object

执行作业的目标。

名称 类型 说明
databaseName

string

数据库名称。
serverName

string

服务器名称。
type

JobTargetType

目标的类型。

JobTargetType

Enumeration

目标的类型。

值 说明
SqlDatabase
SqlElasticPool
SqlServer
SqlShardMap
TargetGroup

ProvisioningState

Enumeration

作业执行的 ARM 预配状态。

值 说明
Canceled
Created
Failed
InProgress
Succeeded