REST API for Oracle Private Cloud Appliance Compute Enclave

ListDrgs

get

/20160918/drgs

List the DRGs in the specified compartment.

Request

Supported Media Types

application/json

Query Parameters

compartmentId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the compartment.
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
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

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

Show Source

Array of: object Drg

A dynamic routing gateway (DRG) is a virtual router that provides a path for private network traffic between networks. You use it with other Networking Service components to create a connection to your on-premises network. For more information, see "Dynamic Routing Gateway" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/concept/concept-vnet-gateways.html#vnet-gw-drg).

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

Nested Schema : Drg

Type: object

A dynamic routing gateway (DRG) is a virtual router that provides a path for private network traffic between networks. You use it with other Networking Service components to create a connection to your on-premises network. For more information, see "Dynamic Routing Gateway" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/concept/concept-vnet-gateways.html#vnet-gw-drg).

Show Source

compartmentId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the compartment containing the DRG.
defaultDrgRouteTables: object DefaultDrgRouteTables

The default DRG route table for this DRG. Each network type has a default DRG route table. You can update a network type to use a different DRG route table, but each network type must have a default DRG route table. You cannot delete a default DRG route table.
defaultExportDrgRouteDistributionId: string

Minimum Length: 1

Maximum Length: 255

The OCID of this DRG's default export route distribution for the DRG attachments.
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.
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's OCID.
lifecycleState(required): string

Allowed Values: [ "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED" ]

The DRG's current state.
timeCreated: string(date-time)

The date and time the DRG was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z

{
    "description":"A dynamic routing gateway (DRG) is a virtual router that provides a path for private network traffic between networks. You use it with other Networking Service components to create a connection to your on-premises network. For more information, see \"Dynamic Routing Gateway\" (https://docs.oracle.com/en/engineered-systems/private-cloud-appliance/3.0-latest/concept/concept-vnet-gateways.html#vnet-gw-drg).",
    "x-obmcs-splat":{
        "resourceKind":"drg",
        "adLocality":"regional"
    },
    "properties":{
        "compartmentId":{
            "description":"The OCID of the compartment containing the DRG.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "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.",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported.",
                    "type":"object"
                }
            }
        },
        "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"
        },
        "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"
            }
        },
        "id":{
            "description":"The DRG's OCID.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The DRG's current state.",
            "enum":[
                "PROVISIONING",
                "AVAILABLE",
                "TERMINATING",
                "TERMINATED"
            ],
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time the DRG 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"
        },
        "defaultDrgRouteTables":{
            "$ref":"#/definitions/DefaultDrgRouteTables"
        },
        "defaultExportDrgRouteDistributionId":{
            "description":"The OCID of this DRG's default export route distribution for the DRG attachments.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        }
    },
    "required":[
        "compartmentId",
        "id",
        "lifecycleState"
    ],
    "x-example":"{   \"compartmentId\": \"ocid1.compartment.<var>unique_ID</var>\",   \"displayName\": \"MyDrg\",   \"id\": \"ocid1.drg.<var>unique_ID</var>\",   \"lifecycleState\": \"PROVISIONING\",   \"timeCreated\": \"2016-12-16T22:34:20.948Z\" } ",
    "type":"object"
}

Nested Schema : DefaultDrgRouteTables

Type: object

The default DRG route table for this DRG. Each network type has a default DRG route table. You can update a network type to use a different DRG route table, but each network type must have a default DRG route table. You cannot delete a default DRG route table.

Show Source

ipsecTunnel: string

Minimum Length: 1

Maximum Length: 255

The OCID of the default DRG route table assigned to DRG attachments of type IPSEC_TUNNEL on creation.
remotePeeringConnection: string

Minimum Length: 1

Maximum Length: 255

The OCID of the default DRG route table to be assigned to DRG attachments of type REMOTE_PEERING_CONNECTION on creation.
vcn: string

Minimum Length: 1

Maximum Length: 255

The OCID of the default DRG route table to be assigned to DRG attachments of type VCN on creation.
virtualCircuit: string

Minimum Length: 1

Maximum Length: 255

The OCID of the default DRG route table to be assigned to DRG attachments of type VIRTUAL_CIRCUIT on creation.

{
    "description":"The default DRG route table for this DRG. Each network type has a default DRG route table. You can update a network type to use a different DRG route table, but each network type must have a default DRG route table. You cannot delete a default DRG route table.",
    "properties":{
        "vcn":{
            "description":"The OCID of the default DRG route table to be assigned to DRG attachments of type VCN on creation.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "ipsecTunnel":{
            "description":"The OCID of the default DRG route table assigned to DRG attachments of type IPSEC_TUNNEL on creation.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "virtualCircuit":{
            "description":"The OCID of the default DRG route table to be assigned to DRG attachments of type VIRTUAL_CIRCUIT on creation.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "remotePeeringConnection":{
            "description":"The OCID of the default DRG route table to be assigned to DRG attachments of type REMOTE_PEERING_CONNECTION on creation.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        }
    },
    "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.

{
    "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.",
        "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 : 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.",
    "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.

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}