Récupération des actifs

L'API Assets (V1) permet à un utilisateur disposant de l'autorisation View Install Base de rechercher des ressources installées en fonction de critères donnés et de récupérer des détails spécifiques sur les ressources.

Préalable

Authentification: soumettez vos identifiants utilisateur, votre identifiant client et votre clé secrète pour l’authentification OAuth2. Consultez la documentation relative à l’authentification API (Authentification API) pour savoir comment appeler l’API OAuth afin de valider et d’authentifier vos identifiants.

Recherche d'actifs et de données sur les actifs

Pour rechercher des informations sur les actifs, envoyez une requête POST au point de terminaison /assets/search. Précisez vos critères de recherche dans le corps de la requête. Vous pouvez également spécifier le comportement de la recherche dans les paramètres de requête.

API specification for "assetsv1" not found.

Exemple de requête cURL:

Cette requête indique qu'une recherche de panneaux de brassage a été effectuée à l'emplacement IBX DA1, dans la cage DA1:01:009800, et installés dans La recherche a été effectuée pour la période du 2003-07-17 au 2019-07-17 . Les résultats ont été triés par numéro de série croissant, filtrés pour ne retenir que les panneaux de brassage dont le numéro d'inventaire incluait « 101 », sélectionnés pour commencer à l'index « 0 » et limités à 100 résultats par page.

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

Exemple de réponse:

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

Pour une liste complète des paramètres de réponse, consultez la référence API.

Obtenir des actifs

Pour obtenir tous les détails d'une ressource spécifique, envoyez une requête GET au point de terminaison /assets/{assetId}. Spécifiez l'identifiant de la ressource dans le chemin de la requête.

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

Exemple de réponse:

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

Pour une liste complète des paramètres de réponse, consultez la référence API.