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.
Atualizado em 2023-05-06 GMT+08:00

Consulta de recursos por tag

Descrição

Essa API é usada para consultar as instâncias de banco de dados especificadas por tag.

Restrições

Um máximo de 20 tags pode ser adicionado a uma instância de banco de dados. A chave de tag deve ser única.

Depuração

Você pode depurar essa API no API Explorer.

URI

  • Formato de URI

    POST https://{Endpoint}/v3/{project_id}/instances/action

  • Exemplo de URI

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/action

Tabela 1 Parâmetros de solicitação

Nome

Tipo

IN

Obrigatório

Descrição

x-auth-token

string

header

Sim

Token do usuário

project_id

string

path

Sim

ID do projeto de um locatário em uma região. Para obter o ID do projeto, consulte Obtenção de um ID de projeto.

Solicitações

  • Descrição do parâmetro
    Tabela 2 Descrição do parâmetro

    Nome

    Tipo

    Obrigatório

    Descrição

    offset

    String

    Não

    A posição do índice. A consulta começa a partir do próximo dado indexado por esse parâmetro.

    • Se action estiver definida como count, este parâmetro não será transferido.
    • Se action estiver definida como filter, esse parâmetro deve ser um número inteiro positivo. O valor padrão é 0, indicando que a consulta começa a partir da primeira parte dos dados.

    limit

    String

    Não

    O número de recursos a serem consultados.

    • Se action estiver definida como count, este parâmetro não será transferido.
    • Se action estiver definida como filter, o intervalo de valores será de 1 a 100. Se esse parâmetro não for transferido, as primeiras 100 instâncias de banco de dados serão consultadas por padrão.

    action

    String

    Sim

    O identificador da operação.

    • Se action estiver definida como filter, as instâncias serão consultadas por critérios de filtragem de tags.
    • Se action estiver definida como count, somente o número total de registros será retornado.

    matches

    Array of objects

    Não

    O campo de busca.

    • Se o valor for deixado em branco, a consulta não será baseada no nome da instância ou no ID da instância.
    • Se o valor não estiver vazio, veja Tabela 4.

    tags

    Array of objects

    Não

    As tags incluídas. Cada tag contém um máximo de 20 chaves. Para obter mais informações, consulte Tabela 3.

    Tabela 3 Descrição da estrutura de dados do campo tags

    Nome

    Tipo

    Obrigatório

    Descrição

    key

    String

    Sim

    A chave da tag. Ele contém um máximo de 36 caracteres Unicode. key não pode estar vazia, uma cadeia vazia ou espaços. Antes de usar key, exclua espaços de caractere de byte único (SBC) antes e depois do valor.

    NOTA:

    O conjunto de caracteres deste parâmetro não é verificado no processo de pesquisa.

    values

    Array of strings

    Sim

    Lista os valores da tag. Cada valor contém no máximo 43 caracteres Unicode e não pode conter espaços. Antes de usar values, exclua os espaços de SBC antes e depois do valor.

    Se os valores forem nulos, isso indica a consulta de qualquer valor. Os valores estão na relação OR.

    Tabela 4 Descrição do campo matches

    Nome

    Tipo

    Obrigatório

    Descrição

    key

    String

    Sim

    Os critérios de consulta. O valor pode ser instance_name ou instance_id, indicando que a consulta é baseada no nome da instância ou no ID da instância.

    value

    String

    Sim

    O nome ou ID da instância de banco de dados a ser correspondida. Você pode chamar a API para consultar instâncias de banco de dados para obter o nome ou o ID da instância de banco de dados. Se você não tiver uma instância, poderá chamar a API usada para criar uma instância.

  • Exemplo de solicitação

    Consultar instâncias de banco de dados especificadas por tag.

    {
      "offset": "100",
      "limit": "100",
      "action": "filter",
      "matches": [
        {
          "key": "instance_name",
          "value": "test-single"
        }
      ],
      "tags": [
        {
          "key": "key1",
          "values": [
            "value1",
            "value2"
          ]
        }
      ]
    }
    Consultar o número total de recursos.
    {
      "action": "count",
      "tags": [
        {
          "key": "key1",
          "values": [
            "value1",
            "value2"
          ]
        },
        {
          "key": "key2",
          "values": [
            "value1",
            "value2"
          ]
        }
      ],
      "matches": [
        {
          "key": "instance_name",
          "value": "test-single"
        },
         {
          "key": "instance_id",
          "value": "958693039f284d6ebfb177375711072ein02"
        }
      ]
    }

Respostas

  • Descrição do parâmetro
    Tabela 5 Descrição do parâmetro

    Nome

    Tipo

    Descrição

    instances

    Array of objects

    A lista de instâncias. Para mais detalhes, consulte Tabela 6.

    total_count

    Integer

    O número total de registros consultados.

    Tabela 6 Descrição da estrutura de dados do campo instance

    Nome

    Tipo

    Descrição

    instance_id

    String

    O ID da instância, que pode ser obtido ao chamar a API para consultar instâncias. Se você não tiver uma instância, poderá chamar a API usada para criar uma instância.

    instance_name

    String

    O nome da instância de banco de dados.

    tags

    Array of objects

    A lista de tags. Se não houver nenhuma tag na lista, tags é tomada como uma matriz vazia. Para obter mais informações, consulte Tabela 7.

    Tabela 7 Descrição da estrutura de dados do campo tags

    Nome

    Tipo

    Descrição

    key

    String

    A chave de tag. O valor contém 36 caracteres Unicode e não pode ficar em branco.

    Conjunto de caracteres: 0-9, A-Z, a-z, "_" e "-".

    value

    String

    O valor da tag. O valor contém um máximo de 43 caracteres Unicode e também pode ser uma cadeia de caracteres vazia.

    Conjunto de caracteres: 0-9, A-Z, a-z, "_", "." e "-".

  • Exemplo de resposta

    Retornar instâncias de banco de dados especificadas por tag.

    {
      "instances": [
        {
          "instance_id": "2acbf2223caf3bac3c33c6153423c3ccin02",
          "instance_name": "test-single",
          "tags": [
            {
              "key": "key1",
              "value": "value1"
            },
            {
              "key": "key2",
              "value": "value1"
            }
          ]
        }
      ]
    }

    Número de registros retornados.

    {
      "total_count": 4
    }

SDK

Clique em SDK do Document Database Service DDS para fazer download do SDK ou exibir o documento do SDK. Para saber como instalar e autenticar um SDK, leia a seção Uso.

Código de status

Para obter mais informações, consulte Código de status.

Código de erro

Para obter mais informações, consulte Código de erro.