开发者社区 问答 正文

Swarm API参考  集群API调用方式  公共参数



公共请求头部


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

[tr=rgb(51, 205, 229)][td]参数名称 说明选项Authorization用于验证请求合法性的认证信息,采用 AccessKeyId:Signature 的形式。RequiredContent-LengthRFC 2616 中定义的 HTTP 请求内容长度。RequiredContent-TypeRFC 2616 中定义的 HTTP 请求内容类型。RequiredContent-MD5HTTP 协议消息体的 128-bit MD5 散列值转换成 BASE64 编码的结果。为了防止所有请求被篡改,建议所有请求都附加该信息。RequiredDate请求的构造时间,目前只支持 GMT 格式。如果与 MNS 的服务器时间前后差异超过 15 分钟将返回本次请求非法。RequiredHost访问 Host 值,例如:diku.aliyuncs.com。RequiredAccept客户端需要的返回值类型,支持 application/json 和 application/xml。Requiredx-acs-versionAPI 版本号。目前版本号为 2015-12-15。Requiredx-acs-region-id地域(Region)指的是 ECS 实例所在的物理位置。更多详细信息参见 地域概念ECS查询可用地域列表。Requiredx-acs-signature-nonce唯一随机数,用于防止网络重放攻击。您在不同请求间要使用不同的随机数值。Requiredx-acs-signature-method用户签名方式,目前只支持 HMAC-SHA1。Required
示例GET /clusters HTTP/ 1.1 Host: cs.aliyuncs.com Accept: application/jsonUser- Agent: cs-sdk-python /0.0.1 (Darwin/ 15.2 .0/x86_64; 2.7 .10)x-acs-signature- nonce: f63659d4 -10ac -483b -99da-ea8fde61eae3 Authorization: acs ACSbW2iBbyX0Pk9N:mp /6Wdr18V3qAc5gbgsqMe/iB0cx-acs-signature- version: 1.0 Date: Wed, 16 Dec 2015 11: 18: 47 GMTx-acs-signature- method: HMAC-SHA1Content- Type: application/json;charset=utf -8X-Acs-Region- Id: cn-beijingContent- Length: 0

公共返回头部


您发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码 RequestId。
示例
XML 示例:<?xml version= "1.0" encoding= "UTF-8"?>< !—结果的根结点-->< 接口名称+Response>| < !—返回请求标签-->| < RequestId>4C467B38-3910-447D-87BC-AC049166F216</ RequestId>| < !—返回结果数据--></ 接口名称+Response>
JSON 示例:{"RequestId": "4C467B38-3910-447D-87BC-AC049166F216"/* 返回结果数据 */}

展开
收起
青蛙跳 2018-08-31 23:13:17 1383 分享 版权
阿里云 AI 助理回答

公共请求头部是阿里云API调用中不可或缺的一部分,它们确保了请求的合法性、完整性及安全性。以下是关键公共请求参数的详细说明:

  1. Authorization: 用于验证请求合法性的认证信息,格式为AccessKeyId:Signature。其中,AccessKeyId是用户的访问密钥ID,而Signature是对请求进行签名后的结果,确保请求未被篡改。

  2. Content-Length: 指定HTTP请求内容的长度,遵循RFC 2616标准,确保服务器能正确处理请求体大小。

  3. Content-Type: 定义了请求内容的类型,如application/x-www-form-urlencoded; charset=UTF-8application/json,帮助服务器正确解析请求数据。

  4. Content-MD5: 表示HTTP消息体的128位MD5散列值经BASE64编码的结果,作为数据完整性的校验手段,推荐所有请求携带此头以防止篡改。

  5. Date: 标识请求构造的时间,需采用GMT格式。与服务器时间差异超过15分钟将导致请求被视为非法。

  6. Host: 指定请求的目标服务地址,例如diku.aliyuncs.com,确保请求路由到正确的服务端点。

  7. Accept: 指定客户端期望的响应内容类型,支持application/jsonapplication/xml,影响返回数据的格式。

  8. x-acs-version: API版本号,如2015-12-15,确保请求与服务端接口版本兼容。

  9. x-acs-region-id: 指定操作的地域ID,如cn-beijing,与ECS实例所在的物理位置相关联。

  10. x-acs-signature-nonce: 一个唯一随机数,用于防御网络重放攻击,每次请求应使用不同的随机值。

  11. x-acs-signature-method: 签名算法标识,当前仅支持HMAC-SHA1

示例请求头:

GET /clusters HTTP/1.1
Host: cs.aliyuncs.com
Accept: application/json
User-Agent: cs-sdk-python/0.0.1 (Darwin/15.2.0/x86_64;2.7.10)
x-acs-signature-nonce: f63659d4-10ac-483b-99da-ea8fde61eae3
Authorization: acs ACSbW2iBbyX0Pk9N:mp/6Wdr18V3qAc5gbgsqMe/iB0cx
x-acs-signature-version: 1.0
Date: Wed, 16 Dec 2015 11:18:47 GMT
x-acs-signature-method: HMAC-SHA1
Content-Type: application/json;charset=utf-8
X-Acs-Region-Id: cn-beijing
Content-Length: 0

至于公共返回头部,每次调用接口后,无论成功还是失败,系统都会在响应中包含一个RequestId,它是一个唯一的识别码,用于追踪和排查问题。示例中的RequestId展示如下:

  • XML示例: <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
  • JSON示例: {"RequestId": "4C467B38-3910-447D-87BC-AC049166F216"}

这些返回头部信息有助于开发者定位请求状态,便于后续的调试和监控。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答