Consulta de tags de recurso
Função
Essa API é usada para consultar tags de uma instância especificada. Antes de chamar essa API:
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
URI
GET /v3/{project_id}/instances/{instance_id}/tags
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto de um locatário numa região. Para obter esse valor, consulte Obtenção de um ID de projeto. |
instance_id |
Sim |
String |
ID da instância, que é compatível com o formato UUID. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
offset |
Não |
Integer |
Deslocamento do índice. Se offset for definido como N, a consulta de recursos será iniciada a partir da parte N+1 dos dados. O valor é 0 por padrão, indicando que a consulta começa a partir da primeira parte dos dados. O valor não pode ser um número negativo. |
limit |
Não |
Integer |
Número de registros a serem consultados. O valor padrão é 100. O valor deve ser um número inteiro positivo. O valor mínimo é 1 e o valor máximo é 100. |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Token do usuário. Para obter esse valor, chame a API do IAM para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o valor do token. |
X-Language |
Não |
String |
Tipo de linguagem da solicitação. O valor padrão é en-us. Valores:
|
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
total_count |
Integer |
Número total de registros. |
tags |
Array of ResourceTagItem objects |
Lista de tags. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
key |
String |
Chave da tag. |
value |
String |
Valor da tag. |
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Código de status: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Exemplo de solicitação
Consulta de tags de recurso
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/61a4ea66210545909d74a05c27a7179ein07/tags?offset=0&limit=2
Exemplo de resposta
Código de status: 200
Bem-sucedido.
{ "total_count" : 2, "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }
Código de status
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.