- ホワイトクラウド ASPIRE
- サービスご利用ガイド
- APIを利用する
- APIリファレンス
- カタログ
- テンプレート一覧取得
テンプレート一覧取得
セルフポータルのカタログ画面(テンプレート)相当の情報を取得します。
GET /api/1.0/template
| Request parameters | ||||
|---|---|---|---|---|
| Name | Description | Type | Data type | Required |
| Authorization | Bearer [APIキー] | Header | String | True |
| pagesize | 取得するデータの取得件数(default:100) | Query | Number | |
| startindex | 取得するデータの開始位置 | Query | Number | |
| Successful Response | |||
|---|---|---|---|
| Response Code | 200 OK | ||
| Response Headers | Content-type: application/json | ||
| Name | Description | Example | Data type |
| totalCount | カタログ(テンプレート)件数 | 120 | Number |
| totalModify | 最終更新日時 | 2023-01-02T11:22:33+0900 | String |
| Templates | カタログ(テンプレート)情報一覧 | Array | |
| Template | カタログ(テンプレート)情報 | Object | |
| siteId | サイトID | 8eb064f7a5db11e895ea005056898046 | String |
| siteName | サイト名 | East | String |
| zoneId | ゾーンID | 0fb296e296924f2bb1a4ce173a0febca | String |
| zoneName | ゾーン名 | Zone11 | String |
| podId | PodId | 5f49b71d1a1b4f1baf1dec19b5778943 | String |
| podName | Pod名 | East_Zone11_VC05 | String |
| tenantId | テナントID | dc5440d1038b4ffcb3fa56a613a8ac7f | String |
| tenantName | テナント名 | APU9999999 | String |
| keiyakuResourceId | 契約リソースID | f05f432d9a774378a30cfa55180786be | String |
| keiyakuResourceName | 契約リソース名 | VC05_Committed01-APU9999999 | String |
| templateId | テンプレートID | d477336f87ed4ed78ccddab1fff9b24f | String |
| templateName | テンプレート名 | Public_tpl_001 | String |
| Comment | コメント | カタログコメント | String |
| goldMasterFlg | ゴールドマスタフラグ | true | Boolean |
| catalogId | カタログID | 766b16720f7b40f3a57f21d6a80b5537 | String |
| catalogName | カタログ名 | Public_Catalog001 | String |
| ownerUserId | 所有者ID | bd6dc58356c4474997c8da96f23cb9e0 | String |
| ownerUserName | 所有者名 | OWNER_USER001 | String |
| shadowVm | シャドウ仮想マシン数 | 2 | Number |
| storageSize | ストレージサイズ | 11264 | Number |
| storageId | ストレージID | 583a5c7a6583451a86a3d8ac065dee9f | String |
| storageName | ストレージ名 | VC05_ST01_SSD_BK1 | String |
| templateVms | テンプレート仮想マシン情報配列 | Array | |
| templateVm | テンプレート仮想マシン情報 | Object | |
| templateVmId | テンプレート仮想マシンID | e425ffed959f4d04b279d8e99a310a26 | String |
| templateVmName | テンプレート仮想マシン名 | VM01 | String |
| guestOsType | ゲストOSコード ※ 3.パラメータ詳細:guestOsType |
01001 | String |
| createDate | 登録日時 | 2020-08-06T17:20:32+0900 | String |
| createUserId | 登録ユーザID | a5dc76bd94ef4abf9536ed441da8a581 | String |
| modifyDate | 更新日時 | 2020-08-06T17:20:32+0900 | String |
| modifyUserId | 更新ユーザID | a5dc76bd94ef4abf9536ed441da8a581 | String |
| 実行例) 11件目から1件表示する場合 |
|---|
|
# Execute request curl -i -X GET -H "Authorization:$token" -H "Content-Type:application/json" ¥ "https://eastapi.aspire.gcf.whitecloud.jp/api/1.0/template?startindex=11&pagesize=1" |
| レスポンス例 |
|---|
|