REST API - probe

probe_result

The probe_result structure defines the subscription information probe result. This describes whether using a given subscription URL is successful or if there are access problems, such as SSL errors.

Representations:

JSON
XML

{
    "error_messages": [
        {
            "args": [
                "string",
                "string"
            ],
            "default_message": "string",
            "id": "string"
        },
        {
            "args": [
                "string",
                "string"
            ],
            "default_message": "string",
            "id": "string"
        }
    ],
    "ssl_thumbprint": "string",
    "status": "SUCCESS"
}

<?xml version="1.0" ?>
<ns0:ProbeResult xmlns:ns0="http://vmware.com/content/subscribed_library" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ssl_thumbprint>string</ssl_thumbprint>
  <status>SUCCESS</status>
  <error_messages-array>
    <array-item>
      <default_message>string</default_message>
      <id>string</id>
      <args-array>
        <array-item>string</array-item>
        <array-item>string</array-item>
      </args-array>
    </array-item>
    <array-item>
      <default_message>string</default_message>
      <id>string</id>
      <args-array>
        <array-item>string</array-item>
        <array-item>string</array-item>
      </args-array>
    </array-item>
  </error_messages-array>
</ns0:ProbeResult>

Attributes:

Name	Type	Required	Description
status *	com.vmware.content.subscribed_library.probe_result.status	Yes	The status of probe result. This will be one of `SUCCESS`, `INVALID_URL`, `TIMED_OUT`, `HOST_NOT_FOUND`, `RESOURCE_NOT_FOUND`, `INVALID_CREDENTIALS`, `CERTIFICATE_ERROR`, `UNKNOWN_ERROR`. The `status` enumerated type defines the error status constants for the probe result. Values one of SUCCESS: Indicates that the probe was successful. INVALID_URL: Indicates that the supplied URL was not valid. TIMED_OUT: Indicates that the probe timed out while attempting to connect to the URL. HOST_NOT_FOUND: Indicates that the host in the URL could not be found. RESOURCE_NOT_FOUND: Indicates that the given resource at the URL was not found. INVALID_CREDENTIALS: Indicates that the connection was rejected due to invalid credentials. CERTIFICATE_ERROR: Indicates that the provided server certificate thumbprint in com.vmware.content.library.subscription_info.ssl_thumbprint is invalid. In this case, the returned #sslThumbprint should be set in com.vmware.content.library.subscription_info.ssl_thumbprint. UNKNOWN_ERROR: Indicates an unspecified error different from the other error cases defined in com.vmware.content.subscribed_library.probe_result.status.
ssl_thumbprint	string	No. An SSL thumbprint is only returned if the host is secured with SSL/TLS.	The SSL thumbprint for the remote endpoint.
error_messages *	List<localizable_message>	Yes	If the probe result is in an error status, this field will contain the detailed error messages.

com.vmware.content.subscribed_library

probe_result