google.rpc 软件包

索引

状态

Status 类型定义了适用于不同编程环境（包括 REST API 和 RPC API）的逻辑错误模型。此类型供 gRPC 使用。设计错误模型的目的是：

  • 方便大多数用户使用和理解
  • 足够灵活地应对意外需求

概览

Status 消息包含三项数据：错误代码、错误消息和错误详细信息。错误代码应为 google.rpc.Code 的枚举值，但如果需要，也可以接受其他错误代码。错误消息应为向开发者显示的英语版消息，旨在帮助开发者理解并解决相关错误。如果需要提供向用户显示的本地化版错误消息，可以将本地化后的消息放入错误详细信息中，也可以在客户端中将该消息本地化。错误详细信息是可选项，其中可包含错误的任意相关信息。google.rpc 软件包中包含一组预定义的错误详细信息类型，可用于常见的错误情况。

语言映射

Status 消息是错误模型的逻辑表示形式，但不一定是实际的传输格式。当 Status 消息在不同的客户端库和不同的传输协议中公开时，可以采用不同的方式映射。例如，此消息可能映射到 Java 中的某些异常，但更可能映射到 C 中的某些错误代码。

其他用途

错误模型和 Status 消息可用于各种环境（无论是否使用 API），以便在不同环境中提供一致的开发者体验。

下面是此错误模型的一些示例运用：

  • 部分错误。如果服务需要将部分错误返回到客户端，则可以将 Status 嵌入正常响应中，以指示部分错误。

  • 工作流错误。一个典型的工作流包含多个步骤。每个步骤都有一条用于报告错误的 Status 消息。

  • 批量操作。如果客户端使用批量请求和批量响应，则应直接在批量响应中使用 Status 消息，使每个错误子响应与一条消息对应。

  • 异步操作。如果 API 调用将异步操作结果嵌入其响应中，则应直接使用 Status 消息表示这些操作的状态。

  • 日志记录。如果某些 API 错误存储在日志中，则在为确保安全/隐私而执行任何必要的删除操作之后，可以直接使用 Status 消息。

字段
code

int32

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

message

string

面向开发者的错误消息（应采用英语）。任何向用户显示的错误消息都应进行本地化并通过 google.rpc.Status.details 字段发送，或者由客户端进行本地化。
details[]

Any

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