公共请求参数是每个接口都需要使用到的请求参数,如非必要, 在各个接口单独的文档中不再对这些参数进行说明, 但每次请求均需要携带这些参数, 才能正常发起请求。公共请求参数的首字母均为大写,以此区分于接口请求参数。
公共请求参数具体列表如下:
名称 | 类型 | 描述 | 是否必选 |
---|---|---|---|
Action | String | 具体操作的指令接口名称,例如想要调用获取监控指标列表接口,DescribeMetrics。 | 是 |
Region | String | 区域参数,用来标识希望操作哪个区域的实例。各区域的参数值为: 北京:bj,广州:gz,上海:sh,中国香港:hk,北美:ca。注意:正常情况下此参数是必须的,如无需传入,则会在相应接口中进行说明。 | 否 |
Timestamp | UInt | 当前UNIX时间戳,可记录发起API请求的时间。 | 是 |
Nonce | UInt | 随机正整数,与 Timestamp 联合起来, 用于防止重放攻击。 | 是 |
SecretId | String | 在云API密钥上申请的标识身份的 SecretId,一个 SecretId 对应唯一的 SecretKey , 而 SecretKey 会用来生成请求签名 Signature。具体可参考 签名方法 页面。 | 是 |
Signature | String | 请求签名,用来验证此次请求的合法性,由系统根据输入参数自动生成。具体可参考 签名方法 页面。 | 是 |
一个完整的请求需要两类请求参数:公共请求参数和接口请求参数。这里只列出了上述6个公共请求参数,并未列出接口请求参数,有关接口请求参数的说明可见接口请求参数小节。