List TGW connect id with VPC name

GET

/

v2

/

api

/

list_tgw_connect_id_with_vpc_name

cURL

curl -sk -X GET "https://${CONTROLLER}/v2/api/list_tgw_connect_id_with_vpc_name" \
  -H "Authorization: cid ${CID}"

import requests

url = f"https://{CONTROLLER}/v2/api/list_tgw_connect_id_with_vpc_name"
headers = {"Authorization": f"cid {cid}"}

response = requests.get(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://"+controller+"/v2/api/list_tgw_connect_id_with_vpc_name", nil)
  req.Header.Set("Authorization", "cid "+cid)

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

Query Parameters

acct_name

string

Account name.

region

string

Region.

tgw_name

string

required

TGW name.

attachment_name

string

Attachment, e.g. VPC ID.

route_domain_name

string

A route domain name.

include_avx

boolean

Include avx attachment.

allowed_prefix

string

Direct Connect allowed prefix.

route_list

string

A list of CIDRs.

enable_access

string

Configure management access from AVX_EDGE_DOMAIN.

learned_cidrs_approval

enum<string>

Learned cidrs approval.

Available options:

no,

yes

pending_learned_cidrs

string

Pending learned cidrs.

approved_learned_cidrs

string

Approved learned cidrs.

disable_local_propagation

boolean

Disable local propagation.

conn_name

string

TGW attachment connection name.

tgw_ip_address

string

TGW IP address.

peer_ip_address

string

TGW Connect peer IP address.

inside_ip_cidr

string

TGW Connect inside CIDR block.

connect_peer_id

string

TGW Connect peer ID.

peer_asn

string

TGW Connect peer ASN number.

connect_peer_name

string

TGW Connect peer name.

action

string

The API action to perform. Required for 7.2 controllers only.

CID

string

The opaque session ID token. Required for 7.2 controllers only.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

errortype

string

Error type if the API failed.

reason

string

Failure reason if the API failed.

results

API response data

return

boolean

Whether the API returned successfully

⌘I

cURL

curl -sk -X GET "https://${CONTROLLER}/v2/api/list_tgw_connect_id_with_vpc_name" \
  -H "Authorization: cid ${CID}"

import requests

url = f"https://{CONTROLLER}/v2/api/list_tgw_connect_id_with_vpc_name"
headers = {"Authorization": f"cid {cid}"}

response = requests.get(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://"+controller+"/v2/api/list_tgw_connect_id_with_vpc_name", nil)
  req.Header.Set("Authorization", "cid "+cid)

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}