ListDrgAttachments
get
/20160918/drgAttachments
List the DrgAttachment resources for the specified compartment. You can filter the results by DRG, attached network, attachment type, DRG route table, or VCN route table. The LIST API lists DRG attachments by attachment type. It defaults to list VCN attachments, but you can request to list ALL attachments of ALL types.
Request
Supported Media Types
- application/json
Query Parameters
-
attachmentType: string
The type for the network resource attached to the DRG.Default Value:
VCN
Allowed Values:[ "VCN", "VIRTUAL_CIRCUIT", "REMOTE_PEERING_CONNECTION", "IPSEC_TUNNEL", "ALL" ]
-
compartmentId(required): string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment. -
displayName: string
Minimum Length:
1
Maximum Length:255
A filter to return only resources that match the entire display name given. -
drgId: string
Minimum Length:
1
Maximum Length:255
The OCID of the DRG. -
drgRouteTableId: string
Minimum Length:
1
Maximum Length:255
The OCID of the DRG route table assigned to the DRG attachment. -
lifecycleState: string
A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
-
limit: integer
Minimum Value:
1
Maximum Value:1000
For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.Default Value:100
-
networkId: string
Minimum Length:
1
Maximum Length:255
The OCID of the resource (virtual circuit, VCN, IPSec tunnel, or remote peering connection) attached to the DRG. -
page: string
Minimum Length:
1
Maximum Length:512
For list pagination. The value of the opc-next-page response header from the previous List call.Default Value:oracle.doceng.json.BetterJsonNull@2c07545f
-
sortBy: string
The optional field to sort the results by.Default Value:
NAME
Allowed Values:[ "ID", "NAME", "TIME_CREATED" ]
-
sortOrder: string
The sort order to use, either ascending (ASC) or descending (DESC).Allowed Values:
[ "ASC", "DESC" ]
-
vcnId: string
Minimum Length:
1
Maximum Length:255
The OCID of the VCN.
Response
Supported Media Types
- application/json
200 Response
The list is being retrieved.
Headers
-
opc-next-page: string
For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object DrgAttachment
A DRG attachment serves as a link between a DRG and a network resource. A DRG can be attached to a VCN, IPSec tunnel, remote peering connection, or virtual circuit.
Nested Schema : DrgAttachment
Type:
object
A DRG attachment serves as a link between a DRG and a network resource. A DRG can be attached to a VCN, IPSec tunnel, remote peering connection, or virtual circuit.
Show Source
-
compartmentId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment containing the DRG attachment. -
definedTags:
object definedTags
Additional Properties Allowed: additionalPropertiesDefined tags for this resource. Each key is predefined and scoped to a namespace.
-
displayName:
string
Minimum Length:
1
Maximum Length:255
A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information. -
drgId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the DRG. -
drgRouteTableId:
string
Minimum Length:
1
Maximum Length:255
The OCID of the DRG route table that is assigned to this attachment. The DRG route table manages traffic inside the DRG. -
exportDrgRouteDistributionId:
string
Minimum Length:
1
Maximum Length:255
The OCID of the export route distribution used to specify how routes in the assigned DRG route table are advertised to the attachment. If this value is null, no routes are advertised through this attachment. -
freeformTags:
object freeformTags
Additional Properties Allowed: additionalPropertiesFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
-
id(required):
string
Minimum Length:
1
Maximum Length:255
The DRG attachment's OCID. -
isCrossTenancy:
boolean
Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG.
-
lifecycleState(required):
string
Allowed Values:
[ "ATTACHING", "ATTACHED", "DETACHING", "DETACHED" ]
The DRG attachment's current state. -
networkDetails:
object DrgAttachmentNetworkDetails
Discriminator:
type
-
routeTableId:
string
Minimum Length:
1
Maximum Length:255
This field is deprecated. Instead, use the networkDetails field to view the OCID of the attached resource. The value of this field is the OCID of the route table the DRG attachment is using. Associate a route table with a DRG attachment to access multiple VCNs. -
timeCreated:
string(date-time)
The date and time the DRG attachment was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
-
vcnId:
string
Minimum Length:
1
Maximum Length:255
The OCID of the VCN. This field is deprecated. Instead, use the networkDetails field to view the OCID of the attached resource.
Nested Schema : definedTags
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalPropertiesKey-value pair representing a defined tag key and value, scoped to a namespace.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
Nested Schema : freeformTags
Type:
object
Additional Properties Allowed
Show Source
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
Nested Schema : DrgAttachmentNetworkDetails
Type:
object
Discriminator:
Show Source
type
-
id(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the network attached to the DRG. -
type(required):
string
Allowed Values:
[ "VCN", "IPSEC_TUNNEL", "VIRTUAL_CIRCUIT", "REMOTE_PEERING_CONNECTION", "INTERNET" ]
Nested Schema : additionalProperties
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
The value of the tag. Only the String type is supported.
Key-value pair representing a defined tag key and value, scoped to a namespace.
Nested Schema : additionalProperties
Type:
object
The value of the tag. Only the String type is supported.
401 Response
Unauthorized
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
Default Response
An error has occurred.
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload