全部文档
当前文档
最近更新时间：2024-04-17 15:16:38
公共请求参数是每个虚拟私有网络都需要使用到的请求参数。支持GET和POST两种HTTP方法。
GET请求：放在url的query里面。例如：vpc.api.ksyun.com?{业务参数}&{公共参数}。
POST请求：放在http body里面。例如: {业务参数}&{公共参数}。
金山云OpenAPI支持AWS V4和简化签名两种签名算法，公共参数不同
AWS V4公共参数
名称 | 类型 | 是否必须参数 | 长度限制(字符) | 参数格式 | 描述 |
|---|---|---|---|---|---|
Action | String | 是 | 不确定 |
| 操作接口名，与调用的具体openAPI相关 |
Version | String | 是 | 10字符 |
| 接口版本号，版本号不同接口支持的参数和返回值可能不同，负载均衡当前只支持一个版本，即 |
X-Amz-Algorithm | String | 是 | 16字符 |
| 签名算法，目前只支持一种，即HMAC-SHA256 |
X-Amz-Credential | String | 是 | 不确定 |
| 信任状信息，包括访问密钥ID，日期，region名称和服务名称以及结尾字符串 |
X-Amz-Date | String | 否（用于覆盖信任状或者date header中的日期） | 16字符 | ISO 8601 基本格式 | 签名日期 |
X-Amz-Signature | String | 是 | 64字符 | 16进制编码表示 | 请求签名值 |
X-Amz-SignedHeaders | String | 是 | 不确定 |
| 需要在签名计算中包含的请求header |
DryRun | Boolean | 否 | 最长5字符 |
| 检查当前调用者是否有权限执行相关操作，而不是真的调用执行相关操作 |
示例
https://vpc.region.api.ksyun.com/?
Action=ListUsers&Version=2016-03-04
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKLTGo0pHK-EQWiDZWTSBSll2Q%2F20160914%2Fcn-beijing-6%2Fiam%2Faws4_request
&X-Amz-Date=20160914T114902Z
&X-Amz-SignedHeaders=host
&X-Amz-Signature=88f6284257863dedfc350da05d19d07f76cca622e93b829f5ce26c1a75d3da39
&接口请求参数简化签名公共参数
名称 | 类型 | 是否必须参数 | 描述 |
|---|---|---|---|
Accesskey | String | 是 | 用户在控制台创建的Accesskey，获取方式请参考获取AK/SK |
Service | String | 是 | 服务名称，参考请求结构章节说明 |
Action | String | 是 | 操作接口名，与调用的具体openAPI相关 |
Version | String | 是 | 接口版本号，与具体的操作接口有关 |
Timestamp | String | 是 | 时间，UTC格式，例如： |
SignatureVersion | String | 是 | 签名版本号，固定值： |
SignatureMethod | String | 是 | 签名算法，固定值： |
Signature | String | 是 | 签名，具体请查看签名机制 |
Region | String | 否 | 区域，不传默认cn-beijing-6。不同服务支持的region不同，参考请求结构章节说明 |
SecurityToken | String | 否 | 安全令牌，在使用临时AK/SK需要传该字段，如果使用GET方法，需要对该字段进行urlencode |
DryRun | Boolean | 否 | 检查当前调用者是否有权限执行相关操作，而不是真的调用执行相关操作 |
Format | String | 否 | 指定响应格式，固定值：json |
纯净模式