REST API for Oracle Private Cloud Appliance Compute Enclave

List DRG Attachments

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", "FLEX_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.
internalType: string

Internal query parameter to filter DRG attachments on `internalType`

Default Value: ALL

Allowed Values: [ "GDRG_SERVICE_RESOURCE", "GDRG_MESH_RPC", "ALL" ]
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
natPolicyId: string

Minimum Length: 1

Maximum Length: 255

The OCID of the NAT policy.
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: 0
sortBy: string

The optional field to sort the results by.

Allowed Values: [ "TIMECREATED", "NAME" ]
sortOrder: string

The sort order to use, either ascending (ASC) or descending (DESC).

Default Value: ASC

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. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : schema

Type: array

Show Source

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.

{
    "items":{
        "$ref":"#/definitions/DrgAttachment"
    },
    "type":"array"
}

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: additionalProperties

Defined 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: additionalProperties

Free-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.
internalType: string

Allowed Values: [ "GDRG_SERVICE_RESOURCE", "GDRG_MESH_RPC" ]

STANDARD applies to all regional resources which are customer visible, GDRG_SERVICE_RESOURCE applies to internal resources created to back GlobalDRGAttachments, and GDRG_MESH_RPC applies to internal RPC Attachments used to facilitate GlobalDRG functionality.
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", "UPDATING" ]

The DRG attachment's current state.
natPolicyId: string

Minimum Length: 1

Maximum Length: 255

The OCID of the DRG attachment's NAT policy.
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
transitiveTrafficEnabled: string

Allowed Values: [ "ENABLED", "DISABLED" ]

Indicates if transitive traffic is enabled for this DRG attachment. This field is only supported for VirtualCircuit and IPSec DRG attachments.
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.
zprTags: object zprTags

Additional Properties Allowed: additionalProperties

zprTags for this resource. This is unique to ZPR, and extends the defined tags to include a mode keyword as well Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}`

{
    "description":"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.",
    "x-obmcs-splat":{
        "resourceKind":"drg-attachment",
        "adLocality":"regional"
    },
    "properties":{
        "compartmentId":{
            "description":"The OCID of the compartment containing the DRG attachment.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "drgId":{
            "description":"The OCID of the DRG.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "id":{
            "description":"The DRG attachment's OCID.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "lifecycleState":{
            "description":"The DRG attachment's current state.",
            "enum":[
                "ATTACHING",
                "ATTACHED",
                "DETACHING",
                "DETACHED",
                "UPDATING"
            ],
            "type":"string"
        },
        "timeCreated":{
            "description":"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 ",
            "format":"date-time",
            "type":"string"
        },
        "drgRouteTableId":{
            "description":"The OCID of the DRG route table that is assigned to this attachment. The DRG route table manages traffic inside the DRG.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "networkDetails":{
            "$ref":"#/definitions/DrgAttachmentNetworkDetails"
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported. ",
                    "type":"object"
                }
            }
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "zprTags":{
            "description":"zprTags for this resource. This is unique to ZPR, and extends the defined tags to include a mode keyword as well  Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}` ",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. ",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. ",
                    "type":"object"
                }
            }
        },
        "routeTableId":{
            "description":"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.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "vcnId":{
            "description":"The OCID of the VCN. This field is deprecated. Instead, use the networkDetails field to view the OCID of the attached resource.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "natPolicyId":{
            "description":"The OCID of the DRG attachment's NAT policy. ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "internalType":{
            "description":"STANDARD applies to all regional resources which are customer visible, GDRG_SERVICE_RESOURCE applies to  internal resources created to back GlobalDRGAttachments, and GDRG_MESH_RPC applies to internal RPC Attachments used to facilitate GlobalDRG functionality. ",
            "type":"string",
            "enum":[
                "GDRG_SERVICE_RESOURCE",
                "GDRG_MESH_RPC"
            ],
            "x-obmcs-top-level-enum":"#/definitions/DrgAttachmentInternalType"
        },
        "transitiveTrafficEnabled":{
            "description":"Indicates if transitive traffic is enabled for this DRG attachment. This field is  only supported for VirtualCircuit and IPSec DRG attachments. ",
            "type":"string",
            "enum":[
                "ENABLED",
                "DISABLED"
            ],
            "x-obmcs-top-level-enum":"#/definitions/DrgAttachmentTransitiveTrafficState"
        },
        "exportDrgRouteDistributionId":{
            "description":"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.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "isCrossTenancy":{
            "description":"Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG.",
            "type":"boolean"
        }
    },
    "required":[
        "id",
        "compartmentId",
        "drgId",
        "lifecycleState"
    ],
    "type":"object"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

Additional Properties Allowed: additionalProperties

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported. ",
            "type":"object"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace.

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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: type

Show Source

id: 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", "FLEX_TUNNEL", "LOOPBACK", "INTERNET" ]

{
    "discriminator":"type",
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "VCN",
                "IPSEC_TUNNEL",
                "VIRTUAL_CIRCUIT",
                "REMOTE_PEERING_CONNECTION",
                "FLEX_TUNNEL",
                "LOOPBACK",
                "INTERNET"
            ]
        },
        "id":{
            "description":"The OCID of the network attached to the DRG.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        }
    },
    "required":[
        "type"
    ],
    "type":"object"
}

Nested Schema : zprTags

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

Additional Properties Allowed: additionalProperties

Key-value pair representing a defined tag key and value, scoped to a namespace.

{
    "description":"zprTags for this resource. This is unique to ZPR, and extends the defined tags to include a mode keyword as well  Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}` ",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. ",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. ",
            "type":"object"
        }
    }
}

zprTags for this resource. This is unique to ZPR, and extends the defined tags to include a mode keyword as well Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}`

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag. Only the String type is supported.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.  Example: `{\"CostCenter\": \"42\"}` ",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported. ",
        "type":"object"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. ",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. ",
        "type":"object"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace.

Nested Schema : additionalProperties

Type: object

The value of the tag.

401 Response

Unauthorized

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred.

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}