Saltar al contenido principal

Recuperación de activos

API de activos (V1) permite a un usuario con View Install Base permiso buscar activos instalados en función de un criterio determinado y obtener detalles específicos del activo.

Requisitos previos​

Autenticar: Envíe sus credenciales de usuario, ID de cliente y secreto de cliente para la autenticación OAuth2. Consulte Autenticación de API para obtener instrucciones sobre cómo llamar al API de OAuth para validar y autenticar sus credenciales.

Búsqueda de activos y datos de activos​

Para buscar información de activos, envíe una POST solicitud al /assets/search punto final. Especifique sus criterios de búsqueda en el cuerpo de la solicitud. Especifique opcionalmente el comportamiento de búsqueda en los parámetros de la consulta.

Dos pasos para recuperar información de activos

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

Ejemplo de solicitud cURL:

Esta solicitud indica que se ha realizado una búsqueda de paneles de conexión en la ubicación IBX, DA1; en la jaula, DA1:01:009800; y se ha instalado en las fechas 2003/07/17 indicadas2019/07/17. Los resultados de la búsqueda se ordenaron por número de serie ascendente, se filtraron para paneles de conexiones que solo tenían números de activos, incluyendo 101, seleccionados para comenzar desde el índice 0, y se limitaron a 100 resultados por página.

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"
        }
    }

Respuesta de muestra:

{
    "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"
        }
    }
}

Para obtener una lista completa de los parámetros de respuesta, consulte la referencia de API .

Obtener activos​

Para obtener todos los detalles de un activo específico, envíe una GET solicitud al /assets/{assetId} punto final. Especifique el activo por ID en la ruta de acceso de la solicitud.

curl -X
GET "https://api.equinix.com/v1/assets/{asset_id}"
-H "content-type: application/json"
-H "authorization: Bearer <token>"

Respuesta de muestra:

{
    "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"
        }
    ]
}

Para obtener una lista completa de los parámetros de respuesta, consulte la referencia de API .

¿Le ha resultado útil esta página?