REST API - info

vstats endpoints: info

The info structure is the endpoint configuration that contains the information pertaining to an endpoint. It contains the authentication details specifying only username, data format supported at endpoint side, status of an endpoint and also number of acquisition specifications associated with this endpoint. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Representation:

JSON

{
    "port" : "string",
    "acqspec_count" : "string",
    "name" : "string",
    "push_data_format" : "string",
    "id" : "obj-103",
    "status_reason" : "string",
    "uri" : "string",
    "auth_data" : {
        "basic" : {
            "password" : "secret string",
            "username" : "string"
        },
        "token" : "secret string"
    },
    "status" : "ENABLED"
}

Attributes:

Name	Type	Description
Required
id	string	Endpoint identifier. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.vstats.model.Endpoint`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.vstats.model.Endpoint`.
uri	string	Designates the uniform resource identifier of an endpoint. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
name	string	Designates the endpoint name to identify an endpoint. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
auth_data.basic.username	string	Username to get access to endpoint. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
auth_data.basic.password	secret	Password to get access to endpoint. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
push_data_format	string	Designates the type of data format supported for stats data at endpoint. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
status	string	Endpoint status. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Describes the status of an endpoint. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: ENABLED: The endpoint is enabled when the endpoint is accessible. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. DISABLED: The endpoint is disabled when the endpoint is under maintenance during which it is inaccessible. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. INVALID: The endpoint is invalid when the endpoint details are invalid. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
acqspec_count	string	Count of acquisition specifications configured to this endpoint. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Optional
port	string	Designates the port of an endpoint. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, there is no port provided.
auth_data	auth_spec	Designates the authentication details of an endpoint. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset there is no authentication needed for the endpoint.
auth_data.basic	basic_auth	Basic authentication details of the endpoint. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. When unset the `token` field will be used.
auth_data.token	secret	Token based authentication information of the endpoint. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. When unset the `basic` field will be used.
status_reason	string	The reason explaining why the status of an endpoint is either DISABLED or INVALID. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, it means status is ENABLED.