Jump to

• Request
• Response

GetInstanceConsoleConnection

get

/20160918/instanceConsoleConnections/{instance_console_connection_id}

Get information about the specified instance console connection.

Request

Supported Media Types

• application/json

Path Parameters

• instanceConsoleConnectionId(required): string
  The OCID of the instance console connection.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The instance console connection was retrieved.

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.

Body ()

Root Schema : InstanceConsoleConnection

Type: object

The InstanceConsoleConnection API provides you with console access to Compute instances, enabling you to troubleshoot malfunctioning instances remotely.

Show Source

• compartmentId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment to contain the console connection.
• connectionString: string
  The SSH connection string for the console connection.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace.
• fingerprint: string
  The SSH public key's fingerprint for client authentication to the console connection.
• 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: string
  The OCID of the console connection.
• instanceId: string
  The OCID of the instance the console connection connects to.
• lifecycleState: string
  Allowed Values: [ "ACTIVE", "CREATING", "DELETED", "DELETING", "FAILED" ]

  The current state of the console connection.
• serviceHostKeyFingerprint: string
  The SSH public key's fingerprint for the console connection service host.
• vncConnectionString: string
  The SSH connection string for the SSH tunnel used to connect to the console connection over VNC.

{
    "x-obmcs-splat":{
        "resourceKind":"InstanceConsoleConnection",
        "adLocality":"regional"
    },
    "description":"The InstanceConsoleConnection API provides you with console access to Compute instances, enabling you to troubleshoot malfunctioning instances remotely.",
    "properties":{
        "compartmentId":{
            "description":"The OCID of the compartment to contain the console connection.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "connectionString":{
            "description":"The SSH connection string for the console connection.",
            "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"
                }
            }
        },
        "fingerprint":{
            "description":"The SSH public key's fingerprint for client authentication to the console connection.",
            "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 OCID of the console connection.",
            "type":"string"
        },
        "instanceId":{
            "description":"The OCID of the instance the console connection connects to.",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the console connection.",
            "enum":[
                "ACTIVE",
                "CREATING",
                "DELETED",
                "DELETING",
                "FAILED"
            ],
            "type":"string"
        },
        "serviceHostKeyFingerprint":{
            "description":"The SSH public key's fingerprint for the console connection service host.",
            "type":"string"
        },
        "vncConnectionString":{
            "description":"The SSH connection string for the SSH tunnel used to connect to the console connection over VNC.",
            "type":"string"
        }
    },
    "x-example":"{     \"compartmentId\": \"ocid1.compartment.<var>unique_ID</var>\",     \"connectionString\": \"ssh -o ProxyCommand='ssh -W %h:%p -p 443 ocid1.instanceconsoleconnection.<var>unique_ID</var>@instance-console.us-ashburn-1.oraclecloud.com' ocid1.instance.<var>unique_ID</var>\",     \"vncConnectionString\": \"ssh -L 5900:ocid1.instance.<var>unique_ID</var> -N ocid1.instanceconsoleconnection.<var>unique_ID</var>@instance-console.us-ashburn-1.oraclecloud.com \",     \"fingerprint\": \"00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:aa\",     \"id\": \"ocid1.instanceconsoleconnection.<var>unique_ID</var>\",     \"instanceId\": \"ocid1.instance.<var>unique_ID</var>\",     \"lifecycleState\": \"ACTIVE\", } ",
    "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.

400 Response

Bad Request

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.

Body ()

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."
        }
    }
}

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.

Body ()

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.

Body ()

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.

Body ()

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.

Body ()

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."
        }
    }
}

Back to Top