Consulta de etiquetas de recurso
Función
Esta API se utiliza para consultar etiquetas de una instancia especificada. Antes de invocar a esta API:
- Aprender cómo autorizar y autenticarla.
- Obtenga la región y el punto de conexión requeridos.
URI
GET /v3/{project_id}/instances/{instance_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, vea Obtención de un ID de proyecto. |
|
instance_id |
Sí |
String |
ID de instancia, que es compatible con el formato UUID. |
|
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. Para obtener este valor, invoque a la API de IAM para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el valor del token. |
|
X-Language |
No |
String |
Tipo de idioma de solicitud. El valor predeterminado es en-us. Valores:
|
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 ResourceTagItem objects |
Lista de etiquetas. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
key |
String |
Clave de etiqueta. |
|
value |
String |
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 de recurso
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags?offset=0&limit=2
Ejemplo de respuesta
Código de estado: 200
Operación exitosa.
{
"total_count" : 2,
"tags" : [ {
"key" : "key1",
"value" : "value1"
}, {
"key" : "key2",
"value" : "value2"
} ]
}
Código de estado
Para más detalles, véase Códigos de estado.
Código de error
Para más detalles, véase Códigos de error.