Consulta de etiquetas de proyecto
Función
Esta API se utiliza para consultar todas las etiquetas de instancias de un proyecto específico. Antes de invocar a esta API:
- Aprender cómo autorizar y autenticarla.
- Obtener los región y punto de conexión requeridos.
URI
GET /v3/{project_id}/tags
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID de proyecto de un tenant en una región. Para obtener este valor, consulte Obtención de un ID de proyecto. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
offset |
No |
Integer |
Desplazamiento de índice. Si offset se establece en N, la consulta de recursos comienza desde el dato N+1. El valor es 0 de forma predeterminada, lo que indica que la consulta comienza desde el primer dato. El valor no puede ser un número negativo. |
limit |
No |
Integer |
Número de registros a consultar. El valor predeterminado es 100. El valor debe ser un número positivo entero. El valor mínimo es de 1 y el valor máximo de 100. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. |
X-Language |
No |
String |
Idioma. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
total_count |
Integer |
Número total de registros. |
tags |
Array of ProjectTagItem objects |
Lista de etiquetas. |
Parámetro |
Tipo |
Descripción |
---|---|---|
key |
String |
Clave de etiqueta. |
values |
Array of strings |
Valor de etiqueta. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Solicitud de ejemplo
Consulta de etiquetas en un proyecto especificado
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/tags?offset=0&limit=2
Ejemplo de respuesta
Código de estado: 200
Success.
{ "total_count" : 2, "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value3", "value4" ] } ] }
Código de estado
Para obtener más información, consulte Códigos de estado.
Código de error
Para obtener más información, consulte Códigos de error.