此资源表示一项由网络 API 调用引发的长时间运行的操作。
JSON 表示法 | |
---|---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
字段 | ||
---|---|---|
name |
由服务器分配的名称,该名称仅在最初返回它的那项服务中是唯一的。如果您使用默认 HTTP 映射,则 |
|
metadata |
与操作关联的服务专属元数据。它通常包含进度信息和常见元数据(如创建时间)。一些服务可能不会提供此类元数据。任何返回长时间运行操作的方法都应记录元数据类型(如果有的话)。 此对象可以包含任意类型的字段。附加字段 |
|
done |
如果值为 |
|
联合字段 result 。操作结果,可以是 error ,也可以是有效的 response 。如果 done == false ,则既不会设置 error ,也不会设置 response 。如果 done == true ,则只会设置 error 或 response 中的一项。result 只能是下列其中一项: |
||
error |
操作失败或被取消时表示有错误发生的结果。 |
|
response |
操作成功时的正常响应。如果原始方法在成功时不返回任何数据(如 此对象可以包含任意类型的字段。附加字段 |
状态
Status
类型定义了适用于不同编程环境(包括 REST API 和 RPC API)的逻辑错误模型。此类型供 gRPC 使用。每条 Status
消息包含三部分数据:错误代码、错误消息和错误详细信息。
如需详细了解该错误模型及其使用方法,请参阅 API 设计指南。
JSON 表示法 | |
---|---|
{ "code": number, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
字段 | |
---|---|
code |
状态代码,应是 |
message |
面向开发者的错误消息(应采用英语)。任何向用户显示的错误消息都应进行本地化并通过 |
details[] |
包含错误详细信息的消息列表。有一组通用的消息类型可供 API 使用。 可以包含任意类型字段的对象。附加字段 |