APIs in Category: Api | API version 4.0

ApiProxy

NetApp Manage ONTAP API version 4.0

ApiProxy (supported) | [top]

> Proxy an API Request To a third party and return the API Response.

> Input Name | Type
> ApiProxy | ApiProxy
> Output Name | Type
> ApiProxyResult | ApiProxyResult

> Error Name | Description
> EACCESSDENIED |  |
> EAPIUNSUPPORTEDVERSION |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTFOUND |  |

Element definition: ApiProxy | [top]

> Proxy an API Request To a third party and return the API Response.

> Name | Type | Description
> Request | Request | The Request To be forwarded To another server.
> Target | xsd:string | The Target Host. May be a Hostname (qualified or unqualified), a Vfiler Name or a Host agent. If the Target is not resolved during a Capability check, EOBJECTAMBIGUOUS or EOBJECTNOTFOUND is returned.
> Timeout | xsd:integer optional | Number of seconds that the proxy server should wait for a Response before giving up.
> Username | xsd:string optional | User account To use for executing the API. If none is specified, the highest Privilege available will be attempted. The proxy server may have a security Policy that restricts the accepted Values for this field. Invalid Values will cause EACCESSDENIED.

Element definition: ApiProxyResult | [top]

> Name | Type | Description
> Response | Response | The Response From the other server.

Element definition: Request | [top]

> One API Request.

> Name | Type | Description
> Args | xsd:any optional | The API arguments.
> Name | xsd:string | API Name. The proxy server may have a security Policy that restricts the accepted Values for this field. Invalid Values will cause EACCESSDENIED.

Element definition: Response | [top]

> One API Response.

> Name | Type | Description
> Errno | xsd:integer optional | Error code. Only present if Status is "failed".
> Reason | xsd:string optional | Reason string. Only present if Status is "failed".
> Results | xsd:any optional | The API Results. Only present if Status is "passed".
> Status | xsd:string | Status of the Response. May be "passed" or "failed".