Jump to

• Request
• Response

Get a private network profile

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/privateNetworkProfiles/{privateNetworkProfileKey}

Returns a private network profile 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.
• privateNetworkProfileKey(required): string
  Minimum Length: 1

  Maximum Length: 200

  The private network profile key.

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

Private network profile retrieved.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• 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 : PrivateNetworkProfile

Type: object

A reusable private network profile for Git repository connectivity.

Show Source

• createdBy: string
  Identifier of the user who created the profile.
• createdByName: string
  Display name of the user who created the profile.
• customerCompartmentId(required): string
  Customer compartment identifier containing the private network resources.
• customerSubnetId(required): string
  Customer subnet identifier used for Git connectivity.
• customerVcnId(required): string
  Customer VCN identifier used for Git connectivity.
• 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
  Allowed Values: [ "CREATING", "ACTIVE", "DELETING", "FAILED" ]

  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":"A reusable private network profile for Git repository connectivity.",
    "required":[
        "key",
        "name",
        "customerCompartmentId",
        "customerVcnId",
        "customerSubnetId",
        "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."
        },
        "customerCompartmentId":{
            "type":"string",
            "description":"Customer compartment identifier containing the private network resources."
        },
        "customerVcnId":{
            "type":"string",
            "description":"Customer VCN identifier used for Git connectivity."
        },
        "customerSubnetId":{
            "type":"string",
            "description":"Customer subnet identifier used for Git connectivity."
        },
        "lifecycleState":{
            "type":"string",
            "description":"Current lifecycle state of the profile.",
            "enum":[
                "CREATING",
                "ACTIVE",
                "DELETING",
                "FAILED"
            ]
        },
        "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