投稿

阿里云开放搜索公共参数

网友投稿 • • 全球云 • 阅读 0

公共请求参数

公共请求参数是指每个接口都需要使用到的请求参数。

名称 类型 是否必须 描述
Version String 是 API 版本，当前版本为：v2
AccessKeyId String 是 阿里云颁发给用户的访问服务所用的密钥ID
Signature String 是 签名结果串，关于签名的计算方法，请参见 授权机制。
SignatureMethod String 是 签名方式，目前支持HMAC-SHA1
Timestamp String 是 请求的时间戳。日期格式按照ISO8601标准表示，必须使用UTC时间。格式为YYYY-MM-DDThh:mm:ssZ 例如，2014-05-26T12:00:00Z（为北京时间2014年5月26日20点0分0秒）
SignatureVersion String 是 签名算法版本，目前版本是1.0
SignatureNonce String 是 唯一随机数，用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值，建议使用13位毫秒时间戳+4位随机数

示例

   http://$host/index/doc/$app_name?Version=v2&AccessKeyId=$accessKeyId&Signature=$signature&SignatureMethod=HMAC-SHA1&Timestamp=$timestamp&SignatureVersion=1.0&SignatureNonce=$signatureNonce

公共返回结果

用户发送的每次接口调用请求，无论成功与否，系统都会返回一个status字段给用户，用来表示本次请求的正确与否。同时，错误的请求将会返回错误代码及错误描述，供用户调试。

请求结束后请务必检查返回值是否正常，并根据错误信息及时修改，否则可能出现数据丢失或者请求无结果的情况。

示例

JSON示例

返回成功：

{
    "status": "OK"
}

返回错误：

{
    "status":"FAIL",
    "errors":[
         {"code":2001, "message":"App is not found"}
     ]
}

原创文章，作者：网友投稿，如若转载，请注明出处：https://www.cloudads.cn/archives/34049.html

赞 (0)
网友投稿网友投稿
0 0
上一篇 2023年2月2日 am11:08
下一篇 2023年2月2日 am11:08

相关推荐

发表评论

登录后才能评论