カタログ一覧取得

セルフポータルのカタログ画面(カタログ一覧)相当の情報を取得します。

GET /api/1.0/catalog

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 最終更新日時 2020-08-06T17:20:32+0900 String
Catalogs カタログ情報一覧 Array
Catalog カタログ情報 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
catalogId カタログID 6d0767fc1adc4514b09d40c22e7e417e String
catalogName カタログ名 Catalog001 String
Comment コメント カタログコメント String
Shares 共有情報配列 Array
Share 共有情報 Object
shareUserId 共有ユーザID 70a3c8db63bc4585b90c58dacb0706f6 String
shareUserName 共有ユーザ名 Username String
ownerUserId 所有者ID bd6dc58356c4474997c8da96f23cb9e0 String
ownerUserName 所有者名 OWNER_USER001 String
storageId ストレージID 583a5c7a6583451a86a3d8ac065dee9f String
storageName ストレージ名 VC05_ST01_SSD_BK1 String
templateNum テンプレート数 5 Number
isoImageNum ISOイメージ数 3 Number
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/catalog?startindex=11&pagesize=1"
レスポンス例
  
  {
    "totalCount": 12,
    "totalModifyDate": "2023-06-27T11:25:08+0900",
    "catalogs": [
        {
          "siteId": "8eb064f7a5db11e895ea005056898046",
          "siteName": "East",
          "zoneId": "0fb296e296924f2bb1a4ce173a0febca",
          "zoneName": "Zone11",
          "podId": "5f49b71d1a1b4f1baf1dec19b5778943",
          "podName": "East_Zone11_VC05",
          "tenantId": "6856a4a04db64fbea0fdea167ad45b7d",
          "tenantName": "APU9999999",
          "keiyakuResourceId": "f05f432d9a774378a30cfa55180786be",
          "keiyakuResourceName": "VC05_Basic_03-APU9999999",
          "catalogId": "38442ffb0dbe4ba1a94357642cf446ab",
          "catalogName": "Cat01",
          "comment": "",
          "shares": [
              {
                  "shareUserId": "ccc4a6803d9f4c52961bf99bd6ecf5d0",
                  "shareUserName": "user02"
              }
          }
        ],
          "ownerUserId": "81ebfe5ae3c048a7bda5a1006d4ad76f",
          "ownerUserName": "APU9999999",
          "storageId": "329c90cd589a4476827fda538880a3a7",
          "storageName": "VC05_ST03_SSD3_BK0",
          "templateNum": 1,
          "isoImageNum": 2,
          "createDate": "2021-12-18T04:15:17+0900",
          "createUserId": "81ebfe5ae3c048a7bda5a1006d4ad76f",
          "modifyDate": "2021-12-18T04:15:17+0900",
          "modifyUserId": "81ebfe5ae3c048a7bda5a1006d4ad76f"
      }
    }