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

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

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

区分	指定方法	パラメータ	意味
共通	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をご覧ください

区分	指定方法	パラメータ	意味
共通	URL	APIVersion	APIバージョン。詳しくは、「UOM-API一覧」をご覧ください
API個別	URL	Action	詳しくは、「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をご覧ください

公開
マニュアル一覧へ