資産の回収
Assets (V1) API を使用すると、View Install Base 権限を持つユーザーは、指定された条件に基づいてインストールされている資産を検索し、特定の資産の詳細を取得することができます。
必須条件
Authenticate - OAuth2認証のためのユーザー認証情報、クライアントID、クライアントシークレットを送信します。OAuth APIを呼び出して認証情報を検証および認証する方法については、API Authenticationを参照してください。
資産と資産データの検索
資産情報を検索するには、/assets/search エンドポイントに POST リクエストを送信します。リクエストの本文で検索条件を指定します。オプションで、クエリパラメータに検索動作を指定します。
POST /v1/assets/searchView the API Reference | |
|---|---|
| Method | POST |
| URL or End Point | /v1/assets/search |
| Headers | Content-Type |
| Query Parameters | sorts, source, q, exactMatch |
| Body Parameters | filter {ibxs [string], cages [string], productTypes [string], dateRange {fromDate, toDate}} |
サンプルcURLリクエスト：
このリクエストは、IBXロケーション、DA1、ケージ、DA1:01:009800、および日付 2003/07/17 から 2019/07/17 内に設置されたパッチパネルの検索が行われたことを示しています。検索結果は、シリアル番号の昇順でソートされ、資産番号が 101 を含むパッチパネルのみでフィルタリングされ、インデックス 0 から開始するように選択され、1ページあたりの検索結果は100件に制限されました。
curl -X
POST "https://api.equinix.com/v1/assets/search?sorts=SERIAL_NUMBER&source=ASSET_NUMBER&q=101&exactMatch=false&offset=0&limit=100"
-H "content-type: application/json"
-H "authorization: Bearer <token>"
-d '{
"filter": {
"ibxs": [
"DA1"
],
"cages": [
"DA1:01:009800"
],
"productTypes": [
"PATCH_PANEL"
],
"dateRange": {
"fromDate": "2003-07-17T03:31:20.455Z",
"toDate": "2019-07-17T03:31:20.455Z"
}
}
回答例
{
"data": [
{
"assetNumber": "10139297",
"serialNumber": "PP:0210:73281",
"orderNumber": 1-126273059,
"productName": "PATCH_PANEL",
"ibx": "DA1",
"cage": "DA1:01:009800",
"productDescription": "Patch Panel",
"accountNumber": "987",
"relatedAccountNumber": null,
"accountName": "JOHN-DOE-CORP",
"installationDate": "2009-05-14T00:00:00Z",
"customerReferenceNumber": DAY-98278,
"billingAgreementNumber": CAB-93678,
"status": "ACTIVE",
"additionalDetails": {
"cabinetNumber": "DA1:01:009800:0210",
"customerOrCarrierCircuitID": null,
"finalzSideSystemName": null,
"productBundle": null,
"patchPanelNumber": "PP:0210:73281"
}
},
{
"assetNumber": "10147789",
"serialNumber": "VP:0101:74679",
"orderNumber": null,
"productName": "PATCH_PANEL",
"ibx": "DA1",
"cage": "DA1:R1:V000170-1-294",
"productDescription": "Patch Panel",
"accountNumber": "987",
"relatedAccountNumber": null,
"accountName": "JOHN-DOE-CORP",
"installationDate": "2009-07-09T00:00:00Z",
"customerReferenceNumber": null,
"billingAgreementNumber": null,
"status": "ACTIVE",
"additionalDetails": {
"cabinetNumber": "DA1:R1:V000170-1-294:V1801",
"customerOrCarrierCircuitID": null,
"finalzSideSystemName": null,
"productBundle": null,
"patchPanelNumber": "VP:0101:74679"
}
}
],
"page": {
"limit": 100,
"offset": 0,
"total": 2,
"sorts": [
"SERIAL_NUMBER"
]
},
"_links": {
"next": {
"href": "/assets/search?q=101&exactMatch=false&offset=0&limit=100&source=ASSET_NUMBER&sorts=SERIAL_NUMBER"
},
"previous": {
"href": "/assets/search?q=101&exactMatch=false&offset=0&limit=100&source=ASSET_NUMBER&sorts=SERIAL_NUMBER"
},
"self": {
"href": "/assets/search?q=101&exactMatch=false&offset=0&limit=100&source=ASSET_NUMBER&sorts=SERIAL_NUMBER"
}
}
}
レスポンスパラメーターの完全なリストについては、APIリファレンスを参照してください。
資産取得
特定のアセットのすべての詳細を取得するには、/assets/{assetId} エンドポイントに GET リクエストを送信します。リクエストのパスにIDでアセットを指定します。
curl -X
GET "https://api.equinix.com/v1/assets/{asset_id}"
-H "content-type: application/json"
-H "authorization: Bearer <token>"
回答例
{
"assetNumber": "9980813",
"serialNumber": "1011585-M",
"orderNumber": "1-198255055853",
"productName": "CROSS_CONNECT",
"ibx": "DC4",
"cage": "DC4:01:043325",
"productDescription": "Network Cable Connection",
"accountNumber": "888",
"accountName": "JOHN-DOE-CORPORATION",
"installationDate": "2008-08-28T00:00:00Z",
"customerReferenceNumber": "",
"status": "Active",
"productDetails": [
{
"key": "ACCOUNT_NAME",
"value": "JOHN-DOE-CORPORATION",
"tag": "HEADER"
},
{
"key": "CUSTOMER",
"value": "JOHN-DOE-CORPORATION",
"tag": "A_SIDE_INFORMATION"
},
{
"key": "ASSET_NUMBER",
"value": "9980813",
"tag": "OTHER_DETAILS"
},
{
"key": "IFC_PANEL",
"value": "No",
"tag": "Z_SIDE_INFORMATION"
}
]
}
レスポンスパラメーターの完全なリストについては、APIリファレンスを参照してください。