|
APIs in Category: api |
API version 3.6R2 |
api-proxy |
| api-proxy | [top] |
Proxy an API request to a third party and return the API response.
Input Name Range Type Description request request
The request to be forwarded to another server. target 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 integer
optional
Number of seconds that the proxy server should wait for a response before giving up. username 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. Output Name Range Type Description response response
The response from the other server.
Errno Description EINVALIDINPUTERROR EINTERNALERROR EACCESSDENIED EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| Element definition: request | [top] |
One API request.
Name Range Type Description args string
optional
The API arguments. name 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 Range Type Description errno integer
optional
Error code. Only present if status is "failed". reason string
optional
Reason string. Only present if status is "failed". results string
optional
The API results. Only present if status is "passed". status string
Status of the response. May be "passed" or "failed".