Passer au contenu principal

Récupération des actifs

Ressources (V1) API permet à un utilisateur View Install Baseautorisé de rechercher des ressources installées en fonction d'un critère donné et de récupérer des détails spécifiques sur les ressources.

Conditions préalables​

Authentifier - envoyez vos identifiants utilisateur, votre identifiant client et votre secret client pour l'authentification OAuth2. Pour obtenir des instructions sur la façon d'appeler l'API OAuth pour valider et authentifier vos identifiants, reportez-vous à authentification API.

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

Pour rechercher des informations sur les équipements, envoyez une POST demande au /assets/searchterminal. Indiquez vos critères de recherche dans le corps de la demande. Vous pouvez également spécifier le comportement de la recherche dans les paramètres de requête.

Deux étapes pour récupérer les informations sur les équipements

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

Exemple de requête cURL:

Cette demande indique qu'une recherche de panneaux de brassage a été effectuée sur le site IBX, DA1, dans la cage, DA1 :01 :009800 et installés aux dates 2003/07/17 à 2019/07/17 a été effectuée. Les résultats de la recherche ont été triés par numéro de série croissant, filtrés pour les panneaux de brassage ayant uniquement des numéros d'équipement, y compris 101, sélectionnés pour commencer à partir de 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 obtenir la liste complète des paramètres de réponse, reportez-vous à la référence API .

Obtenir des actifs​

Pour obtenir tous les détails d'un équipement spécifique, envoyez une GET demande au /assets/{assetId}terminal. Spécifiez l'équipement par identifiant dans le chemin de la demande.

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 obtenir la liste complète des paramètres de réponse, reportez-vous à la référence API .

Cette page vous a-t-elle été utile ?