REST API - get

vstats resource addresses: get

Returns information about a specific Resource Address. 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-addrs/{id}

Path Parameters

Name	Type	Description
Required
id	string	Resource Address ID.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "id" : "obj-103",
    "resource_ids" : [
        {
            "predicate" : "EQUAL",
            "scheme" : "string",
            "type" : "string",
            "key" : "string",
            "id_value" : "string"
        },
        {
            "predicate" : "EQUAL",
            "scheme" : "string",
            "type" : "string",
            "key" : "string",
            "id_value" : "string"
        }
    ]
}

Headers:

None

Type:

Name	Type	Description
bold = required
-	info	Information about the desired Resource Address.
-.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.RsrcAddr`. 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.RsrcAddr`.
-.resource_ids	rsrc_id[]	List of Resource Identifiers. 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.
-.resource_ids[].key	string	Key relates to the corresponding ResourceIdDefinition of the related resource address schema. 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. Optional. When this field is unset, type field will be used.
-.resource_ids[].type	string	Type of the resource identified by the Resource Id. 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. Optional. When this field is unset, in current version the api will throw InvalidArgument error. To be made optional in future.
-.resource_ids[].id_value	string	The id value binding the related resource id definition. 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.
-.resource_ids[].predicate	string	Predicate to use to match resource Ids. 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. Optional. When this field is unset, default predicate is EQUAL.
-.resource_ids[].scheme	string	An optional designation of the scheme. 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. Optional. When this field is unset, default scheme is moid (ManagedObject Identifier).

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 Resource Address could not be located.
401	unauthenticated	if the user can not be authenticated.
403	unauthorized	if the user does not have sufficient privileges.