注意 :您正在查看 API 的 REST 接口的文档。我们的大多数官方客户端库都使用 gRPC。如需了解详情,请参阅
REST 简介 。
发送反馈
ListOperationsResponse
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
Operations.ListOperations
的响应消息。
JSON 表示法
{
"operations" : [
{
object (Operation
)
}
] ,
"nextPageToken" : string
}
字段
operations[]
object (Operation
)
与请求中指定的过滤条件匹配的操作列表。
nextPageToken
string
标准列表下一页令牌。
操作
此资源表示由网络 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
,则表示操作已完成,其结果不是 error
就是 response
。
联合字段 result
。操作结果,可以是 error
,也可以是有效的 response
。如果 done
== false
,则既不会设置 error
,也不会设置 response
。如果 done
== true
,则只能设置 error
或 response
中的一项。部分服务可能不会提供结果。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" }
。
发送反馈
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可 获得了许可,并且代码示例已根据 Apache 2.0 许可 获得了许可。有关详情,请参阅 Google 开发者网站政策 。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-08-21。
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"没有我需要的信息"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"太复杂/步骤太多"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"内容需要更新"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"翻译问题"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"示例/代码问题"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"其他"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"易于理解"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"解决了我的问题"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"其他"
}]
需要向我们提供更多信息?
{
"last_modified": "最后更新时间 (UTC):2024-08-21。",
"state": ""
}