公共参数
爱智云开放平台提供了丰富的 API 以供开发者调用,本章主要介绍爱智云开发平台 API 涉及到的一些公共参数。
为确保爱智云开放平台 API 的合理使用,爱智云对大部分 API 进行了调用频率的限制,默认为每个 Token 5 次/秒。对于某些特殊 API,其限制频率有所调整,对应 API 文档中会有所说明。如果超过了 API 的频率限制,Rest API 将会返回错误码 429,表示请求频率过快,需降低请求频率。
API 响应示例通用结构
爱智云开放平台 API 的响应示例的通用结构如下:
{
"status": 200,
"message": "success",
"fieldErrors": null,
"data": "obj"
}
参数说明如下:
status
:API 返回状态值,调用成功时返回 200,失败时返回对应错误码。message
:API 返回状态值的说明,调用成功时返回success
或者null
,失败时返回错误信息。fieldErrors
:API 返回状态值的详细说明,调用成功时返回null
,失败时返回详细的错误信息。data
:API 的返回数据。