Consulta de recursos por etiqueta
Función
Esta API se utiliza para consultar recursos por etiqueta. Los recursos se ordenan por la hora de creación, en orden descendente.
Autorización
Cada cuenta tiene todos los permisos necesarios para invocar todas las API, pero los usuarios de IAM deben tener los permisos requeridos específicamente asignados. Para conocer los permisos específicos requeridos, consulte Políticas de permisos y acciones admitidas.
URI
- POST /v3/sfs/tms/{project_id}/file-systems/resource-instances/filter
- Descripción del parámetro
Parámetro
Obligatorio
Tipo
Descripción
project_id
Sí
String
El ID del proyecto. Para obtener más información, consulte Obtención de un ID de proyecto.
limit
No
Int
Cantidad máxima de registros que se pueden consultar. El valor oscila entre 1 y 1000 y el valor predeterminado es 1000.
offset
No
Int
La ubicación del índice. La consulta comienza desde el siguiente registro de datos indexado por este parámetro. El valor predeterminado es 0, lo que indica que la consulta comienza desde el primer registro de datos. El valor no puede ser un número negativo.
Parámetros de solicitud
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| Content-type | Sí | String | El tipo MIME del cuerpo de la solicitud. Ejemplo: application/json |
| X-Auth-Token | No | String | El token de usuario. |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| without_any_tag | No | Boolean | Excluye cualquier etiqueta. Si este parámetro se establece en true, se consultan todos los recursos sin etiquetas. En este caso, el campo tags se ignora. Si este parámetro se establece en false o no se especifica, no tiene efecto, lo que significa que se devuelven todos los recursos o se filtran los recursos por tags o matches. |
| tags | No | List<tag> | Incluye etiquetas. Se pueden especificar 20 etiquetas como máximo. Las claves de etiquetas deben ser únicas. Cada clave de etiqueta puede tener un máximo de 20 valores de etiqueta. Un valor de etiqueta puede estar vacío, pero la estructura no puede faltar. Los valores de etiqueta de la misma clave deben ser únicos. La respuesta devuelve recursos que contienen todas las etiquetas de esta lista. Las claves de esta lista están en una relación AND, mientras que los valores de cada estructura clave-valor están en una relación OR. Si no se especifica este parámetro, se devolverán todos los recursos. Para obtener más detalles, consulte Tabla 3. |
| sys_tags | No | List<tag> | Incluye etiquetas del sistema. Este parámetro solo está disponible para los usuarios con el permiso op_service. No se puede utilizar con criterios de filtrado without_any_tag y tags al mismo tiempo. Actualmente, solo contiene una estructura de etiqueta. key: _sys_enterprise_project_id value: El ID de un proyecto de empresa. La clave contiene solo un valor. El valor 0 indica el proyecto de empresa predeterminado. Para obtener más detalles, consulte Tabla 3. |
| matches | No | List<match> | Los campos que se van a emparejar. La clave en match es un valor de diccionario fijo en resource_name, lo que significa que la búsqueda de prefijos se realiza en función del valor de la clave. Se ampliará posteriormente. Para obtener más detalles, consulte Tabla 4. |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| key | Sí | String | La clave de la etiqueta. Una clave de etiqueta puede contener un máximo de 128 caracteres. Puede contener letras, dígitos y espacios representables en UTF-8 y caracteres especiales (_.:=+-@). No puede comenzar ni finalizar con un espacio y no puede estar vacío. Las claves de etiqueta que comienzan con _sys_ son etiquetas del sistema y no puede comenzar una clave de etiqueta con _sys_. |
| values | Sí | List<String> | La lista de valores de etiquetas. El valor puede ser una matriz vacía, pero no puede dejarse en blanco. Si values es una matriz vacía, se consulta cualquier valor. Los valores están en la relación OR. |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| key | Sí | String | La clave. La clave está fija en resource_name actualmente. Otros valores de key estarán disponibles posteriormente. |
| value | Sí | String | El valor. Cada valor de etiqueta puede contener un máximo de 255 caracteres Unicode. El conjunto de caracteres no está verificado. |
Parámetros de respuesta
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| resources | Sí | List<resource> | La lista de recursos. Para obtener más detalles, consulte Tabla 6. |
| total_count | Sí | Integer | La cantidad total de registros. |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| resource_id | Sí | String | El ID del recurso. |
| resource_detail | Sí | Object | Los detalles del recurso. Se deja en blanco por defecto. El valor es un objeto de recurso utilizado para la extensión. |
| tags | Sí | List<resource_tag> | La lista de etiquetas. Si no hay ninguna etiqueta, se utiliza una matriz vacía de forma predeterminada. Para obtener más detalles, consulte Tabla 3. |
| sys_tags | No | List<resource_tag> | Este parámetro solo está disponible para los usuarios con el permiso op_service. Actualmente, solo contiene una estructura de resource_tag. key: _sys_enterprise_project_id value: El ID del proyecto de empresa. El valor 0 indica el proyecto de empresa predeterminado. Para obtener más detalles, consulte Tabla 3. |
| resource_name | Sí | String | El nombre del recurso. Este parámetro es una cadena vacía si no hay un nombre de recurso. |
Ejemplo de solicitud
Listado de recursos (con el ID del proyecto establecido en c80a2157ba1d46c0825265947342077c, el offset en 0 y el límite en 10):
POST https://{endpoint}/v3/sfs/tms/c80a2157ba1d46c0825265947342077c/file-systems/resource-instances/filter?limit=10&offset=0 Ejemplo de cuerpo de solicitud:
{
"tags":[
{
"key":"key1",
"values":[
"value1",
"value2"
]
},
{
"key":"key2",
"values":[
"value1",
"value2"
]
}
],
"matches":[
{
"key":"resource_name",
"value":"resource1"
}
],
"without_any_tag":"false"
} Ejemplo de respuesta
{
"resources":[
{
"resource_detail":"",
"resource_id":"resource1",
"resource_name":"resource1",
"tags":[
{
"key":"key1",
"value":"value1"
}
],
"sys_tags":[]
}
],
"total_count":1
} Códigos de estado
- Normal
| Código de estado | Descripción |
|---|---|
| 200 | Los recursos se enumeran. |
- Anormal
| Código de estado | Descripción |
|---|---|
| 400 | Parámetro de etiqueta no válido. |
| 401 | Error de certificación. |
| 403 | Error de autenticación. |
| 404 | Recurso no encontrado. |
| 500 | Error del sistema. |