Get storage class configuration by id | NVIDIA Run:ai Documentation

{
  "id": "string",
  "tenantId": 1001,
  "scopeType": "cluster",
  "scopeId": "string",
  "name": "Standard",
  "permissions": {
    "allowedForAssets": true,
    "allowedForWorkloads": true,
    "allowedForEphemeralVolumes": true,
    "allowedForPersistentVolumes": true,
    "allowDataSharing": true
  },
  "customization": {
    "accessMode": {
      "required": true,
      "default": {
        "readWriteOnce": true,
        "readOnlyMany": false,
        "readWriteMany": false
      },
      "supportedValues": {
        "readWriteOnce": true,
        "readOnlyMany": true,
        "readWriteMany": true
      }
    },
    "volumeMode": {
      "required": true,
      "default": "Filesystem",
      "supportedValues": {
        "filesystem": true,
        "block": true
      }
    },
    "claimSize": {
      "default": "1G",
      "supportedUnits": [
        "MB"
      ],
      "min": "1G",
      "max": "1G",
      "step": "1G"
    },
    "attributes": [
      {
        "key": "dnsname",
        "format": "text",
        "display": "DNS Name",
        "description": "The host name of the DNS",
        "placeholder": "enter hostname or IP address",
        "required": "true",
        "defaultValue": "my.dns.com",
        "validationRegexp": "^[a-zA-Z0-9.-_]+$",
        "minValue": 100,
        "maxValue": 200,
        "step": 5,
        "validationError": "Invalid URL"
      }
    ]
  }
}

Retrieves a specific storage class configuration by its unique identifier. Use this endpoint to view detailed information about the configuration, including its permissions and customization options.

Authentication

AuthorizationBearer

Bearer authentication

Path parameters

idstringRequired

unique identifier of the storage class configuration

Query parameters

tenantIdintegerOptional

Response

Storage class configuration

idstringformat: "uuid"

The unique identifier of the storage class configuration.

tenantIdinteger

The id of the tenant.

scopeTypeenumDefaults to cluster

Currently supported value: ‘cluster’, which is also the default.

Allowed values:

scopeIdstringformat: "uuid"

The ID of the cluster.

namestring

The name of the storage class to which the configuration applies.

permissionsobjectOptional

Defines the access permissions and behavioral rules for this storage class.

customizationobjectOptional

Optional UI/policy controls that define defaults and requirements when creating PVCs with this storage class.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error