Recuperando Ativos
A API Assets (V1) permite que um usuário com a permissão "Visualizar Base de Instalações" pesquise ativos instalados com base em critérios específicos e obtenha detalhes de ativos específicos.
Pré-requisitos
Autenticar - Envie suas credenciais de usuário, ID do Cliente e Segredo do Cliente para autenticação OAuth2. Consulte Autenticação de API para obter instruções sobre como chamar a API OAuth para validar e autenticar suas credenciais.
Pesquisando Ativos e Dados de Ativos
Para pesquisar informações sobre ativos, envie uma solicitação POST para o endpoint /assets/search. Especifique seus critérios de pesquisa no corpo da solicitação. Opcionalmente, especifique o comportamento da pesquisa nos parâmetros de consulta.
API specification for "assetsv1" not found.
Exemplo de solicitação cURL:
Esta solicitação indica que foi feita uma busca por painéis de conexão na localização IBX, DA1; no rack, DA1:01:009800; e instalados dentro de A pesquisa foi realizada entre 17/07/2003 e 17/07/2019 . Os resultados foram ordenados por número de série crescente, filtrados para painéis de conexão que continham apenas números de ativos incluindo "101", selecionados para iniciar a partir do índice "0" e 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 da API.
Obter ativos
Para obter todos os detalhes de um ativo específico, envie uma solicitação GET para o endpoint /assets/{assetId}. Especifique o ativo pelo 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 da API.