跳到主要内容

检索资产

Assets (V1) API允许具有权限的用户View Install Base根据给定条件搜索已安装资产,并获取特定资产详情。

先决条件​

验证-提交您的用户凭据,客户端ID和客户端机密以进行OAuth2验证。有关如何致电OAuth API以验证和验证您的凭据的说明,请参阅API验证。

搜索资产和资产数据​

要搜索资产信息,请向端点发送POST请求/assets/search。在请求正文中指定搜索条件。(可选)在查询参数中指定搜索行为。

检索资产信息的两个步骤

POST /v1/assets/searchView the API Reference
MethodPOST
URL or End Point/v1/assets/search
HeadersNot applicable
Query Parameterssorts, source, q, exactMatch
Body ParametersNot applicable

cURL 请求示例:

此请求表示 已搜索IBX网点DA1,机笼中DA1:01:009800以及在截止2019/07/17日期内安装的配线架2003/07/17。搜索结果按序列号升序排序,筛选仅包含资产编号的配线架101,选择从索引开始0,每页最多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参考手册。

获取资产​

要获取特定资产的所有详细信息,请向端点发送GET请求/assets/{assetId}。在请求路径中按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参考手册。

这个页面对您有帮助吗?