Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda/ Elastic Cloud Server/ Referência de API/ As API (recomendado)/ Gerenciamento de tags/ Consulta dos ECS por marca

Atualizado em 2022-11-08 GMT+08:00

Consulta dos ECS por marca

Função

Essa API é usada para filtrar os ECS por tag e obter todas as tags e recursos usados por um ECS.

URI

POST /v1/{project_id}/cloudservers/resource_instances/action

Tabela 1 descreve os parâmetros no URI.

**Tabela 1** Descrição do parâmetro
Parâmetro	Obrigatório	Descrição
project_id	Sim	Especifica a ID do projeto. Para obter detalhes de como conseguir o ID de domínio, consulte Obtenção de um ID de projeto.

Solicitação

Tabela 2 descreve os parâmetros de solicitação.

**Tabela 2** Parâmetros de solicitação
Parâmetro	Obrigatório	Tipo	Descrição
action	Sim	String	Especifica a operação. filter de valor indica para filtrar os ECS por tag. Os ECSs que atendem aos critérios de filtro são exibidos.
limit	Não	String	Limita o número máximo dos ECS consultados. O valor não pode ser um número negativo. O valor máximo é 1000. Se o valor da action for count, esse parâmetro será inválido. Se o valor da action for filter, este parâmetro é obrigatório. O valor varia de 0 a 1000. Se nenhum valor for especificado para limit, o valor padrão desse parâmetro é 1000.
offset	Não	String	Especifica o início do registro a ser retornado. O valor deve ser um número maior ou igual a 0. Este parâmetro é opcional quando os dados na primeira página são consultados. Se o valor da action for count, esse parâmetro será inválido. Se o valor da action for filter, este parâmetro é obrigatório. Se nenhum valor for especificado para offset, o valor padrão deste parâmetro é 0.
tags	Não	Array of objects	Exibe os ECS com todas as tags especificadas. Para mais detalhes, consulte Tabela 3. Um máximo de 10 chaves estão incluídas. Cada chave pode ter um máximo de 10 valores. O corpo da estrutura deve ser incluído. A chave de tag não pode ser deixada em branco ou definida como uma string vazia. Uma chave deve ser única. Os valores da mesma chave devem ser exclusivos.
not_tags	Não	Array of strings	Exibe os ECS sem nenhuma das tags especificadas. Um máximo de 10 chaves estão incluídas. Cada chave pode ter um máximo de 10 valores. O corpo da estrutura deve ser incluído. A chave de tag não pode ser deixada em branco ou definida como uma string vazia. As chaves devem ser únicas. Os valores da mesma chave devem ser exclusivos.
matches	Não	Array of objects	Especifica o campo de pesquisa, que é usado para pesquisar os ECS. Atualmente, somente resource_name pode ser usado para pesquisa. Para obter mais informações, consulte Tabela 4.

**Tabela 3** Descrição do campo **tag**
Parâmetro	Obrigatório	Tipo	Descrição
key	Sim	String	Especifica a chave de marcação. Contém um máximo de 127 caracteres Unicode. Não pode ser deixado em branco.
values	Sim	Array of strings	Especifica os valores da tag. Cada tag contém um máximo de 10 valores. Os valores da mesma tag devem ser exclusivos. Cada valor contém um máximo de 255 caracteres Unicode. Se este parâmetro não for especificado, seu valor será any_value. Os valores estão na relação OR.

**Tabela 4** Descrição do campo de **match**
Parâmetro	Obrigatório	Tipo	Descrição
key	Sim	String	Especifica o campo-chave a ser correspondido. A chave da tag só pode ser resource_name. Nesse caso, o valor da tag é o nome do ECS. A chave deve ser exclusiva e o valor é usado para correspondência. Este campo é um valor de dicionário fixo. Este campo não pode ser deixado em branco.
value	Sim	String	Especifica o valor da tag. A chave da tag só pode ser resource_name. Nesse caso, o valor da tag é o nome do ECS. Contém um máximo de 255 caracteres Unicode. Não pode ser deixado em branco.

Resposta

Parâmetros de resposta

Tabela 5 descreve os parâmetros de resposta.

**Tabela 5** Parâmetros de resposta
Parâmetro	Tipo	Descrição
resources	Array of objects	Especifica os ECS devolvidos. Para mais detalhes, consulte Tabela 6.
total_count	Integer	Especifica o número total dos ECS consultados.

**Tabela 6** descrição do campo **resource**
Parâmetro	Tipo	Descrição
resource_id	String	Especifica a ID de ECS.
resource_detail	String	Reservado
tags	Array of objects	Lista tags.
resource_name	String	Especifica o nome do recurso, que é o nome do ECS.

**Tabela 7** **resource_tag** Descrição do campo
Parâmetro	Tipo	Descrição
key	String	Especifica a chave de marcação. Contém um máximo de 127 caracteres Unicode. Não pode ser deixado em branco. Consiste apenas em dígitos, letras, hífens (-) e sublinhados (_).
value	String	Especifica o valor da tag. Contém um máximo de 255 caracteres Unicode. Pode ser deixado em branco. Consiste apenas em dígitos, letras, hífens (-) e sublinhados (_).

Exemplos

Exemplo de solicitação

POST  https://{endpoint}/v1/{project_id}/cloudservers/resource_instances/action

{
    "offset": "100", 
    "limit": "1", 
    "action": "filter", 
    "matches":[
    {
        "key": "resource_name", 
        "value": "ecs_test"
     }], 
    "tags": [
    {
        "key": "key1", 
        "values": [
            "value1", 
            "value2"
        ]
    }]
}

Exemplo de resposta

{
      "resources": [
         {
            "resource_detail": null, 
            "resource_id": "31760ffa-6711-406d-bc94-bce4ae925a8a", 
            "resource_name": "ecs_test", 
            "tags": [
                {
                   "key": "key1",
                   "value": "value1"
                }
             ]
         }
       ], 
      "total_count": 1000
}