本文列举了容器服务Kubernetes版的API的公共请求参数和公共返回参数信息。
公共请求参数
公共请求参数是用于标识目标API、用户身份、签名等通用信息的参数,每次发起API请求时均需要携带这些参数。
公共请求参数应作为HTTP请求的消息头(header)携带在请求中,具体取值如下:
名称 | 是否必须 | 描述 |
x-acs-action | 是 | API的名称。关于取值,请参见API概览。 |
x-acs-version | 是 | API版本,格式为YYYY-MM-DD。示例:2018-01-01。 |
x-acs-signature-nonce | 否 | 唯一随机数,用于防止网络重放攻击。您在不同请求间要使用不同的随机数值。 |
x-acs-signature-method | 非匿名请求必须 | 签名方式,目前支持: HMAC-SHA1。 |
Authorization | 非匿名请求必须 | 用于验证请求合法性的认证信息,格式为
|
Date | 是 | HTTP 1.1协议中规定的GMT 时间,例如:Tue 9 Apr 2019 07:35:29 GMT。 |
Accept | 否 | 客户端需要的返回值类型,取值范围:application/json(推荐)、application/xml(默认值)。 |
Content-MD5 | 否 | HTTP请求正文的128-bit MD5散列值转换成BASE64编码的结果。 |
请求示例
以下请求示例中携带在请求URL中的请求参数为了便于展示未进行编码,在实际发送请求时,URL中的请求参数必须经过URL编码。
请求示例-GET
GET https://demo-product.aliyuncs.com/path?foo1=bar1&foo2=bar2 HTTP/1.1 Authorization: acs DemoAccessKey:31nTIpResD/0C8gb+ChUeuvsxlw= Host: demo-product.aliyuncs.com Date: Thu, 17 Nov 2018 18:49:58 GMT Accept: application/json x-acs-action: demoAction x-acs-version: 2018-01-01 x-acs-signature-nonce: 51284580-614a-11eb-8a9b-9dcfec8d61b7 x-acs-signature-method: HMAC-SHA1
请求示例-POST(application/json)
POST https://demo-product.aliyuncs.com/path?foo=bar HTTP/1.1 Authorization: acs DemoAccessKey:31nTIpResD/0C8gb+ChUeuvsxlw= Host: demo-product.aliyuncs.com Date: Thu, 17 Nov 2018 18:49:58 GMT Accept: application/json Content-Type: application/json; charset=utf-8 Content-Length: 135 Content-MD5: MACiECZtnLiNkNS1v5ZCAA=1 x-acs-action: demoAction x-acs-version: 2018-01-01 x-acs-signature-nonce: 51284580-614a-11eb-8a9b-9dcfec8d61b7 x-acs-signature-method: HMAC-SHA1 {"demoKey":"demoValue", ... }
公共返回参数
每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码RequestId。调用API服务后返回数据采用统一格式。返回的HTTP状态码为2xx
,代表调用成功;返回的HTTP状态码为4xx
或5xx
,代表调用失败。
XML示例
<?xml version="1.0" encoding="UTF-8"?>
<!--结果的根结点-->
<接口名称+Response>
| <!--返回请求标签-->
| <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
| <!--返回结果数据-->
</接口名称+Response>
JSON示例
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
/* 返回结果数据 */
}