开发者社区 问答 正文

开发指南:公共参数


公共参数分为 公共请求参数公共返回参数

公共请求参数


以下公共请求参数适用于通过 URL 发送 GET 请求调用弹性伸缩 API。

名称类型是否必需描述
ActionStringAPI 的名称。
AccessKeyIdString访问密钥 ID。AccessKey 用于调用 API,而用户密码用于登录 管理控制台。更多详情,请参阅 创建AccessKey
SignatureString您的签名。取值参阅 签名机制
SignatureMethodString签名方式。取值范围:HMAC-SHA1。
[tr=rgb(239, 251, 255)][td]SignatureVersion String是签名算法版本。取值范围:1.0。 SignatureNonceString是签名唯一随机数。用于防止网络重放攻击,建议您每一次请求都使用不同的随机数。 TimestampString是请求的时间戳。遵循 ISO8601 标准,并需要使用 UTC 时间,格式为 YYYY-MM-DDThh:mm:ssZ。 示例:2018-01-01T12:00:00Z 表示北京时间 2018 年 01 月 01 日 20 点 00 分 00 秒。 VersionString是API 的版本号,格式为 YYYY-MM-DD。取值范围:2014-08-28。 FormatString否返回参数的语言类型。取值范围:json | xml。默认值:json。

参数示例


https://ess.aliyuncs.com/?Action=XXXXXX
&Format=xml
&Version=2014-08-28
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2018-01-01T12:00:00Z


公共返回参数


名称类型描述
RequestIdString请求 ID。无论调用接口成功与否,我们都会返回请求 ID。

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

公共参数分为两大类:公共请求参数和公共返回参数。

公共请求参数

这些参数是调用阿里云弹性伸缩API时,通过URL发送GET请求必须提供的参数,确保API调用的认证、安全及格式需求。具体参数包括:

  • Action (String, 必选): 指定要执行的API操作名称。
  • AccessKeyId (String, 必选): 访问阿里云服务所用的密钥ID,用于身份验证。
  • Signature (String, 必选): API请求的签名信息,用于验证请求的完整性和来源。
  • SignatureMethod (String, 必选): 签名计算方法,固定为HMAC-SHA1
  • SignatureVersion (String, 必选): 签名算法版本,固定为1.0
  • SignatureNonce (String, 必选): 防止重放攻击的随机字符串,每次请求应不同。
  • Timestamp (String, 必选): 请求时间戳,遵循ISO8601标准,格式为YYYY-MM-DDThh:mm:ssZ
  • Version (String, 必选): API版本号,对于弹性伸缩服务固定为2014-08-28
  • Format (String, 可选): 返回数据的格式,默认为JSON,可选XML

参数示例

一个典型的API调用URL示例如下:

https://ess.aliyuncs.com/?Action=CreateScalingGroup
&AccessKeyId=YourAccessKeyId
&SignatureMethod=HMAC-SHA1
&SignatureVersion=1.0
&SignatureNonce=RandomValue
&Timestamp=2023-04-01T12:00:00Z
&Version=2014-08-28
&Format=json

请将CreateScalingGroup替换为您实际需要调用的Action名称,YourAccessKeyId替换为您的实际AccessKeyId值,RandomValue替换为生成的随机数,并根据实际情况调整时间戳。

公共返回参数

无论API调用成功与否,响应中都会包含以下公共返回参数:

  • RequestId (String): 本次API请求的唯一标识,可用于问题追踪或日志记录。

例如,一个成功的JSON格式响应示例为:

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

确保在构造API请求时正确设置这些公共参数,以实现与阿里云弹性伸缩服务的有效交互。

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