Obtención de la lista de archivos de un directorio especificado
Función
Esta API se utiliza para obtener la lista de archivos de un directorio especificado en un clúster MRS.
Restricciones
Ninguna
Depuración
Puede depurar esta API a través de la autenticación automática en API Explorer. API Explorer puede generar automáticamente código SDK de ejemplo y proporcionar la depuración de código SDK de ejemplo.
URI
- Formato
- Descripción de parámetro
Tabla 1 Parámetros de URI Parámetro
Obligatorio
Tipo
Descripción
project_id
Sí
String
El ID del proyecto. Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID de proyecto.
cluster_id
Sí
String
El ID del clúster. Para obtener más información acerca de cómo obtener el ID de clúster, consulte Obtención de un ID de clúster.
path
Sí
String
El directorio de archivos. Por ejemplo, para acceder a la lista de directorios /tmp/test, el valor debe ser un directorio. El URI global es el siguiente:
/v2/{project_id}/clusters/{cluster_id}/files?path=%2Ftmp%2Ftest
Un directorio de un solo nivel debe cumplir con las siguientes reglas:
- La ruta de acceso del directorio no se puede dejar en blanco.
- El valor no puede comenzar ni finalizar con un período (.).
- El valor no puede contener las siguientes characters: /:*?<>|\;&,'`!{}[]$%+
- El valor no puede exceder de 255 caracteres.
offset
No
String
El parámetro de paginación. La lista de archivos se consulta desde el desplazamiento. El valor predeterminado es 0.
limit
No
String
El parámetro de paginación, que indica el número máximo de registros en una página. El valor predeterminado es 100 y el valor máximo es 1000.
sort_key
No
String
La lista está ordenada por este atributo. El valor predeterminado es path_suffix. Se admiten los siguientes atributos:
- path_suffix: nombre de archivo o directorio
- length: tamaño de archivo
- modification_time: tiempo de modificación
order
No
String
El modo de clasificación de listas. Valores posibles:
- desc: Los archivos se muestran en orden descendente.
- asc: Los archivos se muestran en orden ascendente.
El valor predeterminado es desc.
Parámetros de solicitud
Parámetro de solicitud
Ninguna
Parámetros de respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
total_count |
Integer |
El número total de archivos, que es irrelevante para la paginación. |
files |
Array of FileStatusV2 objects |
La lista de archivos. Para obtener más información, consulte Tabla 3. |
Parámetro |
Tipo |
Descripción |
---|---|---|
path_suffix |
String |
La extensión de nombre de archivo en el directorio actual. Por ejemplo, si obtiene el archivo /tmp/test en el directorio /tmp, el valor de path_suffix es test. |
owner |
String |
El propietario del archivo. |
group |
String |
El grupo de propietarios de archivos. |
permission |
String |
La información de permiso. |
replication |
Integer |
El número de réplicas. |
block_size |
Integer |
El tamaño del bloque. |
length |
Integer |
La longitud del archivo. |
type |
String |
El tipo de archivo. Valores posibles:
|
children_num |
Integer |
El número de archivos en el directorio. |
access_time |
Long |
El tiempo de acceso al archivo. |
modification_time |
Long |
El tiempo de modificación del archivo. |
Ejemplo
- Solicitud de ejemplo
GET /v2/{project_id}/clusters/{cluster_id}/files?path={directory}&offset={offset}&limit={limit}&sort_key={sort_key}&order={order}
- Ejemplo de respuesta
- Ejemplo de una respuesta exitosa
{ "total_count": 2, "files": [ { "access_time": 0, "block_size": 0, "children_num": 0, "group": "hadoop", "length": 0, "modification_time": 1587179516623, "owner": "hdfs", "path_suffix": "app-logs", "permission": "777", "replication": 0, "type": "DIRECTORY" }, { "access_time": 1587267212761, "block_size": 134217728, "children_num": 0, "group": "hadoop", "length": 23666188, "modification_time": 1587222156003, "owner": "root", "path_suffix": "data-m-00000", "permission": "644", "replication": 3, "type": "FILE" } ] }
- Ejemplo de una respuesta exitosa
Códigos de estado
Consulte Códigos de estado.
Códigos de error
Consulte Códigos de error.