このトピックでは、KMSインスタンスAPIのAPIリクエストで使用される一般的なリクエストヘッダーについて説明します。 このトピックでは、APIリクエストの例も示します。
パラメーター
KMSインスタンスAPIはHTTPプロトコルを使用し、プロトコルバッファ形式です。 次の表に、すべてのAPIリクエストで使用できる共通リクエストヘッダーを示します。
ヘッダー | 型 | 必須 / 任意 | 説明 |
Accept | String | 任意 | クライアントがサーバーに返すことを要求するデータのタイプ。 application/x-protobufのみがサポートされています。 |
承認 | String | 対象 | 署名の内容。 署名の形式は 詳細は、「署名要求」をご参照ください。 |
Content-Length | 数値 | 非対象 | RFC 2616で定義されているHTTPリクエストボディの長さ。 このヘッダーは、リクエストボディを含まないリクエストには必要ありません。 |
Content-SHA256 | String | 任意 | リクエストボディがSHA-256を使用して計算された後に生成される大文字の16進文字列。 このヘッダーは、リクエストボディを含まないリクエストには必要ありません。 |
Content-Type | String | 任意 | RFC 2616で定義されているHTTPリクエストボディのタイプ。 application/x-protobufのみがサポートされています。 このヘッダーは、リクエストボディを含まないリクエストには必要ありません。 値はAPIの定義によって異なります。 |
日付 | String | 対象 | リクエストが送信される時刻。 RFC 1123のメッセージ形式のみがサポートされています。 時間は協定世界時 (UTC) です。 文字列の形式は次のとおりです。Mon, 3 Jan 2010 08:33:47 UTC。 |
x-kms-apiversion | String | 対象 | API のバージョン番号です。 現在のバージョンはdkms-gcs-0.2です。 |
x-kms-apiname | String | 対象 | 呼び出すAPI操作の名前。 有効な値： |
x-kms-signaturemethod | String | 対象 | 署名アルゴリズム。 RSA_PKCS1_SHA_256のみがサポートされています。 |
x-kms-acccesskeyid | String | 対象 | アクセスキーのID。 アプリケーションアクセスポイント (AAP) にバインドされているクライアントキーのみがサポートされています。 |
例：
POST / HTTP/1.1
Accept: application/x-protobuf
user-agent: AlibabaCloud (Linux; amd64) Java/1.8.0_302-b08 tea-util/0.2.6 TeaDSL/1
Authorization: TOKEN <Signature>
Content-Length: 40
content-sha256: AE71057543002AD513AB88D78509A1214192C09F20302C4BF8F59B7EB565****
Content-Type: application/x-protobuf
Date: Mon, 27 Sep 2021 11:47:26 GMT
x-kms-apiversion: dkms-gcs-0.2
x-kms-apiname: Encrypt
x-kms-signaturemethod: RSA_PKCS1_SHA_256
x-kms-acccesskeyid: KAAP.9c84ad54-a55d-75bd-235d-7c26d509****
host: kst-****.cryptoservice.kms.aliyuncs.com