Enumerar todos los derechos
GET /accounts/{account_id}/core/v1/entitlements
Devuelve una matriz JSON de todos los recursos coincidentes de la colección. Si se especifican campos individuales en la solicitud, la matriz JSON de elementos contendrá los campos solicitados para cada recurso coincidente en el orden especificado.
Parámetros
| Nombre | Tipo | En | Obligatorio | Descripción |
|---|---|---|---|---|
account_id |
cadena |
ruta |
Verdadero |
ID del recurso de cuenta que lo contiene
|
incluya |
cadena |
consulta |
Falso |
Indica qué campos deben devolverse al listar una colección. Ejemplos de URL: "include=id", "include=id,name" Ejemplos OpenAPI: "id"
|
límite |
cadena |
consulta |
Falso |
Indica el número máximo de recursos a devolver al listar una colección. Ejemplos de URL: "limit=2" Ejemplos OpenAPI: "2" |
filtro |
cadena |
consulta |
Falso |
Indica qué campos deben coincidir para devolver un recurso al listar una colección. Los operadores admitidos son:
Ejemplo de URL: "filter=field%20eq%20%27value%27" Ejemplos OpenAPI: "field eq 'value'" |
OrderBy |
cadena |
consulta |
Falso |
Indica el orden de clasificación de los recursos al listar una colección. Ejemplos de URL: "orderBy=name", "orderBy=name%20desc" Ejemplos OpenAPI: "name desc" |
omitir |
cadena |
consulta |
Falso |
Indica el número de recursos que deben omitirse al listar una colección. Ejemplos de URL: "skip=1" Ejemplos OpenAPI: "1" |
cuente |
cadena |
consulta |
Falso |
Indica si se debe devolver el número total de recursos en el objeto de metadatos. Ejemplos de URL: "count=true" Ejemplos de OpenAPI: "true" |
continuar |
consulta |
Falso |
Indica el token desde el que reanudar el listado. Ejemplos de URL: "continue= Ejemplos OpenAPI: " |
Respuesta
Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
artículos |
array[Cualquiera de: "entitlement_1.0_get_response_body", array[]] |
Verdadero |
|
metadatos |
Verdadero |
Ejemplo de respuesta
{
"type": "application/astra-entitlements",
"version": "1.0",
"items": [
[
"Astra SDS",
"capacity",
"2",
null
],
[
"Astra Enterprise",
"clusters",
"100",
"5e9fe8f7-4c54-441c-ac94-fd8451f9ca38"
]
],
"metadata": {
"labels": [],
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
}
}
Respuesta
Status: 401, Unauthorized
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Respuesta
Status: 400, Bad request
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
|
invalidParams |
array["invalidParams"] |
Falso |
Lista de parámetros de consulta no válidos |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Respuesta
Status: 403, Forbidden
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Error
Status: 404, Not found
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
Ejemplo de respuesta de error
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
Definiciones
Ver definiciones
etiqueta_tipo_astra
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
nombre |
cadena |
Verdadero |
|
valor |
cadena |
Verdadero |
tipo_astra_metadatos
Metadatos especificados por el cliente y el servicio asociados al recurso. Los valores definidos son:
-
Cumple con el esquema de metadatos Astra
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
etiquetas |
array["etiqueta_tipo_astra"] |
Verdadero |
|
CreationTimestamp |
cadena |
Verdadero |
|
Modificación.Marca de hora |
cadena |
Verdadero |
|
CreatedBy |
cadena |
Verdadero |
|
modifiedBy |
cadena |
Falso |
entitlement_1.0_get_response_body
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
Tipo de medio del recurso. Los valores definidos son:
|
versión |
cadena |
Verdadero |
Versión del recurso. Los valores definidos son:
|
id |
cadena |
Verdadero |
Identificador único global del recurso. Los valores definidos son:
|
asignación |
cadena |
Falso |
Cadena JSON que contiene el ID del objeto al que se asigna el derecho. Solo está presente cuando se asigna el derecho. Contenido de cadena no validado por el esquema. |
producto |
cadena |
Falso |
Cadena JSON que contiene la cadena del producto extraída de la licencia o suscripción. Contenido de cadena no validado por el esquema. |
productVersion |
cadena |
Falso |
Cadena JSON que contiene la cadena de versión extraída de la licencia o suscripción. Contenido de cadena no validado por el esquema. |
entitlementType |
cadena |
Verdadero |
Cadena JSON que contiene el tipo de derecho. Se extrae de la licencia o suscripción. Contenido de cadena no validado por el esquema. |
entitlementValue |
cadena |
Verdadero |
Cadena JSON que contiene la capacidad asociada con el entitlement. Contenido de cadena no validado por el esquema. |
entitlementConsumption |
cadena |
Falso |
Cadena JSON que contiene la cantidad de capacidad asociada con la asignación de derechos que está actualmente en uso. Contenido de cadena no validado por el esquema. |
sourceLicense |
cadena |
Falso |
Cadena JSON que contiene el ID del objeto de licencia del que procede el derecho. Los valores definidos son:
|
sourceSubscription |
cadena |
Falso |
Cadena JSON que contiene el ID del objeto de suscripción del que procede el derecho. Los valores definidos son:
|
validFromTimestamp |
cadena |
Falso |
Cadena JSON que contiene una marca de tiempo que indica cuándo el derecho se vuelve válido. Los valores definidos son:
|
validUntilTimestamp |
cadena |
Falso |
Cadena JSON que contiene una marca de tiempo que indica cuándo deja de ser válido el entitlement. Los valores definidos son:
|
metadatos |
Verdadero |
Metadatos especificados por el cliente y el servicio asociados al recurso. Los valores definidos son:
|
type_astra_metadata_list
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
continuar |
cadena |
Falso |
|
cuente |
número |
Falso |
|
etiquetas |
array["etiqueta_tipo_astra"] |
Falso |
|
CreationTimestamp |
cadena |
Falso |
|
Modificación.Marca de hora |
cadena |
Falso |
|
CreatedBy |
cadena |
Falso |
|
modifiedBy |
cadena |
Falso |
invalidParams
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
nombre |
cadena |
Verdadero |
Nombre del parámetro de consulta no válido |
motivo |
cadena |
Verdadero |
Razón por la que el parámetro de consulta no es válido |