开发者社区> 问答> 正文

公共参数有哪些?

公共参数有哪些?

展开
收起
小天使爱美 2020-03-25 14:19:13 679 0
1 条回答
写回答
取消 提交回答
  • 介绍每个接口都需要使用的请求参数和返回参数。 公共请求参数 表 1. 公共请求参数表 名称 类型 是否必须 描述 Format String 否 返回消息的格式。取值:

    JSON | XML (默认值) Version String 是 API版本号,使用YYYY-MM-DD日期格式。取值:

    2018-12-01 AccessKeyId String 是 访问服务使用的密钥ID。 Signature String 是 签名结果串。 SignatureMethod String 是 签名方式,取值:

    HMAC-SHA1 Timestamp String 是 请求的时间戳,为日期格式。使用UTC时间按照 ISO8601标准,格式为YYYY-MM-DDThh:mm:ssZ。

    例如,北京时间2013年1月10日20点0分0秒,表示为2013-01-10T12:00:00Z。 SignatureVersion String 是 签名算法版本,取值:

    1.0 SignatureNonce String 是 唯一随机数,用于防止网络重放攻击。

    在不同请求间要使用不同的随机数值。 ResourceOwnerAccount String 否 本次API请求访问到的资源拥有者账户,即登录用户名。 示例

    http(s)://[Endpoint]/?Action=GetInstance &InstanceId=cri-xkx6vujuhay0tasd &TimeStamp=2014-05-19T10%3A33%3A56Z &Format=xml &AccessKeyId=testid &SignatureMethod=Hmac-SHA1 &SignatureNonce=NwDAxvLU6tFE0DVb &Version=2018-12-01 &SignatureVersion=1.0 &Signature=Signature

    公共返回参数 API返回结果采用统一格式,调用成功返回的数据格式有XML和JSON两种,可以在发送请求时指定返回的数据格式,默认为XML格式。每次接口调用,无论成功与否,系统都会返回一个唯一识别码RequestId。

    返回2xxHTTP状态码表示调用成功。
    返回4xx或5xxHTTP状态码表示调用失败。
    

    公共返回参数示例如下:

    XML格式
    
    <?xml version="1.0" encoding="utf-8"?> 
        <!—结果的根结点-->
        <接口名称+Response>
            <!—返回请求标签-->
            <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
            <!—返回结果数据-->
        </接口名称+Response>
    						
    
    JSON格式
    
    {
        "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
        /*返回结果数据*/
        }
    
    2020-03-25 14:54:31
    赞同 展开评论 打赏
问答地址:
问答排行榜
最热
最新

相关电子书

更多
低代码开发师(初级)实战教程 立即下载
冬季实战营第三期:MySQL数据库进阶实战 立即下载
阿里巴巴DevOps 最佳实践手册 立即下载