MetrosApi.md

\MetrosApi

All URIs are relative to https://api.equinix.com

Method	HTTP request	Description
GetMetroByCode	Get /fabric/v4/metros/{metroCode}	Get Metro by Code
GetMetros	Get /fabric/v4/metros	Get all Metros

GetMetroByCode

Metro GetMetroByCode(ctx, metroCode).Execute()

Get Metro by Code

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/equinix/equinix-sdk-go/services/fabricv4"
)

func main() {
	metroCode := "metroCode_example" // string | Metro Code

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MetrosApi.GetMetroByCode(context.Background(), metroCode).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MetrosApi.GetMetroByCode``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMetroByCode`: Metro
	fmt.Fprintf(os.Stdout, "Response from `MetrosApi.GetMetroByCode`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
metroCode	string	Metro Code

Other Parameters

Other parameters are passed through a pointer to a apiGetMetroByCodeRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Metro

Authorization

BearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMetros

MetroResponse GetMetros(ctx).Presence(presence).Offset(offset).Limit(limit).Execute()

Get all Metros

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/equinix/equinix-sdk-go/services/fabricv4"
)

func main() {
	presence := openapiclient.Presence("MY_PORTS") // Presence | User On Boarded Metros based on Fabric resource availability (optional)
	offset := int32(1) // int32 | offset (optional)
	limit := int32(10) // int32 | number of records to fetch (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.MetrosApi.GetMetros(context.Background()).Presence(presence).Offset(offset).Limit(limit).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `MetrosApi.GetMetros``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMetros`: MetroResponse
	fmt.Fprintf(os.Stdout, "Response from `MetrosApi.GetMetros`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetMetrosRequest struct via the builder pattern

Name	Type	Description	Notes
presence	Presence	User On Boarded Metros based on Fabric resource availability
offset	int32	offset
limit	int32	number of records to fetch

Return type

MetroResponse

Authorization

BearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]