Consulta de recursos por etiqueta
Función
Esta API se utiliza para consultar recursos como los gateway virtuales y las interfaces virtuales por etiqueta.
URI
POST /v3/{project_id}/{resource_type}/resource-instances/action
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
project_id |
Sí |
String |
Especifica el ID del proyecto. |
resource_type |
Sí |
String |
Especifica el tipo de recurso de Direct Connect.
Valores de enumeración:
|
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
offset |
No |
String |
Especifica la posición del índice. La consulta comienza desde el siguiente registro de datos indexado por este parámetro. No es necesario especificar este parámetro cuando consulta recursos en la primera página. Cuando consulte recursos en páginas posteriores, establezca este parámetro en el valor devuelto en el cuerpo de la respuesta de la consulta anterior. Este parámetro no está disponible cuando action se establece en count. Si action se establece en filter, el valor debe ser un número y el valor predeterminado es 0. El valor no puede ser un número negativo. |
limit |
No |
String |
Especifica el número de registros que se van a consultar. Este parámetro no está disponible cuando action se establece en count. Si action se establece en filter, el valor predeterminado es 1000. El valor máximo es de 1000 y el valor mínimo de 1. El valor no puede ser un número negativo. |
action |
Sí |
String |
Especifica la operación que se va a realizar, que solo puede ser filter (filtrar) o count (consultar el número total). filter indica la consulta de paginación. count indica que se devolverá el número total de resultados de consulta que cumplan los criterios de búsqueda. No se permite devolver otros campos. Valores de enumeración:
|
matches |
No |
Array of Match objects |
Especifica el criterio de búsqueda. key es el campo que corresponde, por ejemplo, a resource_name. value indica el valor que se va a hacer coincidir. Este campo es un valor de diccionario fijo. Determine si la coincidencia difusa es necesaria en función de diferentes campos. Por ejemplo, si key es resource_name, se utiliza la búsqueda difusa (sin distinción entre mayúsculas y minúsculas) de forma predeterminada. Si value es una string vacía, se utiliza la coincidencia exacta. Si key es resource_id, se utiliza la coincidencia exacta. Actualmente, solo se admite resource_name. |
not_tags |
No |
Array of Tags objects |
Especifica las etiquetas que no se incluyen. Cada etiqueta contiene un máximo de 10 claves, y cada clave contiene un máximo de 10 valores. El cuerpo de la estructura no puede faltar y la clave no se puede dejar en blanco o establecer una string vacía. Las claves deben ser únicas y los valores de una clave deben ser únicos. Los recursos no identificados por diferentes claves están en relación AND, y los valores en una etiqueta están en relación OR. Si no se especifica ninguna condición de filtrado, se devuelven los datos completos. |
tags |
No |
Array of Tags objects |
Especifica las etiquetas que se incluyen. Cada etiqueta contiene un máximo de 10 claves, y cada clave contiene un máximo de 10 valores. El cuerpo de la estructura no puede faltar y la clave no se puede dejar en blanco o establecer una string vacía. Las claves deben ser únicas y los valores de una clave deben ser únicos. Los recursos identificados por diferentes claves están en relación AND, y los valores en una etiqueta están en relación OR. Si no se especifica ningún criterio de filtrado de etiquetas, se devuelven los datos completos. |
tags_any |
No |
Array of Tags objects |
Especifica cualquier etiqueta que se incluya. Cada etiqueta contiene un máximo de 10 claves, y cada clave contiene un máximo de 10 valores. El cuerpo de la estructura no puede faltar y la clave no se puede dejar en blanco o establecer una string vacía. Las claves deben ser únicas y los valores de una clave deben ser únicos. Los recursos identificados por diferentes claves están en relación OR, y los valores en una etiqueta están en relación OR. Si no se especifica ninguna condición de filtrado, se devuelven los datos completos. |
not_tags_any |
No |
Array of Tags objects |
Especifica cualquier etiqueta que no esté incluida. Cada etiqueta contiene un máximo de 10 claves, y cada clave contiene un máximo de 10 valores. El cuerpo de la estructura no puede faltar y la clave no se puede dejar en blanco o establecer una string vacía. Las claves deben ser únicas y los valores de una clave deben ser únicos. Los recursos no identificados por diferentes claves están en relación OR, y los valores en una etiqueta están en relación OR. Si no se especifica ninguna condición de filtrado, se devuelven los datos completos. |
sys_tags |
No |
Array of Tags objects |
Solo los usuarios con el permiso op_service pueden usar este campo para filtrar recursos. Solo una estructura de etiquetas está contenida cuando esta API es invocada por Tag Management Service (TMS). key es _sys_enterprise_project_id y value es la lista de ID del proyecto empresarial. Cuando TMS invoca esta API, una clave solo puede tener un valor. 0 indica el proyecto de empresa predeterminado. sys_tags y las condiciones de filtrado de etiquetas de tenant (without_any_tag, tags, tags_any, not_tags y not_tags_any) no se pueden usar al mismo tiempo. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
key |
Sí |
String |
Especifica la clave de etiqueta. El valor puede ser dc-directconnect, dc-vgw o dc-vif. |
value |
Sí |
String |
Especifica el valor de etiqueta. Cada valor puede contener un máximo de 255 caracteres de Unicode. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
key |
Sí |
String |
Especifica la clave de etiqueta. Cada clave de etiqueta puede contener un máximo de 127 caracteres de Unicode. Debe especificarse key. |
values |
Sí |
Array of strings |
Especifica la lista de valores de etiqueta. Cada valor puede contener un máximo de 255 caracteres de Unicode. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
|---|---|---|
resources |
Array of Resource objects |
Especifica la lista de recursos. |
total_count |
Integer |
Especifica el número total de registros. |
request_id |
String |
Especifica el ID de la solicitud. |
Parámetro |
Tipo |
Descripción |
|---|---|---|
resource_detail |
Object |
Especifica los detalles del recurso. |
resource_id |
String |
Especifica el ID del recurso. |
resource_name |
String |
Especifica el nombre del recurso. Este parámetro es una string vacía de forma predeterminada si no hay un nombre de recurso. |
tags |
Array of Tag objects |
Especifica la lista de etiquetas consultadas. Si no hay ninguna etiqueta coincidente, se devuelve un array vacío. |
sys_tags |
Array of Tag objects |
Especifica la lista de etiquetas consultadas. Si no hay ninguna etiqueta coincidente, se devuelve un array vacío. |
Parámetro |
Tipo |
Descripción |
|---|---|---|
key |
String |
Especifica la clave de etiqueta. La clave puede contener un máximo de 36 caracteres de Unicode, incluidos letras, dígitos, guiones (-) y guiones bajos (_). Mínimo: 0 Máximo: 36 |
value |
String |
Especifica el valor de etiqueta. El valor puede contener un máximo de 43 caracteres de Unicode, incluidos letras, dígitos, guiones (-), guiones bajos (_), y puntos (.). Mínimo: 0 Máximo: 43 |
Ejemplo de las solicitudes
- Solicitar el cuerpo cuando action se establece como filter
https://{endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/dc-vgw/resource-instances/action { "offset" : "10", "limit" : "10", "action" : "filter", "matches" : [ { "key" : "resource_name", "value" : "resource1" } ], "not_tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "not_tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ] } - Solicitar el cuerpo cuando action se establece en count
https://{endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/dc-vgw/resource_instances/action { "action" : "count", "not_tags" : [ { "key" : "key1", "values" : [ "value1", "*value2" ] } ], "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "value2" ] } ], "tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "not_tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "values" : [ "5aa119a8-d25b-45a7-8d1b-88e127885635" ] } ], "matches" : [ { "key" : "resource_name", "value" : "resource1" } ] }
Ejemplo de las respuestas
Código de estado: 200
Operación realizada correctamente.
{
"resources" : [ ],
"total_count" : 0,
"request_id" : "9a4f4dfc4fb2fc101e65bba07d908535"
}
Códigos de estado
Código de estado |
Descripción |
|---|---|
200 |
Operación realizada correctamente. |
Códigos de error
Consulte Códigos de error.
