Common Parameters

最終更新日:2023-03-03 13:52:49

共通パラメータは、ユーザー識別とAPI認証に使用されます。これらのパラメータは、各APIドキュメントでは紹介および説明されていません。しかし、APIを使用する場合、リクエストを成功させるために、リクエストは常にこれらすべての一般的なパラメータを搬送する必要があります。

リクエストの共通パラメータ

リクエストでは、APIを呼び出す際の認証のために、ヘッダーに以下のパラメータを含める必要があります。

パラメータ タイプ 必須 説明
X-WS-AccessKey 文字列 はい あなたの AccessKey ID。コンソールのセキュリティ設定>アクセス制御>ユーザー情報管理>アクセスキー管理で確認できます。
X-WS-Timestamp 文字列 はい 現在のUNIXタイムスタンプ、単位は秒、例:1677822256。
Authorization int はい 認証情報。詳しくは、 Authentication V3をご覧ください。
content-Type 文字列 はい 実際にサーバーに送信されたデータの種類。
host 文字列 はい クラウドVoD APIドメイン、 api.cloudv.haplat.netに固定。

レスポンスパラメータ

パラメータ タイプ 説明
X-WS-RequestId string レスポンスヘッダーで伝送されるリクエストの一意の識別子。さらなるトラブルシューティングに使用できます。

例えば

Response Headers
X-WS-RequestId: 3728d44912a711e4348190e221012d52