全部产品

公共参数

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

公共请求参数

以下公共请求参数适用于通过 URL 发送 GET 请求调用云效 API。

名称

类型

是否必需

描述

Action

String

API的名称。取值请参见API 概览

AccessKeyId

String

访问密钥ID。AccessKey用于调用API,而用户密码用于登录。

Signature

String

您的签名。取值请参见 签名机制

SignatureMethod

String

签名方式。取值:HMAC-SHA1

SignatureVersion

String

签名算法版本。取值:1.0

SignatureNonce

String

签名唯一随机数。用于防止网络重放攻击,建议您每一次请求都使用不同的随机数。

Timestamp

String

请求的时间戳。

按照 ISO8601 标准表示,并需要使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。

示例:

2018-01-01T12:00:00Z

表示北京时间2018年01月01日20点00分00秒。

Version

String

API 版本号,格式为YYYY-MM-DD。取值:2014-05-26

Format

String

返回参数的语言类型。取值范围:

  • json

  • xml

默认值:xml

请求示例

说明本文中仅提供示例值,实际调用中请进行URL编码。详情请参见签名机制

api-devops.cn-beijing.aliyuncs.com/?Action=<API Name>
&Format=xml
&Version=2014-05-26
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2018-01-01T12:00:00Z
…

公共返回参数

名称

类型

描述

RequestId

String

请求ID。无论调用接口成功与否,都会返回该参数。