- 错误响应正文
- InvalidApiVersion
- InvalidPayloadSignature
- InvalidPayloadEncryption
- InvalidIdentifier
- InvalidFieldValue
- MissingRequiredField
- InvalidDecryptedRequest
- PermissionDenied
- 禁止
- InvalidState
适用于所有方法的 ErrorResponse 对象。发生错误时,系统会返回此类型,而不是常规响应类型。不应将此对象用于基于业务逻辑的拒绝。
| JSON 表示法 |
|---|
{ "responseMetadata": { object ( |
| 字段 | |
|---|---|
responseMetadata |
有关响应的元数据,所有响应都需要提供。 |
errorDescription |
提供此状态的说明,以便支持代表调试错误。请注意,此信息绝不会向用户显示。它可以包含用于调试的说明性非敏感文本。请注意,errorResponseCode 的某些值应附带此字段中的其他详细信息。 警告:请勿在此邮件中包含任何个人身份信息。 |
issuerErrorIdentifier |
此标识符因发卡机构而异,由发卡机构生成。它仅用于调试目的,以便找出此错误。这是颁发者通过该标识符识别此错误的方式。 |
联合字段 result。用于捕获所发生错误类型的 oneof。result 只能是下列其中一项: |
|
invalidApiVersion |
如果请求的 API 版本不受支持,则使用此属性。建议的 HTTP 代码:400 |
invalidPayloadSignature |
如果载荷的签名属于未知或无效密钥,使用此属性。建议的 HTTP 代码:401 |
invalidPayloadEncryption |
如果载荷的加密属于未知密钥或无效密钥,使用此方法。建议的 HTTP 代码:400 |
invalidIdentifier |
如果在请求中发送的标识符无效或未知,使用此属性。建议的 HTTP 代码:404 |
invalidFieldValue |
如果请求包含的字段值不在受支持的值集中,使用此属性。建议的 HTTP 代码:400 |
missingRequiredField |
如果请求中未设置必填字段,使用此属性。建议的 HTTP 代码:400 |
invalidDecryptedRequest |
如果请求载荷可以解密,但无法解析生成的消息,使用此属性。建议的 HTTP 代码:400 |
permissionDenied |
如果请求因 Google 在 API 调用中发送的任何权限凭据存在问题而被拒绝,则使用此值。建议的 HTTP 代码:403 |
forbidden |
禁止访问请求的资源。建议的 HTTP 代码:403 |
invalidState |
如果发出了请求,但系统处于无法执行请求的有效状态,则使用此值。示例:使用已遭拒的校对结果调用 mdl.provisionCredential。建议的 HTTP 代码:400 |
InvalidApiVersion
包含有关无效 API 版本错误的信息的对象。
| JSON 表示法 |
|---|
{ "requestVersion": { object ( |
| 字段 | |
|---|---|
requestVersion |
请求中指定的版本无效。 |
expectedVersion |
预期版本。 |
InvalidPayloadSignature
此消息目前故意为空。我们日后可能会添加新字段。
InvalidPayloadEncryption
此消息目前故意为空。我们日后可能会添加新字段。
InvalidIdentifier
包含无效标识符错误相关信息的对象。
| JSON 表示法 |
|---|
{ "invalidIdentifierType": string } |
| 字段 | |
|---|---|
invalidIdentifierType |
无效标识符的类型,例如校对 ID、文档 ID 等。 |
InvalidFieldValue
包含无效字段值错误相关信息的对象。
| JSON 表示法 |
|---|
{ "invalidFieldName": string } |
| 字段 | |
|---|---|
invalidFieldName |
被发现无效的字段的名称。 |
MissingRequiredField
包含有关缺少必填字段错误的信息的对象。
| JSON 表示法 |
|---|
{ "missingFieldNames": [ string ] } |
| 字段 | |
|---|---|
missingFieldNames[] |
缺失字段的名称。 |
InvalidDecryptedRequest
此消息目前故意为空。我们日后可能会添加新字段。
PermissionDenied
包含有关权限被拒绝错误的信息的对象。
| JSON 表示法 |
|---|
{ "reason": string } |
| 字段 | |
|---|---|
reason |
拒绝授予权限的原因。 |
禁止
此消息目前故意为空。我们日后可能会添加新字段。
InvalidState
此消息目前故意为空。我们日后可能会添加新字段。