Get Resource Address Schemas

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

URL

GET

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

Path Parameters

Required	Parameter Name	Type	Description
required	id	string	Resource address schema identifier.

Response

Response Body

200 OK returns ResourceAddressSchemasInfo of type application/json

Information about the desired resource address schema.

{
    "id": "string",
    "schema": [
        {
            "key": "string",
            "query_options": "enum",
            "type": "string"
        }
    ]
}

Property Name	Type	Description
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	array of ResourceAddressSchemasResourceIdDefinition	List of ResourceAddressSchemas.ResourceIdDefinitions. 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.

Errors

Code	Returns	Description
400	Error	com.vmware.vapi.std.errors.invalid_argument : if id is invalid.
401	Error	com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. \| com.vmware.vapi.std.errors.unauthorized : if the user does not have sufficient privileges.
404	Error	com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. \| com.vmware.vapi.std.errors.not_found : if RsrcAddrSchema could not be located.
default	Error	Not available