Champs de la réponse API de clé de service Azure
Ce sujet montre la réponse à une requête de recherche de clé de service Azure et décrit les champs de la réponse.
GET {baseUrl}/v2/secure/azure/{service_key}
{
"message": "Successful lookup",
"terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy",
"data": {
"managed": true,
"connectType": "AZURE",
"resource_type": "csp_connection",
"bandwidth": 200,
"service_key": "3e2480b2-b4d5-424b-976a-7b0de65a1b62",
"vlan": 3289,
"megaports": [
{
"portSpeed": 10000,
"name": "Washington DC Primary",
"state": "VA",
"description": "Azure ExpressRoute at Equinix DC2/6",
"productUid": "a7ae8a35-433e-44aa-87cb-a1b7995ab008",
"nServiceId": 32832,
"companyUid": "c40de5ed-4707-4471-a78c-69436de2c505",
"country": "USA",
"vxc": 60574,
"port": 14570,
"companyName": "Azure ExpressRoute",
"locationId": 67,
"productId": 14570,
"type": "primary",
"companyId": 1475
},
{
"portSpeed": 10000,
"name": "Washington DC Secondary",
"state": "VA",
"description": "Azure ExpressRoute at Equinix DC2/6",
"productUid": "07ab0ee6-7f77-41ac-bbe6-335e3ee6d182",
"nServiceId": 36431,
"companyUid": "c40de5ed-4707-4471-a78c-69436de2c505",
"country": "USA",
"vxc": 60575,
"port": 16108,
"companyName": "Azure ExpressRoute",
"locationId": 67,
"productId": 16108,
"type": "secondary",
"companyId": 1475
}
],
"peers": [
{
"peer_asn": 133937,
"shared_key": null,
"primary_subnet": "169.254.167.176/30",
"secondary_subnet": "169.254.167.180/30",
"vlan": 100,
"type": "private"
},
{
"peer_asn": 133937,
"shared_key": null,
"prefixes": "117.18.81.116/30,117.18.81.120/30",
"primary_subnet": "117.18.81.116/30",
"secondary_subnet": "117.18.81.120/30",
"vlan": 200,
"type": "microsoft"
}
]
}
}
Ces tableaux décrivent chaque champ de la réponse.
| Attribut | Description | Valeurs |
|---|---|---|
| managed | Indique si Megaport gère les informations de peering | true/false |
| connectType | AZURE | |
| resource_type | csp_connection | |
| bandwidth | La bande passante définie sur la configuration ExpressRoute dans le portail Azure | • 50 Mbps • 100 Mbps • 200 Mbps • 500 Mbps • 1 Gbps • 2 Gbps • 5 Gbps • 10 Gbps Pour plus d’informations, voir le sujet d’aide Microsoft avec les options de bande passante. |
| service_key | L’ID pour la clé de service | UUID |
| vlan | VLAN ID | |
| megaports | Tableau de détails de Megaport, y compris les VXC attachés. Le tableau contient des informations pour un port principal et secondaire. | Pour plus d’informations, voir le tableau Ports (suivant). |
| peers | Tableau des informations de peering, avec un maximum de deux: privé et microsoft. Si les peers ne sont pas configurés, ils ne seront pas présents. | Pour plus d’informations, voir le tableau Peers (ci-dessous). |
Ports
| Attribut | Description |
|---|---|
| portSpeed | Vitesse du Port: 1000, 10000, ou 100000 Mbps |
| name | Nom du Port |
| state | Emplacement du Port (État) |
| description | Description du Port |
| productUid | Port UUID - utilisé pour la commande |
| nServiceId | Utilisé par Megaport |
| companyUid | Utilisé par Megaport |
| country | Emplacement du Port (Pays) |
| vxc | ID numérique de VXC associé avec cette combinaison clé/Port. Null si un VXC n’est pas configuré |
| port | ID numérique du Port |
| companyName | Nom de l’entreprise qui possède le Port |
| locationId | L’ID de l’emplacement de ce Port |
| productId | Identique au Port |
| companyId | ID numérique de l’entreprise |
Peers
Pour un Port, vous configurez le peering via le portail Azure. Lorsqu’il est configuré, les détails de peering apparaissent dans la réponse.
Pour un MCR, vous pouvez définir le type de peering via l’API et Megaport configure automatiquement les détails BGP. Lorsqu’ils sont configurés, ces détails de peering apparaissent dans la réponse de validation de la clé de service.
| Attribut | Description | Valeurs |
|---|---|---|
| peer_asn | L’ASN du peer | ASN valide (ne pas utiliser 65515) |
| shared_key | Clé BGP partagée | Null ou jusqu’à 25 caractères alphanumériques |
| prefixes | Préfixes d’adresses IP | Liste séparée par des virgules des préfixes d’adresses IP publiques associées avec les sous-réseaux primaire et secondaire - uniquement présent pour le peering Microsoft. |
| primary_subnet | Sous-réseau IP principal associé à ce type de peer. | Préfixe IP |
| secondary_subnet | Sous-réseau IP secondaire associé à ce type de peer. | Préfixe IP |
| vlan | VLAN interne associé à ce type de peer | int |
| type | Type de peering | microsoft ou private |