全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

公共参数

最近更新时间: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

不确定

[a-zA-Z]+

操作接口名,与调用的具体openAPI相关

Version

String

10字符

YYYY-MM-DD

接口版本号,版本号不同接口支持的参数和返回值可能不同,负载均衡当前只支持一个版本,即2016-03-04

X-Amz-Algorithm

String

16字符

AWS4-HMAC-SHA256

签名算法,目前只支持一种,即HMAC-SHA256

X-Amz-Credential

String

不确定

AccessKeyId/YYYYMMDD/region/service/AWS4_request

信任状信息,包括访问密钥ID,日期,region名称和服务名称以及结尾字符串AWS4_request

X-Amz-Date

String

否(用于覆盖信任状或者date header中的日期)

16字符

ISO 8601 基本格式 YYYYMMDD'T'HHMMSS'Z',如20160304T120000Z

签名日期

X-Amz-Signature

String

64字符

16进制编码表示

请求签名值

X-Amz-SignedHeaders

String

不确定

[a-zA-Z0-9-;]+

需要在签名计算中包含的请求header

DryRun

Boolean

最长5字符

true(1) or false(0)

检查当前调用者是否有权限执行相关操作,而不是真的调用执行相关操作

  • 示例

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格式,例如:2019-08-13T17:18:36Z

SignatureVersion

String

签名版本号,固定值:1.0

SignatureMethod

String

签名算法,固定值:HMAC-SHA256

Signature

String

签名,具体请查看签名机制

Region

String

区域,不传默认cn-beijing-6。不同服务支持的region不同,参考请求结构章节说明

SecurityToken

String

安全令牌,在使用临时AK/SK需要传该字段,如果使用GET方法,需要对该字段进行urlencode

DryRun

Boolean

检查当前调用者是否有权限执行相关操作,而不是真的调用执行相关操作

Format

String

指定响应格式,固定值:json

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈