Ir para o conteúdo principal

Recuperando Ativos

Ativos (V1) API permite que um usuário com View Install Base permissão procure ativos instalados com base em um determinado critério e busque detalhes específicos do ativo.

Pré-requisitos​

Autenticar - Envie suas credenciais de usuário, ID do cliente e segredo do cliente para autenticação OAuth2. Consulte Autenticação API para obter instruções sobre como chamar o OAuth API para validar e autenticar suas credenciais.

Pesquisando Ativos e Dados de Ativos​

Para pesquisar informações de ativos, envie uma POST solicitação para o /assets/search terminal. Especifique seus critérios de pesquisa no corpo da solicitação. Opcionalmente, especifique o comportamento de pesquisa nos parâmetros de consulta.

Duas etapas para recuperar informações de ativos

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

Exemplo de solicitação cURL:

A solicitação indica que foi feita uma busca por patch panels no local IBX, DA1; no cage, DA1:01:009800; e instalados dentro das datas 2003/07/17 até2019/07/17. Os resultados da pesquisa foram classificados por número de série crescente, filtrados para patch panels que tinham apenas números de ativos, incluindo 101, selecionados para iniciar a partir do índice 0e limitados 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"
        }
    }

Exemplo de resposta:

{
    "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 obter uma lista completa dos parâmetros de resposta, consulte a Referência do API .

Obter ativos​

Para obter todos os detalhes de um ativo específico, envie uma GET solicitação para o /assets/{assetId} endpoint. Especifique o ativo por ID no caminho da solicitação.

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

Exemplo de resposta:

{
    "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 obter uma lista completa dos parâmetros de resposta, consulte a Referência do API .

Esta página foi útil?