REST Resource: operations

资源:操作

此资源表示长时间运行的操作,该操作是网络 API 调用的结果。

JSON 表示
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}
领域
name

string

服务器分配的名称,仅在最初返回它的同一服务中是唯一的。如果您使用默认的 HTTP 映射,则该name应该是以operations/{unique_id}结尾的资源名称。

metadata

object

与操作关联的特定于服务的元数据。它通常包含进度信息和通用元数据,例如创建时间。某些服务可能不提供此类元数据。任何返回长时间运行操作的方法都应记录元数据类型(如果有)。

包含任意类型字段的对象。附加字段"@type"包含标识类型的 URI。示例: { "id": 1234, "@type": "types.example.com/standard/id" }

done

boolean

如果值为false ,则表示操作仍在进行中。如果true ,则操作完成,并且errorresponse可用。

联盟场result 。操作结果,可以是error ,也可以是有效response 。如果done == false ,则不会设置errorresponse 。如果done == true ,则可以设置errorresponse之一。某些服务可能无法提供结果。 result只能是以下之一:
error

object ( Status )

失败或取消时操作的错误结果。

response

object

操作成功时的正常响应。如果原始方法未返回成功数据(例如Delete ,则响应为google.protobuf.Empty 。如果原始方法是标准Get / Create / Update ,则响应应该是资源。对于其他方法,响应应具有类型XxxResponse ,其中Xxx是原始方法名称。例如,如果原始方法名称为TakeSnapshot() ,则推断的响应类型为TakeSnapshotResponse

包含任意类型字段的对象。附加字段"@type"包含标识类型的 URI。示例: { "id": 1234, "@type": "types.example.com/standard/id" }

地位

Status类型定义了适合不同编程环境的逻辑错误模型,包括REST API和RPC API。它由gRPC使用。每条Status消息包含三部分数据:错误代码、错误消息和错误详细信息。

您可以在API 设计指南中找到有关此错误模型以及如何使用它的更多信息。

JSON 表示
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
领域
code

integer

状态代码,应该是google.rpc.Code的枚举值。

message

string

面向开发人员的错误消息,应为英文。任何面向用户的错误消息都应本地化并在google.rpc.Status.details字段中发送,或由客户端本地化。

details[]

object

包含错误详细信息的消息列表。有一组通用的消息类型可供 API 使用。

包含任意类型字段的对象。附加字段"@type"包含标识类型的 URI。示例: { "id": 1234, "@type": "types.example.com/standard/id" }

方法

get

获取长时间运行的操作的最新状态。