发送请求消息后,您会收到服务端的响应,返回结果中包含状态码、响应消息头和响应消息体。
状态码表示请求响应的状态,是一组1XX到5XX的数字代码。
对应请求 Header,响应同样也有 Header,如Content-Type。
响应 Body 通常以JSON结构化格式返回,与响应 Header 中Content-Type对应,传递除响应消息头之外的内容。
ResponseMetadata 和 Result 两部分。Error 字段,Error 字段由 Code 和 Message 组成。{ "ResponseMetadata": { "RequestId": "20240529152920190057222220AC****", "Action": "Moderate", "Version": "2025-08-31", "Service": "llmshield", "Region": "cn-beijing" }, "Result": { "MsgID": "4b090cdd06314c19a9e324b52a09****", "RiskInfo": { "Risks": null }, "Decision": { "DecisionType": 1, "DecisionDetail": { "ReplaceDetail": { "Replacement": null } } }, "PermitInfo": { "Permits": null } } }
ResponseMetadata及其内部的RequestId、Action、Version、Service、Region是固定的字段,无论请求成功与否,只要发起了 API 请求,必定会返回。RequestId是一个 API 请求的唯一标识,如果 API 出现异常,您可以通过该 ID 来帮助定位问题。Result是固定字段,字段内容由不同的产品自行定义。{ "ResponseMetadata": { "RequestId": "202310091403564A8CA5A23A12AEA5****", "Action": "Moderate", "Version": "2025-08-31", "Region": "cn-beijing", "Error": { "CodeN": 10001, "Code": "InvalidParameter", "Message": "The specified parameter Action is invalid." } } }
Result字段。Error字段,Error 字段由 Code 和 Message 组成,其中:
Code表示具体出错的错误码,您可根据错误码自助解决问题。Message表示错误信息,描述了错误发生的具体原因,供您排查问题参考。随着业务发展或体验优化,此文本可能会经常保持变更或更新,不建议完全依赖这个返回值。