Vcenter NamespaceManagement Storage Profiles check

Vcenter NamespaceManagement Storage Profiles check

Returns the compatible management storage profiles for enabling a WCP Supervisor across a given set of zones. A storage profile is compatible if it results in at least one datastore in each of the specified zones.

This operation was added in vSphere API 8.0.0.1.

Request
URI
POST
https://{api_host}/api/vcenter/namespace-management/storage/profiles?action=check_compatibility
COPY
Request Body

Specification of the zones to consider when finding compatible storage profiles. The Vcenter NamespaceManagement Storage Profiles FilterSpec must contain at least 1 zone.

Vcenter NamespaceManagement Storage Profiles FilterSpec of type(s) application/json
Required

Show optional properties

{
    "zones": [
        {}
    ]
}
{
    "zones": [
        "string"
    ]
}
array of string
zones
Required

Zone compatibility criteria. The common storage profiles across the given zones will be returned. A storage profile is considered compatible if it results in at least one datastore in each of the given zones.

This property was added in vSphere API 8.0.0.1.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.consumption_domains.Zone. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.consumption_domains.Zone.

Authentication
This operation uses the following authentication methods.
Responses
200

List of storage profiles compatible across the given Vcenter NamespaceManagement Storage Profiles FilterSpec. The profiles returned will each result in at least one datastore in each zone.

[
    "Vcenter NamespaceManagement Storage Profiles Summary Object"
]
array of Vcenter NamespaceManagement Storage Profiles Summary
Optional

400

if one or more fields of the Vcenter NamespaceManagement Storage Profiles FilterSpec is incorrect.

Returns Vapi Std Errors InvalidArgument of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors InvalidArgument0 
"Vapi Std Errors InvalidArgument Object"

401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0 
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


403

if the user does not have System.Read privilege on all of the Cluster Compute Resources in the specified vSphere Zones.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0 
"Vapi Std Errors Unauthorized Object"

500

if the system reports an error while responding to the request.

Returns Vapi Std Errors Error of type(s) application/json 
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"zones":["string"]}' https://{api_host}/api/vcenter/namespace-management/storage/profiles?action=check_compatibility
On This Page
Vcenter Namespace Management Operations
POST
Vcenter NamespaceManagement Storage Profiles check