商品および価格情報の一覧取得(GET /v1.0/allproducts)

ユーザーの商品カタログ上の商品および価格情報(サービス名、カテゴリ名、プロダクト名、単位、単価)の一覧を取得する。

Request Headers

X-Auth-Token

認証トークンIDを指定する。

Data Type Cardinality
String 1..1

Request Parameter

Locale

商品カタログ上の商品情報の言語を指定する(言語はサービスイン対象となっているものが対象となる)。

以下は日本語、英語、ドイツ語の場合を示す。

ja:
日本語
en:
英語
de:
ドイツ語
Data Type Cardinality
String 1..1

ResellerId

リセラーIDを指定する。

省略した場合はユーザーが属するリセラーIDが対象となる。

Data Type Cardinality
String 0..1

ServiceProviderId

サービスプロバイダIDを指定する。

省略した場合はすべてのサービスプロバイダIDが対象となる。

Data Type Cardinality
String 0..1

RegionId

リージョンIDを指定する。

省略した場合はすべてのリージョンIDが対象となる。

Data Type Cardinality
String 0..1

ServiceId

サービスIDを指定する。

省略した場合はすべてのサービスIDが対象となる。

サービスIDは以下が存在する。

compute:
コンピュート
network:
ネットワーク
image:
イメージ
software:
ソフトウェア
blockstorage:
ブロックストレージ
objectstorage:
オブジェクトストレージ
database:
データベース
loadbalancing:
ロードバランサー
dns:
DNS
telemetry:
監視
queue:
メッセージキュー
mail:
メール配信
vpnaas:
VPN
deploy:
アプリケーションデプロイ
support:
サポート
Data Type Cardinality
String 0..1

Basedate

基準日を指定する。

以下のISO8601準拠に従い基準日を指定する。

YYYY-MM-DD

ただし、上記の基準日は、未来の日付を指定できない(現在、過去の日付が対象)。指定した場合はエラーとなる。

省略した場合はシステムの日付が対象となる。

Data Type Cardinality
String 0..1

Response Headers

Content-Type

"Application/xml"が指定される。

Data Type Cardinality
String 1..1

Response Elements

CatalogList

全体の商品・価格情報を示す(ルート要素)

Data Type Cardinality Parent Element Child Element(s)
String 1..1 None Catalog

Catalog

1リセラーに紐付く商品・価格情報を示す

※タグが表示されない条件は以下となる。

対象のCatalog配下でプロダクト情報(ProductId)がひとつも存在しないまたはすべて無効の場合

Data Type Cardinality Parent Element Child Element(s)
String 0..1 CatalogList ResellerId

Region

ResellerId

リセラーID

※Catalogタグが表示されない場合、本タグも表示されない。

Data Type Cardinality Parent Element Child Element(s)
String 0..1 Catalog None

Region

1リージョンに紐付く商品・価格情報を示す

※タグが表示されない条件は以下となる。

対象のRegion配下でリージョン情報(RegionId)がひとつも存在しないまたはすべて無効の場合

※Catalogタグが表示されない場合、本タグも表示されない。

Data Type Cardinality Parent Element Child Element(s)
String 0..n Catalog RegionId

ServiceProvider

RegionId

リージョンID

※Catalog、Regionタグが表示されない場合、本タグも表示されない。

Data Type Cardinality Parent Element Child Element(s)
String 0..1 Region None

ServiceProvider

1サービスプロバイダに紐付く商品・価格情報を示す

※Catalog、Regionタグが表示されない場合、本タグも表示されない。

Data Type Cardinality Parent Element Child Element(s)
String 0..n Region ServiceProviderId

Service

ServiceProviderId

サービスプロバイダID

※Catalog、Regionタグが表示されない場合、本タグも表示されない。

Data Type Cardinality Parent Element Child Element(s)
String 0..1 ServiceProvider None

Service

1サービスに紐付く商品・価格情報を示す

※タグが表示されない条件は以下となる。

対象のService配下でサービス情報(ServiceName)がひとつも存在しないまたはすべて無効の場合

※Catalog、Regionタグが表示されない場合、本タグも表示されない。

Data Type Cardinality Parent Element Child Element(s)
String 0..n ServiceProvider ServiceName

Category

ServiceName

サービス名

以下の属性をもつ。
xml:lang:
ロケール
※Catalog、Region、Serviceタグが表示されない場合、本タグも表示されない。
Data Type Cardinality Parent Element Child Element(s)
String 0..1 Service None

Category

1カテゴリに紐付く商品・価格情報を示す

※タグが表示されない条件は以下となる。

対象のCatalory配下でカテゴリ情報(CategoryName)がひとつも存在しないまたはすべて無効の場合

※Catalog、Region、Serviceタグが表示されない場合、本タグも表示されない。

Data Type Cardinality Parent Element Child Element(s)
String 0..n Service CategoryName

Product

CategoryName

カテゴリ名

以下の属性をもつ。
xml:lang:
ロケール
※Catalog、Region、Service、Categoryタグが表示されない場合、本タグも表示されない。
Data Type Cardinality Parent Element Child Element(s)
String 0..1 Category None

Product

1プロダクトに紐付く商品・価格情報を示す

※タグが表示されない条件は以下となる。

対象のProduct配下でプロダクト情報(ProductName)、単位情報(UnitName)のいずれかがひとつも存在しないまたはすべて無効の場合

※Catalog、Region、Service、Categoryタグが表示されない場合、本タグも表示されない。

Data Type Cardinality Parent Element Child Element(s)
String 0..n Category ProductId

ProductName

UnitName

InitialCharge

MonthlyChargeInfo

ProductId

プロダクトID

※Catalog、Region、Service、Category、Productタグが表示されない場合、本タグも表示されない。

Data Type Cardinality Parent Element Child Element(s)
String 0..1 Product None

ProductName

プロダクトID

以下の属性をもつ。
xml:lang:
ロケール
※Catalog、Region、Service、Category、Productタグが表示されない場合、本タグも表示されない。
Data Type Cardinality Parent Element Child Element(s)
String 0..1 String 1..1

UnitName

単位名

以下の属性をもつ。
xml:lang:
ロケール
※Catalog、Region、Service、Category、Productタグが表示されない場合、本タグも表示されない。
Data Type Cardinality Parent Element Child Element(s)
String 0..1 Product None

InitialCharge

初期にかかる価格情報を示す

※Catalog、Region、Service、Category、Productタグが表示されない場合、本タグも表示されない。

Data Type Cardinality Parent Element Child Element(s)
String 0..1 Product UnitPrice

UnitPrice

プロダクト単価(初期費用)

以下の属性をもつ。
currencyid:
プロダクト単価に付与する通貨ID(ISO 4217の通貨コード)
通貨IDは運用者が事前に登録した通貨IDを返却する。

そのため、要素の出現回数の上限値(n)は登録されている通貨IDの数になる。

通貨IDに対して単価の指定がない場合、この属性を含むタグのみ(値なし)が返却される。

※Catalog、Region、Service、Category、Productタグが表示されない場合、本タグも表示されない。

Data Type Cardinality Parent Element Child Element(s)
String 0..n InitialCharge None

MonthlyChargeInfo

【課金方式が固定課金、従量課金の場合】

月額にかかる価格情報を示す

以下の属性をもつ。
order:
登録順序

値は固定("1")。

※Catalog、Region、Service、Category、Productタグが表示されない場合、本タグも表示されない。
Data Type Cardinality Parent Element Child Element(s)
String 0..1 Product UnitPrice

【課金方式が変動従量課金の場合】

変動の情報を含む月額にかかる価格情報を示す

以下の属性をもつ。
order:
登録順序

値はユーザーが登録した数だけ指定順に番号が付与される。

※Catalog、Region、Service、Category、Productタグが表示されない場合、本タグも表示されない。
Data Type Cardinality Parent Element Child Element(s)
String 0..n Product Description

UnitPrice

Description

【課金方式が固定課金、従量課金の場合】

価格が変動しないため、この情報は使用せず(タグ、値ともに返却されない)。

Data Type Cardinality Parent Element Child Element(s)
String 0..0 - -

【課金方式が変動従量課金の場合】

価格が変動するため、その変動に関する説明

以下の属性をもつ。
xml:lang:
ロケール
※Catalog、Region、Service、Category、Productタグが表示されない場合、本タグも表示されない。
Data Type Cardinality Parent Element Child Element(s)
String 0..1 MonthlyChargeInfo None

UnitPrice

プロダクト単価(月額費用)

以下の属性をもつ。
currencyid:
プロダクト単価に付与する通貨ID(ISO 4217の通貨コード)
通貨IDは運用者が事前に登録した通貨IDを返却する。

そのため、要素の出現回数の上限値(n)は登録されている通貨IDの数になる。

通貨IDに対して単価の指定がない場合、この属性を含むタグのみ(値なし)が返却される。

※Catalog、Region、Service、Category、Productタグが表示されない場合、本タグも表示されない。

Data Type Cardinality Parent Element Child Element(s)
String 0..n MonthlyChargeInfo None

Example of Request


GET
/v1.0/allproducts?Locale=en&Basedate=2014-08-31
X-Auth-Token:MIIZuwYJKoZIhvcNAQc・・・(認証トークンIDは省略)       
     

Example of Response

【課金方式が固定課金、従量課金の場合、かつ単価を指定した場合】


HTTP/1.1 200 OK
Date: Sun,31 Aug 2014 00:00:00 GMT
Content-Length: 5000
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<CatalogList>
 <Catalog>
  <ResellerId>jp.fujitsu.com</ResellerId>
  <Region>
   <RegionId>jp-east-1</RegionId>
   <ServiceProvider>
    <ServiceProviderId>fcx.fujitsu.com</ServiceProviderId>
    <Service>
     <ServiceName xml:lang="en">compute</ServiceName> 
     <Category>
      <CategoryName xml:lang="en">VM Service</CategoryName> 
      <Product>
       <ProductId>VM00001</ProductId>
       <ProductName xml:lang="en">VM Service S-1Type</ProductName>
       <UnitName xml:lang="en">hours</UnitName>
       <InitialCharge>
        <UnitPrice currencyid="JPY">0</UnitPrice>
        <UnitPrice currencyid="AUD">0</UnitPrice>
        ・・・(※UnitPriceを複数返却可能)
       </InitialCharge>
       <MonthlyChargeInfo order="1">
        <UnitPrice currencyid="JPY">10</UnitPrice>
        <UnitPrice currencyid="AUD">0.01</UnitPrice>
        ・・・(※UnitPriceを複数返却可能)
       </MonthlyChargeInfo>
      </Product>
      ・・・(※Productを複数返却可能)
     <Category>
     ・・・(※Categoryを複数返却可能)
    </Service>
    ・・・(※Serviceを複数返却可能)
   </ServiceProvider>
   ・・・(※ServiceProviderを複数返却可能)
  </Region>
  ・・・(※Regionを複数返却可能)
 </Catalog>
</CatalogList>       
     

【課金方式が変動従量課金の場合、かつ単価を通貨(JPY)で指定、通貨(AUD)で指定しない場合】


HTTP/1.1 200 OK
Date: Sun,31 Aug 2014 00:00:00 GMT
Content-Length: 5000
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<CatalogList>
 <Catalog>
  <ResellerId>jp.fujitsu.com</ResellerId>
  <Region>
   <RegionId>jp-east-1</RegionId>
   <ServiceProvider>
    <ServiceProviderId>fcx.fujitsu.com</ServiceProviderId>
    <Service>
     <ServiceName xml:lang="en">mail</ServiceName> 
     <Category>
      <CategoryName xml:lang="en">Mail Send Service</CategoryName> 
      <Product>
       <ProductId>ML00001</ProductId>
       <ProductName xml:lang="en">Mail Send Service Mail Count</ProductName>
       <UnitName xml:lang="en">none</UnitName>
       <InitialCharge>
        <UnitPrice currencyid="JPY">0</UnitPrice>
        <UnitPrice currencyid="AUD"></UnitPrice>
        ・・・(※UnitPriceを複数返却可能)
       </InitialCharge>
       <MonthlyChargeInfo order="1">
        <Description xml:lang="en">0[messages/month]</Description>
        <UnitPrice currencyid="JPY">0</UnitPrice>
        <UnitPrice currencyid="AUD"></UnitPrice>
        ・・・(※UnitPriceを複数返却可能)
       </MonthlyChargeInfo>
       <MonthlyChargeInfo order="2">
        <Description xml:lang="en">under 10,000[messages/month]</Description>
        <UnitPrice currencyid="JPY">3500</UnitPrice>
        <UnitPrice currencyid="AUD"></UnitPrice>
        ・・・(※UnitPriceを複数返却可能)
       </MonthlyChargeInfo>
       ・・・(※MonthlyChargeInfoを複数返却可能)
      </Product>
      ・・・(※Productを複数返却可能)
     </Category>
     ・・・(※Categoryを複数返却可能)
    </Service>
    ・・・(※Serviceを複数返却可能)
   </ServiceProvider>
   ・・・(※ServiceProviderを複数返却可能)
  </Region>
  ・・・(※Regionを複数返却可能)
 </Catalog>
</CatalogList>  
     

【プロダクト情報(ProductId)がひとつも存在しないまたはすべて無効(適用終了)の場合】


HTTP/1.1 200 OK
Date: Sun,31 Aug 2014 00:00:00 GMT
Content-Length: 5000
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<CatalogList/>       
     

【対象のリージョン情報(RegionId)がひとつも存在しないまたはすべて無効(適用終了)の場合】


HTTP/1.1 200 OK
Date: Sun,31 Aug 2014 00:00:00 GMT
Content-Length: 5000
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<CatalogList>
 <Catalog>
  <ResellerId>jp.fujitsu.com</ResellerId>
 </Catalog>
</CatalogList>       
     

【対象のサービス情報(ServiceName)がひとつも存在しないまたはすべて無効(適用終了)の場合】


HTTP/1.1 200 OK
Date: Sun,31 Aug 2014 00:00:00 GMT
Content-Length: 5000
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<CatalogList>
 <Catalog>
  <ResellerId>jp.fujitsu.com</ResellerId>
  <Region>
   <RegionId>jp-east-1</RegionId>
   <ServiceProvider>
    <ServiceProviderId>fcx.fujitsu.com</ServiceProviderId>
   </ServiceProvider>
   ・・・(※ServiceProviderを複数返却可能)
  </Region>
  ・・・(※Regionを複数返却可能)
 </Catalog>
</CatalogList>       
     

【対象のカテゴリ情報(CategoryName)がひとつも存在しないまたはすべて無効(適用終了)の場合】


HTTP/1.1 200 OK
Date: Sun,31 Aug 2014 00:00:00 GMT
Content-Length: 5000
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<CatalogList>
 <Catalog>
  <ResellerId>jp.fujitsu.com</ResellerId>
  <Region>
   <RegionId>jp-east-1</RegionId>
   <ServiceProvider>
    <ServiceProviderId>fcx.fujitsu.com</ServiceProviderId>
    <Service>
     <ServiceName xml:lang="en">compute</ServiceName>
    </Service>
    ・・・(※Serviceを複数返却可能)
   </ServiceProvider>
   ・・・(※ServiceProviderを複数返却可能)
  </Region>
  ・・・(※Regionを複数返却可能)
 </Catalog>
</CatalogList>       
     

【対象のプロダクト情報(ProductName)、単位情報(UnitName)のいずれかがひとつも存在しないまたはすべて無効(適用終了)の場合】


HTTP/1.1 200 OK
Date: Sun,31 Aug 2014 00:00:00 GMT
Content-Length: 5000
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<CatalogList>
 <Catalog>
  <ResellerId>jp.fujitsu.com</ResellerId>
  <Region>
   <RegionId>jp-east-1</RegionId>
   <ServiceProvider>
    <ServiceProviderId>fcx.fujitsu.com</ServiceProviderId>
    <Service>
     <ServiceName xml:lang="en">compute</ServiceName> 
     <Category>
      <CategoryName xml:lang="en">VM Service</CategoryName>
     <Category>
     ・・・(※Categoryを複数返却可能)
    </Service>
    ・・・(※Serviceを複数返却可能)
   </ServiceProvider>
   ・・・(※ServiceProviderを複数返却可能)
  </Region>
  ・・・(※Regionを複数返却可能)
 </Catalog>
</CatalogList>