vstats resource addresses: list result
The vstats.resource_addresses.list_result structure contains fields used to return the resource addresses. Warning: This structure 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.
Representation:
{
"next" : "string",
"rsrc_addrs" : [
{
"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"
}
]
},
{
"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"
}
]
}
]
}
"next" : "string",
"rsrc_addrs" : [
{
"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"
}
]
},
{
"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"
}
]
}
]
}
Attributes:
Name | Type | Description |
---|---|---|
Required | ||
rsrc_addrs | info[] | List of Resource Addresses received. 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. |
rsrc_addrs[].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 . |
rsrc_addrs[].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. |
rsrc_addrs[].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. |
Optional | ||
rsrc_addrs[].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. |
rsrc_addrs[].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. |
rsrc_addrs[].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. |
rsrc_addrs[].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). |
next | string | Used to retrieve paged data for larger result sets. Token is generated by server. The value of this field should be supplied in a subsequent call to list operation. 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. unset when there are no more pages of data to be retrieved. |