长时间运行的操作

Dialogflow API 的某些方法会返回长时间运行的操作。这些方法是异步执行的，当方法返回响应时，操作可能尚未完成。您可以查看状态或取消操作。

获取操作状态

下文介绍了如何轮询操作的状态。 如果您有许多操作需要检查，则应对调用进行速率限制或改用 list 方法。

REST

对 Operations 类型调用 get 方法。

在使用任何请求数据之前，请先进行以下替换：

• PROJECT_ID：您的 GCP 项目 ID
• OPERATION_ID：您的操作 ID
• API_VERSION：v2 或 v2beta1

HTTP 方法和网址：

GET https://dialogflow.googleapis.com/API_VERSION/projects/my-gcp-project/operations/OPERATION_ID

如需发送您的请求，请展开以下选项之一：

curl（Linux、macOS 或 Cloud Shell）

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI，或者使用了 Cloud Shell，这会使您自动登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

执行以下命令：

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "x-goog-user-project: PROJECT_ID" \
     "https://dialogflow.googleapis.com/API_VERSION/projects/my-gcp-project/operations/OPERATION_ID"

PowerShell (Windows)

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

执行以下命令：

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "PROJECT_ID" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://dialogflow.googleapis.com/API_VERSION/projects/my-gcp-project/operations/OPERATION_ID" | Select-Object -Expand Content

您应该收到类似以下内容的 JSON 响应：

{
  "name": "projects/PROJECT_ID/operations/some-operation-name-OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.dialogflow.API_VERSION.SomeOperationType",
    "state": "DONE"
  },
  "done": true,
  ...
}

操作完成后，系统会返回 state 值 SUCCESSFUL。

列出和取消操作

除了获取特定操作之外，您还可以列出和取消操作。请参阅 Operations 类型的 list 和 cancel 方法。

list 结果可能包含与当前任务无关的操作，因此请务必过滤结果。