調(diào)用密鑰對認(rèn)證 API

本頁目錄：

• 操作場景
• 前提條件
• 調(diào)用樣例
• 響應(yīng)處理

操作場景

該任務(wù)指導(dǎo)您對密鑰對認(rèn)證的 API 發(fā)起調(diào)用。

前提條件

創(chuàng)建密鑰對鑒權(quán)的API

1. 在 API 網(wǎng)關(guān)控制臺，創(chuàng)建一個(gè) API，選擇鑒權(quán)類型為“密鑰對鑒權(quán)”（參考 創(chuàng)建 API 概述）。
2. 將 API 所在服務(wù)發(fā)布至發(fā)布環(huán)境（參考 服務(wù)發(fā)布與下線）。
3. 在控制臺密鑰管理界面創(chuàng)建密鑰對。
4. 在控制臺使用計(jì)劃界面創(chuàng)建使用計(jì)劃，并將使用計(jì)劃與已創(chuàng)建的密鑰對綁定（參考 使用計(jì)劃示例）。
5. 將使用計(jì)劃與 API 或 API 所在服務(wù)進(jìn)行綁定。

確認(rèn)信息

在發(fā)起調(diào)用前，您必須擁有所要調(diào)用的 API 的 SecretId 和 SecretKey，了解所調(diào)用 API 的請求路徑、請求方法、請求參數(shù)等信息。

工具準(zhǔn)備

您可以通過瀏覽器、瀏覽器插件、Postman 工具、客戶端等來源發(fā)起請求，如果是簡單驗(yàn)證，建議使用 Postman 工具來發(fā)起請求。

調(diào)用樣例

地址

http://service-xxxxxxxx-1234567890.ap-guangzhou.apigateway.myqcloud.com/release
//請?zhí)钊肽{(diào)用的 API 服務(wù) URL

URL 拼接規(guī)則為：服務(wù)路徑 + 環(huán)境參數(shù) + API path

方法

POST

請求體

QueryParam_a=value1&QueryParam_b=value2

請求頭

Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8
Accept-Language: zh-cn
Connection: Keep-Alive
Host: service-xxxxxxxx-1234567890.ap-guangzhou.apigateway.myqcloud.com/release
User-Agent: Mozila/4.0（compatible;MSIE5.01;Window NT5.0）
Accept-Encoding: gzip,deflate
Content-Type: application/x-www-form-urlencoded;charset=utf-8
//請求體類型，請根據(jù)實(shí)際請求體內(nèi)容設(shè)置。
X-Client-Proto: http
X-Client-Proto-Ver: HTTP/1.1
X-Real-IP: 163.xxx.xx.244
X-Forwarded-For: 106.xxx.xx.102, 163.xxx.xx.244
Date: Sun, 21 Sep 2017 06:18:21 GMT
Authorization: hmac id="AKIDCgXXXXXXXX48pN", algorithm="hmac-sha1", headers="Date Host", signature="630123456789da9c"
//簽名，具體簽名方法見認(rèn)證與安全中的密鑰計(jì)算方法

• 最終發(fā)送的 HTTP 請求內(nèi)至少包含兩個(gè) Header：Date 和 X-Date 二選一以及 Authorization，可以包含更多 header。如果使用 Date Header，服務(wù)端將不會(huì)校驗(yàn)時(shí)間；如果使用 X-Date Header，服務(wù)端將校驗(yàn)時(shí)間。
• Date Header 的值為格林威治時(shí)間（GMT）格式的 HTTP 請求構(gòu)造時(shí)間，例如 Fri, 09 Oct 2015 00:00:00 GMT。
• X-Date Header 的值為格林威治時(shí)間（GMT）格式的 HTTP 請求構(gòu)造時(shí)間，例如 Mon, 19 Mar 2018 12:08:40 GMT。X-Date Header 里的時(shí)間和當(dāng)前時(shí)間的差值不能超過15分鐘。
• Authorization Header的組成可參見 密鑰對認(rèn)證，多種語言生成簽名的樣例可參見 多種語言生成簽名。

響應(yīng)處理

響應(yīng)碼

響應(yīng)頭

Content-Type: text/html; charset=UTF-8
Content-Length: 122
Date: Sun, 21 Sep 2017 06:46:04 GMT
Server: squid/3.5.20
Connection: close
Set-Cookie:1P_JAR=2017-09-18-06; expires=Mon, 25-Sep-2017 06:46:04 GMT; path=/; domain=.qq.com
X-Secret-ID:AKIDXXXXXXXX48pN
//密鑰對中的 secret_id
X-UsagePlan-ID:XXXXXXXX
//密鑰對綁定的使用計(jì)劃 ID
X-RateLimit-Limit:500
//使用計(jì)劃中的限流配置
X-RateLimit-Used:100/125
//使用計(jì)劃中的限流使用情況