Jump to

• Request
• Response

List private network profiles

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/privateNetworkProfiles

Returns private network profile summaries for the requested AI data platform.

Request

Path Parameters

• aiDataPlatformId(required): string
  Minimum Length: 1

  Maximum Length: 500

  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.

Query Parameters

• displayNameContains: string
  Maximum Length: 1000

  A filter to return only resources that have a display name containing the text provided.
• lifecycleState: string
  A filter to return only private network profiles with the given lifecycle state.
• 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. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

  Default Value: 100
• name: string
  Minimum Length: 1

  Maximum Length: 1000

  An exact-name filter for private network profiles.
• page: string
  Maximum Length: 1024

  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](/iaas/Content/API/Concepts/usingapi.htm#nine).
• sortBy: string
  The field to sort by. You can provide only one sort order. The default order for `timeCreated` is descending.

  Default Value: timeCreated

  Allowed Values: [ "timeCreated" ]
• sortOrder: string
  The sort order to use, either ascending (`ASC`) or descending (`DESC`).

  Allowed Values: [ "ASC", "DESC" ]

Header Parameters

• opc-request-id: string
  Maximum Length: 255

  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A page of private network profile summaries.

Headers

• opc-next-page: string
  For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• opc-total-items: integer
  For list pagination. This header provides total number of items available.

Body ()

Root Schema : PrivateNetworkProfileCollection

Type: object

A page of Git connectivity profile summaries.

Show Source

• items(required): array items
  Git connectivity profile summaries.

{
    "type":"object",
    "description":"A page of Git connectivity profile summaries.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"Git connectivity profile summaries.",
            "items":{
                "$ref":"#/definitions/PrivateNetworkProfileSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

Git connectivity profile summaries.

Show Source

• Array of: object PrivateNetworkProfileSummary
  Summary information for a Git connectivity profile.

{
    "type":"array",
    "description":"Git connectivity profile summaries.",
    "items":{
        "$ref":"#/definitions/PrivateNetworkProfileSummary"
    }
}

Nested Schema : PrivateNetworkProfileSummary

Type: object

Summary information for a Git connectivity profile.

Show Source

• createdBy: string
  Identifier of the user who created the profile.
• createdByName: string
  Display name of the user who created the profile.
• description: string
  Optional description of the Git connectivity profile.
• key(required): string
  Unique key for the Git connectivity profile.
• lastValidationErrorCode: string
  Non-sensitive code for the latest validation failure.
• lastValidationErrorMessage: string
  Non-sensitive message for the latest validation failure.
• lifecycleState(required): string
  Current lifecycle state of the profile.
• name(required): string
  Display name of the Git connectivity profile.
• timeCreated(required): string(date-time)
  Time at which the profile was created.
• timeLastValidated: string(date-time)
  Time at which the profile was last validated.
• timeUpdated(required): string(date-time)
  Time at which the profile was last updated.
• validationState(required): string
  Allowed Values: [ "UNKNOWN", "VALID", "INVALID" ]

  Latest validation state of the profile.

{
    "type":"object",
    "description":"Summary information for a Git connectivity profile.",
    "required":[
        "key",
        "name",
        "lifecycleState",
        "validationState",
        "timeCreated",
        "timeUpdated"
    ],
    "properties":{
        "key":{
            "type":"string",
            "description":"Unique key for the Git connectivity profile."
        },
        "name":{
            "type":"string",
            "description":"Display name of the Git connectivity profile."
        },
        "description":{
            "type":"string",
            "description":"Optional description of the Git connectivity profile."
        },
        "lifecycleState":{
            "type":"string",
            "description":"Current lifecycle state of the profile.",
            "x-obmcs-enumref":"#/definitions/PrivateNetworkProfile/lifecycleState"
        },
        "validationState":{
            "type":"string",
            "description":"Latest validation state of the profile.",
            "enum":[
                "UNKNOWN",
                "VALID",
                "INVALID"
            ]
        },
        "timeLastValidated":{
            "type":"string",
            "format":"date-time",
            "description":"Time at which the profile was last validated."
        },
        "lastValidationErrorCode":{
            "type":"string",
            "description":"Non-sensitive code for the latest validation failure."
        },
        "lastValidationErrorMessage":{
            "type":"string",
            "description":"Non-sensitive message for the latest validation failure."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time at which the profile was created."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time at which the profile was last updated."
        },
        "createdBy":{
            "type":"string",
            "description":"Identifier of the user who created the profile."
        },
        "createdByName":{
            "type":"string",
            "description":"Display name of the user who created the profile."
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top