跟踪异步 Azure 操作

某些 Azure REST 操作以异步方式运行,因为操作无法快速完成。 本文介绍如何通过响应中返回的值跟踪异步操作的状态。

异步操作的状态代码

最初,异步操作返回下面的一个 HTTP 状态代码:

  • 201 (已创建)
  • 202 (已接受)

该操作在成功完成时返回下面的一个代码:

  • 200 (正常)
  • 204 (无内容)

请参阅 REST API 文档,了解要执行的操作的响应。

获取 201 或 202 响应代码后,就可以监视操作状态了。

用来监视状态的 URL

可以通过两种不同的方式监视异步操作的状态。 请通过检查从原始请求返回的标头值来确定正确的方法。 首先,查找:

  • Azure-AsyncOperation - URL,用于检查操作目前的状态。 如果操作返回此值,请使用它来跟踪操作的状态。
  • Retry-After - 在检查异步操作的状态之前等待的秒数。

如果 Azure-AsyncOperation 不是标头值之一,请查找:

  • Location - URL,用于确定操作的完成时间。 只有在未返回 Azure-AsyncOperation 时,才使用此值。
  • Retry-After - 在检查异步操作的状态之前等待的秒数。

Azure-AsyncOperation 请求和响应

如果你有一个来自 Azure-AsyncOperation 标头值的 URL,请向该 URL 发送 GET 请求。 使用来自 Retry-After 的值计划以何频率检查状态。 你将得到一个指示操作状态的响应对象。 使用 Location URL 检查操作状态时,将返回一个不同的响应。 若要详细了解来自某个位置 URL 的响应,请参阅创建存储帐户(202,位置和重试间隔)

响应属性可能会变化,但始终包括异步操作的状态。

{
    "status": "{status-value}"
}

以下示例显示可能从操作返回的其他值:

{
    "id": "{resource path from GET operation}",
    "name": "{operation-id}",
    "status" : "Succeeded | Failed | Canceled | {resource provider values}",
    "startTime": "2017-01-06T20:56:36.002812+00:00",
    "endTime": "2017-01-06T20:56:56.002812+00:00",
    "percentComplete": {double between 0 and 100 },
    "properties": {
        /* Specific resource provider values for successful operations */
    },
    "error" : {
        "code": "{error code}",  
        "message": "{error description}"
    }
}

当状态为“已失败”或“已取消”时,返回错误对象。 所有其他值都是可选的。 你收到的响应看起来可能不同于示例。

provisioningState 值

用于创建、更新或删除(PUT、PATCH、DELETE)资源的操作通常返回 provisioningState 值。 完成操作后,将返回以下三个值之一:

  • 已成功
  • 失败
  • 已取消

所有其他值表示该操作仍在运行。 资源提供程序可以返回自定义的值,用于指示其状态。 例如,当请求已收到且正在运行时,用户会收到“已接受” 。

示例请求和响应

启动虚拟机(Azure-AsyncOperation 标头出现 202 响应)

此示例演示了如何确定虚拟机的启动操作的状态。 初始请求采用以下格式:

POST 
https://management.chinacloudapi.cn/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Compute/virtualMachines/{vm-name}/start?api-version=2019-12-01

它返回状态代码 202。 在标头值中可以看到:

Azure-AsyncOperation : https://management.chinacloudapi.cn/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/{region}/operations/{operation-id}?api-version=2019-12-01

若要检查异步操作的状态,请向该 URL 发送另一请求。

GET 
https://management.chinacloudapi.cn/subscriptions/{subscription-id}/providers/Microsoft.Compute/locations/{region}/operations/{operation-id}?api-version=2019-12-01

响应正文包含操作的状态:

{
  "startTime": "2017-01-06T18:58:24.7596323+00:00",
  "status": "InProgress",
  "name": "9a062a88-e463-4697-bef2-fe039df73a02"
}

部署资源(Azure-AsyncOperation 标头出现 201 响应)

此示例演示了将资源部署到 Azure 时,如何确定部署操作的状态。 初始请求采用以下格式:

PUT
https://management.chinacloudapi.cn/subscriptions/{subscription-id}/resourcegroups/{resource-group}/providers/microsoft.resources/deployments/{deployment-name}?api-version=2020-06-01

它返回状态代码 201。 响应的正文包括:

"provisioningState":"Accepted",

在标头值中可以看到:

Azure-AsyncOperation: https://management.chinacloudapi.cn/subscriptions/{subscription-id}/resourcegroups/{resource-group}/providers/Microsoft.Resources/deployments/{deployment-name}/operationStatuses/{operation-id}?api-version=2020-06-01

若要检查异步操作的状态,请向该 URL 发送另一请求。

GET 
https://management.chinacloudapi.cn/subscriptions/{subscription-id}/resourcegroups/{resource-group}/providers/Microsoft.Resources/deployments/{deployment-name}/operationStatuses/{operation-id}?api-version=2020-06-01

响应正文包含操作的状态:

{
    "status": "Running"
}

部署完成后,响应包含:

{
    "status": "Succeeded"
}

创建存储帐户(Location 和 Retry-After 标头出现 202 响应)

此示例演示了如何确定存储帐户的创建操作的状态。 初始请求采用以下格式:

PUT
https://management.chinacloudapi.cn/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.Storage/storageAccounts/{storage-name}?api-version=2019-06-01

请求正文包含存储帐户的属性:

{
    "location": "China East",
    "properties": {},
    "sku": {
        "name": "Standard_LRS"
    },
    "kind": "Storage"
}

它返回状态代码 202。 在标头值中会出现以下两个值:

Location: https://management.chinacloudapi.cn/subscriptions/{subscription-id}/providers/Microsoft.Storage/operations/{operation-id}?monitor=true&api-version=2019-06-01
Retry-After: 17

等待特定的秒数(在 Retry-After 中指定)后,查看异步操作的状态,方法是向该 URL 发送另一请求。

GET 
https://management.chinacloudapi.cn/subscriptions/{subscription-id}/providers/Microsoft.Storage/operations/{operation-id}?monitor=true&api-version=2019-06-01

如果请求仍在运行,则会收到状态代码 202。 如果请求已完成,则会收到状态代码 200,且响应的正文包含已创建存储帐户的属性。

后续步骤