视请求的接口而定,不同的接口会有不同的结果返回。
调用失败的返回示例如下:
{ "error": { "code": "MissingParameter", "message": "The request failed because it is missing one or multiple required parameters. Request id: 02172046847020185d65de0b597df************************", "param": "input", "type": "BadRequest" } }
当流式输出过程中出现错误时,错误信息将在以 data:
开头的数据块中返回。字段解释如下:
参数名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
type | String | 错误类型 | BadRequest |
code | String | 错误码 | MissingParameter |
param | String | 请求参数缺失或不合法导致请求失败时,未通过校验的具体参数名称 | model |
message | String | 错误提示信息 | The request failed because it is missing one or multiple required parameters. |
接口调用成功后,会返回 RequestId
和接口返回参数。HTTP 状态码为 200。
{ "ResponseMetadata": { "RequestId": "202010201722300102****", "Action": "{Action}", "Version": "{Version}", "Service": "{Service}", "Region": "{Region}" }, "Result":"..." }
请求被正常处理后,返回中会包含ResponseMetadata
和Result
两部分,Result
视请求的接口而定,不同的接口会有不同的 Result
返回。
字段解释如下:
字段 | 类型 | 描述 |
---|---|---|
RequestId | String | RequestId 为每次 API 请求的唯一标识。 |
Action | String | 请求的接口名,属于请求的公共参数。 |
Version | String | 请求的版本号,属于请求的公共参数。 |
Service | String | 请求的服务,属于请求的公共参数。 |
Region | String | 服务所在的地域信息,属于请求的公共参数。火山方舟服务所在的地域请参见地域和访问域名。 |
接口调用出错后,会返回 RequestId
和错误信息。HTTP 状态码为 4xx 或者 5xx。您可以根据接口错误代码 Code
和错误信息 Message
,参考公共错误码和接口错误码排查错误。
{ "ResponseMetadata": { "RequestId": "202010201722300102****", "Action": "{Action}", "Version": "{Version}", "Service": "{Service}", "Region": "{Region}", "Error": { "Code": "InvalidActionOrVersion", "Message": "Could not find operation GetUserById for version 2024-01-01" } } }
相较于成功结果,错误结果将不再有 Result
部分,而 ResponseMetadata
中将额外出现 Error
字段,包括 Code
和 Message
。
字段解释如下:
字段 | 类型 | 描述 |
---|---|---|
Code | String | Code内容为具体的错误码,您可根据错误码查询文档自助解决问题。 |
Message | String | Message描述了错误发生的具体原因,供您排查问题参考。 |