Introduction
The IBM Cloud Transit Gateway API is a RESTful API that allows you to manage your Transit Gateway resources.
Familiarize yourself with Transit Gateway functionality described in About IBM Cloud Transit Gateway.
The code examples on this tab use the client library that is provided for Go.
Installation
go get -u github.com/IBM/networking-go-sdk
GitHub:
The code examples on this tab use the client library that is provided for Java.
Maven:
<dependency>
<groupId>com.ibm.cloud</groupId>
<artifactId>transit-gateway-ap-is</artifactId>
<version>X.X.X</version>
</dependency>
Gradle:
compile 'com.ibm.cloud:transit-gateway-ap-is:X.X.X'
GitHub:
The code examples on this tab use the client library that is provided for Node.js.
Installation
npm install ibm-cloud-networking
GitHub:
The code examples on this tab use the client library that is provided for Python.
Installation
pip install --upgrade "ibm-cloud-networking-services>=X.X.X"
GitHub
Authentication
The IBM Cloud Transit Gateway API uses Identity and Access Management (IAM) to authenticate requests. Pass a bearer token in an Authorization header.
You can retrieve an access token by first creating an API key, and then exchanging your API key for an IAM token. For more information, see Retrieving an access token programmatically.
Authorization
Access management to Transit Gateway resources is done through Identity and Access Management (IAM). For more information, see Using IAM permissions with Transit Gateway.
API Endpoint
https://transit.cloud.ibm.com/v1
Use Virtual Private Endpoint (VPE) for VPC to access Transit Gateway via https://private.transit.cloud.ibm.com/v1
.
import (
"github.com/IBM/networking-go-sdk/transitgatewayapisv1"
)
authenticator := &core.IamAuthenticator{
ApiKey: apikey,
}
version := "2021-12-30"
options := &transitgatewayapisv1.TransitGatewayApisV1Options{
Version: &version,
Authenticator: authenticator,
}
transitGatewayService, transitGatewayServiceErr := transitgatewayapisv1.NewTransitGatewayApisV1(options)
transitGatewayService.SetServiceURL("{api_endpoint}")
TransitGatewayApis transitGatewayService = new TransitGatewayApis("2020-03-31", "{service_name}", authenticator);
transitGatewayService.setServiceUrl("{api_endpoint}");
const transitGatewayService = new TransitGatewayApisV1({
version: '2020-03-31',
authenticator: new IamAuthenticator({
apikey: '{apikey}',
}),
serviceUrl: '{api_endpoint}',
});
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
from ibm_cloud_networking_services import TransitGatewayApisV1
authenticator = IAMAuthenticator(
apikey={apikey}
)
transit_gateway_service = TransitGatewayApisV1(
version='2020-03-31',
authenticator=authenticator
)
transit_gateway_service.set_service_url('{api_endpoint}')
Versioning
All API requests require a major version in the path (/v1/
) and a date-based version as a query parameter in the format version=YYYY-MM-DD
.
For example: GET /v1/transit_gateways?version=2020-03-31
Start development of new applications with the current date as a fixed value. Do not dynamically use the current date as the version for a production application. Instead, use a fixed date-based version that was tested with your application.
Pagination
Some API requests can return many results. To improve performance, results are returned one page at a time, with a limited number of results on each page. The default page size is typically 50 items, with a maximum size of 100.
The default and maximum limits might vary by operation. To specify a different page size, use the limit query parameter.
For a request that uses pagination, the response includes additional properties:
- The
first.href
property links to the first page of resources - The
next.href
property links to the next page of resources (included for all pages except for the last page)
Use query parameters to page through your available resources and retrieve a subset of objects. To retrieve the first page of results, make the request without specifying a start
query parameter. If the results cannot fit on the first page, the response will include a next
property, whose value can then be specified as the start
parameter when making the next page request. Each page of results is based on the resources that exist at the time of each paginated request, and therefore may include resources that did not exist when the first request was made. The last page of results will not include a next
property.
When you're retrieving a subset of objects:
- You may use the value of
first.href
to retrieve the first page of resources in the requested sort order and with the requested filters - You may use the value of
next.href
to retrieve the next page of resources in the requested sort order and with the requested filters - You may not change the requested filters across page retrievals
- You may not add a
sort
query parameter to thehref
value (sort order is set by the first paginated list request) - You may modify the
limit
in thehref
value to limit the number of resources to return, per page, in a paginated list operation - You may not change the path segments of the request (that is, anything before the
?
in thehref
value)
Best practices
To minimize regressions from changes, the following best practices are recommended when you call the API:
- Log any 4xx or 5xx HTTP status code along with the included trace property.
- Follow HTTP redirect rules for any 3xx HTTP status code.
- Consume only the resources and properties that are needed for your application to function.
- Avoid depending on any behavior that is not explicitly documented.
Error handling
The Transit Gateway API uses standard HTTP response codes to indicate whether a method completed successfully. A 2xx
response indicates success. A 4xx
type response indicates a failure, and 5xx
type response indicates an internal system error.
This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200
response indicates success. A 400
type response indicates a failure, and a 500
type response indicates an internal system error.
HTTP Error Code | Description | Recovery |
---|---|---|
200 |
Success | The request was successful. |
400 |
Bad Request | The input parameters in the request body are either incomplete or in the wrong format. See the specific error message for more details. Be sure to include all required parameters in your request. |
401 |
Unauthorized | You are not authorized to make this request. Log in to IBM Cloud® and try again. If this error persists, contact the account owner to check your permissions. |
403 |
Forbidden | The supplied authentication is not authorized to access the requested action. Check that you have the correct access credentials and permissions. |
404 |
Not Found | The requested resource might not exist, or the supplied authentication is not authorized to access it. See the specific error message for resource details, verify that the specified resource exists, or contact the account owner to check your permissions to view it. |
408 |
Request Timeout | The connection to the server timed out. Wait a few minutes, then try again. |
409 |
Conflict | The entity is already in the requested state, or resources are in an incorrect state. See the specific error message for more details. |
500 |
Internal Server Error | IBM Cloud Transit Gateway API is currently unavailable. Your request could not be processed. Wait a few minutes and try again. |
Auditing
Monitor API activity within your account by using the IBM Cloud Activity Tracker service. Each time that you make an API call, an event is generated and saved to Activity Tracker. The specific event type is listed for each individual method. For more information, see Auditing events for account management.
Methods
Retrieves all Transit Gateways
List all Transit Gateways in account the caller is authorized to view.
List all Transit Gateways in account the caller is authorized to view.
List all Transit Gateways in account the caller is authorized to view.
List all Transit Gateways in account the caller is authorized to view.
List all Transit Gateways in account the caller is authorized to view.
GET /transit_gateways
ServiceCall<TransitGatewayCollection> listTransitGateways(ListTransitGatewaysOptions listTransitGatewaysOptions)
listTransitGateways(params)
list_transit_gateways(self,
*,
limit: int = None,
start: str = None,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) ListTransitGateways(listTransitGatewaysOptions *ListTransitGatewaysOptions) (result *TransitGatewayCollection, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) ListTransitGatewaysWithContext(ctx context.Context, listTransitGatewaysOptions *ListTransitGatewaysOptions) (result *TransitGatewayCollection, response *core.DetailedResponse, err error)
Request
Use the ListTransitGatewaysOptions.Builder
to create a ListTransitGatewaysOptions
object that contains the parameter values for the listTransitGateways
method.
Instantiate the ListTransitGatewaysOptions
struct and set the fields to provide parameter values for the ListTransitGateways
method.
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The maximum number of resources to return per page
Possible values: 1 ≤ value ≤ 50
Default:
50
A server supplied token determining which resource to start the page on
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
^([0-9a-zA-Z]{1,500})$
The listTransitGateways options.
The maximum number of resources to return per page.
Possible values: 1 ≤ value ≤ 50
A server supplied token determining which resource to start the page on.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/^([0-9a-zA-Z]{1,500})$/
parameters
The maximum number of resources to return per page.
Possible values: 1 ≤ value ≤ 50
A server supplied token determining which resource to start the page on.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/^([0-9a-zA-Z]{1,500})$/
parameters
The maximum number of resources to return per page.
Possible values: 1 ≤ value ≤ 50
A server supplied token determining which resource to start the page on.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/^([0-9a-zA-Z]{1,500})$/
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The ListTransitGateways options.
The maximum number of resources to return per page.
Possible values: 1 ≤ value ≤ 50
A server supplied token determining which resource to start the page on.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/^([0-9a-zA-Z]{1,500})$/
curl -X GET --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" "{base_url}/transit_gateways?version={version}"
listTransitGatewaysOptions := transitGatewayApisService.NewListTransitGatewaysOptions() transitGatewayCollection, response, err := transitGatewayApisService.ListTransitGateways(listTransitGatewaysOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(transitGatewayCollection, "", " ") fmt.Println(string(b))
ListTransitGatewaysOptions listTransitGatewaysOptions = new ListTransitGatewaysOptions.Builder() .build(); Response<TransitGatewayCollection> response = transitGatewayApisService.listTransitGateways(listTransitGatewaysOptions).execute(); TransitGatewayCollection transitGatewayCollection = response.getResult(); System.out.println(transitGatewayCollection);
let res; try { res = await transitGatewayApisService.listTransitGateways({}); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
transit_gateway_collection = transit_gateway_apis_service.list_transit_gateways().get_result() print(json.dumps(transit_gateway_collection, indent=2))
Response
A list of Transit Gateways
A reference to the first page of resources
The maximum number of gateways returned on one request
Possible values: 1 ≤ value ≤ 50
Example:
50
Collection of Transit Services gateways
Possible values: 0 ≤ number of items ≤ 10
A reference to the next page of resources; this reference is included for all pages except the last page
A list of Transit Gateways.
A reference to the first page of resources.
url.
Examples:View
first
The maximum number of gateways returned on one request.
Possible values: 1 ≤ value ≤ 50
Examples:ViewA reference to the next page of resources; this reference is included for all pages except the last page.
url.
Examples:Viewserver generated start token for next page of resources.
Examples:View
next
Collection of Transit Services gateways.
The unique identifier for this Transit Gateway.
Possible values: 0 ≤ length ≤ 100
Examples:ViewThe CRN for this Transit Gateway.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/./
Examples:ViewA human readable name for the transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewLocation of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:ViewThe date and time that this gateway was created.
Allow global routing for a Transit Gateway.
Examples:ViewThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:ViewThe URL for this resource group.
Possible values: 0 ≤ length ≤ 65536, Value must match regular expression
/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/
Examples:View
resourceGroup
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The date and time that this gateway was last updated.
transitGateways
A list of Transit Gateways.
A reference to the first page of resources.
url.
Possible values: 0 ≤ length ≤ 65536
Examples:View
first
The maximum number of gateways returned on one request.
Possible values: 1 ≤ value ≤ 50
Examples:ViewA reference to the next page of resources; this reference is included for all pages except the last page.
url.
Possible values: 0 ≤ length ≤ 65536
Examples:Viewserver generated start token for next page of resources.
Examples:View
next
Collection of Transit Services gateways.
Possible values: 0 ≤ number of items ≤ 10
The unique identifier for this Transit Gateway.
Possible values: 0 ≤ length ≤ 100
Examples:ViewThe CRN for this Transit Gateway.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/./
Examples:ViewA human readable name for the transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewLocation of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:ViewThe date and time that this gateway was created.
Allow global routing for a Transit Gateway.
Examples:ViewThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:ViewThe URL for this resource group.
Possible values: 0 ≤ length ≤ 65536, Value must match regular expression
/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/
Examples:View
resource_group
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The date and time that this gateway was last updated.
transit_gateways
A list of Transit Gateways.
A reference to the first page of resources.
url.
Possible values: 0 ≤ length ≤ 65536
Examples:View
first
The maximum number of gateways returned on one request.
Possible values: 1 ≤ value ≤ 50
Examples:ViewA reference to the next page of resources; this reference is included for all pages except the last page.
url.
Possible values: 0 ≤ length ≤ 65536
Examples:Viewserver generated start token for next page of resources.
Examples:View
next
Collection of Transit Services gateways.
Possible values: 0 ≤ number of items ≤ 10
The unique identifier for this Transit Gateway.
Possible values: 0 ≤ length ≤ 100
Examples:ViewThe CRN for this Transit Gateway.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/./
Examples:ViewA human readable name for the transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewLocation of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:ViewThe date and time that this gateway was created.
Allow global routing for a Transit Gateway.
Examples:ViewThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:ViewThe URL for this resource group.
Possible values: 0 ≤ length ≤ 65536, Value must match regular expression
/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/
Examples:View
resource_group
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The date and time that this gateway was last updated.
transit_gateways
A list of Transit Gateways.
A reference to the first page of resources.
url.
Possible values: 0 ≤ length ≤ 65536
Examples:View
First
The maximum number of gateways returned on one request.
Possible values: 1 ≤ value ≤ 50
Examples:ViewA reference to the next page of resources; this reference is included for all pages except the last page.
url.
Possible values: 0 ≤ length ≤ 65536
Examples:Viewserver generated start token for next page of resources.
Examples:View
Next
Collection of Transit Services gateways.
Possible values: 0 ≤ number of items ≤ 10
The unique identifier for this Transit Gateway.
Possible values: 0 ≤ length ≤ 100
Examples:ViewThe CRN for this Transit Gateway.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/./
Examples:ViewA human readable name for the transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewLocation of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:ViewThe date and time that this gateway was created.
Allow global routing for a Transit Gateway.
Examples:ViewThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:ViewThe URL for this resource group.
Possible values: 0 ≤ length ≤ 65536, Value must match regular expression
/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/
Examples:View
ResourceGroup
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The date and time that this gateway was last updated.
TransitGateways
Status Code
The Transit Gateways were retrieved successfully.
{ "first": { "href": "https://transit.cloud.ibm.com/v1/transit_gateways?limit=50" }, "limit": 50, "transit_gateways": [ { "created_at": "2020-03-31T12:08:05Z", "crn": "crn:[...]", "global": true, "id": "ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4", "location": "us-south", "name": "example-gateway", "resource_group": { "href": "https://resource-manager.bluemix.net/v1/resource_groups/56969d6043e9465c883cb9f7363e78e8", "id": "56969d6043e9465c883cb9f7363e78e8" }, "status": "available", "updated_at": "2020-03-31T12:08:05Z" } ] }
{ "first": { "href": "https://transit.cloud.ibm.com/v1/transit_gateways?limit=50" }, "limit": 50, "transit_gateways": [ { "created_at": "2020-03-31T12:08:05Z", "crn": "crn:[...]", "global": true, "id": "ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4", "location": "us-south", "name": "example-gateway", "resource_group": { "href": "https://resource-manager.bluemix.net/v1/resource_groups/56969d6043e9465c883cb9f7363e78e8", "id": "56969d6043e9465c883cb9f7363e78e8" }, "status": "available", "updated_at": "2020-03-31T12:08:05Z" } ] }
Creates a Transit Gateway
Create a Transit Gateway based on the supplied input template.
Create a Transit Gateway based on the supplied input template.
Create a Transit Gateway based on the supplied input template.
Create a Transit Gateway based on the supplied input template.
Create a Transit Gateway based on the supplied input template.
POST /transit_gateways
ServiceCall<TransitGateway> createTransitGateway(CreateTransitGatewayOptions createTransitGatewayOptions)
createTransitGateway(params)
create_transit_gateway(self,
location: str,
name: str,
*,
global_: bool = None,
resource_group: 'ResourceGroupIdentity' = None,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) CreateTransitGateway(createTransitGatewayOptions *CreateTransitGatewayOptions) (result *TransitGateway, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayWithContext(ctx context.Context, createTransitGatewayOptions *CreateTransitGatewayOptions) (result *TransitGateway, response *core.DetailedResponse, err error)
Request
Use the CreateTransitGatewayOptions.Builder
to create a CreateTransitGatewayOptions
object that contains the parameter values for the createTransitGateway
method.
Instantiate the CreateTransitGatewayOptions
struct and set the fields to provide parameter values for the CreateTransitGateway
method.
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The Transit Gateway template
Location of Transit Gateway Services
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$
Example:
us-south
Name Transit Gateway Services
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$
Example:
Transit_Service_BWTN_SJ_DL
Allow global routing for a Transit Gateway. If unspecified, the default value is false.
Default:
false
Example:
true
The resource group to use. If unspecified, the account's default resource group is used.
The createTransitGateway options.
Location of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:ViewName Transit Gateway Services.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewAllow global routing for a Transit Gateway. If unspecified, the default value is false.
Default:
false
Examples:ViewThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:View
resourceGroup
parameters
Location of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:value_source_lines_htmlName Transit Gateway Services.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:value_source_lines_htmlAllow global routing for a Transit Gateway. If unspecified, the default value is false.
Default:
false
Examples:value_source_lines_htmlThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:View
resourceGroup
parameters
Location of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:value_source_lines_htmlName Transit Gateway Services.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:value_source_lines_htmlAllow global routing for a Transit Gateway. If unspecified, the default value is false.
Default:
false
Examples:value_source_lines_htmlThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:View
resource_group
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The CreateTransitGateway options.
Location of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:ViewName Transit Gateway Services.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewAllow global routing for a Transit Gateway. If unspecified, the default value is false.
Default:
false
Examples:ViewThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:View
ResourceGroup
curl -X POST --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" --header "Content-Type: application/json" --data '{ "location": "us-south", "name": "Transit_Service_BWTN_SJ_DL" }' "{base_url}/transit_gateways?version={version}"
createTransitGatewayOptions := transitGatewayApisService.NewCreateTransitGatewayOptions( "us-south", "Transit_Service_BWTN_SJ_DL", ) transitGateway, response, err := transitGatewayApisService.CreateTransitGateway(createTransitGatewayOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(transitGateway, "", " ") fmt.Println(string(b))
CreateTransitGatewayOptions createTransitGatewayOptions = new CreateTransitGatewayOptions.Builder() .location("us-south") .name("Transit_Service_BWTN_SJ_DL") .build(); Response<TransitGateway> response = transitGatewayApisService.createTransitGateway(createTransitGatewayOptions).execute(); TransitGateway transitGateway = response.getResult(); System.out.println(transitGateway);
const params = { location: 'us-south', name: 'Transit_Service_BWTN_SJ_DL', }; let res; try { res = await transitGatewayApisService.createTransitGateway(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
transit_gateway = transit_gateway_apis_service.create_transit_gateway( location='us-south', name='Transit_Service_BWTN_SJ_DL' ).get_result() print(json.dumps(transit_gateway, indent=2))
Response
Details of a Transit Gateway
The unique identifier for this Transit Gateway
Possible values: 0 ≤ length ≤ 100
Example:
ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4
The CRN for this Transit Gateway
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
.
Example:
crn:v1:bluemix:public:transit:dal03:a/57a7d05f36894e3cb9b46a43556d903e::gateway:ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4
A human readable name for the transit gateway
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$
Example:
my-transit-gateway-in-TransitGateway
Location of Transit Gateway Services
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$
Example:
us-south
The date and time that this gateway was created
Allow global routing for a Transit Gateway
Example:
true
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The resource group to use. If unspecified, the account's default resource group is used.
The date and time that this gateway was last updated
Details of a Transit Gateway.
The unique identifier for this Transit Gateway.
Possible values: 0 ≤ length ≤ 100
Examples:ViewThe CRN for this Transit Gateway.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/./
Examples:ViewA human readable name for the transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewLocation of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:ViewThe date and time that this gateway was created.
Allow global routing for a Transit Gateway.
Examples:ViewThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:ViewThe URL for this resource group.
Possible values: 0 ≤ length ≤ 65536, Value must match regular expression
/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/
Examples:View
resourceGroup
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The date and time that this gateway was last updated.
Details of a Transit Gateway.
The unique identifier for this Transit Gateway.
Possible values: 0 ≤ length ≤ 100
Examples:ViewThe CRN for this Transit Gateway.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/./
Examples:ViewA human readable name for the transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewLocation of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:ViewThe date and time that this gateway was created.
Allow global routing for a Transit Gateway.
Examples:ViewThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:ViewThe URL for this resource group.
Possible values: 0 ≤ length ≤ 65536, Value must match regular expression
/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/
Examples:View
resource_group
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The date and time that this gateway was last updated.
Details of a Transit Gateway.
The unique identifier for this Transit Gateway.
Possible values: 0 ≤ length ≤ 100
Examples:ViewThe CRN for this Transit Gateway.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/./
Examples:ViewA human readable name for the transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewLocation of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:ViewThe date and time that this gateway was created.
Allow global routing for a Transit Gateway.
Examples:ViewThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:ViewThe URL for this resource group.
Possible values: 0 ≤ length ≤ 65536, Value must match regular expression
/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/
Examples:View
resource_group
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The date and time that this gateway was last updated.
Details of a Transit Gateway.
The unique identifier for this Transit Gateway.
Possible values: 0 ≤ length ≤ 100
Examples:ViewThe CRN for this Transit Gateway.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/./
Examples:ViewA human readable name for the transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewLocation of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:ViewThe date and time that this gateway was created.
Allow global routing for a Transit Gateway.
Examples:ViewThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:ViewThe URL for this resource group.
Possible values: 0 ≤ length ≤ 65536, Value must match regular expression
/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/
Examples:View
ResourceGroup
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The date and time that this gateway was last updated.
Status Code
The Transit Gateway was created successfully.
An invalid Transit Gateway template was provided.
A Transit Gateway location could not be found for the identifier given in the template, a resource group could not be found for the given resource group identifier, or the default resource group could not be found for the account (if no resource group identifier was supplied).
The Transit Gateway could not be created as a transit gateway with the same name already exists.
{ "created_at": "2020-03-31T12:08:05Z", "crn": "crn:[...]", "global": true, "id": "ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4", "location": "us-south", "name": "example-gateway", "resource_group": { "href": "https://resource-manager.bluemix.net/v1/resource_groups/56969d6043e9465c883cb9f7363e78e8", "id": "56969d6043e9465c883cb9f7363e78e8" }, "status": "pending", "updated_at": "2020-03-31T12:08:05Z" }
{ "created_at": "2020-03-31T12:08:05Z", "crn": "crn:[...]", "global": true, "id": "ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4", "location": "us-south", "name": "example-gateway", "resource_group": { "href": "https://resource-manager.bluemix.net/v1/resource_groups/56969d6043e9465c883cb9f7363e78e8", "id": "56969d6043e9465c883cb9f7363e78e8" }, "status": "pending", "updated_at": "2020-03-31T12:08:05Z" }
{ "errors": [ { "code": "validation_required_field_missing", "message": "Mandatory field is missing.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling", "target": { "name": "name", "type": "field" } } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "validation_required_field_missing", "message": "Mandatory field is missing.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling", "target": { "name": "name", "type": "field" } } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Location not found.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Location not found.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "invalid_state", "message": "A gateway with the same name already exists", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "invalid_state", "message": "A gateway with the same name already exists", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
Deletes specified Transit Gateway
This request deletes a Transit Gateway. This operation cannot be reversed. For this request to succeed, the Transit Gateway must not contain connections.
This request deletes a Transit Gateway. This operation cannot be reversed. For this request to succeed, the Transit Gateway must not contain connections.
This request deletes a Transit Gateway. This operation cannot be reversed. For this request to succeed, the Transit Gateway must not contain connections.
This request deletes a Transit Gateway. This operation cannot be reversed. For this request to succeed, the Transit Gateway must not contain connections.
This request deletes a Transit Gateway. This operation cannot be reversed. For this request to succeed, the Transit Gateway must not contain connections.
DELETE /transit_gateways/{id}
ServiceCall<Void> deleteTransitGateway(DeleteTransitGatewayOptions deleteTransitGatewayOptions)
deleteTransitGateway(params)
delete_transit_gateway(self,
id: str,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) DeleteTransitGateway(deleteTransitGatewayOptions *DeleteTransitGatewayOptions) (response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) DeleteTransitGatewayWithContext(ctx context.Context, deleteTransitGatewayOptions *DeleteTransitGatewayOptions) (response *core.DetailedResponse, err error)
Request
Use the DeleteTransitGatewayOptions.Builder
to create a DeleteTransitGatewayOptions
object that contains the parameter values for the deleteTransitGateway
method.
Instantiate the DeleteTransitGatewayOptions
struct and set the fields to provide parameter values for the DeleteTransitGateway
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The deleteTransitGateway options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The DeleteTransitGateway options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
curl -X DELETE --location --header "Authorization: Bearer {iam_token}" "{base_url}/transit_gateways/{id}?version={version}"
deleteTransitGatewayOptions := transitGatewayApisService.NewDeleteTransitGatewayOptions( "testString", ) response, err := transitGatewayApisService.DeleteTransitGateway(deleteTransitGatewayOptions) if err != nil { panic(err) }
DeleteTransitGatewayOptions deleteTransitGatewayOptions = new DeleteTransitGatewayOptions.Builder() .id("testString") .build(); Response<Void> response = transitGatewayApisService.deleteTransitGateway(deleteTransitGatewayOptions).execute();
const params = { id: 'testString', }; try { await transitGatewayApisService.deleteTransitGateway(params); } catch (err) { console.warn(err); }
response = transit_gateway_apis_service.delete_transit_gateway( id='testString' )
Response
Status Code
The Transit Gateway was deleted successfully.
A Transit Gateway with the specified identifier could not be found.
The Transit Gateway could not be deleted as there are pre-existing connections attached.
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "invalid_state", "message": "The gateway could not be deleted as there are connections attached to it. Delete all connections attached to this gateway and retry.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "invalid_state", "message": "The gateway could not be deleted as there are connections attached to it. Delete all connections attached to this gateway and retry.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
Retrieves specified Transit Gateway
This request retrieves a single Transit Gateway specified by the identifier in the URL.
This request retrieves a single Transit Gateway specified by the identifier in the URL.
This request retrieves a single Transit Gateway specified by the identifier in the URL.
This request retrieves a single Transit Gateway specified by the identifier in the URL.
This request retrieves a single Transit Gateway specified by the identifier in the URL.
GET /transit_gateways/{id}
ServiceCall<TransitGateway> getTransitGateway(GetTransitGatewayOptions getTransitGatewayOptions)
getTransitGateway(params)
get_transit_gateway(self,
id: str,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) GetTransitGateway(getTransitGatewayOptions *GetTransitGatewayOptions) (result *TransitGateway, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayWithContext(ctx context.Context, getTransitGatewayOptions *GetTransitGatewayOptions) (result *TransitGateway, response *core.DetailedResponse, err error)
Request
Use the GetTransitGatewayOptions.Builder
to create a GetTransitGatewayOptions
object that contains the parameter values for the getTransitGateway
method.
Instantiate the GetTransitGatewayOptions
struct and set the fields to provide parameter values for the GetTransitGateway
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The getTransitGateway options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The GetTransitGateway options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
curl -X GET --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" "{base_url}/transit_gateways/{id}?version={version}"
getTransitGatewayOptions := transitGatewayApisService.NewGetTransitGatewayOptions( "testString", ) transitGateway, response, err := transitGatewayApisService.GetTransitGateway(getTransitGatewayOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(transitGateway, "", " ") fmt.Println(string(b))
GetTransitGatewayOptions getTransitGatewayOptions = new GetTransitGatewayOptions.Builder() .id("testString") .build(); Response<TransitGateway> response = transitGatewayApisService.getTransitGateway(getTransitGatewayOptions).execute(); TransitGateway transitGateway = response.getResult(); System.out.println(transitGateway);
const params = { id: 'testString', }; let res; try { res = await transitGatewayApisService.getTransitGateway(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
transit_gateway = transit_gateway_apis_service.get_transit_gateway( id='testString' ).get_result() print(json.dumps(transit_gateway, indent=2))
Response
Details of a Transit Gateway
The unique identifier for this Transit Gateway
Possible values: 0 ≤ length ≤ 100
Example:
ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4
The CRN for this Transit Gateway
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
.
Example:
crn:v1:bluemix:public:transit:dal03:a/57a7d05f36894e3cb9b46a43556d903e::gateway:ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4
A human readable name for the transit gateway
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$
Example:
my-transit-gateway-in-TransitGateway
Location of Transit Gateway Services
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$
Example:
us-south
The date and time that this gateway was created
Allow global routing for a Transit Gateway
Example:
true
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The resource group to use. If unspecified, the account's default resource group is used.
The date and time that this gateway was last updated
Details of a Transit Gateway.
The unique identifier for this Transit Gateway.
Possible values: 0 ≤ length ≤ 100
Examples:ViewThe CRN for this Transit Gateway.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/./
Examples:ViewA human readable name for the transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewLocation of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:ViewThe date and time that this gateway was created.
Allow global routing for a Transit Gateway.
Examples:ViewThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:ViewThe URL for this resource group.
Possible values: 0 ≤ length ≤ 65536, Value must match regular expression
/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/
Examples:View
resourceGroup
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The date and time that this gateway was last updated.
Details of a Transit Gateway.
The unique identifier for this Transit Gateway.
Possible values: 0 ≤ length ≤ 100
Examples:ViewThe CRN for this Transit Gateway.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/./
Examples:ViewA human readable name for the transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewLocation of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:ViewThe date and time that this gateway was created.
Allow global routing for a Transit Gateway.
Examples:ViewThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:ViewThe URL for this resource group.
Possible values: 0 ≤ length ≤ 65536, Value must match regular expression
/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/
Examples:View
resource_group
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The date and time that this gateway was last updated.
Details of a Transit Gateway.
The unique identifier for this Transit Gateway.
Possible values: 0 ≤ length ≤ 100
Examples:ViewThe CRN for this Transit Gateway.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/./
Examples:ViewA human readable name for the transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewLocation of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:ViewThe date and time that this gateway was created.
Allow global routing for a Transit Gateway.
Examples:ViewThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:ViewThe URL for this resource group.
Possible values: 0 ≤ length ≤ 65536, Value must match regular expression
/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/
Examples:View
resource_group
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The date and time that this gateway was last updated.
Details of a Transit Gateway.
The unique identifier for this Transit Gateway.
Possible values: 0 ≤ length ≤ 100
Examples:ViewThe CRN for this Transit Gateway.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/./
Examples:ViewA human readable name for the transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewLocation of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:ViewThe date and time that this gateway was created.
Allow global routing for a Transit Gateway.
Examples:ViewThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:ViewThe URL for this resource group.
Possible values: 0 ≤ length ≤ 65536, Value must match regular expression
/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/
Examples:View
ResourceGroup
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The date and time that this gateway was last updated.
Status Code
The Transit Gateway was retrieved successfully.
A Transit Gateway with the specified identifier could not be found.
{ "created_at": "2020-03-31T12:08:05Z", "crn": "crn:[...]", "global": true, "id": "ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4", "location": "us-south", "name": "example-gateway", "resource_group": { "href": "https://resource-manager.bluemix.net/v1/resource_groups/56969d6043e9465c883cb9f7363e78e8", "id": "56969d6043e9465c883cb9f7363e78e8" }, "status": "available", "updated_at": "2020-03-31T12:08:05Z" }
{ "created_at": "2020-03-31T12:08:05Z", "crn": "crn:[...]", "global": true, "id": "ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4", "location": "us-south", "name": "example-gateway", "resource_group": { "href": "https://resource-manager.bluemix.net/v1/resource_groups/56969d6043e9465c883cb9f7363e78e8", "id": "56969d6043e9465c883cb9f7363e78e8" }, "status": "available", "updated_at": "2020-03-31T12:08:05Z" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
Updates specified Transit Gateway
This request updates a Transit Gateway's name and/or global flag.
This request updates a Transit Gateway's name and/or global flag.
This request updates a Transit Gateway's name and/or global flag.
This request updates a Transit Gateway's name and/or global flag.
This request updates a Transit Gateway's name and/or global flag.
PATCH /transit_gateways/{id}
ServiceCall<TransitGateway> updateTransitGateway(UpdateTransitGatewayOptions updateTransitGatewayOptions)
updateTransitGateway(params)
update_transit_gateway(self,
id: str,
*,
global_: bool = None,
name: str = None,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) UpdateTransitGateway(updateTransitGatewayOptions *UpdateTransitGatewayOptions) (result *TransitGateway, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) UpdateTransitGatewayWithContext(ctx context.Context, updateTransitGatewayOptions *UpdateTransitGatewayOptions) (result *TransitGateway, response *core.DetailedResponse, err error)
Request
Use the UpdateTransitGatewayOptions.Builder
to create a UpdateTransitGatewayOptions
object that contains the parameter values for the updateTransitGateway
method.
Instantiate the UpdateTransitGatewayOptions
struct and set the fields to provide parameter values for the UpdateTransitGateway
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
Update a Transit Gateway
Allow global routing for a Transit Gateway
Example:
true
The user-defined name for this transit gateway
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$
Example:
my-transit-gateway
The updateTransitGateway options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Allow global routing for a Transit Gateway.
Examples:ViewThe user-defined name for this transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:View
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Allow global routing for a Transit Gateway.
Examples:value_source_lines_htmlThe user-defined name for this transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:value_source_lines_html
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Allow global routing for a Transit Gateway.
Examples:value_source_lines_htmlThe user-defined name for this transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:value_source_lines_html
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The UpdateTransitGateway options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Allow global routing for a Transit Gateway.
Examples:ViewThe user-defined name for this transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:View
curl -X PATCH --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" --header "Content-Type: application/json" --data '{}' "{base_url}/transit_gateways/{id}?version={version}"
updateTransitGatewayOptions := transitGatewayApisService.NewUpdateTransitGatewayOptions( "testString", ) transitGateway, response, err := transitGatewayApisService.UpdateTransitGateway(updateTransitGatewayOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(transitGateway, "", " ") fmt.Println(string(b))
UpdateTransitGatewayOptions updateTransitGatewayOptions = new UpdateTransitGatewayOptions.Builder() .id("testString") .build(); Response<TransitGateway> response = transitGatewayApisService.updateTransitGateway(updateTransitGatewayOptions).execute(); TransitGateway transitGateway = response.getResult(); System.out.println(transitGateway);
const params = { id: 'testString', }; let res; try { res = await transitGatewayApisService.updateTransitGateway(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
transit_gateway = transit_gateway_apis_service.update_transit_gateway( id='testString', ).get_result() print(json.dumps(transit_gateway, indent=2))
Response
Details of a Transit Gateway
The unique identifier for this Transit Gateway
Possible values: 0 ≤ length ≤ 100
Example:
ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4
The CRN for this Transit Gateway
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
.
Example:
crn:v1:bluemix:public:transit:dal03:a/57a7d05f36894e3cb9b46a43556d903e::gateway:ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4
A human readable name for the transit gateway
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$
Example:
my-transit-gateway-in-TransitGateway
Location of Transit Gateway Services
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$
Example:
us-south
The date and time that this gateway was created
Allow global routing for a Transit Gateway
Example:
true
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The resource group to use. If unspecified, the account's default resource group is used.
The date and time that this gateway was last updated
Details of a Transit Gateway.
The unique identifier for this Transit Gateway.
Possible values: 0 ≤ length ≤ 100
Examples:ViewThe CRN for this Transit Gateway.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/./
Examples:ViewA human readable name for the transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewLocation of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:ViewThe date and time that this gateway was created.
Allow global routing for a Transit Gateway.
Examples:ViewThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:ViewThe URL for this resource group.
Possible values: 0 ≤ length ≤ 65536, Value must match regular expression
/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/
Examples:View
resourceGroup
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The date and time that this gateway was last updated.
Details of a Transit Gateway.
The unique identifier for this Transit Gateway.
Possible values: 0 ≤ length ≤ 100
Examples:ViewThe CRN for this Transit Gateway.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/./
Examples:ViewA human readable name for the transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewLocation of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:ViewThe date and time that this gateway was created.
Allow global routing for a Transit Gateway.
Examples:ViewThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:ViewThe URL for this resource group.
Possible values: 0 ≤ length ≤ 65536, Value must match regular expression
/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/
Examples:View
resource_group
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The date and time that this gateway was last updated.
Details of a Transit Gateway.
The unique identifier for this Transit Gateway.
Possible values: 0 ≤ length ≤ 100
Examples:ViewThe CRN for this Transit Gateway.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/./
Examples:ViewA human readable name for the transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewLocation of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:ViewThe date and time that this gateway was created.
Allow global routing for a Transit Gateway.
Examples:ViewThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:ViewThe URL for this resource group.
Possible values: 0 ≤ length ≤ 65536, Value must match regular expression
/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/
Examples:View
resource_group
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The date and time that this gateway was last updated.
Details of a Transit Gateway.
The unique identifier for this Transit Gateway.
Possible values: 0 ≤ length ≤ 100
Examples:ViewThe CRN for this Transit Gateway.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/./
Examples:ViewA human readable name for the transit gateway.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewLocation of Transit Gateway Services.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:ViewThe date and time that this gateway was created.
Allow global routing for a Transit Gateway.
Examples:ViewThe resource group to use. If unspecified, the account's default resource group is used.
The unique identifier for this resource group.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-f]{32}$/
Examples:ViewThe URL for this resource group.
Possible values: 0 ≤ length ≤ 65536, Value must match regular expression
/^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/
Examples:View
ResourceGroup
The status of the Transit Gateway. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
available
,failed
,pending
,deleting
,suspending
,suspended
]The date and time that this gateway was last updated.
Status Code
The Transit Gateway was updated successfully.
The supplied Transit Gateway patch was invalid.
A Transit Gateway with the specified identifier could not be found.
The Transit Gateway could not be updated as there are pre-existing cross-region connections attached.
{ "created_at": "2020-03-31T12:08:05Z", "crn": "crn:[...]", "global": false, "id": "ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4", "location": "us-south", "name": "example-gateway-new-name", "resource_group": { "href": "https://resource-manager.bluemix.net/v1/resource_groups/56969d6043e9465c883cb9f7363e78e8", "id": "56969d6043e9465c883cb9f7363e78e8" }, "status": "available", "updated_at": "2020-03-31T12:08:05Z" }
{ "created_at": "2020-03-31T12:08:05Z", "crn": "crn:[...]", "global": false, "id": "ef4dcb1a-fee4-41c7-9e11-9cd99e65c1f4", "location": "us-south", "name": "example-gateway-new-name", "resource_group": { "href": "https://resource-manager.bluemix.net/v1/resource_groups/56969d6043e9465c883cb9f7363e78e8", "id": "56969d6043e9465c883cb9f7363e78e8" }, "status": "available", "updated_at": "2020-03-31T12:08:05Z" }
{ "errors": [ { "code": "bad_request", "message": "The information given was invalid, malformed, or missing a required field.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling", "target": { "name": "request_body", "type": "field" } } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "bad_request", "message": "The information given was invalid, malformed, or missing a required field.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling", "target": { "name": "request_body", "type": "field" } } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "invalid_state", "message": "all non-local connections need to be deleted before the gateway's routing can be updated to local", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "invalid_state", "message": "all non-local connections need to be deleted before the gateway's routing can be updated to local", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
Retrieves all connections
List all transit gateway connections associated with this account.
List all transit gateway connections associated with this account.
List all transit gateway connections associated with this account.
List all transit gateway connections associated with this account.
List all transit gateway connections associated with this account.
GET /connections
ServiceCall<TransitConnectionCollection> listConnections(ListConnectionsOptions listConnectionsOptions)
listConnections(params)
list_connections(self,
*,
limit: int = None,
start: str = None,
network_id: str = None,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) ListConnections(listConnectionsOptions *ListConnectionsOptions) (result *TransitConnectionCollection, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) ListConnectionsWithContext(ctx context.Context, listConnectionsOptions *ListConnectionsOptions) (result *TransitConnectionCollection, response *core.DetailedResponse, err error)
Request
Use the ListConnectionsOptions.Builder
to create a ListConnectionsOptions
object that contains the parameter values for the listConnections
method.
Instantiate the ListConnectionsOptions
struct and set the fields to provide parameter values for the ListConnections
method.
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The maximum number of resources to return per page
Possible values: 1 ≤ value ≤ 100
Default:
50
A server supplied token determining which resource to start the page on
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
^([0-9a-zA-Z]){0,500}$
Search for connections with the given network_id value
Possible values: 0 ≤ length ≤ 220, Value must match regular expression
.
The listConnections options.
The maximum number of resources to return per page.
Possible values: 1 ≤ value ≤ 100
A server supplied token determining which resource to start the page on.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/^([0-9a-zA-Z]){0,500}$/
Search for connections with the given network_id value.
Possible values: 0 ≤ length ≤ 220
parameters
The maximum number of resources to return per page.
Possible values: 1 ≤ value ≤ 100
A server supplied token determining which resource to start the page on.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/^([0-9a-zA-Z]){0,500}$/
Search for connections with the given network_id value.
Possible values: 0 ≤ length ≤ 220, Value must match regular expression
/./
parameters
The maximum number of resources to return per page.
Possible values: 1 ≤ value ≤ 100
A server supplied token determining which resource to start the page on.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/^([0-9a-zA-Z]){0,500}$/
Search for connections with the given network_id value.
Possible values: 0 ≤ length ≤ 220, Value must match regular expression
/./
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The ListConnections options.
The maximum number of resources to return per page.
Possible values: 1 ≤ value ≤ 100
A server supplied token determining which resource to start the page on.
Possible values: 0 ≤ length ≤ 500, Value must match regular expression
/^([0-9a-zA-Z]){0,500}$/
Search for connections with the given network_id value.
Possible values: 0 ≤ length ≤ 220, Value must match regular expression
/./
curl -X GET --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" "{base_url}/connections?version={version}"
listConnectionsOptions := transitGatewayApisService.NewListConnectionsOptions() transitConnectionCollection, response, err := transitGatewayApisService.ListConnections(listConnectionsOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(transitConnectionCollection, "", " ") fmt.Println(string(b))
ListConnectionsOptions listConnectionsOptions = new ListConnectionsOptions.Builder() .build(); Response<TransitConnectionCollection> response = transitGatewayApisService.listConnections(listConnectionsOptions).execute(); TransitConnectionCollection transitConnectionCollection = response.getResult(); System.out.println(transitConnectionCollection);
let res; try { res = await transitGatewayApisService.listConnections({}); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
transit_connection_collection = transit_gateway_apis_service.list_connections().get_result() print(json.dumps(transit_connection_collection, indent=2))
Response
Transit gateway connections
Array of transit gateway connections
Possible values: 0 ≤ number of items ≤ 50
A reference to the first page of resources
The maximum number of connections returned on one request
Possible values: 1 ≤ value ≤ 50
Example:
50
A reference to the next page of resources; this reference is included for all pages except the last page
Transit gateway connections.
Array of transit gateway connections.
network_type 'gre_tunnel' connections use 'base_connection_id' to specify the id of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
The unique identifier for this connection.
Possible values: 0 ≤ length ≤ 100
Examples:ViewLocal network BGP ASN. This field only applies to network type 'gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 40
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 40
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' connections.
Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Possible values: 0 ≤ length ≤ 220
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
prefixFilters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 40
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 40
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]Reference to the transit gateway that contains this connection.
gateway CRN.
Possible values: 0 ≤ length ≤ 220
Examples:Viewgateway ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewtransit gateway name.
Possible values: 0 ≤ length ≤ 64
Examples:View
transitGateway
The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' connections.
Availability zone name.
Examples:View
zone
connections
A reference to the first page of resources.
url.
Possible values: 0 ≤ length ≤ 500
Examples:View
first
The maximum number of connections returned on one request.
Possible values: 1 ≤ value ≤ 50
Examples:ViewA reference to the next page of resources; this reference is included for all pages except the last page.
url.
Possible values: 0 ≤ length ≤ 500
Examples:Viewserver generated start token for next page of resources.
Examples:View
next
Transit gateway connections.
Array of transit gateway connections.
Possible values: 0 ≤ number of items ≤ 50
network_type 'gre_tunnel' connections use 'base_connection_id' to specify the id of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
The unique identifier for this connection.
Possible values: 0 ≤ length ≤ 100
Examples:ViewLocal network BGP ASN. This field only applies to network type 'gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 40
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 40
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' connections.
Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Possible values: 0 ≤ length ≤ 220
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
prefix_filters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 40
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 40
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]Reference to the transit gateway that contains this connection.
gateway CRN.
Possible values: 0 ≤ length ≤ 220
Examples:Viewgateway ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewtransit gateway name.
Possible values: 0 ≤ length ≤ 64
Examples:View
transit_gateway
The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' connections.
Availability zone name.
Examples:View
zone
connections
A reference to the first page of resources.
url.
Possible values: 0 ≤ length ≤ 65536
Examples:View
first
The maximum number of connections returned on one request.
Possible values: 1 ≤ value ≤ 50
Examples:ViewA reference to the next page of resources; this reference is included for all pages except the last page.
url.
Possible values: 0 ≤ length ≤ 65536
Examples:Viewserver generated start token for next page of resources.
Examples:View
next
Transit gateway connections.
Array of transit gateway connections.
Possible values: 0 ≤ number of items ≤ 50
network_type 'gre_tunnel' connections use 'base_connection_id' to specify the id of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
The unique identifier for this connection.
Possible values: 0 ≤ length ≤ 100
Examples:ViewLocal network BGP ASN. This field only applies to network type 'gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 40
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 40
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' connections.
Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Possible values: 0 ≤ length ≤ 220
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
prefix_filters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 40
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 40
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]Reference to the transit gateway that contains this connection.
gateway CRN.
Possible values: 0 ≤ length ≤ 220
Examples:Viewgateway ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewtransit gateway name.
Possible values: 0 ≤ length ≤ 64
Examples:View
transit_gateway
The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' connections.
Availability zone name.
Examples:View
zone
connections
A reference to the first page of resources.
url.
Possible values: 0 ≤ length ≤ 65536
Examples:View
first
The maximum number of connections returned on one request.
Possible values: 1 ≤ value ≤ 50
Examples:ViewA reference to the next page of resources; this reference is included for all pages except the last page.
url.
Possible values: 0 ≤ length ≤ 65536
Examples:Viewserver generated start token for next page of resources.
Examples:View
next
Transit gateway connections.
Array of transit gateway connections.
Possible values: 0 ≤ number of items ≤ 50
network_type 'gre_tunnel' connections use 'base_connection_id' to specify the id of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
The unique identifier for this connection.
Possible values: 0 ≤ length ≤ 100
Examples:ViewLocal network BGP ASN. This field only applies to network type 'gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 40
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 40
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' connections.
Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Possible values: 0 ≤ length ≤ 220
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
PrefixFilters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 40
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 40
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]Reference to the transit gateway that contains this connection.
gateway CRN.
Possible values: 0 ≤ length ≤ 220
Examples:Viewgateway ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewtransit gateway name.
Possible values: 0 ≤ length ≤ 64
Examples:View
TransitGateway
The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' connections.
Availability zone name.
Examples:View
Zone
Connections
A reference to the first page of resources.
url.
Possible values: 0 ≤ length ≤ 65536
Examples:View
First
The maximum number of connections returned on one request.
Possible values: 1 ≤ value ≤ 50
Examples:ViewA reference to the next page of resources; this reference is included for all pages except the last page.
url.
Possible values: 0 ≤ length ≤ 65536
Examples:Viewserver generated start token for next page of resources.
Examples:View
Next
Status Code
The connections were retrieved successfully.
{ "connections": [ { "created_at": "2020-03-31T12:08:05Z", "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531", "name": "example-connection", "network_id": "crn:[...]", "network_type": "vpc", "prefix_filters_default": "permit", "status": "attached", "transit_gateway": [ { "crn": "crn:[...]", "id": "456f58c1-afe7-123a-0a0a-7f3d720f1a44", "name": "my-transit-gw100" } ], "updated_at": "2020-03-31T12:08:05Z" } ], "first": { "href": "https://transit.cloud.ibm.com/v1/connections?limit=50" }, "limit": 50 }
{ "connections": [ { "created_at": "2020-03-31T12:08:05Z", "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531", "name": "example-connection", "network_id": "crn:[...]", "network_type": "vpc", "prefix_filters_default": "permit", "status": "attached", "transit_gateway": [ { "crn": "crn:[...]", "id": "456f58c1-afe7-123a-0a0a-7f3d720f1a44", "name": "my-transit-gw100" } ], "updated_at": "2020-03-31T12:08:05Z" } ], "first": { "href": "https://transit.cloud.ibm.com/v1/connections?limit=50" }, "limit": 50 }
Retrieves all connections in a Transit Gateway
This request retrieves all connections in a Transit Gateway.
This request retrieves all connections in a Transit Gateway.
This request retrieves all connections in a Transit Gateway.
This request retrieves all connections in a Transit Gateway.
This request retrieves all connections in a Transit Gateway.
GET /transit_gateways/{transit_gateway_id}/connections
ServiceCall<TransitGatewayConnectionCollection> listTransitGatewayConnections(ListTransitGatewayConnectionsOptions listTransitGatewayConnectionsOptions)
listTransitGatewayConnections(params)
list_transit_gateway_connections(self,
transit_gateway_id: str,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) ListTransitGatewayConnections(listTransitGatewayConnectionsOptions *ListTransitGatewayConnectionsOptions) (result *TransitGatewayConnectionCollection, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) ListTransitGatewayConnectionsWithContext(ctx context.Context, listTransitGatewayConnectionsOptions *ListTransitGatewayConnectionsOptions) (result *TransitGatewayConnectionCollection, response *core.DetailedResponse, err error)
Request
Use the ListTransitGatewayConnectionsOptions.Builder
to create a ListTransitGatewayConnectionsOptions
object that contains the parameter values for the listTransitGatewayConnections
method.
Instantiate the ListTransitGatewayConnectionsOptions
struct and set the fields to provide parameter values for the ListTransitGatewayConnections
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The listTransitGatewayConnections options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The ListTransitGatewayConnections options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
curl -X GET --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" "{base_url}/transit_gateways/{transit_gateway_id}/connections?version={version}"
listTransitGatewayConnectionsOptions := transitGatewayApisService.NewListTransitGatewayConnectionsOptions( "testString", ) transitGatewayConnectionCollection, response, err := transitGatewayApisService.ListTransitGatewayConnections(listTransitGatewayConnectionsOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(transitGatewayConnectionCollection, "", " ") fmt.Println(string(b))
ListTransitGatewayConnectionsOptions listTransitGatewayConnectionsOptions = new ListTransitGatewayConnectionsOptions.Builder() .transitGatewayId("testString") .build(); Response<TransitGatewayConnectionCollection> response = transitGatewayApisService.listTransitGatewayConnections(listTransitGatewayConnectionsOptions).execute(); TransitGatewayConnectionCollection transitGatewayConnectionCollection = response.getResult(); System.out.println(transitGatewayConnectionCollection);
const params = { transitGatewayId: 'testString', }; let res; try { res = await transitGatewayApisService.listTransitGatewayConnections(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
transit_gateway_connection_collection = transit_gateway_apis_service.list_transit_gateway_connections( transit_gateway_id='testString' ).get_result() print(json.dumps(transit_gateway_connection_collection, indent=2))
Response
A set of Transit Gateway network connections
Array of transit gateways network Connections
Possible values: 0 ≤ number of items ≤ 50
A set of Transit Gateway network connections.
Array of transit gateways network Connections.
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewThe unique identifier for this Transit Gateway Connection.
Possible values: 0 ≤ length ≤ 100
Examples:Viewnetwork_type 'gre_tunnel' connections use 'base_connection_id' to specify the ID of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
Local network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
prefixFilters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection's current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Availability zone name.
Examples:View
zone
connections
A set of Transit Gateway network connections.
Array of transit gateways network Connections.
Possible values: 0 ≤ number of items ≤ 50
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewThe unique identifier for this Transit Gateway Connection.
Possible values: 0 ≤ length ≤ 100
Examples:Viewnetwork_type 'gre_tunnel' connections use 'base_connection_id' to specify the ID of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
Local network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
prefix_filters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection's current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Availability zone name.
Examples:View
zone
connections
A set of Transit Gateway network connections.
Array of transit gateways network Connections.
Possible values: 0 ≤ number of items ≤ 50
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewThe unique identifier for this Transit Gateway Connection.
Possible values: 0 ≤ length ≤ 100
Examples:Viewnetwork_type 'gre_tunnel' connections use 'base_connection_id' to specify the ID of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
Local network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
prefix_filters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection's current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Availability zone name.
Examples:View
zone
connections
A set of Transit Gateway network connections.
Array of transit gateways network Connections.
Possible values: 0 ≤ number of items ≤ 50
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewThe unique identifier for this Transit Gateway Connection.
Possible values: 0 ≤ length ≤ 100
Examples:Viewnetwork_type 'gre_tunnel' connections use 'base_connection_id' to specify the ID of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
Local network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
PrefixFilters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection's current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Availability zone name.
Examples:View
Zone
Connections
Status Code
The connections were retrieved successfully.
The specified Transit Gateway could not be found.
{ "connections": [ { "created_at": "2020-03-31T12:08:05Z", "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531", "name": "example-connection", "network_id": "crn:[...]", "network_type": "vpc", "prefix_filters_default": "permit", "status": "attached", "updated_at": "2020-03-31T12:08:05Z" } ] }
{ "connections": [ { "created_at": "2020-03-31T12:08:05Z", "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531", "name": "example-connection", "network_id": "crn:[...]", "network_type": "vpc", "prefix_filters_default": "permit", "status": "attached", "updated_at": "2020-03-31T12:08:05Z" } ] }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
Add connection to a Transit Gateway
Add a connection to Transit Gateway.
Add a connection to Transit Gateway.
Add a connection to Transit Gateway.
Add a connection to Transit Gateway.
Add a connection to Transit Gateway.
POST /transit_gateways/{transit_gateway_id}/connections
ServiceCall<TransitGatewayConnectionCust> createTransitGatewayConnection(CreateTransitGatewayConnectionOptions createTransitGatewayConnectionOptions)
createTransitGatewayConnection(params)
create_transit_gateway_connection(self,
transit_gateway_id: str,
network_type: str,
*,
base_connection_id: str = None,
base_network_type: str = None,
local_gateway_ip: str = None,
local_tunnel_ip: str = None,
name: str = None,
network_account_id: str = None,
network_id: str = None,
prefix_filters: List['TransitGatewayConnectionPrefixFilter'] = None,
prefix_filters_default: str = None,
remote_bgp_asn: int = None,
remote_gateway_ip: str = None,
remote_tunnel_ip: str = None,
zone: 'ZoneIdentity' = None,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayConnection(createTransitGatewayConnectionOptions *CreateTransitGatewayConnectionOptions) (result *TransitGatewayConnectionCust, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayConnectionWithContext(ctx context.Context, createTransitGatewayConnectionOptions *CreateTransitGatewayConnectionOptions) (result *TransitGatewayConnectionCust, response *core.DetailedResponse, err error)
Request
Use the CreateTransitGatewayConnectionOptions.Builder
to create a CreateTransitGatewayConnectionOptions
object that contains the parameter values for the createTransitGatewayConnection
method.
Instantiate the CreateTransitGatewayConnectionOptions
struct and set the fields to provide parameter values for the CreateTransitGatewayConnection
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The connection template
Defines what type of network is connected via this connection. For access to gre_tunnel or unbound_gre_tunnel connections contact IBM support.
Allowable values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
]Example:
vpc
network_type
gre_tunnel
connections must be created over an existing network_typeclassic
connection. This field must specify the ID of an active transit gateway network_typeclassic
connection in the same transit gateway.This field is required for network type
gre_tunnel
connections.This field is required to be unspecified for network type
classic
,directlink
,vpc
, andunbound_gre_tunnel
connections.Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
975f58c1-afe7-469a-9727-7f3d720f2d32
The type of network the Unbound GRE tunnel is targeting. This field is required for network type
unbound_gre_tunnel
connections. This field is required to be unspecified for network typeclassic
,directlink
,vpc
, andgre_tunnel
connections.Allowable values: [
classic
]Example:
classic
Local gateway IP address. This field is required for network type
gre_tunnel
andunbound_gre_tunnel
connections. This field is required to be unspecified for network typeclassic
,directlink
, andvpc
connections.Possible values: 0 ≤ length ≤ 40, Value must match regular expression
^(([0-9]){1,3}\.){3}([0-9]{1,3})$
Example:
192.168.100.1
Local tunnel IP address. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses.
This field is required for network type
gre_tunnel
andunbound_gre_tunnel
connections.This field is required to be unspecified for network type
classic
,directlink
, andvpc
connections.Possible values: 0 ≤ length ≤ 40, Value must match regular expression
^(([0-9]){1,3}\.){3}([0-9]{1,3})$
Example:
192.168.129.2
The user-defined name for this transit gateway connection. Network type
vpc
connections are defaulted to the name of the VPC. Network typeclassic
connections are namedClassic
.This field is required for network type
gre_tunnel
andunbound_gre_tunnel
connections.This field is optional for network type
classic
,directlink
, andvpc
connections.Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$
Example:
Transit_Service_BWTN_SJ_DL
The ID of the account which owns the network that is being connected. Generally only used if the network is in a different account than the gateway. This field is required for type
unbound_gre_tunnel
when the associated_network_type isclassic
and the GRE tunnel is in a different account than the gateway.Possible values: 0 ≤ length ≤ 100, Value must match regular expression
.
Example:
28e4d90ac7504be694471ee66e70d0d5
The ID of the network being connected via this connection. For network types
vpc
anddirectlink
this is the CRN of the VPC / Direct Link gateway respectively. This field is required for network typevpc
anddirectlink
connections. This field is required to be unspecified for network typeclassic
,gre_tunnel
andunbound_gre_tunnel
connections.Possible values: 0 ≤ length ≤ 220, Value must match regular expression
.
Example:
crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b
Array of prefix route filters for a transit gateway connection. Prefix filters can be specified for netowrk type
vpc
,classic
, anddirectlink
connections. They are not allowed for typegre_tunnel
connections. This is order dependent with those first in the array being applied first, and those at the end of the array being applied last, or just before applying the default. This field is optional for network typeclassic
,vpc
, anddirectlink
connections. This field is required to be unspecified for network typegre_tunnel
andunbound_gre_tunnel
connections.Possible values: 0 ≤ number of items ≤ 10
Default setting of permit or deny which applies to any routes that don't match a specified filter. This field is optional for network type
classic
,vpc
, anddirectlink
connections. This field is required to be unspecified for network typegre_tunnel
andunbound_gre_tunnel
connections.Allowable values: [
permit
,deny
]Example:
permit
Remote network BGP ASN. The following ASN values are reserved and unavailable 64512-64513, 65100, 65201-65234, 65402-65433, 65500 and 4201065000-4201065999. If
remote_bgp_asn
is omitted on gre_tunnel or unbound_gre_tunnel connection create requests IBM will assign an ASN.This field is optional for network type
gre_tunnel
andunbound_gre_tunnel
connections.This field is required to be unspecified for network type
classic
,directlink
, andvpc
connections.Example:
65010
Remote gateway IP address. This field is required for network type
gre_tunnel
andunbound_gre_tunnel
connections. This field is required to be unspecified for network typeclassic
,directlink
, andvpc
connections.Possible values: 0 ≤ length ≤ 40, Value must match regular expression
^(([0-9]){1,3}\.){3}([0-9]{1,3})$
Example:
10.242.63.12
Remote tunnel IP address. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses.
This field is required for network type 'gre_tunnel
and
unbound_gre_tunnel` connections.This field is required to be unspecified for network type
classic
,directlink
, andvpc
connections.Possible values: 0 ≤ length ≤ 40, Value must match regular expression
^(([0-9]){1,3}\.){3}([0-9]{1,3})$
Example:
192.168.129.1
Specify the connection
s location. The specified availability zone must reside in the gateway
s region. Use the IBM Cloud global catalog to list zones within the desired region.This field is required for network type
gre_tunnel
andunbound_gre_tunnel
connections.This field is required to be unspecified for network type
classic
,directlink
, andvpc
connections.Availability zone name.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$
Example:
us-south-1
zone
The createTransitGatewayConnection options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Defines what type of network is connected via this connection. For access to gre_tunnel or unbound_gre_tunnel connections contact IBM support.
Allowable values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:Viewnetwork_type 'gre_tunnel' connections must be created over an existing network_type 'classic' connection. This field must specify the ID of an active transit gateway network_type 'classic' connection in the same transit gateway.
This field is required for network type 'gre_tunnel' connections.
This field is required to be unspecified for network type 'classic', 'directlink', 'vpc', 'power_virtual_server' and 'unbound_gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Examples:ViewThe type of network the Unbound GRE tunnel is targeting. This field is required for network type 'unbound_gre_tunnel' connections. This field is required to be unspecified for network type 'classic', 'directlink', 'vpc', 'power_virtual_server' and 'gre_tunnel' connections.
Allowable values: [
classic
]Examples:ViewLocal gateway IP address. This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections. This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 0 ≤ length ≤ 40, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:ViewLocal tunnel IP address. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses.
This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 0 ≤ length ≤ 40, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:ViewThe user-defined name for this transit gateway connection. Network type 'vpc' connections are defaulted to the name of the VPC. Network type 'classic' connections are named 'Classic'.
This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
This field is optional for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the account which owns the network that is being connected. Generally only used if the network is in a different account than the gateway. This field is required for type 'unbound_gre_tunnel' when the associated_network_type is 'classic' and the GRE tunnel is in a different account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewThe ID of the network being connected via this connection. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively. This field is required for network type 'vpc', 'power_virtual_server' and 'directlink' connections. This field is required to be unspecified for network type 'classic', 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 220, Value must match regular expression
/./
Examples:ViewArray of prefix route filters for a transit gateway connection. Prefix filters can be specified for netowrk type 'vpc', 'classic', 'power_virtual_server' and 'directlink' connections. They are not allowed for type 'gre_tunnel' connections. This is order dependent with those first in the array being applied first, and those at the end of the array being applied last, or just before applying the default. This field is optional for network type 'classic', 'vpc', 'directlink', and 'power_virtual_server' connections. This field is required to be unspecified for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Whether to permit or deny prefix filter.
Allowable values: [
permit
,deny
]Examples:ViewIP Prefix GE.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:View
prefixFilters
Default setting of permit or deny which applies to any routes that don't match a specified filter. This field is optional for network type 'classic', 'vpc', 'directlink', and 'power_virtual_server' connections. This field is required to be unspecified for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Allowable values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. The following ASN values are reserved and unavailable 64512-64513, 65100, 65201-65234, 65402-65433, 65500 and 4201065000-4201065999. If 'remote_bgp_asn' is omitted on gre_tunnel or unbound_gre_tunnel connection create requests IBM will assign an ASN.
This field is optional for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Examples:ViewRemote gateway IP address. This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections. This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 0 ≤ length ≤ 40, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:ViewRemote tunnel IP address. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses.
This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 0 ≤ length ≤ 40, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:ViewAvailability zone.
Availability zone name.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:View
zone
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Defines what type of network is connected via this connection. For access to gre_tunnel or unbound_gre_tunnel connections contact IBM support.
Allowable values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:value_source_lines_htmlnetwork_type 'gre_tunnel' connections must be created over an existing network_type 'classic' connection. This field must specify the ID of an active transit gateway network_type 'classic' connection in the same transit gateway.
This field is required for network type 'gre_tunnel' connections.
This field is required to be unspecified for network type 'classic', 'directlink', 'vpc', 'power_virtual_server' and 'unbound_gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Examples:value_source_lines_htmlThe type of network the Unbound GRE tunnel is targeting. This field is required for network type 'unbound_gre_tunnel' connections. This field is required to be unspecified for network type 'classic', 'directlink', 'vpc', 'power_virtual_server' and 'gre_tunnel' connections.
Allowable values: [
classic
]Examples:value_source_lines_htmlLocal gateway IP address. This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections. This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 0 ≤ length ≤ 40, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:value_source_lines_htmlLocal tunnel IP address. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses.
This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 0 ≤ length ≤ 40, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:value_source_lines_htmlThe user-defined name for this transit gateway connection. Network type 'vpc' connections are defaulted to the name of the VPC. Network type 'classic' connections are named 'Classic'.
This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
This field is optional for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:value_source_lines_htmlThe ID of the account which owns the network that is being connected. Generally only used if the network is in a different account than the gateway. This field is required for type 'unbound_gre_tunnel' when the associated_network_type is 'classic' and the GRE tunnel is in a different account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:value_source_lines_htmlThe ID of the network being connected via this connection. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively. This field is required for network type 'vpc', 'power_virtual_server' and 'directlink' connections. This field is required to be unspecified for network type 'classic', 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 220, Value must match regular expression
/./
Examples:value_source_lines_htmlArray of prefix route filters for a transit gateway connection. Prefix filters can be specified for netowrk type 'vpc', 'classic', 'power_virtual_server' and 'directlink' connections. They are not allowed for type 'gre_tunnel' connections. This is order dependent with those first in the array being applied first, and those at the end of the array being applied last, or just before applying the default. This field is optional for network type 'classic', 'vpc', 'directlink', and 'power_virtual_server' connections. This field is required to be unspecified for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Allowable values: [
permit
,deny
]Examples:ViewIP Prefix GE.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:View
prefixFilters
Default setting of permit or deny which applies to any routes that don't match a specified filter. This field is optional for network type 'classic', 'vpc', 'directlink', and 'power_virtual_server' connections. This field is required to be unspecified for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Allowable values: [
permit
,deny
]Examples:value_source_lines_htmlRemote network BGP ASN. The following ASN values are reserved and unavailable 64512-64513, 65100, 65201-65234, 65402-65433, 65500 and 4201065000-4201065999. If 'remote_bgp_asn' is omitted on gre_tunnel or unbound_gre_tunnel connection create requests IBM will assign an ASN.
This field is optional for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Examples:value_source_lines_htmlRemote gateway IP address. This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections. This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 0 ≤ length ≤ 40, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:value_source_lines_htmlRemote tunnel IP address. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses.
This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 0 ≤ length ≤ 40, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:value_source_lines_htmlAvailability zone.
Availability zone name.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:View
zone
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Defines what type of network is connected via this connection. For access to gre_tunnel or unbound_gre_tunnel connections contact IBM support.
Allowable values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:value_source_lines_htmlnetwork_type 'gre_tunnel' connections must be created over an existing network_type 'classic' connection. This field must specify the ID of an active transit gateway network_type 'classic' connection in the same transit gateway.
This field is required for network type 'gre_tunnel' connections.
This field is required to be unspecified for network type 'classic', 'directlink', 'vpc', 'power_virtual_server' and 'unbound_gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Examples:value_source_lines_htmlThe type of network the Unbound GRE tunnel is targeting. This field is required for network type 'unbound_gre_tunnel' connections. This field is required to be unspecified for network type 'classic', 'directlink', 'vpc', 'power_virtual_server' and 'gre_tunnel' connections.
Allowable values: [
classic
]Examples:value_source_lines_htmlLocal gateway IP address. This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections. This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 0 ≤ length ≤ 40, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:value_source_lines_htmlLocal tunnel IP address. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses.
This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 0 ≤ length ≤ 40, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:value_source_lines_htmlThe user-defined name for this transit gateway connection. Network type 'vpc' connections are defaulted to the name of the VPC. Network type 'classic' connections are named 'Classic'.
This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
This field is optional for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:value_source_lines_htmlThe ID of the account which owns the network that is being connected. Generally only used if the network is in a different account than the gateway. This field is required for type 'unbound_gre_tunnel' when the associated_network_type is 'classic' and the GRE tunnel is in a different account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:value_source_lines_htmlThe ID of the network being connected via this connection. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively. This field is required for network type 'vpc', 'power_virtual_server' and 'directlink' connections. This field is required to be unspecified for network type 'classic', 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 220, Value must match regular expression
/./
Examples:value_source_lines_htmlArray of prefix route filters for a transit gateway connection. Prefix filters can be specified for netowrk type 'vpc', 'classic', 'power_virtual_server' and 'directlink' connections. They are not allowed for type 'gre_tunnel' connections. This is order dependent with those first in the array being applied first, and those at the end of the array being applied last, or just before applying the default. This field is optional for network type 'classic', 'vpc', 'directlink', and 'power_virtual_server' connections. This field is required to be unspecified for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Allowable values: [
permit
,deny
]Examples:ViewIP Prefix GE.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:View
prefix_filters
Default setting of permit or deny which applies to any routes that don't match a specified filter. This field is optional for network type 'classic', 'vpc', 'directlink', and 'power_virtual_server' connections. This field is required to be unspecified for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Allowable values: [
permit
,deny
]Examples:value_source_lines_htmlRemote network BGP ASN. The following ASN values are reserved and unavailable 64512-64513, 65100, 65201-65234, 65402-65433, 65500 and 4201065000-4201065999. If 'remote_bgp_asn' is omitted on gre_tunnel or unbound_gre_tunnel connection create requests IBM will assign an ASN.
This field is optional for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Examples:value_source_lines_htmlRemote gateway IP address. This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections. This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 0 ≤ length ≤ 40, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:value_source_lines_htmlRemote tunnel IP address. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses.
This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 0 ≤ length ≤ 40, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:value_source_lines_htmlAvailability zone.
Availability zone name.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:View
zone
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The CreateTransitGatewayConnection options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Defines what type of network is connected via this connection. For access to gre_tunnel or unbound_gre_tunnel connections contact IBM support.
Allowable values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:Viewnetwork_type 'gre_tunnel' connections must be created over an existing network_type 'classic' connection. This field must specify the ID of an active transit gateway network_type 'classic' connection in the same transit gateway.
This field is required for network type 'gre_tunnel' connections.
This field is required to be unspecified for network type 'classic', 'directlink', 'vpc', 'power_virtual_server' and 'unbound_gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Examples:ViewThe type of network the Unbound GRE tunnel is targeting. This field is required for network type 'unbound_gre_tunnel' connections. This field is required to be unspecified for network type 'classic', 'directlink', 'vpc', 'power_virtual_server' and 'gre_tunnel' connections.
Allowable values: [
classic
]Examples:ViewLocal gateway IP address. This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections. This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 0 ≤ length ≤ 40, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:ViewLocal tunnel IP address. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses.
This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 0 ≤ length ≤ 40, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:ViewThe user-defined name for this transit gateway connection. Network type 'vpc' connections are defaulted to the name of the VPC. Network type 'classic' connections are named 'Classic'.
This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
This field is optional for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the account which owns the network that is being connected. Generally only used if the network is in a different account than the gateway. This field is required for type 'unbound_gre_tunnel' when the associated_network_type is 'classic' and the GRE tunnel is in a different account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewThe ID of the network being connected via this connection. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively. This field is required for network type 'vpc', 'power_virtual_server' and 'directlink' connections. This field is required to be unspecified for network type 'classic', 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 220, Value must match regular expression
/./
Examples:ViewArray of prefix route filters for a transit gateway connection. Prefix filters can be specified for netowrk type 'vpc', 'classic', 'power_virtual_server' and 'directlink' connections. They are not allowed for type 'gre_tunnel' connections. This is order dependent with those first in the array being applied first, and those at the end of the array being applied last, or just before applying the default. This field is optional for network type 'classic', 'vpc', 'directlink', and 'power_virtual_server' connections. This field is required to be unspecified for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Allowable values: [
permit
,deny
]Examples:ViewIP Prefix GE.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:View
PrefixFilters
Default setting of permit or deny which applies to any routes that don't match a specified filter. This field is optional for network type 'classic', 'vpc', 'directlink', and 'power_virtual_server' connections. This field is required to be unspecified for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Allowable values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. The following ASN values are reserved and unavailable 64512-64513, 65100, 65201-65234, 65402-65433, 65500 and 4201065000-4201065999. If 'remote_bgp_asn' is omitted on gre_tunnel or unbound_gre_tunnel connection create requests IBM will assign an ASN.
This field is optional for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Examples:ViewRemote gateway IP address. This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections. This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 0 ≤ length ≤ 40, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:ViewRemote tunnel IP address. The local_tunnel_ip and remote_tunnel_ip addresses must be in the same /30 network. Neither can be the network nor broadcast addresses.
This field is required for network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
This field is required to be unspecified for network type 'classic', 'directlink', 'vpc' and 'power_virtual_server' connections.
Possible values: 0 ≤ length ≤ 40, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})$/
Examples:ViewAvailability zone.
Availability zone name.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/^([a-z]|[a-z][-_a-z0-9]*[a-z0-9]+)$/
Examples:View
Zone
curl -X POST --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" --header "Content-Type: application/json" --data '{ "network_type": "vpc" }' "{base_url}/transit_gateways/{transit_gateway_id}/connections?version={version}"
createTransitGatewayConnectionOptions := transitGatewayApisService.NewCreateTransitGatewayConnectionOptions( "testString", "vpc", ) transitGatewayConnectionCust, response, err := transitGatewayApisService.CreateTransitGatewayConnection(createTransitGatewayConnectionOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(transitGatewayConnectionCust, "", " ") fmt.Println(string(b))
CreateTransitGatewayConnectionOptions createTransitGatewayConnectionOptions = new CreateTransitGatewayConnectionOptions.Builder() .transitGatewayId("testString") .networkType("vpc") .build(); Response<TransitGatewayConnectionCust> response = transitGatewayApisService.createTransitGatewayConnection(createTransitGatewayConnectionOptions).execute(); TransitGatewayConnectionCust transitGatewayConnectionCust = response.getResult(); System.out.println(transitGatewayConnectionCust);
const params = { transitGatewayId: 'testString', networkType: 'vpc', }; let res; try { res = await transitGatewayApisService.createTransitGatewayConnection(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
transit_gateway_connection_cust = transit_gateway_apis_service.create_transit_gateway_connection( transit_gateway_id='testString', network_type='vpc' ).get_result() print(json.dumps(transit_gateway_connection_cust, indent=2))
Response
Connection included in transit gateway
The user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$
Example:
Transit_Service_BWTN_SJ_DL
Defines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
]Example:
vpc
A unique identifier for a resource
Possible values: 0 ≤ length ≤ 100
Example:
0a06fb9b-820f-4c44-8a31-77f1f0806d28
The date and time that this connection was created
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Example:
permit
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Example:
classic
The ID of the network being connected via this connection. This field is required for some types, such as
vpc
anddirectlink
. For network typesvpc
anddirectlink
this is the CRN of the VPC / Direct Link gateway respectively.Example:
crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b
network_type
gre_tunnel
connections usebase_connection_id
to specify the ID of a network_typeclassic
connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. Theclassic
connection cannot be deleted until anygre_tunnel
connections using it are deleted. This field only applies to and is required for network typegre_tunnel
connections.Possible values: 0 ≤ length ≤ 36
Example:
975f58c1-afe7-469a-9727-7f3d720f2d32
Local network BGP ASN. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
64490
Local gateway IP address. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
192.168.100.1
Local tunnel IP address. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
192.168.129.2
GRE tunnel MTU. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
9000
The ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
.
Example:
28e4d90ac7504be694471ee66e70d0d5
Array of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Possible values: 0 ≤ number of items ≤ 10
Remote network BGP ASN. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
65010
Remote gateway IP address. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
10.242.63.12
Remote tunnel IP address. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
192.168.129.1
Only visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection`s current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated
Location of GRE tunnel. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Availability zone name
Example:
us-south-1
zone
Connection included in transit gateway.
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewThe unique identifier for this Transit Gateway Connection.
Possible values: 0 ≤ length ≤ 100
Examples:Viewnetwork_type 'gre_tunnel' connections use 'base_connection_id' to specify the ID of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
Local network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
prefixFilters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection's current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Availability zone name.
Examples:View
zone
Connection included in transit gateway.
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewThe unique identifier for this Transit Gateway Connection.
Possible values: 0 ≤ length ≤ 100
Examples:Viewnetwork_type 'gre_tunnel' connections use 'base_connection_id' to specify the ID of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
Local network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
prefix_filters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection's current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Availability zone name.
Examples:View
zone
Connection included in transit gateway.
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewThe unique identifier for this Transit Gateway Connection.
Possible values: 0 ≤ length ≤ 100
Examples:Viewnetwork_type 'gre_tunnel' connections use 'base_connection_id' to specify the ID of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
Local network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
prefix_filters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection's current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Availability zone name.
Examples:View
zone
Connection included in transit gateway.
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewThe unique identifier for this Transit Gateway Connection.
Possible values: 0 ≤ length ≤ 100
Examples:Viewnetwork_type 'gre_tunnel' connections use 'base_connection_id' to specify the ID of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
Local network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
PrefixFilters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection's current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Availability zone name.
Examples:View
Zone
Status Code
The Transit Gateway connection was created successfully.
An invalid connection template was provided.
The specified Transit Gateway could not be found, the specified resource group could not be found, or the default resource group could not be found (if the resource group was not specified in the template).
The network being connected must either be in a location that is considered "local" to the specified Transit Gateway, or the specified Transit Gateway needs to be global. The network being connected cannot already be connected to another Transit Gateway.
{ "created_at": "2020-03-31T12:08:05Z", "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531", "name": "example-connection", "network_id": "crn:[...]", "network_type": "vpc", "prefix_filters_default": "permit", "status": "pending", "updated_at": "2020-03-31T12:08:05Z" }
{ "created_at": "2020-03-31T12:08:05Z", "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531", "name": "example-connection", "network_id": "crn:[...]", "network_type": "vpc", "prefix_filters_default": "permit", "status": "pending", "updated_at": "2020-03-31T12:08:05Z" }
{ "errors": [ { "code": "validation_required_field_missing", "message": "Mandatory field is missing.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling", "target": { "name": "type", "type": "field" } } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "validation_required_field_missing", "message": "Mandatory field is missing.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling", "target": { "name": "type", "type": "field" } } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "invalid_state", "message": "NetworkID already exists, Invalid request", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "invalid_state", "message": "NetworkID already exists, Invalid request", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
Remove connection from Transit Gateway
After the specified connection is detached, entities still within the Transit Gateway will no longer be able to communicate directly to it through the IBM Cloud private backbone.
After the specified connection is detached, entities still within the Transit Gateway will no longer be able to communicate directly to it through the IBM Cloud private backbone.
After the specified connection is detached, entities still within the Transit Gateway will no longer be able to communicate directly to it through the IBM Cloud private backbone.
After the specified connection is detached, entities still within the Transit Gateway will no longer be able to communicate directly to it through the IBM Cloud private backbone.
After the specified connection is detached, entities still within the Transit Gateway will no longer be able to communicate directly to it through the IBM Cloud private backbone.
DELETE /transit_gateways/{transit_gateway_id}/connections/{id}
ServiceCall<Void> deleteTransitGatewayConnection(DeleteTransitGatewayConnectionOptions deleteTransitGatewayConnectionOptions)
deleteTransitGatewayConnection(params)
delete_transit_gateway_connection(self,
transit_gateway_id: str,
id: str,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) DeleteTransitGatewayConnection(deleteTransitGatewayConnectionOptions *DeleteTransitGatewayConnectionOptions) (response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) DeleteTransitGatewayConnectionWithContext(ctx context.Context, deleteTransitGatewayConnectionOptions *DeleteTransitGatewayConnectionOptions) (response *core.DetailedResponse, err error)
Request
Use the DeleteTransitGatewayConnectionOptions.Builder
to create a DeleteTransitGatewayConnectionOptions
object that contains the parameter values for the deleteTransitGatewayConnection
method.
Instantiate the DeleteTransitGatewayConnectionOptions
struct and set the fields to provide parameter values for the DeleteTransitGatewayConnection
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
The connection identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The deleteTransitGatewayConnection options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The DeleteTransitGatewayConnection options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
curl -X DELETE --location --header "Authorization: Bearer {iam_token}" "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}?version={version}"
deleteTransitGatewayConnectionOptions := transitGatewayApisService.NewDeleteTransitGatewayConnectionOptions( "testString", "testString", ) response, err := transitGatewayApisService.DeleteTransitGatewayConnection(deleteTransitGatewayConnectionOptions) if err != nil { panic(err) }
DeleteTransitGatewayConnectionOptions deleteTransitGatewayConnectionOptions = new DeleteTransitGatewayConnectionOptions.Builder() .transitGatewayId("testString") .id("testString") .build(); Response<Void> response = transitGatewayApisService.deleteTransitGatewayConnection(deleteTransitGatewayConnectionOptions).execute();
const params = { transitGatewayId: 'testString', id: 'testString', }; try { await transitGatewayApisService.deleteTransitGatewayConnection(params); } catch (err) { console.warn(err); }
response = transit_gateway_apis_service.delete_transit_gateway_connection( transit_gateway_id='testString', id='testString' )
Response
Status Code
The connection was removed successfully.
A Transit Gateway or Transit Gateway connection with the specified identifier could not be found.
{ "errors": [ { "code": "not_found", "message": "Cannot find Connection", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Connection", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
Retrieves specified Transit Gateway connection
This request retrieves a connection from the Transit Gateway.
This request retrieves a connection from the Transit Gateway.
This request retrieves a connection from the Transit Gateway.
This request retrieves a connection from the Transit Gateway.
This request retrieves a connection from the Transit Gateway.
GET /transit_gateways/{transit_gateway_id}/connections/{id}
ServiceCall<TransitGatewayConnectionCust> getTransitGatewayConnection(GetTransitGatewayConnectionOptions getTransitGatewayConnectionOptions)
getTransitGatewayConnection(params)
get_transit_gateway_connection(self,
transit_gateway_id: str,
id: str,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayConnection(getTransitGatewayConnectionOptions *GetTransitGatewayConnectionOptions) (result *TransitGatewayConnectionCust, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayConnectionWithContext(ctx context.Context, getTransitGatewayConnectionOptions *GetTransitGatewayConnectionOptions) (result *TransitGatewayConnectionCust, response *core.DetailedResponse, err error)
Request
Use the GetTransitGatewayConnectionOptions.Builder
to create a GetTransitGatewayConnectionOptions
object that contains the parameter values for the getTransitGatewayConnection
method.
Instantiate the GetTransitGatewayConnectionOptions
struct and set the fields to provide parameter values for the GetTransitGatewayConnection
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
The connection identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The getTransitGatewayConnection options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The GetTransitGatewayConnection options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
curl -X GET --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}?version={version}"
getTransitGatewayConnectionOptions := transitGatewayApisService.NewGetTransitGatewayConnectionOptions( "testString", "testString", ) transitGatewayConnectionCust, response, err := transitGatewayApisService.GetTransitGatewayConnection(getTransitGatewayConnectionOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(transitGatewayConnectionCust, "", " ") fmt.Println(string(b))
GetTransitGatewayConnectionOptions getTransitGatewayConnectionOptions = new GetTransitGatewayConnectionOptions.Builder() .transitGatewayId("testString") .id("testString") .build(); Response<TransitGatewayConnectionCust> response = transitGatewayApisService.getTransitGatewayConnection(getTransitGatewayConnectionOptions).execute(); TransitGatewayConnectionCust transitGatewayConnectionCust = response.getResult(); System.out.println(transitGatewayConnectionCust);
const params = { transitGatewayId: 'testString', id: 'testString', }; let res; try { res = await transitGatewayApisService.getTransitGatewayConnection(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
transit_gateway_connection_cust = transit_gateway_apis_service.get_transit_gateway_connection( transit_gateway_id='testString', id='testString' ).get_result() print(json.dumps(transit_gateway_connection_cust, indent=2))
Response
Connection included in transit gateway
The user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$
Example:
Transit_Service_BWTN_SJ_DL
Defines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
]Example:
vpc
A unique identifier for a resource
Possible values: 0 ≤ length ≤ 100
Example:
0a06fb9b-820f-4c44-8a31-77f1f0806d28
The date and time that this connection was created
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Example:
permit
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Example:
classic
The ID of the network being connected via this connection. This field is required for some types, such as
vpc
anddirectlink
. For network typesvpc
anddirectlink
this is the CRN of the VPC / Direct Link gateway respectively.Example:
crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b
network_type
gre_tunnel
connections usebase_connection_id
to specify the ID of a network_typeclassic
connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. Theclassic
connection cannot be deleted until anygre_tunnel
connections using it are deleted. This field only applies to and is required for network typegre_tunnel
connections.Possible values: 0 ≤ length ≤ 36
Example:
975f58c1-afe7-469a-9727-7f3d720f2d32
Local network BGP ASN. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
64490
Local gateway IP address. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
192.168.100.1
Local tunnel IP address. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
192.168.129.2
GRE tunnel MTU. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
9000
The ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
.
Example:
28e4d90ac7504be694471ee66e70d0d5
Array of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Possible values: 0 ≤ number of items ≤ 10
Remote network BGP ASN. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
65010
Remote gateway IP address. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
10.242.63.12
Remote tunnel IP address. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
192.168.129.1
Only visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection`s current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated
Location of GRE tunnel. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Availability zone name
Example:
us-south-1
zone
Connection included in transit gateway.
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewThe unique identifier for this Transit Gateway Connection.
Possible values: 0 ≤ length ≤ 100
Examples:Viewnetwork_type 'gre_tunnel' connections use 'base_connection_id' to specify the ID of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
Local network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
prefixFilters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection's current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Availability zone name.
Examples:View
zone
Connection included in transit gateway.
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewThe unique identifier for this Transit Gateway Connection.
Possible values: 0 ≤ length ≤ 100
Examples:Viewnetwork_type 'gre_tunnel' connections use 'base_connection_id' to specify the ID of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
Local network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
prefix_filters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection's current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Availability zone name.
Examples:View
zone
Connection included in transit gateway.
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewThe unique identifier for this Transit Gateway Connection.
Possible values: 0 ≤ length ≤ 100
Examples:Viewnetwork_type 'gre_tunnel' connections use 'base_connection_id' to specify the ID of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
Local network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
prefix_filters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection's current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Availability zone name.
Examples:View
zone
Connection included in transit gateway.
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewThe unique identifier for this Transit Gateway Connection.
Possible values: 0 ≤ length ≤ 100
Examples:Viewnetwork_type 'gre_tunnel' connections use 'base_connection_id' to specify the ID of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
Local network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
PrefixFilters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection's current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Availability zone name.
Examples:View
Zone
Status Code
The connection was retrieved successfully.
A connection or gateway with the specified identifier(s) could not be found.
{ "created_at": "2020-03-31T12:08:05Z", "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531", "name": "example-connection", "network_id": "crn:[...]", "network_type": "vpc", "prefix_filters_default": "permit", "status": "attached", "updated_at": "2020-03-31T12:08:05Z" }
{ "created_at": "2020-03-31T12:08:05Z", "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531", "name": "example-connection", "network_id": "crn:[...]", "network_type": "vpc", "prefix_filters_default": "permit", "status": "attached", "updated_at": "2020-03-31T12:08:05Z" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Connection", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Connection", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
Updates specified Transit Gateway connection
Update the name of a connection to a Transit Gateway.
Update the name of a connection to a Transit Gateway.
Update the name of a connection to a Transit Gateway.
Update the name of a connection to a Transit Gateway.
Update the name of a connection to a Transit Gateway.
PATCH /transit_gateways/{transit_gateway_id}/connections/{id}
ServiceCall<TransitGatewayConnectionCust> updateTransitGatewayConnection(UpdateTransitGatewayConnectionOptions updateTransitGatewayConnectionOptions)
updateTransitGatewayConnection(params)
update_transit_gateway_connection(self,
transit_gateway_id: str,
id: str,
*,
name: str = None,
prefix_filters_default: str = None,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) UpdateTransitGatewayConnection(updateTransitGatewayConnectionOptions *UpdateTransitGatewayConnectionOptions) (result *TransitGatewayConnectionCust, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) UpdateTransitGatewayConnectionWithContext(ctx context.Context, updateTransitGatewayConnectionOptions *UpdateTransitGatewayConnectionOptions) (result *TransitGatewayConnectionCust, response *core.DetailedResponse, err error)
Request
Use the UpdateTransitGatewayConnectionOptions.Builder
to create a UpdateTransitGatewayConnectionOptions
object that contains the parameter values for the updateTransitGatewayConnection
method.
Instantiate the UpdateTransitGatewayConnectionOptions
struct and set the fields to provide parameter values for the UpdateTransitGatewayConnection
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
The connection identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The connection template
The user-defined name for this transit gateway. If specified as empty string or nil, the name will be the network name (the name of the VPC in the case of network type
vpc
, and the word Classic, in the case of network typeclassic
).Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$
Example:
Transit_Service_BWTN_SJ_DL
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Allowable values: [
permit
,deny
]Example:
permit
The updateTransitGatewayConnection options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The user-defined name for this transit gateway. If specified as empty string or nil, the name will be the network name (the name of the VPC in the case of network type 'vpc', and the word Classic, in the case of network type 'classic').
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewDefault setting of permit or deny which applies to any routes that don't match a specified filter.
Allowable values: [
permit
,deny
]Examples:View
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The user-defined name for this transit gateway. If specified as empty string or nil, the name will be the network name (the name of the VPC in the case of network type 'vpc', and the word Classic, in the case of network type 'classic').
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:value_source_lines_htmlDefault setting of permit or deny which applies to any routes that don't match a specified filter.
Allowable values: [
permit
,deny
]Examples:value_source_lines_html
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The user-defined name for this transit gateway. If specified as empty string or nil, the name will be the network name (the name of the VPC in the case of network type 'vpc', and the word Classic, in the case of network type 'classic').
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:value_source_lines_htmlDefault setting of permit or deny which applies to any routes that don't match a specified filter.
Allowable values: [
permit
,deny
]Examples:value_source_lines_html
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The UpdateTransitGatewayConnection options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The user-defined name for this transit gateway. If specified as empty string or nil, the name will be the network name (the name of the VPC in the case of network type 'vpc', and the word Classic, in the case of network type 'classic').
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewDefault setting of permit or deny which applies to any routes that don't match a specified filter.
Allowable values: [
permit
,deny
]Examples:View
curl -X PATCH --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" --header "Content-Type: application/json" --data '{}' "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}?version={version}"
updateTransitGatewayConnectionOptions := transitGatewayApisService.NewUpdateTransitGatewayConnectionOptions( "testString", "testString", ) transitGatewayConnectionCust, response, err := transitGatewayApisService.UpdateTransitGatewayConnection(updateTransitGatewayConnectionOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(transitGatewayConnectionCust, "", " ") fmt.Println(string(b))
UpdateTransitGatewayConnectionOptions updateTransitGatewayConnectionOptions = new UpdateTransitGatewayConnectionOptions.Builder() .transitGatewayId("testString") .id("testString") .build(); Response<TransitGatewayConnectionCust> response = transitGatewayApisService.updateTransitGatewayConnection(updateTransitGatewayConnectionOptions).execute(); TransitGatewayConnectionCust transitGatewayConnectionCust = response.getResult(); System.out.println(transitGatewayConnectionCust);
const params = { transitGatewayId: 'testString', id: 'testString', }; let res; try { res = await transitGatewayApisService.updateTransitGatewayConnection(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
transit_gateway_connection_cust = transit_gateway_apis_service.update_transit_gateway_connection( transit_gateway_id='testString', id='testString', ).get_result() print(json.dumps(transit_gateway_connection_cust, indent=2))
Response
Connection included in transit gateway
The user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$
Example:
Transit_Service_BWTN_SJ_DL
Defines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
]Example:
vpc
A unique identifier for a resource
Possible values: 0 ≤ length ≤ 100
Example:
0a06fb9b-820f-4c44-8a31-77f1f0806d28
The date and time that this connection was created
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Example:
permit
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Example:
classic
The ID of the network being connected via this connection. This field is required for some types, such as
vpc
anddirectlink
. For network typesvpc
anddirectlink
this is the CRN of the VPC / Direct Link gateway respectively.Example:
crn:v1:bluemix:public:is:us-south:a/123456::vpc:4727d842-f94f-4a2d-824a-9bc9b02c523b
network_type
gre_tunnel
connections usebase_connection_id
to specify the ID of a network_typeclassic
connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. Theclassic
connection cannot be deleted until anygre_tunnel
connections using it are deleted. This field only applies to and is required for network typegre_tunnel
connections.Possible values: 0 ≤ length ≤ 36
Example:
975f58c1-afe7-469a-9727-7f3d720f2d32
Local network BGP ASN. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
64490
Local gateway IP address. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
192.168.100.1
Local tunnel IP address. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
192.168.129.2
GRE tunnel MTU. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
9000
The ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
.
Example:
28e4d90ac7504be694471ee66e70d0d5
Array of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Possible values: 0 ≤ number of items ≤ 10
Remote network BGP ASN. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
65010
Remote gateway IP address. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
10.242.63.12
Remote tunnel IP address. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Example:
192.168.129.1
Only visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection`s current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated
Location of GRE tunnel. This field only applies to network type
gre_tunnel
andunbound_gre_tunnel
connections.Availability zone name
Example:
us-south-1
zone
Connection included in transit gateway.
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewThe unique identifier for this Transit Gateway Connection.
Possible values: 0 ≤ length ≤ 100
Examples:Viewnetwork_type 'gre_tunnel' connections use 'base_connection_id' to specify the ID of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
Local network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
prefixFilters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection's current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Availability zone name.
Examples:View
zone
Connection included in transit gateway.
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewThe unique identifier for this Transit Gateway Connection.
Possible values: 0 ≤ length ≤ 100
Examples:Viewnetwork_type 'gre_tunnel' connections use 'base_connection_id' to specify the ID of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
Local network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
prefix_filters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection's current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Availability zone name.
Examples:View
zone
Connection included in transit gateway.
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewThe unique identifier for this Transit Gateway Connection.
Possible values: 0 ≤ length ≤ 100
Examples:Viewnetwork_type 'gre_tunnel' connections use 'base_connection_id' to specify the ID of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
Local network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
prefix_filters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection's current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Availability zone name.
Examples:View
zone
Connection included in transit gateway.
The type of network the GRE tunnel is targeting.
Possible values: [
classic
]Examples:ViewThe user-defined name for this transit gateway connection.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^([a-zA-Z]|[a-zA-Z][-_a-zA-Z0-9]*[a-zA-Z0-9])$/
Examples:ViewThe ID of the network being connected via this connection. This field is required for some types, such as 'vpc', 'power_virtual_server' and 'directlink'. For network types 'vpc','power_virtual_server' and 'directlink' this is the CRN of the VPC / PowerVS / Direct Link gateway respectively.
Examples:ViewDefines what type of network is connected via this connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
classic
,directlink
,gre_tunnel
,unbound_gre_tunnel
,vpc
,power_virtual_server
]Examples:ViewThe unique identifier for this Transit Gateway Connection.
Possible values: 0 ≤ length ≤ 100
Examples:Viewnetwork_type 'gre_tunnel' connections use 'base_connection_id' to specify the ID of a network_type 'classic' connection the tunnel is configured over. The specified connection must reside in the same transit gateway and be in an active state. The 'classic' connection cannot be deleted until any 'gre_tunnel' connections using it are deleted. This field only applies to and is required for network type 'gre_tunnel' connections.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this connection was created.
Local network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewLocal tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewGRE tunnel MTU. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewThe ID of the account which owns the connected network. Generally only used if the network is in a different IBM Cloud account than the gateway.
Possible values: 0 ≤ length ≤ 100, Value must match regular expression
/./
Examples:ViewArray of prefix route filters for a transit gateway connection. This is order dependent with those first in the array being applied first, and those at the end of the array is applied last, or just before the default.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Examples:ViewThe date and time that this prefix filter was last updated.
PrefixFilters
Default setting of permit or deny which applies to any routes that don't match a specified filter.
Possible values: [
permit
,deny
]Examples:ViewRemote network BGP ASN. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote gateway IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewRemote tunnel IP address. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Examples:ViewOnly visible for cross account connections, this field represents the status of a connection request between IBM Cloud accounts. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
pending
,approved
,rejected
,expired
,detached
]Connection's current configuration state. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
attached
,failed
,pending
,deleting
,detaching
,detached
,suspending
,suspended
]The date and time that this connection was last updated.
Location of GRE tunnel. This field only applies to network type 'gre_tunnel' and 'unbound_gre_tunnel' connections.
Availability zone name.
Examples:View
Zone
Status Code
The connection was updated successfully.
The connection update template was invalid.
A connection or gateway with the specified identifier(s) could not be found.
{ "created_at": "2020-03-31T12:08:05Z", "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531", "name": "example-connection-new-name", "network_id": "crn:[...]", "network_type": "vpc", "prefix_filters_default": "permit", "status": "attached", "updated_at": "2020-03-31T12:08:05Z" }
{ "created_at": "2020-03-31T12:08:05Z", "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531", "name": "example-connection-new-name", "network_id": "crn:[...]", "network_type": "vpc", "prefix_filters_default": "permit", "status": "attached", "updated_at": "2020-03-31T12:08:05Z" }
{ "errors": [ { "code": "bad_request", "message": "The information given was invalid, malformed, or missing a required field.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling", "target": { "name": "request_body", "type": "field" } } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "bad_request", "message": "The information given was invalid, malformed, or missing a required field.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling", "target": { "name": "request_body", "type": "field" } } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Connection", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Connection", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
Perform actions on a connection for a Transit Gateway
Allow a network owner to approve or reject a cross-account connection request.
Allow a network owner to approve or reject a cross-account connection request.
Allow a network owner to approve or reject a cross-account connection request.
Allow a network owner to approve or reject a cross-account connection request.
Allow a network owner to approve or reject a cross-account connection request.
POST /transit_gateways/{transit_gateway_id}/connections/{id}/actions
ServiceCall<Void> createTransitGatewayConnectionActions(CreateTransitGatewayConnectionActionsOptions createTransitGatewayConnectionActionsOptions)
createTransitGatewayConnectionActions(params)
create_transit_gateway_connection_actions(self,
transit_gateway_id: str,
id: str,
action: str,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayConnectionActions(createTransitGatewayConnectionActionsOptions *CreateTransitGatewayConnectionActionsOptions) (response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayConnectionActionsWithContext(ctx context.Context, createTransitGatewayConnectionActionsOptions *CreateTransitGatewayConnectionActionsOptions) (response *core.DetailedResponse, err error)
Request
Use the CreateTransitGatewayConnectionActionsOptions.Builder
to create a CreateTransitGatewayConnectionActionsOptions
object that contains the parameter values for the createTransitGatewayConnectionActions
method.
Instantiate the CreateTransitGatewayConnectionActionsOptions
struct and set the fields to provide parameter values for the CreateTransitGatewayConnectionActions
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
The connection identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The action template
The action that is to be performed against the connection request
Allowable values: [
approve
,reject
]Example:
approve
The createTransitGatewayConnectionActions options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The action that is to be performed against the connection request.
Allowable values: [
approve
,reject
]Examples:View
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The action that is to be performed against the connection request.
Allowable values: [
approve
,reject
]Examples:value_source_lines_html
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The action that is to be performed against the connection request.
Allowable values: [
approve
,reject
]Examples:value_source_lines_html
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The CreateTransitGatewayConnectionActions options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The action that is to be performed against the connection request.
Allowable values: [
approve
,reject
]Examples:View
curl -X POST --location --header "Authorization: Bearer {iam_token}" --header "Content-Type: application/json" --data '{ "action": "approve" }' "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/actions?version={version}"
createTransitGatewayConnectionActionsOptions := transitGatewayApisService.NewCreateTransitGatewayConnectionActionsOptions( "testString", "testString", "approve", ) response, err := transitGatewayApisService.CreateTransitGatewayConnectionActions(createTransitGatewayConnectionActionsOptions) if err != nil { panic(err) }
CreateTransitGatewayConnectionActionsOptions createTransitGatewayConnectionActionsOptions = new CreateTransitGatewayConnectionActionsOptions.Builder() .transitGatewayId("testString") .id("testString") .action("approve") .build(); Response<Void> response = transitGatewayApisService.createTransitGatewayConnectionActions(createTransitGatewayConnectionActionsOptions).execute();
const params = { transitGatewayId: 'testString', id: 'testString', action: 'approve', }; try { await transitGatewayApisService.createTransitGatewayConnectionActions(params); } catch (err) { console.warn(err); }
response = transit_gateway_apis_service.create_transit_gateway_connection_actions( transit_gateway_id='testString', id='testString', action='approve' )
Response
Status Code
The connection approval/rejection was successful.
The caller is not authorized to perform the requested action, or the action was called by the gateway owning account.
A Transit Gateway or Transit Gateway connection with the specified identifier could not be found.
Attempted to approve a classic_access VPC connection.
{ "errors": [ { "code": "not_authorized", "message": "The request is not authorized.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_authorized", "message": "The request is not authorized.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Connection", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Connection", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "invalid_state", "message": "Attempted to approve a classic_access VPC connection.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "invalid_state", "message": "Attempted to approve a classic_access VPC connection.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
List all locations that support Transit Gateways
List all locations that support Transit Gateways.
List all locations that support Transit Gateways.
List all locations that support Transit Gateways.
List all locations that support Transit Gateways.
List all locations that support Transit Gateways.
GET /locations
ServiceCall<TSCollection> listGatewayLocations(ListGatewayLocationsOptions listGatewayLocationsOptions)
listGatewayLocations(params)
list_gateway_locations(self,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) ListGatewayLocations(listGatewayLocationsOptions *ListGatewayLocationsOptions) (result *TSCollection, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) ListGatewayLocationsWithContext(ctx context.Context, listGatewayLocationsOptions *ListGatewayLocationsOptions) (result *TSCollection, response *core.DetailedResponse, err error)
Request
Use the ListGatewayLocationsOptions.Builder
to create a ListGatewayLocationsOptions
object that contains the parameter values for the listGatewayLocations
method.
Instantiate the ListGatewayLocationsOptions
struct and set the fields to provide parameter values for the ListGatewayLocations
method.
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
parameters
parameters
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
curl -X GET --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" "{base_url}/locations?version={version}"
listGatewayLocationsOptions := transitGatewayApisService.NewListGatewayLocationsOptions() tsCollection, response, err := transitGatewayApisService.ListGatewayLocations(listGatewayLocationsOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(tsCollection, "", " ") fmt.Println(string(b))
ListGatewayLocationsOptions listGatewayLocationsOptions = new ListGatewayLocationsOptions(); Response<TSCollection> response = transitGatewayApisService.listGatewayLocations(listGatewayLocationsOptions).execute(); TSCollection tsCollection = response.getResult(); System.out.println(tsCollection);
let res; try { res = await transitGatewayApisService.listGatewayLocations({}); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
ts_collection = transit_gateway_apis_service.list_gateway_locations().get_result() print(json.dumps(ts_collection, indent=2))
Response
A list of Transit Gateway locations
Collection of Transit Gateway locations
Possible values: 1 ≤ number of items ≤ 50
A list of Transit Gateway locations.
Collection of Transit Gateway locations.
The geographical location of this location, used for billing purposes.
Possible values: 0 ≤ length ≤ 20
Examples:ViewName of the Location.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe type of the location, determining is this a multi-zone region, a single data center, or a point of presence.
Possible values: 0 ≤ length ≤ 20
Examples:View
locations
A list of Transit Gateway locations.
Collection of Transit Gateway locations.
Possible values: 1 ≤ number of items ≤ 50
The geographical location of this location, used for billing purposes.
Possible values: 0 ≤ length ≤ 20
Examples:ViewName of the Location.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe type of the location, determining is this a multi-zone region, a single data center, or a point of presence.
Possible values: 0 ≤ length ≤ 20
Examples:View
locations
A list of Transit Gateway locations.
Collection of Transit Gateway locations.
Possible values: 1 ≤ number of items ≤ 50
The geographical location of this location, used for billing purposes.
Possible values: 0 ≤ length ≤ 20
Examples:ViewName of the Location.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe type of the location, determining is this a multi-zone region, a single data center, or a point of presence.
Possible values: 0 ≤ length ≤ 20
Examples:View
locations
A list of Transit Gateway locations.
Collection of Transit Gateway locations.
Possible values: 1 ≤ number of items ≤ 50
The geographical location of this location, used for billing purposes.
Possible values: 0 ≤ length ≤ 20
Examples:ViewName of the Location.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe type of the location, determining is this a multi-zone region, a single data center, or a point of presence.
Possible values: 0 ≤ length ≤ 20
Examples:View
Locations
Status Code
Successfully retrieved the list of Transit Gateway locations.
{ "locations": [ { "billing_location": "us", "name": "us-south", "type": "region" }, { "billing_location": "us", "name": "us-east", "type": "region" }, { "billing_location": "ap", "name": "au-syd", "type": "region" }, { "billing_location": "eu", "name": "eu-de", "type": "region" }, { "billing_location": "ap", "name": "jp-jok", "type": "region" } ] }
{ "locations": [ { "billing_location": "us", "name": "us-south", "type": "region" }, { "billing_location": "us", "name": "us-east", "type": "region" }, { "billing_location": "ap", "name": "au-syd", "type": "region" }, { "billing_location": "eu", "name": "eu-de", "type": "region" }, { "billing_location": "ap", "name": "jp-jok", "type": "region" } ] }
Show the details of a given Transit Gateway location
Get the details of a Transit Gateway Location.
Get the details of a Transit Gateway Location.
Get the details of a Transit Gateway Location.
Get the details of a Transit Gateway Location.
Get the details of a Transit Gateway Location.
GET /locations/{name}
ServiceCall<TSLocation> getGatewayLocation(GetGatewayLocationOptions getGatewayLocationOptions)
getGatewayLocation(params)
get_gateway_location(self,
name: str,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) GetGatewayLocation(getGatewayLocationOptions *GetGatewayLocationOptions) (result *TSLocation, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) GetGatewayLocationWithContext(ctx context.Context, getGatewayLocationOptions *GetGatewayLocationOptions) (result *TSLocation, response *core.DetailedResponse, err error)
Request
Use the GetGatewayLocationOptions.Builder
to create a GetGatewayLocationOptions
object that contains the parameter values for the getGatewayLocation
method.
Instantiate the GetGatewayLocationOptions
struct and set the fields to provide parameter values for the GetGatewayLocation
method.
Path Parameters
The Transit Gateway location Name
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[a-z]([a-z-0-9]){0,35}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The getGatewayLocation options.
The Transit Gateway location Name.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[a-z]([a-z-0-9]){0,35}$/
parameters
The Transit Gateway location Name.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[a-z]([a-z-0-9]){0,35}$/
parameters
The Transit Gateway location Name.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[a-z]([a-z-0-9]){0,35}$/
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The GetGatewayLocation options.
The Transit Gateway location Name.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[a-z]([a-z-0-9]){0,35}$/
curl -X GET --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" "{base_url}/locations/{name}?version={version}"
getGatewayLocationOptions := transitGatewayApisService.NewGetGatewayLocationOptions( "testString", ) tsLocation, response, err := transitGatewayApisService.GetGatewayLocation(getGatewayLocationOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(tsLocation, "", " ") fmt.Println(string(b))
GetGatewayLocationOptions getGatewayLocationOptions = new GetGatewayLocationOptions.Builder() .name("testString") .build(); Response<TSLocation> response = transitGatewayApisService.getGatewayLocation(getGatewayLocationOptions).execute(); TSLocation tsLocation = response.getResult(); System.out.println(tsLocation);
const params = { name: 'testString', }; let res; try { res = await transitGatewayApisService.getGatewayLocation(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
ts_location = transit_gateway_apis_service.get_gateway_location( name='testString' ).get_result() print(json.dumps(ts_location, indent=2))
Response
Details of a Transit Gateway location
The geographical location of this location, used for billing purposes
Possible values: 0 ≤ length ≤ 20
Example:
us
Name of the Location
Possible values: 0 ≤ length ≤ 36
Example:
us-south
The type of the location, determining is this a multi-zone region, a single data center, or a point of presence.
Possible values: 0 ≤ length ≤ 20
Example:
region
The set of network locations that are considered local for this Transit Gateway location
Possible values: 1 ≤ number of items ≤ 10
Details of a Transit Gateway location.
The geographical location of this location, used for billing purposes.
Possible values: 0 ≤ length ≤ 20
Examples:ViewName of the Location.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe type of the location, determining is this a multi-zone region, a single data center, or a point of presence.
Possible values: 0 ≤ length ≤ 20
Examples:ViewThe set of network locations that are considered local for this Transit Gateway location.
A descriptive display name for the location.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^[a-zA-Z0-9-_\\s]+$/
Examples:ViewThe name of the location.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^[a-z0-9-_]+$/
Examples:ViewArray of supported connection types.
Possible values: 0 ≤ length ≤ 20
Examples:ViewThe type of the location, determining is this a multi-zone region, a single data center, or a point of presence. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
region
,dc
]Examples:View
localConnectionLocations
Details of a Transit Gateway location.
The geographical location of this location, used for billing purposes.
Possible values: 0 ≤ length ≤ 20
Examples:ViewName of the Location.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe type of the location, determining is this a multi-zone region, a single data center, or a point of presence.
Possible values: 0 ≤ length ≤ 20
Examples:ViewThe set of network locations that are considered local for this Transit Gateway location.
Possible values: 1 ≤ number of items ≤ 10
A descriptive display name for the location.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^[a-zA-Z0-9-_\\s]+$/
Examples:ViewThe name of the location.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^[a-z0-9-_]+$/
Examples:ViewArray of supported connection types.
Possible values: 0 ≤ number of items ≤ 6, 0 ≤ length ≤ 20
Examples:ViewThe type of the location, determining is this a multi-zone region, a single data center, or a point of presence. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
region
,dc
]Examples:View
local_connection_locations
Details of a Transit Gateway location.
The geographical location of this location, used for billing purposes.
Possible values: 0 ≤ length ≤ 20
Examples:ViewName of the Location.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe type of the location, determining is this a multi-zone region, a single data center, or a point of presence.
Possible values: 0 ≤ length ≤ 20
Examples:ViewThe set of network locations that are considered local for this Transit Gateway location.
Possible values: 1 ≤ number of items ≤ 10
A descriptive display name for the location.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^[a-zA-Z0-9-_\\s]+$/
Examples:ViewThe name of the location.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^[a-z0-9-_]+$/
Examples:ViewArray of supported connection types.
Possible values: 0 ≤ number of items ≤ 6, 0 ≤ length ≤ 20
Examples:ViewThe type of the location, determining is this a multi-zone region, a single data center, or a point of presence. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
region
,dc
]Examples:View
local_connection_locations
Details of a Transit Gateway location.
The geographical location of this location, used for billing purposes.
Possible values: 0 ≤ length ≤ 20
Examples:ViewName of the Location.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe type of the location, determining is this a multi-zone region, a single data center, or a point of presence.
Possible values: 0 ≤ length ≤ 20
Examples:ViewThe set of network locations that are considered local for this Transit Gateway location.
Possible values: 1 ≤ number of items ≤ 10
A descriptive display name for the location.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^[a-zA-Z0-9-_\\s]+$/
Examples:ViewThe name of the location.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
/^[a-z0-9-_]+$/
Examples:ViewArray of supported connection types.
Possible values: 0 ≤ number of items ≤ 6, 0 ≤ length ≤ 20
Examples:ViewThe type of the location, determining is this a multi-zone region, a single data center, or a point of presence. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
region
,dc
]Examples:View
LocalConnectionLocations
Status Code
Successfully retrieved the Transit Gateway Location.
The given location name could not be found.
{ "billing_location": "us", "local_connection_locations": [ { "display_name": "Dallas", "name": "us-south", "type": "region" } ], "name": "us-south", "type": "region" }
{ "billing_location": "us", "local_connection_locations": [ { "display_name": "Dallas", "name": "us-south", "type": "region" } ], "name": "us-south", "type": "region" }
{ "errors": [ { "code": "not_found", "message": "Location not found", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Location not found", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
Retrieves all prefix filters in a Transit Gateway connection
This request retrieves all prefix filters in a Transit Gateway connection.
This request retrieves all prefix filters in a Transit Gateway connection.
This request retrieves all prefix filters in a Transit Gateway connection.
This request retrieves all prefix filters in a Transit Gateway connection.
This request retrieves all prefix filters in a Transit Gateway connection.
GET /transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters
ServiceCall<PrefixFilterCollection> listTransitGatewayConnectionPrefixFilters(ListTransitGatewayConnectionPrefixFiltersOptions listTransitGatewayConnectionPrefixFiltersOptions)
listTransitGatewayConnectionPrefixFilters(params)
list_transit_gateway_connection_prefix_filters(self,
transit_gateway_id: str,
id: str,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) ListTransitGatewayConnectionPrefixFilters(listTransitGatewayConnectionPrefixFiltersOptions *ListTransitGatewayConnectionPrefixFiltersOptions) (result *PrefixFilterCollection, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) ListTransitGatewayConnectionPrefixFiltersWithContext(ctx context.Context, listTransitGatewayConnectionPrefixFiltersOptions *ListTransitGatewayConnectionPrefixFiltersOptions) (result *PrefixFilterCollection, response *core.DetailedResponse, err error)
Request
Use the ListTransitGatewayConnectionPrefixFiltersOptions.Builder
to create a ListTransitGatewayConnectionPrefixFiltersOptions
object that contains the parameter values for the listTransitGatewayConnectionPrefixFilters
method.
Instantiate the ListTransitGatewayConnectionPrefixFiltersOptions
struct and set the fields to provide parameter values for the ListTransitGatewayConnectionPrefixFilters
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
The connection identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The listTransitGatewayConnectionPrefixFilters options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The ListTransitGatewayConnectionPrefixFilters options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
listTransitGatewayConnectionPrefixFiltersOptions := transitGatewayApisService.NewListTransitGatewayConnectionPrefixFiltersOptions( "testString", "testString", ) prefixFilterCollection, response, err := transitGatewayApisService.ListTransitGatewayConnectionPrefixFilters(listTransitGatewayConnectionPrefixFiltersOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(prefixFilterCollection, "", " ") fmt.Println(string(b))
curl -X GET --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters?version={version}"
ListTransitGatewayConnectionPrefixFiltersOptions listTransitGatewayConnectionPrefixFiltersOptions = new ListTransitGatewayConnectionPrefixFiltersOptions.Builder() .transitGatewayId("testString") .id("testString") .build(); Response<PrefixFilterCollection> response = transitGatewayApisService.listTransitGatewayConnectionPrefixFilters(listTransitGatewayConnectionPrefixFiltersOptions).execute(); PrefixFilterCollection prefixFilterCollection = response.getResult(); System.out.println(prefixFilterCollection);
const params = { transitGatewayId: 'testString', id: 'testString', }; let res; try { res = await transitGatewayApisService.listTransitGatewayConnectionPrefixFilters(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
prefix_filter_collection = transit_gateway_apis_service.list_transit_gateway_connection_prefix_filters( transit_gateway_id='testString', id='testString' ).get_result() print(json.dumps(prefix_filter_collection, indent=2))
Response
prefix filters
Array of prefix filters
Possible values: 0 ≤ number of items ≤ 10
prefix filters.
Array of prefix filters.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
prefixFilters
prefix filters.
Array of prefix filters.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
prefix_filters
prefix filters.
Array of prefix filters.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
prefix_filters
prefix filters.
Array of prefix filters.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
PrefixFilters
Status Code
The prefix filters were retrieved successfully.
The specified Transit Gateway could not be found.
{ "prefix_filters": [ { "action": "permit", "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782", "created_at": "2021-11-15T12:08:05Z", "ge": 0, "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865", "le": 32, "prefix": "192.168.100.0/24", "updated_at": "2021-11-15T12:08:05Z" } ] }
{ "prefix_filters": [ { "action": "permit", "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782", "created_at": "2021-11-15T12:08:05Z", "ge": 0, "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865", "le": 32, "prefix": "192.168.100.0/24", "updated_at": "2021-11-15T12:08:05Z" } ] }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
Add a prefix filter to a Transit Gateway Connection
Add a prefix filter to a Transit Gateway Connection.
Add a prefix filter to a Transit Gateway Connection.
Add a prefix filter to a Transit Gateway Connection.
Add a prefix filter to a Transit Gateway Connection.
Add a prefix filter to a Transit Gateway Connection.
POST /transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters
ServiceCall<PrefixFilterCust> createTransitGatewayConnectionPrefixFilter(CreateTransitGatewayConnectionPrefixFilterOptions createTransitGatewayConnectionPrefixFilterOptions)
createTransitGatewayConnectionPrefixFilter(params)
create_transit_gateway_connection_prefix_filter(self,
transit_gateway_id: str,
id: str,
action: str,
prefix: str,
*,
before: str = None,
ge: int = None,
le: int = None,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayConnectionPrefixFilter(createTransitGatewayConnectionPrefixFilterOptions *CreateTransitGatewayConnectionPrefixFilterOptions) (result *PrefixFilterCust, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayConnectionPrefixFilterWithContext(ctx context.Context, createTransitGatewayConnectionPrefixFilterOptions *CreateTransitGatewayConnectionPrefixFilterOptions) (result *PrefixFilterCust, response *core.DetailedResponse, err error)
Request
Use the CreateTransitGatewayConnectionPrefixFilterOptions.Builder
to create a CreateTransitGatewayConnectionPrefixFilterOptions
object that contains the parameter values for the createTransitGatewayConnectionPrefixFilter
method.
Instantiate the CreateTransitGatewayConnectionPrefixFilterOptions
struct and set the fields to provide parameter values for the CreateTransitGatewayConnectionPrefixFilter
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
The connection identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The prefix filters template
Whether to permit or deny prefix filter
Allowable values: [
permit
,deny
]Example:
permit
IP Prefix
Possible values: 0 ≤ length ≤ 50, Value must match regular expression
^(([0-9]){1,3}\.){3}([0-9]{1,3})/([0-9]{1,2})$
Example:
192.168.100.0/24
Identifier of prefix filter to handle the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
1a15dcab-7e40-45e1-b7c5-bc690eaa9782
IP Prefix GE
IP Prefix LE
Example:
32
The createTransitGatewayConnectionPrefixFilter options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Whether to permit or deny prefix filter.
Allowable values: [
permit
,deny
]Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:ViewIdentifier of prefix filter to handle the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Examples:ViewIP Prefix GE.
Examples:ViewIP Prefix LE.
Examples:View
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Whether to permit or deny prefix filter.
Allowable values: [
permit
,deny
]Examples:value_source_lines_htmlIP Prefix.
Possible values: 0 ≤ length ≤ 50, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:value_source_lines_htmlIdentifier of prefix filter to handle the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Examples:value_source_lines_htmlIP Prefix GE.
Examples:value_source_lines_htmlIP Prefix LE.
Examples:value_source_lines_html
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Whether to permit or deny prefix filter.
Allowable values: [
permit
,deny
]Examples:value_source_lines_htmlIP Prefix.
Possible values: 0 ≤ length ≤ 50, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:value_source_lines_htmlIdentifier of prefix filter to handle the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Examples:value_source_lines_htmlIP Prefix GE.
Examples:value_source_lines_htmlIP Prefix LE.
Examples:value_source_lines_html
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The CreateTransitGatewayConnectionPrefixFilter options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Whether to permit or deny prefix filter.
Allowable values: [
permit
,deny
]Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:ViewIdentifier of prefix filter to handle the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Examples:ViewIP Prefix GE.
Examples:ViewIP Prefix LE.
Examples:View
createTransitGatewayConnectionPrefixFilterOptions := transitGatewayApisService.NewCreateTransitGatewayConnectionPrefixFilterOptions( "testString", "testString", "permit", "192.168.100.0/24", ) prefixFilterCust, response, err := transitGatewayApisService.CreateTransitGatewayConnectionPrefixFilter(createTransitGatewayConnectionPrefixFilterOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(prefixFilterCust, "", " ") fmt.Println(string(b))
curl -X POST --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" --header "Content-Type: application/json" --data '{ "action": "permit", "prefix": "192.168.100.0/24" }' "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters?version={version}"
CreateTransitGatewayConnectionPrefixFilterOptions createTransitGatewayConnectionPrefixFilterOptions = new CreateTransitGatewayConnectionPrefixFilterOptions.Builder() .transitGatewayId("testString") .id("testString") .action("permit") .prefix("192.168.100.0/24") .build(); Response<PrefixFilterCust> response = transitGatewayApisService.createTransitGatewayConnectionPrefixFilter(createTransitGatewayConnectionPrefixFilterOptions).execute(); PrefixFilterCust prefixFilterCust = response.getResult(); System.out.println(prefixFilterCust);
const params = { transitGatewayId: 'testString', id: 'testString', action: 'permit', prefix: '192.168.100.0/24', }; let res; try { res = await transitGatewayApisService.createTransitGatewayConnectionPrefixFilter(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
prefix_filter_cust = transit_gateway_apis_service.create_transit_gateway_connection_prefix_filter( transit_gateway_id='testString', id='testString', action='permit', prefix='192.168.100.0/24' ).get_result() print(json.dumps(prefix_filter_cust, indent=2))
Response
prefix filter
Whether to permit or deny prefix filter
Possible values: [
permit
,deny
]Example:
permit
The date and time that this prefix filter was created
Possible values: 0 ≤ length ≤ 100
Prefix Filter identifier
Possible values: 0 ≤ length ≤ 36
Example:
1a15dcab-7e30-45e1-b7c5-bc690eaa9865
IP Prefix
Possible values: 0 ≤ length ≤ 50
Example:
192.168.100.0/24
Identifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Example:
1a15dcab-7e40-45e1-b7c5-bc690eaa9782
IP Prefix GE
IP Prefix LE
Example:
32
The date and time that this prefix filter was last updated
Possible values: 0 ≤ length ≤ 100
prefix filter.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
prefix filter.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
prefix filter.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
prefix filter.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
Status Code
The Transit Gateway connection prefix filters was created successfully.
An invalid prefix filter template was provided.
The specified Transit Gateway could not be found.
{ "action": "permit", "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782", "created_at": "2021-11-15T12:08:05Z", "ge": 0, "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865", "le": 32, "prefix": "192.168.100.0/24", "updated_at": "2021-11-15T12:08:05Z" }
{ "action": "permit", "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782", "created_at": "2021-11-15T12:08:05Z", "ge": 0, "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865", "le": 32, "prefix": "192.168.100.0/24", "updated_at": "2021-11-15T12:08:05Z" }
{ "errors": [ { "code": "bad_request", "message": "The information given was invalid, malformed, or missing a required field.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling", "target": { "name": "request_body", "type": "field" } } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "bad_request", "message": "The information given was invalid, malformed, or missing a required field.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling", "target": { "name": "request_body", "type": "field" } } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
Replaces the prefix filters of the Transit Gateway Connection
Replaces the prefix filters of the Transit Gateway Connection.
Replaces the prefix filters of the Transit Gateway Connection.
Replaces the prefix filters of the Transit Gateway Connection.
Replaces the prefix filters of the Transit Gateway Connection.
Replaces the prefix filters of the Transit Gateway Connection.
PUT /transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters
ServiceCall<PrefixFilterCollection> replaceTransitGatewayConnectionPrefixFilter(ReplaceTransitGatewayConnectionPrefixFilterOptions replaceTransitGatewayConnectionPrefixFilterOptions)
replaceTransitGatewayConnectionPrefixFilter(params)
replace_transit_gateway_connection_prefix_filter(self,
transit_gateway_id: str,
id: str,
prefix_filters: List['PrefixFilterPut'],
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) ReplaceTransitGatewayConnectionPrefixFilter(replaceTransitGatewayConnectionPrefixFilterOptions *ReplaceTransitGatewayConnectionPrefixFilterOptions) (result *PrefixFilterCollection, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) ReplaceTransitGatewayConnectionPrefixFilterWithContext(ctx context.Context, replaceTransitGatewayConnectionPrefixFilterOptions *ReplaceTransitGatewayConnectionPrefixFilterOptions) (result *PrefixFilterCollection, response *core.DetailedResponse, err error)
Request
Use the ReplaceTransitGatewayConnectionPrefixFilterOptions.Builder
to create a ReplaceTransitGatewayConnectionPrefixFilterOptions
object that contains the parameter values for the replaceTransitGatewayConnectionPrefixFilter
method.
Instantiate the ReplaceTransitGatewayConnectionPrefixFilterOptions
struct and set the fields to provide parameter values for the ReplaceTransitGatewayConnectionPrefixFilter
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
The connection identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The prefix filter list template
Array of prefix filters
Possible values: 1 ≤ number of items ≤ 10
The replaceTransitGatewayConnectionPrefixFilter options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Array of prefix filters.
Whether to permit or deny prefix filter.
Allowable values: [
permit
,deny
]Examples:ViewIP Prefix GE.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:View
prefixFilters
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Array of prefix filters.
Possible values: 1 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Allowable values: [
permit
,deny
]Examples:ViewIP Prefix GE.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:View
prefixFilters
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Array of prefix filters.
Possible values: 1 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Allowable values: [
permit
,deny
]Examples:ViewIP Prefix GE.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:View
prefix_filters
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The ReplaceTransitGatewayConnectionPrefixFilter options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Array of prefix filters.
Possible values: 1 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Allowable values: [
permit
,deny
]Examples:ViewIP Prefix GE.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:View
PrefixFilters
prefixFilterPutModel := &transitgatewayapisv1.PrefixFilterPut{ Action: core.StringPtr("permit"), Prefix: core.StringPtr("192.168.100.0/24"), } replaceTransitGatewayConnectionPrefixFilterOptions := transitGatewayApisService.NewReplaceTransitGatewayConnectionPrefixFilterOptions( "testString", "testString", []transitgatewayapisv1.PrefixFilterPut{*prefixFilterPutModel}, ) prefixFilterCollection, response, err := transitGatewayApisService.ReplaceTransitGatewayConnectionPrefixFilter(replaceTransitGatewayConnectionPrefixFilterOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(prefixFilterCollection, "", " ") fmt.Println(string(b))
curl -X PUT --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" --header "Content-Type: application/json" --data '{ "prefix_filters": [] }' "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters?version={version}"
PrefixFilterPut prefixFilterPutModel = new PrefixFilterPut.Builder() .action("permit") .prefix("192.168.100.0/24") .build(); ReplaceTransitGatewayConnectionPrefixFilterOptions replaceTransitGatewayConnectionPrefixFilterOptions = new ReplaceTransitGatewayConnectionPrefixFilterOptions.Builder() .transitGatewayId("testString") .id("testString") .prefixFilters(new java.util.ArrayList<PrefixFilterPut>(java.util.Arrays.asList(prefixFilterPutModel))) .build(); Response<PrefixFilterCollection> response = transitGatewayApisService.replaceTransitGatewayConnectionPrefixFilter(replaceTransitGatewayConnectionPrefixFilterOptions).execute(); PrefixFilterCollection prefixFilterCollection = response.getResult(); System.out.println(prefixFilterCollection);
// Request models needed by this operation. // PrefixFilterPut const prefixFilterPutModel = { action: 'permit', prefix: '192.168.100.0/24', }; const params = { transitGatewayId: 'testString', id: 'testString', prefixFilters: [prefixFilterPutModel], }; let res; try { res = await transitGatewayApisService.replaceTransitGatewayConnectionPrefixFilter(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
prefix_filter_put_model = { 'action': 'permit', 'prefix': '192.168.100.0/24', } prefix_filter_collection = transit_gateway_apis_service.replace_transit_gateway_connection_prefix_filter( transit_gateway_id='testString', id='testString', prefix_filters=[prefix_filter_put_model] ).get_result() print(json.dumps(prefix_filter_collection, indent=2))
Response
prefix filters
Array of prefix filters
Possible values: 0 ≤ number of items ≤ 10
prefix filters.
Array of prefix filters.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
prefixFilters
prefix filters.
Array of prefix filters.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
prefix_filters
prefix filters.
Array of prefix filters.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
prefix_filters
prefix filters.
Array of prefix filters.
Possible values: 0 ≤ number of items ≤ 10
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
PrefixFilters
Status Code
The Transit Gateway connection prefix filters was replaced successfully.
An invalid prefix filter template was provided.
The specified Transit Gateway could not be found.
{ "prefix_filters": [ { "action": "permit", "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782", "created_at": "2021-11-15T12:08:05Z", "ge": 0, "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865", "le": 32, "prefix": "192.168.100.0/24", "updated_at": "2021-11-15T12:08:05Z" } ] }
{ "prefix_filters": [ { "action": "permit", "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782", "created_at": "2021-11-15T12:08:05Z", "ge": 0, "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865", "le": 32, "prefix": "192.168.100.0/24", "updated_at": "2021-11-15T12:08:05Z" } ] }
{ "errors": [ { "code": "bad_request", "message": "The information given was invalid, malformed, or missing a required field.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling", "target": { "name": "request_body", "type": "field" } } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "bad_request", "message": "The information given was invalid, malformed, or missing a required field.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling", "target": { "name": "request_body", "type": "field" } } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
Remove prefix filter from Transit Gateway Connection
Delete a prefix filter.
Delete a prefix filter.
Delete a prefix filter.
Delete a prefix filter.
Delete a prefix filter.
DELETE /transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters/{filter_id}
ServiceCall<Void> deleteTransitGatewayConnectionPrefixFilter(DeleteTransitGatewayConnectionPrefixFilterOptions deleteTransitGatewayConnectionPrefixFilterOptions)
deleteTransitGatewayConnectionPrefixFilter(params)
delete_transit_gateway_connection_prefix_filter(self,
transit_gateway_id: str,
id: str,
filter_id: str,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) DeleteTransitGatewayConnectionPrefixFilter(deleteTransitGatewayConnectionPrefixFilterOptions *DeleteTransitGatewayConnectionPrefixFilterOptions) (response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) DeleteTransitGatewayConnectionPrefixFilterWithContext(ctx context.Context, deleteTransitGatewayConnectionPrefixFilterOptions *DeleteTransitGatewayConnectionPrefixFilterOptions) (response *core.DetailedResponse, err error)
Request
Use the DeleteTransitGatewayConnectionPrefixFilterOptions.Builder
to create a DeleteTransitGatewayConnectionPrefixFilterOptions
object that contains the parameter values for the deleteTransitGatewayConnectionPrefixFilter
method.
Instantiate the DeleteTransitGatewayConnectionPrefixFilterOptions
struct and set the fields to provide parameter values for the DeleteTransitGatewayConnectionPrefixFilter
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
The connection identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Prefix filter identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The deleteTransitGatewayConnectionPrefixFilter options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Prefix filter identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Prefix filter identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Prefix filter identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The DeleteTransitGatewayConnectionPrefixFilter options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Prefix filter identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
deleteTransitGatewayConnectionPrefixFilterOptions := transitGatewayApisService.NewDeleteTransitGatewayConnectionPrefixFilterOptions( "testString", "testString", "testString", ) response, err := transitGatewayApisService.DeleteTransitGatewayConnectionPrefixFilter(deleteTransitGatewayConnectionPrefixFilterOptions) if err != nil { panic(err) }
curl -X DELETE --location --header "Authorization: Bearer {iam_token}" "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters/{filter_id}?version={version}"
DeleteTransitGatewayConnectionPrefixFilterOptions deleteTransitGatewayConnectionPrefixFilterOptions = new DeleteTransitGatewayConnectionPrefixFilterOptions.Builder() .transitGatewayId("testString") .id("testString") .filterId("testString") .build(); Response<Void> response = transitGatewayApisService.deleteTransitGatewayConnectionPrefixFilter(deleteTransitGatewayConnectionPrefixFilterOptions).execute();
const params = { transitGatewayId: 'testString', id: 'testString', filterId: 'testString', }; try { await transitGatewayApisService.deleteTransitGatewayConnectionPrefixFilter(params); } catch (err) { console.warn(err); }
response = transit_gateway_apis_service.delete_transit_gateway_connection_prefix_filter( transit_gateway_id='testString', id='testString', filter_id='testString' )
Response
Status Code
Prefix filter deleted successfully.
A Prefix Filter with the specified identifier could not be found.
{ "errors": [ { "code": "not_found", "message": "Cannot find Prefix Filter", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Prefix Filter", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
Retrieves specified Transit Gateway connection prefix filter
This request retrieves a prefix filter from the Transit Gateway Connection.
This request retrieves a prefix filter from the Transit Gateway Connection.
This request retrieves a prefix filter from the Transit Gateway Connection.
This request retrieves a prefix filter from the Transit Gateway Connection.
This request retrieves a prefix filter from the Transit Gateway Connection.
GET /transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters/{filter_id}
ServiceCall<PrefixFilterCust> getTransitGatewayConnectionPrefixFilter(GetTransitGatewayConnectionPrefixFilterOptions getTransitGatewayConnectionPrefixFilterOptions)
getTransitGatewayConnectionPrefixFilter(params)
get_transit_gateway_connection_prefix_filter(self,
transit_gateway_id: str,
id: str,
filter_id: str,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayConnectionPrefixFilter(getTransitGatewayConnectionPrefixFilterOptions *GetTransitGatewayConnectionPrefixFilterOptions) (result *PrefixFilterCust, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayConnectionPrefixFilterWithContext(ctx context.Context, getTransitGatewayConnectionPrefixFilterOptions *GetTransitGatewayConnectionPrefixFilterOptions) (result *PrefixFilterCust, response *core.DetailedResponse, err error)
Request
Use the GetTransitGatewayConnectionPrefixFilterOptions.Builder
to create a GetTransitGatewayConnectionPrefixFilterOptions
object that contains the parameter values for the getTransitGatewayConnectionPrefixFilter
method.
Instantiate the GetTransitGatewayConnectionPrefixFilterOptions
struct and set the fields to provide parameter values for the GetTransitGatewayConnectionPrefixFilter
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
The connection identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Prefix filter identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The getTransitGatewayConnectionPrefixFilter options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Prefix filter identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Prefix filter identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Prefix filter identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The GetTransitGatewayConnectionPrefixFilter options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Prefix filter identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
getTransitGatewayConnectionPrefixFilterOptions := transitGatewayApisService.NewGetTransitGatewayConnectionPrefixFilterOptions( "testString", "testString", "testString", ) prefixFilterCust, response, err := transitGatewayApisService.GetTransitGatewayConnectionPrefixFilter(getTransitGatewayConnectionPrefixFilterOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(prefixFilterCust, "", " ") fmt.Println(string(b))
curl -X GET --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters/{filter_id}?version={version}"
GetTransitGatewayConnectionPrefixFilterOptions getTransitGatewayConnectionPrefixFilterOptions = new GetTransitGatewayConnectionPrefixFilterOptions.Builder() .transitGatewayId("testString") .id("testString") .filterId("testString") .build(); Response<PrefixFilterCust> response = transitGatewayApisService.getTransitGatewayConnectionPrefixFilter(getTransitGatewayConnectionPrefixFilterOptions).execute(); PrefixFilterCust prefixFilterCust = response.getResult(); System.out.println(prefixFilterCust);
const params = { transitGatewayId: 'testString', id: 'testString', filterId: 'testString', }; let res; try { res = await transitGatewayApisService.getTransitGatewayConnectionPrefixFilter(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
prefix_filter_cust = transit_gateway_apis_service.get_transit_gateway_connection_prefix_filter( transit_gateway_id='testString', id='testString', filter_id='testString' ).get_result() print(json.dumps(prefix_filter_cust, indent=2))
Response
prefix filter
Whether to permit or deny prefix filter
Possible values: [
permit
,deny
]Example:
permit
The date and time that this prefix filter was created
Possible values: 0 ≤ length ≤ 100
Prefix Filter identifier
Possible values: 0 ≤ length ≤ 36
Example:
1a15dcab-7e30-45e1-b7c5-bc690eaa9865
IP Prefix
Possible values: 0 ≤ length ≤ 50
Example:
192.168.100.0/24
Identifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Example:
1a15dcab-7e40-45e1-b7c5-bc690eaa9782
IP Prefix GE
IP Prefix LE
Example:
32
The date and time that this prefix filter was last updated
Possible values: 0 ≤ length ≤ 100
prefix filter.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
prefix filter.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
prefix filter.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
prefix filter.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
Status Code
The prefix filter was retrieved successfully.
A prefix filter with the specified identifier could not be found.
{ "action": "permit", "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782", "created_at": "2021-11-15T12:08:05Z", "ge": 0, "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865", "le": 32, "prefix": "192.168.100.0/24", "updated_at": "2021-11-15T12:08:05Z" }
{ "action": "permit", "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782", "created_at": "2021-11-15T12:08:05Z", "ge": 0, "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865", "le": 32, "prefix": "192.168.100.0/24", "updated_at": "2021-11-15T12:08:05Z" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Prefix Filter", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Prefix Filter", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
Updates specified Transit Gateway connection prefix filter
Update prefix filter for a Transit Gateway Connection.
Update prefix filter for a Transit Gateway Connection.
Update prefix filter for a Transit Gateway Connection.
Update prefix filter for a Transit Gateway Connection.
Update prefix filter for a Transit Gateway Connection.
PATCH /transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters/{filter_id}
ServiceCall<PrefixFilterCust> updateTransitGatewayConnectionPrefixFilter(UpdateTransitGatewayConnectionPrefixFilterOptions updateTransitGatewayConnectionPrefixFilterOptions)
updateTransitGatewayConnectionPrefixFilter(params)
update_transit_gateway_connection_prefix_filter(self,
transit_gateway_id: str,
id: str,
filter_id: str,
*,
action: str = None,
before: str = None,
ge: int = None,
le: int = None,
prefix: str = None,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) UpdateTransitGatewayConnectionPrefixFilter(updateTransitGatewayConnectionPrefixFilterOptions *UpdateTransitGatewayConnectionPrefixFilterOptions) (result *PrefixFilterCust, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) UpdateTransitGatewayConnectionPrefixFilterWithContext(ctx context.Context, updateTransitGatewayConnectionPrefixFilterOptions *UpdateTransitGatewayConnectionPrefixFilterOptions) (result *PrefixFilterCust, response *core.DetailedResponse, err error)
Request
Use the UpdateTransitGatewayConnectionPrefixFilterOptions.Builder
to create a UpdateTransitGatewayConnectionPrefixFilterOptions
object that contains the parameter values for the updateTransitGatewayConnectionPrefixFilter
method.
Instantiate the UpdateTransitGatewayConnectionPrefixFilterOptions
struct and set the fields to provide parameter values for the UpdateTransitGatewayConnectionPrefixFilter
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
The connection identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Prefix filter identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The prefix filter patch template
Whether to permit or deny prefix filter
Allowable values: [
permit
,deny
]Example:
permit
Identifier of prefix filter to handle the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:
1a15dcab-7e40-45e1-b7c5-bc690eaa9782
IP Prefix GE
IP Prefix LE
Example:
32
IP Prefix
Possible values: 0 ≤ length ≤ 50, Value must match regular expression
^(([0-9]){1,3}\.){3}([0-9]{1,3})/([0-9]{1,2})$
Example:
192.168.100.0/24
The updateTransitGatewayConnectionPrefixFilter options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Prefix filter identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Whether to permit or deny prefix filter.
Allowable values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter to handle the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Examples:ViewIP Prefix GE.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:View
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Prefix filter identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Whether to permit or deny prefix filter.
Allowable values: [
permit
,deny
]Examples:value_source_lines_htmlIdentifier of prefix filter to handle the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Examples:value_source_lines_htmlIP Prefix GE.
Examples:value_source_lines_htmlIP Prefix LE.
Examples:value_source_lines_htmlIP Prefix.
Possible values: 0 ≤ length ≤ 50, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:value_source_lines_html
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Prefix filter identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Whether to permit or deny prefix filter.
Allowable values: [
permit
,deny
]Examples:value_source_lines_htmlIdentifier of prefix filter to handle the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Examples:value_source_lines_htmlIP Prefix GE.
Examples:value_source_lines_htmlIP Prefix LE.
Examples:value_source_lines_htmlIP Prefix.
Possible values: 0 ≤ length ≤ 50, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:value_source_lines_html
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The UpdateTransitGatewayConnectionPrefixFilter options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
The connection identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Prefix filter identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Whether to permit or deny prefix filter.
Allowable values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter to handle the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Examples:ViewIP Prefix GE.
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50, Value must match regular expression
/^(([0-9]){1,3}\\.){3}([0-9]{1,3})\/([0-9]{1,2})$/
Examples:View
updateTransitGatewayConnectionPrefixFilterOptions := transitGatewayApisService.NewUpdateTransitGatewayConnectionPrefixFilterOptions( "testString", "testString", "testString", ) prefixFilterCust, response, err := transitGatewayApisService.UpdateTransitGatewayConnectionPrefixFilter(updateTransitGatewayConnectionPrefixFilterOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(prefixFilterCust, "", " ") fmt.Println(string(b))
curl -X PATCH --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" --header "Content-Type: application/json" --data '{}' "{base_url}/transit_gateways/{transit_gateway_id}/connections/{id}/prefix_filters/{filter_id}?version={version}"
UpdateTransitGatewayConnectionPrefixFilterOptions updateTransitGatewayConnectionPrefixFilterOptions = new UpdateTransitGatewayConnectionPrefixFilterOptions.Builder() .transitGatewayId("testString") .id("testString") .filterId("testString") .build(); Response<PrefixFilterCust> response = transitGatewayApisService.updateTransitGatewayConnectionPrefixFilter(updateTransitGatewayConnectionPrefixFilterOptions).execute(); PrefixFilterCust prefixFilterCust = response.getResult(); System.out.println(prefixFilterCust);
const params = { transitGatewayId: 'testString', id: 'testString', filterId: 'testString', }; let res; try { res = await transitGatewayApisService.updateTransitGatewayConnectionPrefixFilter(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
prefix_filter_cust = transit_gateway_apis_service.update_transit_gateway_connection_prefix_filter( transit_gateway_id='testString', id='testString', filter_id='testString', ).get_result() print(json.dumps(prefix_filter_cust, indent=2))
Response
prefix filter
Whether to permit or deny prefix filter
Possible values: [
permit
,deny
]Example:
permit
The date and time that this prefix filter was created
Possible values: 0 ≤ length ≤ 100
Prefix Filter identifier
Possible values: 0 ≤ length ≤ 36
Example:
1a15dcab-7e30-45e1-b7c5-bc690eaa9865
IP Prefix
Possible values: 0 ≤ length ≤ 50
Example:
192.168.100.0/24
Identifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Example:
1a15dcab-7e40-45e1-b7c5-bc690eaa9782
IP Prefix GE
IP Prefix LE
Example:
32
The date and time that this prefix filter was last updated
Possible values: 0 ≤ length ≤ 100
prefix filter.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
prefix filter.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
prefix filter.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
prefix filter.
Whether to permit or deny prefix filter.
Possible values: [
permit
,deny
]Examples:ViewIdentifier of prefix filter that handles the ordering and follow semantics:
- When a filter reference another filter in it's before field, then the filter making the reference is applied before the referenced filter. For example: if filter A references filter B in its before field, A is applied before B.
- When a new filter is added that has the same before as an existing filter, then the older filter will have its before field updated to point to the new filter. Starting with the above example: if filter C is added and it references B in its before field, then A's before field should be modified to point to C, so the order of application would be A, C and finally B.
- A filter that has an empty before reference will be applied last (though the date order mentioned above will still apply). So continuing the above examples, if filter B has an empty before field, then it will be applied last, but if filter D is created with an empty before field, then B's before field will be modified to point to D, so B will be applied before D.
Possible values: 0 ≤ length ≤ 36
Examples:ViewThe date and time that this prefix filter was created.
IP Prefix GE.
Examples:ViewPrefix Filter identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewIP Prefix LE.
Examples:ViewIP Prefix.
Possible values: 0 ≤ length ≤ 50
Examples:ViewThe date and time that this prefix filter was last updated.
Status Code
The prefix was updated successfully.
The prefix filter update template was invalid.
A prefix filter with the specified identifier could not be found.
{ "action": "deny", "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782", "created_at": "2021-11-15T12:08:05Z", "ge": 0, "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865", "le": 32, "prefix": "192.168.100.0/24", "updated_at": "2021-11-16T12:08:05Z" }
{ "action": "deny", "before": "1a15dcab-7e40-45e1-b7c5-bc690eaa9782", "created_at": "2021-11-15T12:08:05Z", "ge": 0, "id": "1a15dcab-7e30-45e1-b7c5-bc690eaa9865", "le": 32, "prefix": "192.168.100.0/24", "updated_at": "2021-11-16T12:08:05Z" }
{ "errors": [ { "code": "bad_request", "message": "The information given was invalid, malformed, or missing a required field.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling", "target": { "name": "request_body", "type": "field" } } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "bad_request", "message": "The information given was invalid, malformed, or missing a required field.", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling", "target": { "name": "request_body", "type": "field" } } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Prefix Filter", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Prefix Filter", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
List route reports
Retrieve all route reports for the specified Transit Gateway. There will normally be at most one completed report and one pending report. Additionally, completed route reports are written to IBM Cloud Activity Tracker.
Retrieve all route reports for the specified Transit Gateway. There will normally be at most one completed report and one pending report. Additionally, completed route reports are written to IBM Cloud Activity Tracker.
Retrieve all route reports for the specified Transit Gateway. There will normally be at most one completed report and one pending report. Additionally, completed route reports are written to IBM Cloud Activity Tracker.
Retrieve all route reports for the specified Transit Gateway. There will normally be at most one completed report and one pending report. Additionally, completed route reports are written to IBM Cloud Activity Tracker.
Retrieve all route reports for the specified Transit Gateway. There will normally be at most one completed report and one pending report. Additionally, completed route reports are written to IBM Cloud Activity Tracker.
GET /transit_gateways/{transit_gateway_id}/route_reports
ServiceCall<RouteReportCollection> listTransitGatewayRouteReports(ListTransitGatewayRouteReportsOptions listTransitGatewayRouteReportsOptions)
listTransitGatewayRouteReports(params)
list_transit_gateway_route_reports(self,
transit_gateway_id: str,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) ListTransitGatewayRouteReports(listTransitGatewayRouteReportsOptions *ListTransitGatewayRouteReportsOptions) (result *RouteReportCollection, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) ListTransitGatewayRouteReportsWithContext(ctx context.Context, listTransitGatewayRouteReportsOptions *ListTransitGatewayRouteReportsOptions) (result *RouteReportCollection, response *core.DetailedResponse, err error)
Request
Use the ListTransitGatewayRouteReportsOptions.Builder
to create a ListTransitGatewayRouteReportsOptions
object that contains the parameter values for the listTransitGatewayRouteReports
method.
Instantiate the ListTransitGatewayRouteReportsOptions
struct and set the fields to provide parameter values for the ListTransitGatewayRouteReports
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The listTransitGatewayRouteReports options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The ListTransitGatewayRouteReports options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
listTransitGatewayRouteReportsOptions := transitGatewayApisService.NewListTransitGatewayRouteReportsOptions( "testString", ) routeReportCollection, response, err := transitGatewayApisService.ListTransitGatewayRouteReports(listTransitGatewayRouteReportsOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(routeReportCollection, "", " ") fmt.Println(string(b))
curl -X GET --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" "{base_url}/transit_gateways/{transit_gateway_id}/route_reports?version={version}"
ListTransitGatewayRouteReportsOptions listTransitGatewayRouteReportsOptions = new ListTransitGatewayRouteReportsOptions.Builder() .transitGatewayId("testString") .build(); Response<RouteReportCollection> response = transitGatewayApisService.listTransitGatewayRouteReports(listTransitGatewayRouteReportsOptions).execute(); RouteReportCollection routeReportCollection = response.getResult(); System.out.println(routeReportCollection);
const params = { transitGatewayId: 'testString', }; let res; try { res = await transitGatewayApisService.listTransitGatewayRouteReports(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
route_report_collection = transit_gateway_apis_service.list_transit_gateway_route_reports( transit_gateway_id='testString' ).get_result() print(json.dumps(route_report_collection, indent=2))
Response
route reports
Array of route reports
Possible values: 0 ≤ number of items ≤ 2
route reports.
Array of route reports.
Array of connections with their routes.
Array of connection's bgps.
AS path.
Possible values: 0 ≤ length ≤ 200
Examples:ViewIndicates whether current route is used or not.
Examples:Viewlocal preference.
Possible values: 0 ≤ length ≤ 50
Examples:Viewprefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
bgps
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewconnection name.
Possible values: 0 ≤ length ≤ 64
Examples:ViewArray of connection's routes.
prefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
routes
connection type.
Possible values: 0 ≤ length ≤ 20
Examples:View
connections
Date and time route report was requested.
Report identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewArray of overlapping routes.
Array of overlapping connection/prefix pairs.
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewoverlapping prefix.
Possible values: 0 ≤ length ≤ 50
routes
overlappingRoutes
Route report status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
complete
,pending
]Examples:ViewDate and time route report was last modified.
routeReports
route reports.
Array of route reports.
Possible values: 0 ≤ number of items ≤ 2
Array of connections with their routes.
Possible values: 0 ≤ number of items ≤ 50
Array of connection's bgps.
Possible values: 0 ≤ number of items ≤ 200
AS path.
Possible values: 0 ≤ length ≤ 200
Examples:ViewIndicates whether current route is used or not.
Examples:Viewlocal preference.
Possible values: 0 ≤ length ≤ 50
Examples:Viewprefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
bgps
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewconnection name.
Possible values: 0 ≤ length ≤ 64
Examples:ViewArray of connection's routes.
Possible values: 0 ≤ number of items ≤ 200
prefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
routes
connection type.
Possible values: 0 ≤ length ≤ 20
Examples:View
connections
Date and time route report was requested.
Report identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewArray of overlapping routes.
Possible values: 0 ≤ number of items ≤ 100
Array of overlapping connection/prefix pairs.
Possible values: 0 ≤ number of items ≤ 1000
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewoverlapping prefix.
Possible values: 0 ≤ length ≤ 50
routes
overlapping_routes
Route report status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
complete
,pending
]Examples:ViewDate and time route report was last modified.
route_reports
route reports.
Array of route reports.
Possible values: 0 ≤ number of items ≤ 2
Array of connections with their routes.
Possible values: 0 ≤ number of items ≤ 50
Array of connection's bgps.
Possible values: 0 ≤ number of items ≤ 200
AS path.
Possible values: 0 ≤ length ≤ 200
Examples:ViewIndicates whether current route is used or not.
Examples:Viewlocal preference.
Possible values: 0 ≤ length ≤ 50
Examples:Viewprefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
bgps
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewconnection name.
Possible values: 0 ≤ length ≤ 64
Examples:ViewArray of connection's routes.
Possible values: 0 ≤ number of items ≤ 200
prefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
routes
connection type.
Possible values: 0 ≤ length ≤ 20
Examples:View
connections
Date and time route report was requested.
Report identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewArray of overlapping routes.
Possible values: 0 ≤ number of items ≤ 100
Array of overlapping connection/prefix pairs.
Possible values: 0 ≤ number of items ≤ 1000
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewoverlapping prefix.
Possible values: 0 ≤ length ≤ 50
routes
overlapping_routes
Route report status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
complete
,pending
]Examples:ViewDate and time route report was last modified.
route_reports
route reports.
Array of route reports.
Possible values: 0 ≤ number of items ≤ 2
Array of connections with their routes.
Possible values: 0 ≤ number of items ≤ 50
Array of connection's bgps.
Possible values: 0 ≤ number of items ≤ 200
AS path.
Possible values: 0 ≤ length ≤ 200
Examples:ViewIndicates whether current route is used or not.
Examples:Viewlocal preference.
Possible values: 0 ≤ length ≤ 50
Examples:Viewprefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
Bgps
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewconnection name.
Possible values: 0 ≤ length ≤ 64
Examples:ViewArray of connection's routes.
Possible values: 0 ≤ number of items ≤ 200
prefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
Routes
connection type.
Possible values: 0 ≤ length ≤ 20
Examples:View
Connections
Date and time route report was requested.
Report identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewArray of overlapping routes.
Possible values: 0 ≤ number of items ≤ 100
Array of overlapping connection/prefix pairs.
Possible values: 0 ≤ number of items ≤ 1000
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewoverlapping prefix.
Possible values: 0 ≤ length ≤ 50
Routes
OverlappingRoutes
Route report status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
complete
,pending
]Examples:ViewDate and time route report was last modified.
RouteReports
Status Code
Reports retrieved successfully.
The specified Transit Gateway could not be found.
{ "route_reports": [ { "connections": [ { "bgps": [ { "as_path": "(65201 4201065544) 4203065544", "is_used": true, "local_preference": "190", "prefix": "172.17.0.0/16" } ], "id": "3c265a62-91da-4261-a950-950b6af0eb58", "name": "transit-connection-vpc1", "routes": [ { "prefix": "172.17.0.0/16" } ], "type": "vpc" }, { "bgps": [ { "as_path": "(65201 4201065544) 4203065545", "is_used": true, "local_preference": "190", "prefix": "172.17.0.0/16" } ], "id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff", "name": "transit-connection-vpc2", "routes": [ { "prefix": "172.17.0.0/16" } ], "type": "vpc" } ], "created_at": "2020-03-31T12:08:05Z", "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531", "overlapping_routes": [ { "routes": [ { "connection_id": "3c265a62-91da-4261-a950-950b6af0eb58", "prefix": "172.17.0.0/16" }, { "connection_id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff", "prefix": "172.17.0.0/16" } ] } ], "status": "complete" } ] }
{ "route_reports": [ { "connections": [ { "bgps": [ { "as_path": "(65201 4201065544) 4203065544", "is_used": true, "local_preference": "190", "prefix": "172.17.0.0/16" } ], "id": "3c265a62-91da-4261-a950-950b6af0eb58", "name": "transit-connection-vpc1", "routes": [ { "prefix": "172.17.0.0/16" } ], "type": "vpc" }, { "bgps": [ { "as_path": "(65201 4201065544) 4203065545", "is_used": true, "local_preference": "190", "prefix": "172.17.0.0/16" } ], "id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff", "name": "transit-connection-vpc2", "routes": [ { "prefix": "172.17.0.0/16" } ], "type": "vpc" } ], "created_at": "2020-03-31T12:08:05Z", "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531", "overlapping_routes": [ { "routes": [ { "connection_id": "3c265a62-91da-4261-a950-950b6af0eb58", "prefix": "172.17.0.0/16" }, { "connection_id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff", "prefix": "172.17.0.0/16" } ] } ], "status": "complete" } ] }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
Request a route report
Request route report generation. While report generation is in progress, additional requests to generate a report are ignored and return the current pending report.
Request route report generation. While report generation is in progress, additional requests to generate a report are ignored and return the current pending report.
Request route report generation. While report generation is in progress, additional requests to generate a report are ignored and return the current pending report.
Request route report generation. While report generation is in progress, additional requests to generate a report are ignored and return the current pending report.
Request route report generation. While report generation is in progress, additional requests to generate a report are ignored and return the current pending report.
POST /transit_gateways/{transit_gateway_id}/route_reports
ServiceCall<RouteReport> createTransitGatewayRouteReport(CreateTransitGatewayRouteReportOptions createTransitGatewayRouteReportOptions)
createTransitGatewayRouteReport(params)
create_transit_gateway_route_report(self,
transit_gateway_id: str,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayRouteReport(createTransitGatewayRouteReportOptions *CreateTransitGatewayRouteReportOptions) (result *RouteReport, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) CreateTransitGatewayRouteReportWithContext(ctx context.Context, createTransitGatewayRouteReportOptions *CreateTransitGatewayRouteReportOptions) (result *RouteReport, response *core.DetailedResponse, err error)
Request
Use the CreateTransitGatewayRouteReportOptions.Builder
to create a CreateTransitGatewayRouteReportOptions
object that contains the parameter values for the createTransitGatewayRouteReport
method.
Instantiate the CreateTransitGatewayRouteReportOptions
struct and set the fields to provide parameter values for the CreateTransitGatewayRouteReport
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The createTransitGatewayRouteReport options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The CreateTransitGatewayRouteReport options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
createTransitGatewayRouteReportOptions := transitGatewayApisService.NewCreateTransitGatewayRouteReportOptions( "testString", ) routeReport, response, err := transitGatewayApisService.CreateTransitGatewayRouteReport(createTransitGatewayRouteReportOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(routeReport, "", " ") fmt.Println(string(b))
curl -X POST --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" "{base_url}/transit_gateways/{transit_gateway_id}/route_reports?version={version}"
CreateTransitGatewayRouteReportOptions createTransitGatewayRouteReportOptions = new CreateTransitGatewayRouteReportOptions.Builder() .transitGatewayId("testString") .build(); Response<RouteReport> response = transitGatewayApisService.createTransitGatewayRouteReport(createTransitGatewayRouteReportOptions).execute(); RouteReport routeReport = response.getResult(); System.out.println(routeReport);
const params = { transitGatewayId: 'testString', }; let res; try { res = await transitGatewayApisService.createTransitGatewayRouteReport(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
route_report = transit_gateway_apis_service.create_transit_gateway_route_report( transit_gateway_id='testString' ).get_result() print(json.dumps(route_report, indent=2))
Response
route report
Array of connections with their routes
Possible values: 0 ≤ number of items ≤ 50
Date and time route report was requested
Possible values: 0 ≤ length ≤ 100
Report identifier
Possible values: 0 ≤ length ≤ 36
Example:
1a15dcab-7e26-45e1-b7c5-bc690eaa9724
Array of overlapping routes
Possible values: 0 ≤ number of items ≤ 100
Route report status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
complete
,pending
]Example:
complete
Date and time route report was last modified
Possible values: 0 ≤ length ≤ 100
route report.
Array of connections with their routes.
Array of connection's bgps.
AS path.
Possible values: 0 ≤ length ≤ 200
Examples:ViewIndicates whether current route is used or not.
Examples:Viewlocal preference.
Possible values: 0 ≤ length ≤ 50
Examples:Viewprefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
bgps
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewconnection name.
Possible values: 0 ≤ length ≤ 64
Examples:ViewArray of connection's routes.
prefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
routes
connection type.
Possible values: 0 ≤ length ≤ 20
Examples:View
connections
Date and time route report was requested.
Report identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewArray of overlapping routes.
Array of overlapping connection/prefix pairs.
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewoverlapping prefix.
Possible values: 0 ≤ length ≤ 50
routes
overlappingRoutes
Route report status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
complete
,pending
]Examples:ViewDate and time route report was last modified.
route report.
Array of connections with their routes.
Possible values: 0 ≤ number of items ≤ 50
Array of connection's bgps.
Possible values: 0 ≤ number of items ≤ 200
AS path.
Possible values: 0 ≤ length ≤ 200
Examples:ViewIndicates whether current route is used or not.
Examples:Viewlocal preference.
Possible values: 0 ≤ length ≤ 50
Examples:Viewprefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
bgps
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewconnection name.
Possible values: 0 ≤ length ≤ 64
Examples:ViewArray of connection's routes.
Possible values: 0 ≤ number of items ≤ 200
prefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
routes
connection type.
Possible values: 0 ≤ length ≤ 20
Examples:View
connections
Date and time route report was requested.
Report identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewArray of overlapping routes.
Possible values: 0 ≤ number of items ≤ 100
Array of overlapping connection/prefix pairs.
Possible values: 0 ≤ number of items ≤ 1000
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewoverlapping prefix.
Possible values: 0 ≤ length ≤ 50
routes
overlapping_routes
Route report status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
complete
,pending
]Examples:ViewDate and time route report was last modified.
route report.
Array of connections with their routes.
Possible values: 0 ≤ number of items ≤ 50
Array of connection's bgps.
Possible values: 0 ≤ number of items ≤ 200
AS path.
Possible values: 0 ≤ length ≤ 200
Examples:ViewIndicates whether current route is used or not.
Examples:Viewlocal preference.
Possible values: 0 ≤ length ≤ 50
Examples:Viewprefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
bgps
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewconnection name.
Possible values: 0 ≤ length ≤ 64
Examples:ViewArray of connection's routes.
Possible values: 0 ≤ number of items ≤ 200
prefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
routes
connection type.
Possible values: 0 ≤ length ≤ 20
Examples:View
connections
Date and time route report was requested.
Report identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewArray of overlapping routes.
Possible values: 0 ≤ number of items ≤ 100
Array of overlapping connection/prefix pairs.
Possible values: 0 ≤ number of items ≤ 1000
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewoverlapping prefix.
Possible values: 0 ≤ length ≤ 50
routes
overlapping_routes
Route report status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
complete
,pending
]Examples:ViewDate and time route report was last modified.
route report.
Array of connections with their routes.
Possible values: 0 ≤ number of items ≤ 50
Array of connection's bgps.
Possible values: 0 ≤ number of items ≤ 200
AS path.
Possible values: 0 ≤ length ≤ 200
Examples:ViewIndicates whether current route is used or not.
Examples:Viewlocal preference.
Possible values: 0 ≤ length ≤ 50
Examples:Viewprefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
Bgps
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewconnection name.
Possible values: 0 ≤ length ≤ 64
Examples:ViewArray of connection's routes.
Possible values: 0 ≤ number of items ≤ 200
prefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
Routes
connection type.
Possible values: 0 ≤ length ≤ 20
Examples:View
Connections
Date and time route report was requested.
Report identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewArray of overlapping routes.
Possible values: 0 ≤ number of items ≤ 100
Array of overlapping connection/prefix pairs.
Possible values: 0 ≤ number of items ≤ 1000
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewoverlapping prefix.
Possible values: 0 ≤ length ≤ 50
Routes
OverlappingRoutes
Route report status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
complete
,pending
]Examples:ViewDate and time route report was last modified.
Status Code
Route report request successful. If not already in progress, report generation has begun.
The specified Transit Gateway could not be found.
{ "connections": [ { "bgps": [ { "as_path": "(65201 4201065544) 4203065544", "is_used": true, "local_preference": "190", "prefix": "172.17.0.0/16" } ], "id": "3c265a62-91da-4261-a950-950b6af0eb58", "name": "transit-connection-vpc1", "routes": [ { "prefix": "172.17.0.0/16" } ], "type": "vpc" }, { "bgps": [ { "as_path": "(65201 4201065544) 4203065545", "is_used": true, "local_preference": "190", "prefix": "172.17.0.0/16" } ], "id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff", "name": "transit-connection-vpc2", "routes": [ { "prefix": "172.17.0.0/16" } ], "type": "vpc" } ], "created_at": "2020-03-31T12:08:05Z", "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531", "overlapping_routes": [ { "routes": [ { "connection_id": "3c265a62-91da-4261-a950-950b6af0eb58", "prefix": "172.17.0.0/16" }, { "connection_id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff", "prefix": "172.17.0.0/16" } ] } ], "status": "complete" }
{ "connections": [ { "bgps": [ { "as_path": "(65201 4201065544) 4203065544", "is_used": true, "local_preference": "190", "prefix": "172.17.0.0/16" } ], "id": "3c265a62-91da-4261-a950-950b6af0eb58", "name": "transit-connection-vpc1", "routes": [ { "prefix": "172.17.0.0/16" } ], "type": "vpc" }, { "bgps": [ { "as_path": "(65201 4201065544) 4203065545", "is_used": true, "local_preference": "190", "prefix": "172.17.0.0/16" } ], "id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff", "name": "transit-connection-vpc2", "routes": [ { "prefix": "172.17.0.0/16" } ], "type": "vpc" } ], "created_at": "2020-03-31T12:08:05Z", "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531", "overlapping_routes": [ { "routes": [ { "connection_id": "3c265a62-91da-4261-a950-950b6af0eb58", "prefix": "172.17.0.0/16" }, { "connection_id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff", "prefix": "172.17.0.0/16" } ] } ], "status": "complete" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Cannot find Gateway", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
Delete route report
Delete a route report.
Delete a route report.
Delete a route report.
Delete a route report.
Delete a route report.
DELETE /transit_gateways/{transit_gateway_id}/route_reports/{id}
ServiceCall<Void> deleteTransitGatewayRouteReport(DeleteTransitGatewayRouteReportOptions deleteTransitGatewayRouteReportOptions)
deleteTransitGatewayRouteReport(params)
delete_transit_gateway_route_report(self,
transit_gateway_id: str,
id: str,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) DeleteTransitGatewayRouteReport(deleteTransitGatewayRouteReportOptions *DeleteTransitGatewayRouteReportOptions) (response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) DeleteTransitGatewayRouteReportWithContext(ctx context.Context, deleteTransitGatewayRouteReportOptions *DeleteTransitGatewayRouteReportOptions) (response *core.DetailedResponse, err error)
Request
Use the DeleteTransitGatewayRouteReportOptions.Builder
to create a DeleteTransitGatewayRouteReportOptions
object that contains the parameter values for the deleteTransitGatewayRouteReport
method.
Instantiate the DeleteTransitGatewayRouteReportOptions
struct and set the fields to provide parameter values for the DeleteTransitGatewayRouteReport
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Route report identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The deleteTransitGatewayRouteReport options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Route report identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Route report identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Route report identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The DeleteTransitGatewayRouteReport options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Route report identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
deleteTransitGatewayRouteReportOptions := transitGatewayApisService.NewDeleteTransitGatewayRouteReportOptions( "testString", "testString", ) response, err := transitGatewayApisService.DeleteTransitGatewayRouteReport(deleteTransitGatewayRouteReportOptions) if err != nil { panic(err) }
curl -X DELETE --location --header "Authorization: Bearer {iam_token}" "{base_url}/transit_gateways/{transit_gateway_id}/route_reports/{id}?version={version}"
DeleteTransitGatewayRouteReportOptions deleteTransitGatewayRouteReportOptions = new DeleteTransitGatewayRouteReportOptions.Builder() .transitGatewayId("testString") .id("testString") .build(); Response<Void> response = transitGatewayApisService.deleteTransitGatewayRouteReport(deleteTransitGatewayRouteReportOptions).execute();
const params = { transitGatewayId: 'testString', id: 'testString', }; try { await transitGatewayApisService.deleteTransitGatewayRouteReport(params); } catch (err) { console.warn(err); }
response = transit_gateway_apis_service.delete_transit_gateway_route_report( transit_gateway_id='testString', id='testString' )
Response
Status Code
Route report deleted successfully.
A Transit Gateway or route report with the specified identifier could not be found.
{ "errors": [ { "code": "not_found", "message": "Route report not found", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Route report not found", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
Retrieve route report
Retrieve a route report.
Retrieve a route report.
Retrieve a route report.
Retrieve a route report.
Retrieve a route report.
GET /transit_gateways/{transit_gateway_id}/route_reports/{id}
ServiceCall<RouteReport> getTransitGatewayRouteReport(GetTransitGatewayRouteReportOptions getTransitGatewayRouteReportOptions)
getTransitGatewayRouteReport(params)
get_transit_gateway_route_report(self,
transit_gateway_id: str,
id: str,
**kwargs
) -> DetailedResponse
(transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayRouteReport(getTransitGatewayRouteReportOptions *GetTransitGatewayRouteReportOptions) (result *RouteReport, response *core.DetailedResponse, err error)
(transitGatewayApis *TransitGatewayApisV1) GetTransitGatewayRouteReportWithContext(ctx context.Context, getTransitGatewayRouteReportOptions *GetTransitGatewayRouteReportOptions) (result *RouteReport, response *core.DetailedResponse, err error)
Request
Use the GetTransitGatewayRouteReportOptions.Builder
to create a GetTransitGatewayRouteReportOptions
object that contains the parameter values for the getTransitGatewayRouteReport
method.
Instantiate the GetTransitGatewayRouteReportOptions
struct and set the fields to provide parameter values for the GetTransitGatewayRouteReport
method.
Path Parameters
The Transit Gateway identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Route report identifier
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Query Parameters
Requests the version of the API as of a date in the format
YYYY-MM-DD
. Any date up to the current date may be provided. Specify the current date to request the latest version.Possible values: length = 10, Value must match regular expression
^[0-9]{4}-[0-9]{2}-[0-9]{2}$
The getTransitGatewayRouteReport options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Route report identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Route report identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
parameters
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Route report identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
WithContext method only
A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
The GetTransitGatewayRouteReport options.
The Transit Gateway identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
Route report identifier.
Possible values: 0 ≤ length ≤ 36, Value must match regular expression
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
getTransitGatewayRouteReportOptions := transitGatewayApisService.NewGetTransitGatewayRouteReportOptions( "testString", "testString", ) routeReport, response, err := transitGatewayApisService.GetTransitGatewayRouteReport(getTransitGatewayRouteReportOptions) if err != nil { panic(err) } b, _ := json.MarshalIndent(routeReport, "", " ") fmt.Println(string(b))
curl -X GET --location --header "Authorization: Bearer {iam_token}" --header "Accept: application/json" "{base_url}/transit_gateways/{transit_gateway_id}/route_reports/{id}?version={version}"
GetTransitGatewayRouteReportOptions getTransitGatewayRouteReportOptions = new GetTransitGatewayRouteReportOptions.Builder() .transitGatewayId("testString") .id("testString") .build(); Response<RouteReport> response = transitGatewayApisService.getTransitGatewayRouteReport(getTransitGatewayRouteReportOptions).execute(); RouteReport routeReport = response.getResult(); System.out.println(routeReport);
const params = { transitGatewayId: 'testString', id: 'testString', }; let res; try { res = await transitGatewayApisService.getTransitGatewayRouteReport(params); console.log(JSON.stringify(res.result, null, 2)); } catch (err) { console.warn(err); }
route_report = transit_gateway_apis_service.get_transit_gateway_route_report( transit_gateway_id='testString', id='testString' ).get_result() print(json.dumps(route_report, indent=2))
Response
route report
Array of connections with their routes
Possible values: 0 ≤ number of items ≤ 50
Date and time route report was requested
Possible values: 0 ≤ length ≤ 100
Report identifier
Possible values: 0 ≤ length ≤ 36
Example:
1a15dcab-7e26-45e1-b7c5-bc690eaa9724
Array of overlapping routes
Possible values: 0 ≤ number of items ≤ 100
Route report status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
complete
,pending
]Example:
complete
Date and time route report was last modified
Possible values: 0 ≤ length ≤ 100
route report.
Array of connections with their routes.
Array of connection's bgps.
AS path.
Possible values: 0 ≤ length ≤ 200
Examples:ViewIndicates whether current route is used or not.
Examples:Viewlocal preference.
Possible values: 0 ≤ length ≤ 50
Examples:Viewprefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
bgps
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewconnection name.
Possible values: 0 ≤ length ≤ 64
Examples:ViewArray of connection's routes.
prefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
routes
connection type.
Possible values: 0 ≤ length ≤ 20
Examples:View
connections
Date and time route report was requested.
Report identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewArray of overlapping routes.
Array of overlapping connection/prefix pairs.
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewoverlapping prefix.
Possible values: 0 ≤ length ≤ 50
routes
overlappingRoutes
Route report status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
complete
,pending
]Examples:ViewDate and time route report was last modified.
route report.
Array of connections with their routes.
Possible values: 0 ≤ number of items ≤ 50
Array of connection's bgps.
Possible values: 0 ≤ number of items ≤ 200
AS path.
Possible values: 0 ≤ length ≤ 200
Examples:ViewIndicates whether current route is used or not.
Examples:Viewlocal preference.
Possible values: 0 ≤ length ≤ 50
Examples:Viewprefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
bgps
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewconnection name.
Possible values: 0 ≤ length ≤ 64
Examples:ViewArray of connection's routes.
Possible values: 0 ≤ number of items ≤ 200
prefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
routes
connection type.
Possible values: 0 ≤ length ≤ 20
Examples:View
connections
Date and time route report was requested.
Report identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewArray of overlapping routes.
Possible values: 0 ≤ number of items ≤ 100
Array of overlapping connection/prefix pairs.
Possible values: 0 ≤ number of items ≤ 1000
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewoverlapping prefix.
Possible values: 0 ≤ length ≤ 50
routes
overlapping_routes
Route report status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
complete
,pending
]Examples:ViewDate and time route report was last modified.
route report.
Array of connections with their routes.
Possible values: 0 ≤ number of items ≤ 50
Array of connection's bgps.
Possible values: 0 ≤ number of items ≤ 200
AS path.
Possible values: 0 ≤ length ≤ 200
Examples:ViewIndicates whether current route is used or not.
Examples:Viewlocal preference.
Possible values: 0 ≤ length ≤ 50
Examples:Viewprefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
bgps
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewconnection name.
Possible values: 0 ≤ length ≤ 64
Examples:ViewArray of connection's routes.
Possible values: 0 ≤ number of items ≤ 200
prefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
routes
connection type.
Possible values: 0 ≤ length ≤ 20
Examples:View
connections
Date and time route report was requested.
Report identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewArray of overlapping routes.
Possible values: 0 ≤ number of items ≤ 100
Array of overlapping connection/prefix pairs.
Possible values: 0 ≤ number of items ≤ 1000
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewoverlapping prefix.
Possible values: 0 ≤ length ≤ 50
routes
overlapping_routes
Route report status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
complete
,pending
]Examples:ViewDate and time route report was last modified.
route report.
Array of connections with their routes.
Possible values: 0 ≤ number of items ≤ 50
Array of connection's bgps.
Possible values: 0 ≤ number of items ≤ 200
AS path.
Possible values: 0 ≤ length ≤ 200
Examples:ViewIndicates whether current route is used or not.
Examples:Viewlocal preference.
Possible values: 0 ≤ length ≤ 50
Examples:Viewprefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
Bgps
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewconnection name.
Possible values: 0 ≤ length ≤ 64
Examples:ViewArray of connection's routes.
Possible values: 0 ≤ number of items ≤ 200
prefix.
Possible values: 0 ≤ length ≤ 50
Examples:View
Routes
connection type.
Possible values: 0 ≤ length ≤ 20
Examples:View
Connections
Date and time route report was requested.
Report identifier.
Possible values: 0 ≤ length ≤ 36
Examples:ViewArray of overlapping routes.
Possible values: 0 ≤ number of items ≤ 100
Array of overlapping connection/prefix pairs.
Possible values: 0 ≤ number of items ≤ 1000
connection ID.
Possible values: 0 ≤ length ≤ 36
Examples:Viewoverlapping prefix.
Possible values: 0 ≤ length ≤ 50
Routes
OverlappingRoutes
Route report status. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
Possible values: [
complete
,pending
]Examples:ViewDate and time route report was last modified.
Status Code
Route report retrieved successfully.
A route report or gateway with the specified identifier(s) could not be found.
{ "connections": [ { "bgps": [ { "as_path": "(65201 4201065544) 4203065544", "is_used": true, "local_preference": "190", "prefix": "172.17.0.0/16" } ], "id": "3c265a62-91da-4261-a950-950b6af0eb58", "name": "transit-connection-vpc1", "routes": [ { "prefix": "172.17.0.0/16" } ], "type": "vpc" }, { "bgps": [ { "as_path": "(65201 4201065544) 4203065545", "is_used": true, "local_preference": "190", "prefix": "172.17.0.0/16" } ], "id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff", "name": "transit-connection-vpc2", "routes": [ { "prefix": "172.17.0.0/16" } ], "type": "vpc" } ], "created_at": "2020-03-31T12:08:05Z", "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531", "overlapping_routes": [ { "routes": [ { "connection_id": "3c265a62-91da-4261-a950-950b6af0eb58", "prefix": "172.17.0.0/16" }, { "connection_id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff", "prefix": "172.17.0.0/16" } ] } ], "status": "complete" }
{ "connections": [ { "bgps": [ { "as_path": "(65201 4201065544) 4203065544", "is_used": true, "local_preference": "190", "prefix": "172.17.0.0/16" } ], "id": "3c265a62-91da-4261-a950-950b6af0eb58", "name": "transit-connection-vpc1", "routes": [ { "prefix": "172.17.0.0/16" } ], "type": "vpc" }, { "bgps": [ { "as_path": "(65201 4201065544) 4203065545", "is_used": true, "local_preference": "190", "prefix": "172.17.0.0/16" } ], "id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff", "name": "transit-connection-vpc2", "routes": [ { "prefix": "172.17.0.0/16" } ], "type": "vpc" } ], "created_at": "2020-03-31T12:08:05Z", "id": "1a15dca5-7e33-45e1-b7c5-bc690e569531", "overlapping_routes": [ { "routes": [ { "connection_id": "3c265a62-91da-4261-a950-950b6af0eb58", "prefix": "172.17.0.0/16" }, { "connection_id": "d2d985d8-1d8e-4e8b-96cd-cee2290ecaff", "prefix": "172.17.0.0/16" } ] } ], "status": "complete" }
{ "errors": [ { "code": "not_found", "message": "Route report not found", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }
{ "errors": [ { "code": "not_found", "message": "Route report not found", "more_info": "https://cloud.ibm.com/apidocs/transit-gateway#error-handling" } ], "trace": "86780a34-e651-4b47-9fb0-184a169cc9af" }