Consulta de recursos por etiqueta
Función
Esta API se utiliza para consultar recursos por etiqueta.
URI
POST /v3/{domain_id}/ccaas/{resource_type}/resource-instances/action
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
domain_id |
Sí |
String |
ID de cuenta. Mínimo: 10 Máximo: 32 |
resource_type |
Sí |
String |
Tipo de recurso.
|
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
No |
String |
Token de usuario. Mínimo: 0 Máximo: 102400 |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
action |
No |
String |
La acción.
|
limit |
No |
Integer |
Máximo de registros que se pueden mostrar en una página. Mínimo: 1 Máximo 1000 |
offset |
No |
Integer |
Offset del resultado de la consulta. Mínimo: 0 Máximo: 999 |
tags |
No |
Array of AggTag objects |
Si están contenidas las siguientes etiquetas. (Si hay varias claves, se utiliza la relación AND. Si hay varios valores, se utiliza la relación OR.) |
matches |
No |
Array of Tag objects |
Si debe coincidir con las siguientes etiquetas. La clave debe ser resource_name. Si el valor tiene un valor, se utiliza la coincidencia difusa. Si el valor es una string vacía, se utiliza la coincidencia exacta. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
resources |
Array of FilterTagResource objects |
Lista de recursos. |
request_id |
String |
ID de solicitud. Mínimo: 0 Máximo: 36 |
total_count |
Integer |
Número total de recursos que cumplen los criterios de consulta. Mínimo: 0 Máximo: 2000 |
Parámetro |
Tipo |
Descripción |
---|---|---|
resource_id |
String |
ID del recurso. Mínimo: 0 Máximo: 36 |
resource_name |
String |
Nombre del recurso. Mínimo: 0 Máximo: 64 |
resource_detail |
String |
Detalles del recurso. Mínimo: 0 Máximo: 255 |
tags |
Array of Tag objects |
Etiquetas agregadas para un recurso. |
Ejemplo de las solicitudes
- Ejemplo de solicitud con action establecido en filter
POST https://{cc_endpoint}/v3/{domain_id}/ccaas/{resource_type}/resource-instances/action { "offset" : "0", "limit" : "100", "action" : "filter", "matches" : [ { "key" : "resource_name", "value" : "resource1" } ], "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ] }
- Ejemplo de solicitud con action establecido en count
POST https://{cc_endpoint}/v3/{domain_id}/ccaas/cloud-connection/resource-instances/action { "action" : "count", "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "value2" ] } ], "matches" : [ { "key" : "resource_name", "value" : "resource1" } ] }
Ejemplo de las respuestas
Código de estado: 200
Se encuentran los recursos.
{ "resources" : [ { "resource_detail" : null, "resource_id" : "cdfs_cefs_wesas_12_dsad", "resource_name" : "resouece1", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value1" } ] } ], "request_id" : "XXX", "total_count" : 1000 }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Se encuentran los recursos. |
400 |
Valor demoId no válido |
Códigos de error
Consulte Códigos de error.