REST API - get

vstats resource address schemas: get

Returns information about a specific resource address schema. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Request:

HTTP request

GET https://{server}/api/stats/rsrc-addr-schemas/{id}

Path Parameters

Name	Type	Description
Required
id	string	Resource address schema identifier.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "schema" : [
        {
            "query_options" : "EQUAL",
            "type" : "obj-103",
            "key" : "string"
        },
        {
            "query_options" : "EQUAL",
            "type" : "obj-103",
            "key" : "string"
        }
    ],
    "id" : "obj-103"
}

Headers:

None

Type:

Name	Type	Description
bold = required
-	info	Information about the desired resource address schema.
-.id	string	Identifier. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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.RsrcAddrSchema`. 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.RsrcAddrSchema`.
-.schema	resource_id_definition[]	List of vstats.resource_address_schemas.resource_id_definitions. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
-.schema[].key	string	Designates a semantic key for the resource identifier. This could be "vm" for virtual machine whose CPU usage is metered or "source" to identify the virtual machine that is origin of measured network traffic. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
-.schema[].type	string	Type of the resource. This represents various entities for which statistical data is gathered such as virtual machines, containers, servers, disks etc. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. 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.RsrcType`. 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.RsrcType`.
-.schema[].query_options	string	Designates the supported query-options. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Declares which predicates are supported by the `resource_id_definition`. Warning: This enumeration is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Value is one of: EQUAL: Equal. Warning: This constant is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. EQUAL_ALL: Supports both Equality and Aggregation. Warning: This constant is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Errors:

HTTP Status Code	Type	Description
500	error	if the system reports an error while responding to the request.
400	invalid_argument	if `id` is invalid.
404	not_found	if RsrcAddrSchema could not be located.
401	unauthenticated	if the user can not be authenticated.
403	unauthorized	if the user does not have sufficient privileges.