Algunas solicitudes pueden incluir parámetros de consulta opcionales que seleccionan qué datos se devuelven o sobre qué datos se realizan operaciones. En esta sección, se documentan los parámetros de consulta que pueden ser utilizados por más de un tipo de recurso. Consulte la documentación de cada recurso para conocer los parámetros de consulta específicos de ese recurso y los usos especializados de los parámetros de consulta que se describen en esta sección.
|
El parámetro de consulta props muestra los valores de metadatos de propiedad. Cuando se usa props=true con operaciones que de otro modo cambiarían datos o crearían nuevos datos, se muestran propiedades y metadatos, y la operación no se realiza. Esto le permite mostrar valores de datos actuales que pueden ayudarlo a modificar o crear el recurso.
|
El parámetro de consulta start puede ser un número de índice de objeto o una hora.
Especifica un número de índice de objeto para devolver una lista que incluya el objeto seleccionado por ese índice y los objetos más antiguos que se crearon después de que se creó el objeto especificado.
Especifica una hora UTC para devolver una lista de los objetos o datos más antiguos que se crearon en la hora especificada o después de esa hora. Algunos recursos no admiten valores de tiempo para el parámetro de consulta start.
Los valores de tiempo deben expresarse en hora UTC en el formato que se muestra en la siguiente tabla.
|
Consulte las siguientes secciones para ver ejemplos que utilizan el parámetro de consulta start:
El parámetro de consulta end puede ser un número de índice de objeto o una hora.
Especifica un número de índice de objeto para devolver una lista que incluya el objeto seleccionado por ese índice y los objetos más recientes que se crearon antes de la creación del objeto especificado.
Especifica una hora UTC para devolver una lista de los objetos o datos más recientes que se crearon en la hora especificada o antes de esa hora.
Los valores de tiempo deben expresarse en hora UTC en el formato %Y-%m-%dT%H:%M:%SZ.
Para ver un ejemplo del uso del parámetro de consulta end, consulte Enumerar copias de seguridad en la nube.
El parámetro de consulta limit especifica el número máximo de elementos que se devolverán.
Cuando los parámetros start y end no se especifican, limit=n devuelve los n elementos más recientes.
El parámetro de consulta depth especifica el nivel de detalle de una lista de recursos devuelta, donde un valor de profundidad más alto devuelve más detalles, como se muestra en la siguiente tabla.
|
Solicitud de ejemplo para una lista de usuarios que utilizan el parámetro de consulta depth:
GET /api/user/v1/users?depth=2 HTTP/1.1 Host: zfs-storage.example.com:215 X-Auth-User: root X-Auth-Key: password-xxx
Ejemplo de respuesta:
Los usuarios adicionales se omiten por motivos de brevedad.
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1558
X-Zfssa-Access-Api: 1.0
{
"users": [
{
"name": "root",
...
},
{
"name": "firstlast",
"properties": {
"logname": "firstlast",
"type": "directory",
"uid": uid,
"fullname": "First Last",
"require_annotation": false,
"roles": [
"basic"
],
"kiosk_mode": false,
"kiosk_screen": "status/dashboard"
},
"children": [
{
"name": "exceptions",
"properties": {},
"children": [],
"list": [
{
"name": "auth-000",
"properties": {
"scope": "ad",
"name": "*",
"allow_domain": true,
"allow_workgroup": false
},
"children": [],
"list": []
},
{
"name": "auth-001",
"properties": {
"scope": "alert",
"allow_configure": true,
"allow_post": true
},
"children": [],
"list": []
}
]
},
{
"name": "preferences",
"properties": {
"locale": "C",
"login_screen": "configuration/preferences",
"session_timeout": 15,
"cli_idle_timeout": "infinite",
"advanced_analytics": false
},
"children": [
{
"name": "keys",
"properties": {},
"children": [],
"list": []
},
{
"name": "tokens",
"properties": {},
"children": [],
"list": []
}
],
"list": []
}
],
"list": [],
"href": "/api/user/v1/users/firstlast"
},
{
...
}
]
}
El parámetro de consulta matchproperty-name=value devuelve una lista de recursos que tienen el nombre de propiedad especificado en el valor especificado.
El siguiente ejemplo devuelve la lista de usuarios para los cuales el valor de la propiedad kiosk_mode es true:
match_kiosk_mode=true
En el siguiente ejemplo, se devuelve la lista de usuarios para los cuales el valor de la propiedad roles contiene super y el valor de la propiedad require_annotation es true:
match_roles='*super*'&match_require_annotation=true