Skip to main content

Display HTTP proxy server, port, and IPspace information for an SVM or cluster IPspace

Contributors
PDFs

GET /network/http-proxy/{uuid}

Introduced In: 9.7

Displays the HTTP proxy server, port, and IPspace of the specified SVM or Cluster IPspace.

  • vserver http-proxy show

Parameters

Name Type In Required Description

uuid

string

path

True

HTTP proxy UUID

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

authentication_enabled

boolean

Specifies whether or not authentication with the HTTP proxy server is enabled.

ipspace

ipspace

Applies to both SVM and cluster-scoped objects. Either the UUID or name is supplied on input. This is mutually exclusive with SVM during POST and PATCH.

password

string

Password to authenticate with the HTTP proxy server when authentication_enabled is set to "true".

port

integer

The port number on which the HTTP proxy service is configured on the proxy server.

scope

string

Set to “svm” for HTTP proxy owned by an SVM. Otherwise, set to "cluster".

server

string

Fully qualified domain name (FQDN) or IP address of the HTTP proxy server.

svm

svm

This is mutually exclusive with IPspace during POST and PATCH.

username

string

Username to authenticate with the HTTP proxy server when authentication_enabled is set to "true".

uuid

string

The UUID that uniquely identifies the HTTP proxy.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "ipspace": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "exchange",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "port": 3128,
  "scope": "svm",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "uuid": "string"
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

ipspace

Applies to both SVM and cluster-scoped objects. Either the UUID or name is supplied on input. This is mutually exclusive with SVM during POST and PATCH.

Name Type Description

_links

_links

name

string

IPspace name

uuid

string

IPspace UUID

svm

This is mutually exclusive with IPspace during POST and PATCH.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.