ListDrgAttachments
GET {{baseUrl}}/drgAttachments?compartmentId={{compartment_ocid}}&vcnId=amet ut&drgId=amet ut&limit=801&page=laboris proident officia tempor&networkId=amet ut&attachmentType=VCN&drgRouteTableId=amet ut&displayName=amet ut&sortBy=TIMECREATED&sortOrder=DESC&lifecycleState=ACTIVE
Lists the DrgAttachment
resource 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 will default to list VCN attachments, but you may request to list ALL attachments of ALL types.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
compartmentId | string | (Required) The OCID of the compartment. | |
vcnId | string | The OCID of the VCN. | |
drgId | string | The OCID of the DRG. | |
limit | number | For list pagination. The maximum number of results per page, or items to return in a paginated | |
"List" call. For important details about how pagination works, see | |||
List Pagination. |
Example: 50
|
| page
| string | | For list pagination. The value of the opc-next-page
response header from the previous "List"
call. For important details about how pagination works, see
List Pagination.
|
| networkId
| string | | The OCID of the resource (virtual circuit, VCN, IPSec tunnel, or remote peering connection) attached to the DRG. |
| attachmentType
| string | | The type for the network resource attached to the DRG. |
| drgRouteTableId
| string | | The OCID of the DRG route table assigned to the DRG attachment. |
| displayName
| string | | A filter to return only resources that match the given display name exactly.
|
| sortBy
| string | | The field to sort by. You can provide one sort order (sortOrder
). Default order for
TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
sort order is case sensitive.
Note: In general, some "List" operations (for example, ListInstances
) let you
optionally filter by availability domain if the scope of the resource type is within a
single availability domain. If you call one of these "List" operations without specifying
an availability domain, the resources are grouped by availability domain, then sorted.
|
| sortOrder
| string | | The sort order to use, either ascending (ASC
) or descending (DESC
). The DISPLAYNAME sort order
is case sensitive.
|
| lifecycleState
| string | | A filter to return only resources that match the specified lifecycle
state. The value is case insensitive.
|
RESPONSES
status: OK
[{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"compartmentId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"drgId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lifecycleState":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"definedTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"displayName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"drgRouteTableId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"exportDrgRouteDistributionId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"freeformTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isCrossTenancy":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"networkDetails":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"routeTableId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"timeCreated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"vcnId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"compartmentId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"drgId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lifecycleState":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"definedTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"displayName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"drgRouteTableId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"exportDrgRouteDistributionId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"freeformTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isCrossTenancy":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"networkDetails":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"routeTableId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"timeCreated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"vcnId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]