UOM-API呼び出し時における共通パラメータ

UOM-APIでは、パラメータをHTTPリクエストで指定します。リクエスト時に必要なパラメータは以下のとおりです。

  • 区分
    • 共通:すべてのAPIで共通のパラメータ
    • リクエスト個別:リクエストごとに指定が異なるパラメータ
    • API個別:APIごとに指定が異なるパラメータ
  • 指定方法
    • URL:リクエストのURL
    • HTTPヘッダ:HTTPリクエストヘッダ
    • HTTPボディ:HTTPリクエストボディ
  • パラメータ
    • 各パラメータの名称
  • 意味
    • 各パラメータの意味
Query形式の場合
区分指定方法パラメータ意味
共通HTTPボディAccessKeyId

使用するアクセスキー。詳しくは、「アクセスキーの作成」をご覧ください

共通HTTPボディAPIVersion

APIバージョン。詳しくは、「UOM-API一覧」をご覧ください

共通HTTPボディSignatureMethod

Singature生成に用いるハッシュアルゴリズム

値:HmacSHA256, HmacSHA1

共通HTTPボディSignatureVersion

Signature生成ロジックのバージョン

値:2

リクエスト個別HTTPボディSignatureリクエストの署名
リクエスト個別HTTPボディExpire

Signatureの有効期間 APIリクエストの発行から24時間未満の値が指定可能

書式:YYYY-MM-DDThh:mm:ssZ

API個別HTTPボディAction

API名称。詳しくは、「UOM-API一覧」から各APIをご覧ください

API個別HTTPボディAPIごとのパラメータ

APIごとに指定されたパラメータ。詳しくは、「UOM-API一覧」から各APIをご覧ください

REST形式の場合
区分指定方法パラメータ意味
共通URLAPIVersion

APIバージョン。詳しくは、「UOM-API一覧」をご覧ください

API個別URLAction詳しくは、「UOM-API一覧」から各APIをご覧ください
共通HTTPヘッダAccessKeyId

使用するアクセスキー。詳しくは、「アクセスキーの作成」をご覧ください

共通HTTPヘッダx-iijapi-SignatureMethod

Singature生成に用いるハッシュアルゴリズム

値:HmacSHA256, HmacSHA1

共通HTTPヘッダx-iijapi-SignatureVersion

Signature生成ロジックのバージョン

値:2

リクエスト個別HTTPヘッダx-iijapi-Expire

Signatureの有効期間APIリクエストの発行から24時間未満の値が指定可能

書式:YYYY-MM-DDThh:mm:ssZ

リクエスト個別HTTPヘッダSignatureリクエストの署名参照
API個別HTTPボディAPIごとのパラメータ

APIごとに指定されたパラメータ。詳しくは、「UOM-API一覧」から各APIをご覧ください