API - Conectar ao IBM Cloud Direct Link 2.0

Estabeleça uma conexão com o IBM Cloud™ Direct Link 2.0 para conectar seus ativos IBX colocalizados aos seus recursos do IBM Cloud.

Identifique seu ID de conta IBM

Faça login no [console do IBM Cloud e selecione Gerenciar. > Digite Conta para localizar o seu ID de conta IBM.

Pré-requisitos da API Fabric

Autenticar - Envie suas credenciais de usuário, ID do cliente e segredo do cliente para OAuth2. Autenticação. Consulte Autenticação de API para obter instruções sobre como chamar a API OAuth para validar e autenticar suas credenciais.
Determine as informações do seu lado A. Ou:
- Recupere as informações das portas do Equinix Fabric usando a solicitação de API Obter todas as portas.
OU
- Determine as informações do seu dispositivo de borda de rede. Você precisa de um dispositivo virtual/dispositivo redundante/cluster Equinix provisionado com uma licença registrada. Verifique seus dispositivos virtuais e clusters disponíveis chamando Obter Dispositivos Virtuais ou Obter Dispositivo Virtual {uuid}. Você pode escolher qualquer interface disponível no dispositivo para sua conexão. No entanto, a Equinix selecionará uma interface se você não especificar uma.
Escolha a localização do metrô do lado Z. Use a solicitação de API Obter todos os metrôs para encontrar todos os metrôs onde o Equinix Fabric está disponível e determinar a localização de destino.
Identifique o perfil de serviço. Use a solicitação de API Recuperar Perfis de Serviço para pesquisar um perfil de serviço específico ou use a solicitação de API Obter Perfis de Serviço para listar todos os perfis de serviço disponíveis e identificar o perfil desejado. perfil ao qual você deseja se conectar.

Conectando-se ao IBM Cloud Direct Link 2.0 a partir de uma porta DOT1Q

Para criar uma conexão da sua porta DOT1Q com o IBM Cloud Direct Link 2.0, envie uma solicitação POST para o endpoint /fabric/v4/connections. Especifique os detalhes de configuração da sua conexão no corpo da solicitação.

	POST /fabric/v4/connections
Method	`POST`
Endpoint	`/fabric/v4/connections`
Headers	`Authorization`, `Content-Type`
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	`type`, `name`, `order`, `bandwidth`, `redundancy`, `aSide`, `zSide`, `additionalInfo`, `notifications`

Exemplo de solicitação cURL:

curl -X  
POST 'https://api.equinix.com/fabric/v4/connections'  
-H 'content-type: application/json'  
-H 'authorization: Bearer <token>'  
-d '{  
    "type": "EVPL_VC",  
    "name": "Conn-1",  
    "order": {  
        "purchaseOrderNumber": "1-129105284100"  
    },  
    "bandwidth": 1000,  
    "redundancy": {  
        "priority": "PRIMARY"  
    },  
    "aSide": {  
        "accessPoint": {  
            "type": "COLO",  
            "port": {  
                "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"  
            },  
            "linkProtocol": {  
                "type": "DOT1Q",  
                "vlanTag": 1001  
            }  
        }  
    },  
    "zSide": {  
        "accessPoint": {  
            "type": "SP",  
            "profile": {  
                "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"  
            },  
            "location": {  
                "metroCode": "SV"  
            },  
            "authenticationKey": "xx-xxx-xx",  
            "sellerRegion": "us-west-1"  
        }  
    },  
    "additionalInfo": [  
        {  
            "key": "ASN",  
            "value": "12345"  
        },  
        {  
            "key": "CER IPv4 CIDR",  
            "value": "11.1.1.10/30"  
        },  
        {  
            "key": "IBM IPv4 CIDR",  
            "value": "11.1.1.10/30"  
        }  
    ],  
    "notifications": {  
        "type": "ALL",  
        "emails": [  
            "test@equinix.com",  
            "test2@equinix.com"  
        ]  
    }  
}'

Os parâmetros incluídos no corpo da solicitação são específicos deste exemplo. Para obter uma lista completa dos parâmetros e suas descrições, consulte a Referência da API.

Exemplo de resposta:

{  
    "href": "https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62",  
    "type": "EVPL_VC",  
    "uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",  
    "name": "Conn-1",  
    "state": "PROVISIONING",  
    "order": {  
        "purchaseOrderNumber": "1-129105284100",  
        "billingTier": "Up to 1 Gbps"  
    },  
    "bandwidth": 1000,  
    "redundancy": {  
        "group": "m167f685-41b0-1b07-6de0-320a5c00abeu",  
        "priority": "PRIMARY"  
    },  
    "aSide": {  
        "accessPoint": {  
            "type": "COLO",  
            "port": {  
                "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",  
                "type": "XF_PORT",  
                "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"  
            },  
            "linkProtocol": {  
                "type": "DOT1Q",  
                "vlanTag": 1001  
            }  
        }  
    },  
    "zSide": {  
        "accessPoint": {  
            "type": "SP",  
            "profile": {  
                "href": "https://api.equinix.com/fabric/v4/services/serviceProfiles/20d32a80-0d61-4333-bc03-707b591ae2f5",  
                "type": "L2_PROFILE",  
                "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"  
            },  
            "location": {  
                "href": "https://api.equinix.com/v4/metros/SV",  
                "metroCode": "SV",  
                "region": "AMER"  
            },  
            "authenticationKey": "xx-xxx-xx",  
            "sellerRegion": "us-west-1"  
        }  
    },  
    "additionalInfo": [  
        {  
            "key": "ASN",  
            "value": "12345"  
        },  
        {  
            "key": "CER IPv4 CIDR",  
            "value": "11.1.1.10/30"  
        },  
        {  
            "key": "IBM IPv4 CIDR",  
            "value": "11.1.1.10/30"  
        }  
    ],  
    "notifications": [  
        {  
            "type": "ALL",  
            "emails": [  
                "test@equinix.com",  
                "test2@equinix.com"  
            ]  
        }  
    ],  
    "operation": {  
        "equinixStatus": "PROVISIONING",  
        "providerStatus": "PROVISIONING"  
    },  
    "changeLog": {  
        "createdDateTime": "2021-07-15T19:30:29.526Z"  
    }  
}

A resposta inclui parâmetros de configuração definidos no corpo da requisição. Para obter uma lista completa dos parâmetros possíveis e suas descrições, consulte a Referência da API.

Conectando-se ao IBM Cloud Direct Link 2.0 a partir de uma porta QINQ

Para criar uma conexão da sua porta QINQ com o IBM Cloud Direct Link 2.0, envie uma solicitação POST para o endpoint /fabric/v4/connections. Especifique os detalhes de configuração da sua conexão no corpo da solicitação.

	POST /fabric/v4/connections
Method	`POST`
Endpoint	`/fabric/v4/connections`
Headers	`Authorization`, `Content-Type`
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	`type`, `name`, `order`, `bandwidth`, `redundancy`, `aSide`, `zSide`, `additionalInfo`, `notifications`

Exemplo de solicitação cURL:

curl -X  
POST 'https://api.equinix.com/fabric/v4/connections'  
-H 'content-type: application/json'  
-H 'authorization: Bearer <token>'  
-d '{  
    "type": "EVPL_VC",  
    "name": "Conn-1",  
    "order": {  
        "purchaseOrderNumber": "1-129105284100"  
    },  
    "bandwidth": 1000,  
    "redundancy": {  
        "priority": "PRIMARY"  
    },  
    "aSide": {  
        "accessPoint": {  
            "type": "COLO",  
            "port": {  
                "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"  
            },  
            "linkProtocol": {  
                "type": "QINQ",  
                "vlanCTag": 1001,  
                "vlanSTag": 1002  
            }  
        }  
    },  
    "zSide": {  
        "accessPoint": {  
            "type": "SP",  
            "profile": {  
                "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"  
            },  
            "location": {  
                "metroCode": "SV"  
            },  
            "authenticationKey": "xx-xxx-xx",  
            "sellerRegion": "us-west-1"  
        }  
    },  
    "additionalInfo": [  
        {  
            "key": "ASN",  
            "value": "12345"  
        },  
        {  
            "key": "CER IPv4 CIDR",  
            "value": "11.1.1.10/30"  
        },  
        {  
            "key": "IBM IPv4 CIDR",  
            "value": "11.1.1.10/30"  
        }  
    ],  
    "notifications": {  
        "type": "ALL",  
        "emails": [  
            "test@equinix.com",  
            "test2@equinix.com"  
        ]  
    }  
}'

Os parâmetros incluídos no corpo da solicitação são específicos deste exemplo. Para obter uma lista completa dos parâmetros e suas descrições, consulte a Referência da API.

Conectando-se ao IBM Cloud Direct Link 2.0 a partir de um dispositivo de Network Edge

Para criar uma conexão do seu dispositivo Network Edge com o IBM Cloud Direct Link 2.0, envie uma solicitação POST para o endpoint /fabric/v4/connections. Especifique os detalhes de configuração da sua conexão no corpo da solicitação.

	POST /fabric/v4/connections
Method	`POST`
Endpoint	`/fabric/v4/connections`
Headers	`Authorization`, `Content-Type`
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	`type`, `name`, `order`, `bandwidth`, `redundancy`, `aSide`, `zSide`, `additionalInfo`, `notifications`

Exemplo de solicitação cURL:

curl -X  
POST 'https://api.equinix.com/fabric/v4/connections'  
-H 'content-type: application/json'  
-H 'authorization: Bearer <token>'  
-d '  
{  
    "type": "EVPL_VC",  
    "name": "port2ibm2-vvv-0425f",  
    "bandwidth": "50",  
    "aSide": {  
        "accessPoint": {  
            "type": "VD",  
            "virtualDevice": {  
                "type": "EDGE",  
                "uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"  
            }  
        }  
    },  
    "zSide": {  
        "accessPoint": {  
            "type": "SP",  
            "profile": {  
                "type": "L2_PROFILE",  
                "uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"  
            },  
            "location": {  
                "metroCode": "SV"  
            },  
            "authenticationKey": "XXXXXXXXXX",  
            "sellerRegion": "San Jose 2"  
        }  
    },  
    "additionalInfo": [  
        {  
            "key": "ASN",  
            "value": 12345  
        },  
        {  
            "key": "BGP_CER_CIDR",  
            "value": "172.16.0.17/30"  
        },  
        {  
            "key": "BGP_IBM_CIDR",  
            "value": "172.16.0.18/30"  
        },  
        {  
            "key": "Global",  
            "value": false  
        }  
    ],  
    "project": {  
        "projectId": "16799d66-ef43-445c-ba29-d17522d8a137"  
    },  
    "order": {  
        "purchaseOrderNumber": "1-129105284100"  
    },  
    "notifications": [  
        {  
            "type": "ALL",  
            "emails": [  
                "x@gmail.com"  
            ]  
        }  
    ]  
}  
'

Os parâmetros incluídos no corpo da solicitação são específicos deste exemplo. Para obter uma lista completa dos parâmetros e suas descrições, consulte a Referência da API.

Exemplo de resposta:

{  
    "type": "EVPL_VC",  
    "href": "https://api.equinix.com/fabric/v4/connections/0175e136-8be7-4b04-8d57-c33c20555501",  
    "uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",  
    "name": "port2ibm2-vvv-0425f",  
    "operation": {  
        "providerStatus": "PROVISIONING",  
        "equinixStatus": "PROVISIONING"  
    },  
    "order": {  
        "purchaseOrderNumber": "1-129105284100",  
        "billingTier": "Up to 50 MB"  
    },  
    "notifications": [  
        {  
            "type": "ALL",  
            "emails": [  
                "x@gmail.com"  
            ]  
        }  
    ],  
    "changeLog": {  
        "createdBy": "fabricamcrh1",  
        "createdByFullName": "XXXXX XXXXXX",  
        "createdByEmail": "x@gmail.com",  
        "createdDateTime": "2024-04-25T20:41:37.805Z",  
        "updatedBy": "fabricamcrh1",  
        "updatedByFullName": "XXXXXX XXXXXX",  
        "updatedByEmail": "x@gmail.com",  
        "updatedDateTime": "2024-04-25T20:41:37.805Z"  
    },  
    "bandwidth": 50,  
    "redundancy": {  
        "group": "d1f11356-91ca-4550-8488-ba434a771e09",  
        "priority": "PRIMARY"  
    },  
    "aSide": {  
        "accessPoint": {  
            "interface": {  
                "uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",  
                "id": 8,  
                "type": "CLOUD"  
            },  
            "location": {  
                "metroCode": "DC"  
            },  
            "virtualDevice": {  
                "uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",  
                "type": "EDGE"  
            }  
        }  
    },  
    "zSide": {  
        "accessPoint": {  
            "location": {  
                "metroCode": "SV"  
            },  
            "profile": {  
                "href": "https://api.equinix.com/fabric/v4/serviceProfiles/e092ed47-63d2-4f4a-87a0-82e3b08eefe5",  
                "type": "L2_PROFILE",  
                "name": "IBM Cloud Direct Link 2",  
                "uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"  
            },  
            "sellerRegion": "San Jose 2",  
            "authenticationKey": "XXXXXXXXXXXXXXXXXXX"  
        }  
    }  
}

A resposta inclui parâmetros de configuração definidos no corpo da requisição. Para obter uma lista completa dos parâmetros possíveis e suas descrições, consulte a Referência da API.

Monitorando o status da conexão

Envie uma solicitação GET para o endpoint fabric/v4/connections/{connectionId} para monitorar o status da conexão.

`equinixStatus`attribute values	`providerStatus`attribute values	IBM Direct Link status	Description
`PROVISIONING`	`PROVISIONING`	-	Connection request has not been sent to IBM yet.
`PENDING_PROVIDER_VLAN`	`PENDING_APPROVAL`	Create approval pending	The connection awaits for approval.
`PROVISIONED`	`PROVISIONING / PROVISIONED`	Create in progress	Connection establishment in progress.
`PROVISIONED`	`PROVISIONED`	Provisioned	Connection established.

Aceitando a conexão

Faça login no [console do IBM Cloud e navegue até a [página de troca de links diretos do IBM Cloud para revisar e aceitar a conexão pendente.

Identifique seu ID de conta IBM​

Pré-requisitos da API Fabric​

Conectando-se ao IBM Cloud Direct Link 2.0 a partir de uma porta DOT1Q​

Conectando-se ao IBM Cloud Direct Link 2.0 a partir de uma porta QINQ​

Conectando-se ao IBM Cloud Direct Link 2.0 a partir de um dispositivo de Network Edge​

Monitorando o status da conexão​

Aceitando a conexão​

Identifique seu ID de conta IBM

Pré-requisitos da API Fabric

Conectando-se ao IBM Cloud Direct Link 2.0 a partir de uma porta DOT1Q

Conectando-se ao IBM Cloud Direct Link 2.0 a partir de uma porta QINQ

Conectando-se ao IBM Cloud Direct Link 2.0 a partir de um dispositivo de Network Edge

Monitorando o status da conexão

Aceitando a conexão