Gets a list of Database Management private endpoints.
GET {{baseUrl}}/dbManagementPrivateEndpoints?compartmentId=<string>&name=<string>&vcnId=<string>&isCluster=false&lifecycleState=FAILED&limit=10&page=<string>&sortOrder=ASC&sortBy=TIMECREATED
Gets a list of Database Management private endpoints.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
compartmentId | string | (Required) The OCID of the compartment. | |
name | string | A filter to return only resources that match the entire name. | |
vcnId | string | The OCID of the VCN. | |
isCluster | boolean | The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter. | |
lifecycleState | string | The lifecycle state of a resource. | |
limit | number | The maximum number of records returned in the paginated response. | |
page | string | The page token representing the page from where the next set of paginated results | |
are retrieved. This is usually retrieved from a previous list call. | |||
sortOrder | string | The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. | |
sortBy | string | The field to sort information by. Only one sortOrder can be used. The default sort order | |
for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. | |||
The ‘NAME’ sort order is case-sensitive. | |||
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
opc-request-id | string | The client request ID for tracing. | |
Accept | string |
RESPONSES
status: OK
{"items":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","vcnId":"\u003cstring\u003e","subnetId":"\u003cstring\u003e","definedTags":{"dolore2_":{"id_3b9":{}},"sit_4":{"amet_":{},"sit__d":{},"dolore_3":{},"et_d":{}}},"description":"\u003cstring\u003e","freeformTags":{"ad__5":"\u003cstring\u003e","est_54":"\u003cstring\u003e","in3":"\u003cstring\u003e"},"lifecycleState":"FAILED","timeCreated":"\u003cdateTime\u003e"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","compartmentId":"\u003cstring\u003e","vcnId":"\u003cstring\u003e","subnetId":"\u003cstring\u003e","definedTags":{"deserunte":{"utd8c":{},"id_9":{},"eu6d9":{},"ut_f4f":{}}},"description":"\u003cstring\u003e","freeformTags":{"in7":"\u003cstring\u003e","dolor_f":"\u003cstring\u003e"},"lifecycleState":"DELETING","timeCreated":"\u003cdateTime\u003e"}]}